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
1136 # define aligned_alloc my_aligned_alloc /* Avoid collision with lisp.h. */
1138 aligned_alloc (size_t alignment
, size_t size
)
1141 return posix_memalign (&p
, alignment
, size
) == 0 ? p
: 0;
1146 /* BLOCK_ALIGN has to be a power of 2. */
1147 #define BLOCK_ALIGN (1 << 10)
1149 /* Padding to leave at the end of a malloc'd block. This is to give
1150 malloc a chance to minimize the amount of memory wasted to alignment.
1151 It should be tuned to the particular malloc library used.
1152 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
1153 aligned_alloc on the other hand would ideally prefer a value of 4
1154 because otherwise, there's 1020 bytes wasted between each ablocks.
1155 In Emacs, testing shows that those 1020 can most of the time be
1156 efficiently used by malloc to place other objects, so a value of 0 can
1157 still preferable unless you have a lot of aligned blocks and virtually
1159 #define BLOCK_PADDING 0
1160 #define BLOCK_BYTES \
1161 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
1163 /* Internal data structures and constants. */
1165 #define ABLOCKS_SIZE 16
1167 /* An aligned block of memory. */
1172 char payload
[BLOCK_BYTES
];
1173 struct ablock
*next_free
;
1175 /* `abase' is the aligned base of the ablocks. */
1176 /* It is overloaded to hold the virtual `busy' field that counts
1177 the number of used ablock in the parent ablocks.
1178 The first ablock has the `busy' field, the others have the `abase'
1179 field. To tell the difference, we assume that pointers will have
1180 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1181 is used to tell whether the real base of the parent ablocks is `abase'
1182 (if not, the word before the first ablock holds a pointer to the
1184 struct ablocks
*abase
;
1185 /* The padding of all but the last ablock is unused. The padding of
1186 the last ablock in an ablocks is not allocated. */
1188 char padding
[BLOCK_PADDING
];
1192 /* A bunch of consecutive aligned blocks. */
1195 struct ablock blocks
[ABLOCKS_SIZE
];
1198 /* Size of the block requested from malloc or aligned_alloc. */
1199 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1201 #define ABLOCK_ABASE(block) \
1202 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1203 ? (struct ablocks *)(block) \
1206 /* Virtual `busy' field. */
1207 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1209 /* Pointer to the (not necessarily aligned) malloc block. */
1210 #ifdef USE_ALIGNED_ALLOC
1211 #define ABLOCKS_BASE(abase) (abase)
1213 #define ABLOCKS_BASE(abase) \
1214 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void **)abase)[-1])
1217 /* The list of free ablock. */
1218 static struct ablock
*free_ablock
;
1220 /* Allocate an aligned block of nbytes.
1221 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1222 smaller or equal to BLOCK_BYTES. */
1224 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1227 struct ablocks
*abase
;
1229 eassert (nbytes
<= BLOCK_BYTES
);
1233 #ifdef GC_MALLOC_CHECK
1234 allocated_mem_type
= type
;
1240 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1242 #ifdef DOUG_LEA_MALLOC
1243 if (!mmap_lisp_allowed_p ())
1244 mallopt (M_MMAP_MAX
, 0);
1247 #ifdef USE_ALIGNED_ALLOC
1248 abase
= base
= aligned_alloc (BLOCK_ALIGN
, ABLOCKS_BYTES
);
1250 base
= malloc (ABLOCKS_BYTES
);
1251 abase
= ALIGN (base
, BLOCK_ALIGN
);
1256 MALLOC_UNBLOCK_INPUT
;
1257 memory_full (ABLOCKS_BYTES
);
1260 aligned
= (base
== abase
);
1262 ((void **) abase
)[-1] = base
;
1264 #ifdef DOUG_LEA_MALLOC
1265 if (!mmap_lisp_allowed_p ())
1266 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1270 /* If the memory just allocated cannot be addressed thru a Lisp
1271 object's pointer, and it needs to be, that's equivalent to
1272 running out of memory. */
1273 if (type
!= MEM_TYPE_NON_LISP
)
1276 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1277 XSETCONS (tem
, end
);
1278 if ((char *) XCONS (tem
) != end
)
1280 lisp_malloc_loser
= base
;
1282 MALLOC_UNBLOCK_INPUT
;
1283 memory_full (SIZE_MAX
);
1288 /* Initialize the blocks and put them on the free list.
1289 If `base' was not properly aligned, we can't use the last block. */
1290 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1292 abase
->blocks
[i
].abase
= abase
;
1293 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1294 free_ablock
= &abase
->blocks
[i
];
1296 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1298 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1299 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1300 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1301 eassert (ABLOCKS_BASE (abase
) == base
);
1302 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1305 abase
= ABLOCK_ABASE (free_ablock
);
1306 ABLOCKS_BUSY (abase
)
1307 = (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1309 free_ablock
= free_ablock
->x
.next_free
;
1311 #ifndef GC_MALLOC_CHECK
1312 if (type
!= MEM_TYPE_NON_LISP
)
1313 mem_insert (val
, (char *) val
+ nbytes
, type
);
1316 MALLOC_UNBLOCK_INPUT
;
1318 MALLOC_PROBE (nbytes
);
1320 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1325 lisp_align_free (void *block
)
1327 struct ablock
*ablock
= block
;
1328 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1331 #ifndef GC_MALLOC_CHECK
1332 mem_delete (mem_find (block
));
1334 /* Put on free list. */
1335 ablock
->x
.next_free
= free_ablock
;
1336 free_ablock
= ablock
;
1337 /* Update busy count. */
1338 ABLOCKS_BUSY (abase
)
1339 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1341 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1342 { /* All the blocks are free. */
1343 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1344 struct ablock
**tem
= &free_ablock
;
1345 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1349 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1352 *tem
= (*tem
)->x
.next_free
;
1355 tem
= &(*tem
)->x
.next_free
;
1357 eassert ((aligned
& 1) == aligned
);
1358 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1359 #ifdef USE_POSIX_MEMALIGN
1360 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1362 free (ABLOCKS_BASE (abase
));
1364 MALLOC_UNBLOCK_INPUT
;
1368 /***********************************************************************
1370 ***********************************************************************/
1372 /* Number of intervals allocated in an interval_block structure.
1373 The 1020 is 1024 minus malloc overhead. */
1375 #define INTERVAL_BLOCK_SIZE \
1376 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1378 /* Intervals are allocated in chunks in the form of an interval_block
1381 struct interval_block
1383 /* Place `intervals' first, to preserve alignment. */
1384 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1385 struct interval_block
*next
;
1388 /* Current interval block. Its `next' pointer points to older
1391 static struct interval_block
*interval_block
;
1393 /* Index in interval_block above of the next unused interval
1396 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1398 /* Number of free and live intervals. */
1400 static EMACS_INT total_free_intervals
, total_intervals
;
1402 /* List of free intervals. */
1404 static INTERVAL interval_free_list
;
1406 /* Return a new interval. */
1409 make_interval (void)
1415 if (interval_free_list
)
1417 val
= interval_free_list
;
1418 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1422 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1424 struct interval_block
*newi
1425 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1427 newi
->next
= interval_block
;
1428 interval_block
= newi
;
1429 interval_block_index
= 0;
1430 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1432 val
= &interval_block
->intervals
[interval_block_index
++];
1435 MALLOC_UNBLOCK_INPUT
;
1437 consing_since_gc
+= sizeof (struct interval
);
1439 total_free_intervals
--;
1440 RESET_INTERVAL (val
);
1446 /* Mark Lisp objects in interval I. */
1449 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1451 /* Intervals should never be shared. So, if extra internal checking is
1452 enabled, GC aborts if it seems to have visited an interval twice. */
1453 eassert (!i
->gcmarkbit
);
1455 mark_object (i
->plist
);
1458 /* Mark the interval tree rooted in I. */
1460 #define MARK_INTERVAL_TREE(i) \
1462 if (i && !i->gcmarkbit) \
1463 traverse_intervals_noorder (i, mark_interval, Qnil); \
1466 /***********************************************************************
1468 ***********************************************************************/
1470 /* Lisp_Strings are allocated in string_block structures. When a new
1471 string_block is allocated, all the Lisp_Strings it contains are
1472 added to a free-list string_free_list. When a new Lisp_String is
1473 needed, it is taken from that list. During the sweep phase of GC,
1474 string_blocks that are entirely free are freed, except two which
1477 String data is allocated from sblock structures. Strings larger
1478 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1479 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1481 Sblocks consist internally of sdata structures, one for each
1482 Lisp_String. The sdata structure points to the Lisp_String it
1483 belongs to. The Lisp_String points back to the `u.data' member of
1484 its sdata structure.
1486 When a Lisp_String is freed during GC, it is put back on
1487 string_free_list, and its `data' member and its sdata's `string'
1488 pointer is set to null. The size of the string is recorded in the
1489 `n.nbytes' member of the sdata. So, sdata structures that are no
1490 longer used, can be easily recognized, and it's easy to compact the
1491 sblocks of small strings which we do in compact_small_strings. */
1493 /* Size in bytes of an sblock structure used for small strings. This
1494 is 8192 minus malloc overhead. */
1496 #define SBLOCK_SIZE 8188
1498 /* Strings larger than this are considered large strings. String data
1499 for large strings is allocated from individual sblocks. */
1501 #define LARGE_STRING_BYTES 1024
1503 /* The SDATA typedef is a struct or union describing string memory
1504 sub-allocated from an sblock. This is where the contents of Lisp
1505 strings are stored. */
1509 /* Back-pointer to the string this sdata belongs to. If null, this
1510 structure is free, and NBYTES (in this structure or in the union below)
1511 contains the string's byte size (the same value that STRING_BYTES
1512 would return if STRING were non-null). If non-null, STRING_BYTES
1513 (STRING) is the size of the data, and DATA contains the string's
1515 struct Lisp_String
*string
;
1517 #ifdef GC_CHECK_STRING_BYTES
1521 unsigned char data
[FLEXIBLE_ARRAY_MEMBER
];
1524 #ifdef GC_CHECK_STRING_BYTES
1526 typedef struct sdata sdata
;
1527 #define SDATA_NBYTES(S) (S)->nbytes
1528 #define SDATA_DATA(S) (S)->data
1534 struct Lisp_String
*string
;
1536 /* When STRING is nonnull, this union is actually of type 'struct sdata',
1537 which has a flexible array member. However, if implemented by
1538 giving this union a member of type 'struct sdata', the union
1539 could not be the last (flexible) member of 'struct sblock',
1540 because C99 prohibits a flexible array member from having a type
1541 that is itself a flexible array. So, comment this member out here,
1542 but remember that the option's there when using this union. */
1547 /* When STRING is null. */
1550 struct Lisp_String
*string
;
1555 #define SDATA_NBYTES(S) (S)->n.nbytes
1556 #define SDATA_DATA(S) ((struct sdata *) (S))->data
1558 #endif /* not GC_CHECK_STRING_BYTES */
1560 enum { SDATA_DATA_OFFSET
= offsetof (struct sdata
, data
) };
1562 /* Structure describing a block of memory which is sub-allocated to
1563 obtain string data memory for strings. Blocks for small strings
1564 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1565 as large as needed. */
1570 struct sblock
*next
;
1572 /* Pointer to the next free sdata block. This points past the end
1573 of the sblock if there isn't any space left in this block. */
1577 sdata data
[FLEXIBLE_ARRAY_MEMBER
];
1580 /* Number of Lisp strings in a string_block structure. The 1020 is
1581 1024 minus malloc overhead. */
1583 #define STRING_BLOCK_SIZE \
1584 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1586 /* Structure describing a block from which Lisp_String structures
1591 /* Place `strings' first, to preserve alignment. */
1592 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1593 struct string_block
*next
;
1596 /* Head and tail of the list of sblock structures holding Lisp string
1597 data. We always allocate from current_sblock. The NEXT pointers
1598 in the sblock structures go from oldest_sblock to current_sblock. */
1600 static struct sblock
*oldest_sblock
, *current_sblock
;
1602 /* List of sblocks for large strings. */
1604 static struct sblock
*large_sblocks
;
1606 /* List of string_block structures. */
1608 static struct string_block
*string_blocks
;
1610 /* Free-list of Lisp_Strings. */
1612 static struct Lisp_String
*string_free_list
;
1614 /* Number of live and free Lisp_Strings. */
1616 static EMACS_INT total_strings
, total_free_strings
;
1618 /* Number of bytes used by live strings. */
1620 static EMACS_INT total_string_bytes
;
1622 /* Given a pointer to a Lisp_String S which is on the free-list
1623 string_free_list, return a pointer to its successor in the
1626 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1628 /* Return a pointer to the sdata structure belonging to Lisp string S.
1629 S must be live, i.e. S->data must not be null. S->data is actually
1630 a pointer to the `u.data' member of its sdata structure; the
1631 structure starts at a constant offset in front of that. */
1633 #define SDATA_OF_STRING(S) ((sdata *) ((S)->data - SDATA_DATA_OFFSET))
1636 #ifdef GC_CHECK_STRING_OVERRUN
1638 /* We check for overrun in string data blocks by appending a small
1639 "cookie" after each allocated string data block, and check for the
1640 presence of this cookie during GC. */
1642 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1643 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1644 { '\xde', '\xad', '\xbe', '\xef' };
1647 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1650 /* Value is the size of an sdata structure large enough to hold NBYTES
1651 bytes of string data. The value returned includes a terminating
1652 NUL byte, the size of the sdata structure, and padding. */
1654 #ifdef GC_CHECK_STRING_BYTES
1656 #define SDATA_SIZE(NBYTES) \
1657 ((SDATA_DATA_OFFSET \
1659 + sizeof (ptrdiff_t) - 1) \
1660 & ~(sizeof (ptrdiff_t) - 1))
1662 #else /* not GC_CHECK_STRING_BYTES */
1664 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1665 less than the size of that member. The 'max' is not needed when
1666 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1667 alignment code reserves enough space. */
1669 #define SDATA_SIZE(NBYTES) \
1670 ((SDATA_DATA_OFFSET \
1671 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1673 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1675 + sizeof (ptrdiff_t) - 1) \
1676 & ~(sizeof (ptrdiff_t) - 1))
1678 #endif /* not GC_CHECK_STRING_BYTES */
1680 /* Extra bytes to allocate for each string. */
1682 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1684 /* Exact bound on the number of bytes in a string, not counting the
1685 terminating null. A string cannot contain more bytes than
1686 STRING_BYTES_BOUND, nor can it be so long that the size_t
1687 arithmetic in allocate_string_data would overflow while it is
1688 calculating a value to be passed to malloc. */
1689 static ptrdiff_t const STRING_BYTES_MAX
=
1690 min (STRING_BYTES_BOUND
,
1691 ((SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
1693 - offsetof (struct sblock
, data
)
1694 - SDATA_DATA_OFFSET
)
1695 & ~(sizeof (EMACS_INT
) - 1)));
1697 /* Initialize string allocation. Called from init_alloc_once. */
1702 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1703 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1707 #ifdef GC_CHECK_STRING_BYTES
1709 static int check_string_bytes_count
;
1711 /* Like STRING_BYTES, but with debugging check. Can be
1712 called during GC, so pay attention to the mark bit. */
1715 string_bytes (struct Lisp_String
*s
)
1718 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1720 if (!PURE_P (s
) && s
->data
&& nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1725 /* Check validity of Lisp strings' string_bytes member in B. */
1728 check_sblock (struct sblock
*b
)
1730 sdata
*from
, *end
, *from_end
;
1734 for (from
= b
->data
; from
< end
; from
= from_end
)
1736 /* Compute the next FROM here because copying below may
1737 overwrite data we need to compute it. */
1740 /* Check that the string size recorded in the string is the
1741 same as the one recorded in the sdata structure. */
1742 nbytes
= SDATA_SIZE (from
->string
? string_bytes (from
->string
)
1743 : SDATA_NBYTES (from
));
1744 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1749 /* Check validity of Lisp strings' string_bytes member. ALL_P
1750 means check all strings, otherwise check only most
1751 recently allocated strings. Used for hunting a bug. */
1754 check_string_bytes (bool all_p
)
1760 for (b
= large_sblocks
; b
; b
= b
->next
)
1762 struct Lisp_String
*s
= b
->data
[0].string
;
1767 for (b
= oldest_sblock
; b
; b
= b
->next
)
1770 else if (current_sblock
)
1771 check_sblock (current_sblock
);
1774 #else /* not GC_CHECK_STRING_BYTES */
1776 #define check_string_bytes(all) ((void) 0)
1778 #endif /* GC_CHECK_STRING_BYTES */
1780 #ifdef GC_CHECK_STRING_FREE_LIST
1782 /* Walk through the string free list looking for bogus next pointers.
1783 This may catch buffer overrun from a previous string. */
1786 check_string_free_list (void)
1788 struct Lisp_String
*s
;
1790 /* Pop a Lisp_String off the free-list. */
1791 s
= string_free_list
;
1794 if ((uintptr_t) s
< 1024)
1796 s
= NEXT_FREE_LISP_STRING (s
);
1800 #define check_string_free_list()
1803 /* Return a new Lisp_String. */
1805 static struct Lisp_String
*
1806 allocate_string (void)
1808 struct Lisp_String
*s
;
1812 /* If the free-list is empty, allocate a new string_block, and
1813 add all the Lisp_Strings in it to the free-list. */
1814 if (string_free_list
== NULL
)
1816 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1819 b
->next
= string_blocks
;
1822 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1825 /* Every string on a free list should have NULL data pointer. */
1827 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1828 string_free_list
= s
;
1831 total_free_strings
+= STRING_BLOCK_SIZE
;
1834 check_string_free_list ();
1836 /* Pop a Lisp_String off the free-list. */
1837 s
= string_free_list
;
1838 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1840 MALLOC_UNBLOCK_INPUT
;
1842 --total_free_strings
;
1845 consing_since_gc
+= sizeof *s
;
1847 #ifdef GC_CHECK_STRING_BYTES
1848 if (!noninteractive
)
1850 if (++check_string_bytes_count
== 200)
1852 check_string_bytes_count
= 0;
1853 check_string_bytes (1);
1856 check_string_bytes (0);
1858 #endif /* GC_CHECK_STRING_BYTES */
1864 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1865 plus a NUL byte at the end. Allocate an sdata structure for S, and
1866 set S->data to its `u.data' member. Store a NUL byte at the end of
1867 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1868 S->data if it was initially non-null. */
1871 allocate_string_data (struct Lisp_String
*s
,
1872 EMACS_INT nchars
, EMACS_INT nbytes
)
1874 sdata
*data
, *old_data
;
1876 ptrdiff_t needed
, old_nbytes
;
1878 if (STRING_BYTES_MAX
< nbytes
)
1881 /* Determine the number of bytes needed to store NBYTES bytes
1883 needed
= SDATA_SIZE (nbytes
);
1886 old_data
= SDATA_OF_STRING (s
);
1887 old_nbytes
= STRING_BYTES (s
);
1894 if (nbytes
> LARGE_STRING_BYTES
)
1896 size_t size
= offsetof (struct sblock
, data
) + needed
;
1898 #ifdef DOUG_LEA_MALLOC
1899 if (!mmap_lisp_allowed_p ())
1900 mallopt (M_MMAP_MAX
, 0);
1903 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
1905 #ifdef DOUG_LEA_MALLOC
1906 if (!mmap_lisp_allowed_p ())
1907 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1910 b
->next_free
= b
->data
;
1911 b
->data
[0].string
= NULL
;
1912 b
->next
= large_sblocks
;
1915 else if (current_sblock
== NULL
1916 || (((char *) current_sblock
+ SBLOCK_SIZE
1917 - (char *) current_sblock
->next_free
)
1918 < (needed
+ GC_STRING_EXTRA
)))
1920 /* Not enough room in the current sblock. */
1921 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
1922 b
->next_free
= b
->data
;
1923 b
->data
[0].string
= NULL
;
1927 current_sblock
->next
= b
;
1935 data
= b
->next_free
;
1936 b
->next_free
= (sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
1938 MALLOC_UNBLOCK_INPUT
;
1941 s
->data
= SDATA_DATA (data
);
1942 #ifdef GC_CHECK_STRING_BYTES
1943 SDATA_NBYTES (data
) = nbytes
;
1946 s
->size_byte
= nbytes
;
1947 s
->data
[nbytes
] = '\0';
1948 #ifdef GC_CHECK_STRING_OVERRUN
1949 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
1950 GC_STRING_OVERRUN_COOKIE_SIZE
);
1953 /* Note that Faset may call to this function when S has already data
1954 assigned. In this case, mark data as free by setting it's string
1955 back-pointer to null, and record the size of the data in it. */
1958 SDATA_NBYTES (old_data
) = old_nbytes
;
1959 old_data
->string
= NULL
;
1962 consing_since_gc
+= needed
;
1966 /* Sweep and compact strings. */
1968 NO_INLINE
/* For better stack traces */
1970 sweep_strings (void)
1972 struct string_block
*b
, *next
;
1973 struct string_block
*live_blocks
= NULL
;
1975 string_free_list
= NULL
;
1976 total_strings
= total_free_strings
= 0;
1977 total_string_bytes
= 0;
1979 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
1980 for (b
= string_blocks
; b
; b
= next
)
1983 struct Lisp_String
*free_list_before
= string_free_list
;
1987 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
1989 struct Lisp_String
*s
= b
->strings
+ i
;
1993 /* String was not on free-list before. */
1994 if (STRING_MARKED_P (s
))
1996 /* String is live; unmark it and its intervals. */
1999 /* Do not use string_(set|get)_intervals here. */
2000 s
->intervals
= balance_intervals (s
->intervals
);
2003 total_string_bytes
+= STRING_BYTES (s
);
2007 /* String is dead. Put it on the free-list. */
2008 sdata
*data
= SDATA_OF_STRING (s
);
2010 /* Save the size of S in its sdata so that we know
2011 how large that is. Reset the sdata's string
2012 back-pointer so that we know it's free. */
2013 #ifdef GC_CHECK_STRING_BYTES
2014 if (string_bytes (s
) != SDATA_NBYTES (data
))
2017 data
->n
.nbytes
= STRING_BYTES (s
);
2019 data
->string
= NULL
;
2021 /* Reset the strings's `data' member so that we
2025 /* Put the string on the free-list. */
2026 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2027 string_free_list
= s
;
2033 /* S was on the free-list before. Put it there again. */
2034 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2035 string_free_list
= s
;
2040 /* Free blocks that contain free Lisp_Strings only, except
2041 the first two of them. */
2042 if (nfree
== STRING_BLOCK_SIZE
2043 && total_free_strings
> STRING_BLOCK_SIZE
)
2046 string_free_list
= free_list_before
;
2050 total_free_strings
+= nfree
;
2051 b
->next
= live_blocks
;
2056 check_string_free_list ();
2058 string_blocks
= live_blocks
;
2059 free_large_strings ();
2060 compact_small_strings ();
2062 check_string_free_list ();
2066 /* Free dead large strings. */
2069 free_large_strings (void)
2071 struct sblock
*b
, *next
;
2072 struct sblock
*live_blocks
= NULL
;
2074 for (b
= large_sblocks
; b
; b
= next
)
2078 if (b
->data
[0].string
== NULL
)
2082 b
->next
= live_blocks
;
2087 large_sblocks
= live_blocks
;
2091 /* Compact data of small strings. Free sblocks that don't contain
2092 data of live strings after compaction. */
2095 compact_small_strings (void)
2097 struct sblock
*b
, *tb
, *next
;
2098 sdata
*from
, *to
, *end
, *tb_end
;
2099 sdata
*to_end
, *from_end
;
2101 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2102 to, and TB_END is the end of TB. */
2104 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2107 /* Step through the blocks from the oldest to the youngest. We
2108 expect that old blocks will stabilize over time, so that less
2109 copying will happen this way. */
2110 for (b
= oldest_sblock
; b
; b
= b
->next
)
2113 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2115 for (from
= b
->data
; from
< end
; from
= from_end
)
2117 /* Compute the next FROM here because copying below may
2118 overwrite data we need to compute it. */
2120 struct Lisp_String
*s
= from
->string
;
2122 #ifdef GC_CHECK_STRING_BYTES
2123 /* Check that the string size recorded in the string is the
2124 same as the one recorded in the sdata structure. */
2125 if (s
&& string_bytes (s
) != SDATA_NBYTES (from
))
2127 #endif /* GC_CHECK_STRING_BYTES */
2129 nbytes
= s
? STRING_BYTES (s
) : SDATA_NBYTES (from
);
2130 eassert (nbytes
<= LARGE_STRING_BYTES
);
2132 nbytes
= SDATA_SIZE (nbytes
);
2133 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2135 #ifdef GC_CHECK_STRING_OVERRUN
2136 if (memcmp (string_overrun_cookie
,
2137 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2138 GC_STRING_OVERRUN_COOKIE_SIZE
))
2142 /* Non-NULL S means it's alive. Copy its data. */
2145 /* If TB is full, proceed with the next sblock. */
2146 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2147 if (to_end
> tb_end
)
2151 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2153 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2156 /* Copy, and update the string's `data' pointer. */
2159 eassert (tb
!= b
|| to
< from
);
2160 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2161 to
->string
->data
= SDATA_DATA (to
);
2164 /* Advance past the sdata we copied to. */
2170 /* The rest of the sblocks following TB don't contain live data, so
2171 we can free them. */
2172 for (b
= tb
->next
; b
; b
= next
)
2180 current_sblock
= tb
;
2184 string_overflow (void)
2186 error ("Maximum string size exceeded");
2189 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2190 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2191 LENGTH must be an integer.
2192 INIT must be an integer that represents a character. */)
2193 (Lisp_Object length
, Lisp_Object init
)
2195 register Lisp_Object val
;
2199 CHECK_NATNUM (length
);
2200 CHECK_CHARACTER (init
);
2202 c
= XFASTINT (init
);
2203 if (ASCII_CHAR_P (c
))
2205 nbytes
= XINT (length
);
2206 val
= make_uninit_string (nbytes
);
2209 memset (SDATA (val
), c
, nbytes
);
2210 SDATA (val
)[nbytes
] = 0;
2215 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2216 ptrdiff_t len
= CHAR_STRING (c
, str
);
2217 EMACS_INT string_len
= XINT (length
);
2218 unsigned char *p
, *beg
, *end
;
2220 if (INT_MULTIPLY_WRAPV (len
, string_len
, &nbytes
))
2222 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2223 for (beg
= SDATA (val
), p
= beg
, end
= beg
+ nbytes
; p
< end
; p
+= len
)
2225 /* First time we just copy `str' to the data of `val'. */
2227 memcpy (p
, str
, len
);
2230 /* Next time we copy largest possible chunk from
2231 initialized to uninitialized part of `val'. */
2232 len
= min (p
- beg
, end
- p
);
2233 memcpy (p
, beg
, len
);
2243 /* Fill A with 1 bits if INIT is non-nil, and with 0 bits otherwise.
2247 bool_vector_fill (Lisp_Object a
, Lisp_Object init
)
2249 EMACS_INT nbits
= bool_vector_size (a
);
2252 unsigned char *data
= bool_vector_uchar_data (a
);
2253 int pattern
= NILP (init
) ? 0 : (1 << BOOL_VECTOR_BITS_PER_CHAR
) - 1;
2254 ptrdiff_t nbytes
= bool_vector_bytes (nbits
);
2255 int last_mask
= ~ (~0u << ((nbits
- 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1));
2256 memset (data
, pattern
, nbytes
- 1);
2257 data
[nbytes
- 1] = pattern
& last_mask
;
2262 /* Return a newly allocated, uninitialized bool vector of size NBITS. */
2265 make_uninit_bool_vector (EMACS_INT nbits
)
2268 EMACS_INT words
= bool_vector_words (nbits
);
2269 EMACS_INT word_bytes
= words
* sizeof (bits_word
);
2270 EMACS_INT needed_elements
= ((bool_header_size
- header_size
+ word_bytes
2273 struct Lisp_Bool_Vector
*p
2274 = (struct Lisp_Bool_Vector
*) allocate_vector (needed_elements
);
2275 XSETVECTOR (val
, p
);
2276 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0, 0);
2279 /* Clear padding at the end. */
2281 p
->data
[words
- 1] = 0;
2286 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2287 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2288 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2289 (Lisp_Object length
, Lisp_Object init
)
2293 CHECK_NATNUM (length
);
2294 val
= make_uninit_bool_vector (XFASTINT (length
));
2295 return bool_vector_fill (val
, init
);
2298 DEFUN ("bool-vector", Fbool_vector
, Sbool_vector
, 0, MANY
, 0,
2299 doc
: /* Return a new bool-vector with specified arguments as elements.
2300 Any number of arguments, even zero arguments, are allowed.
2301 usage: (bool-vector &rest OBJECTS) */)
2302 (ptrdiff_t nargs
, Lisp_Object
*args
)
2307 vector
= make_uninit_bool_vector (nargs
);
2308 for (i
= 0; i
< nargs
; i
++)
2309 bool_vector_set (vector
, i
, !NILP (args
[i
]));
2314 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2315 of characters from the contents. This string may be unibyte or
2316 multibyte, depending on the contents. */
2319 make_string (const char *contents
, ptrdiff_t nbytes
)
2321 register Lisp_Object val
;
2322 ptrdiff_t nchars
, multibyte_nbytes
;
2324 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2325 &nchars
, &multibyte_nbytes
);
2326 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2327 /* CONTENTS contains no multibyte sequences or contains an invalid
2328 multibyte sequence. We must make unibyte string. */
2329 val
= make_unibyte_string (contents
, nbytes
);
2331 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2335 /* Make a unibyte string from LENGTH bytes at CONTENTS. */
2338 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2340 register Lisp_Object val
;
2341 val
= make_uninit_string (length
);
2342 memcpy (SDATA (val
), contents
, length
);
2347 /* Make a multibyte string from NCHARS characters occupying NBYTES
2348 bytes at CONTENTS. */
2351 make_multibyte_string (const char *contents
,
2352 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2354 register Lisp_Object val
;
2355 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2356 memcpy (SDATA (val
), contents
, nbytes
);
2361 /* Make a string from NCHARS characters occupying NBYTES bytes at
2362 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2365 make_string_from_bytes (const char *contents
,
2366 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2368 register Lisp_Object val
;
2369 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2370 memcpy (SDATA (val
), contents
, nbytes
);
2371 if (SBYTES (val
) == SCHARS (val
))
2372 STRING_SET_UNIBYTE (val
);
2377 /* Make a string from NCHARS characters occupying NBYTES bytes at
2378 CONTENTS. The argument MULTIBYTE controls whether to label the
2379 string as multibyte. If NCHARS is negative, it counts the number of
2380 characters by itself. */
2383 make_specified_string (const char *contents
,
2384 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
2391 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2396 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2397 memcpy (SDATA (val
), contents
, nbytes
);
2399 STRING_SET_UNIBYTE (val
);
2404 /* Return a unibyte Lisp_String set up to hold LENGTH characters
2405 occupying LENGTH bytes. */
2408 make_uninit_string (EMACS_INT length
)
2413 return empty_unibyte_string
;
2414 val
= make_uninit_multibyte_string (length
, length
);
2415 STRING_SET_UNIBYTE (val
);
2420 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2421 which occupy NBYTES bytes. */
2424 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2427 struct Lisp_String
*s
;
2432 return empty_multibyte_string
;
2434 s
= allocate_string ();
2435 s
->intervals
= NULL
;
2436 allocate_string_data (s
, nchars
, nbytes
);
2437 XSETSTRING (string
, s
);
2438 string_chars_consed
+= nbytes
;
2442 /* Print arguments to BUF according to a FORMAT, then return
2443 a Lisp_String initialized with the data from BUF. */
2446 make_formatted_string (char *buf
, const char *format
, ...)
2451 va_start (ap
, format
);
2452 length
= vsprintf (buf
, format
, ap
);
2454 return make_string (buf
, length
);
2458 /***********************************************************************
2460 ***********************************************************************/
2462 /* We store float cells inside of float_blocks, allocating a new
2463 float_block with malloc whenever necessary. Float cells reclaimed
2464 by GC are put on a free list to be reallocated before allocating
2465 any new float cells from the latest float_block. */
2467 #define FLOAT_BLOCK_SIZE \
2468 (((BLOCK_BYTES - sizeof (struct float_block *) \
2469 /* The compiler might add padding at the end. */ \
2470 - (sizeof (struct Lisp_Float) - sizeof (bits_word))) * CHAR_BIT) \
2471 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2473 #define GETMARKBIT(block,n) \
2474 (((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2475 >> ((n) % BITS_PER_BITS_WORD)) \
2478 #define SETMARKBIT(block,n) \
2479 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2480 |= (bits_word) 1 << ((n) % BITS_PER_BITS_WORD))
2482 #define UNSETMARKBIT(block,n) \
2483 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2484 &= ~((bits_word) 1 << ((n) % BITS_PER_BITS_WORD)))
2486 #define FLOAT_BLOCK(fptr) \
2487 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2489 #define FLOAT_INDEX(fptr) \
2490 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2494 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2495 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2496 bits_word gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2497 struct float_block
*next
;
2500 #define FLOAT_MARKED_P(fptr) \
2501 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2503 #define FLOAT_MARK(fptr) \
2504 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2506 #define FLOAT_UNMARK(fptr) \
2507 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2509 /* Current float_block. */
2511 static struct float_block
*float_block
;
2513 /* Index of first unused Lisp_Float in the current float_block. */
2515 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2517 /* Free-list of Lisp_Floats. */
2519 static struct Lisp_Float
*float_free_list
;
2521 /* Return a new float object with value FLOAT_VALUE. */
2524 make_float (double float_value
)
2526 register Lisp_Object val
;
2530 if (float_free_list
)
2532 /* We use the data field for chaining the free list
2533 so that we won't use the same field that has the mark bit. */
2534 XSETFLOAT (val
, float_free_list
);
2535 float_free_list
= float_free_list
->u
.chain
;
2539 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2541 struct float_block
*new
2542 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2543 new->next
= float_block
;
2544 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2546 float_block_index
= 0;
2547 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2549 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2550 float_block_index
++;
2553 MALLOC_UNBLOCK_INPUT
;
2555 XFLOAT_INIT (val
, float_value
);
2556 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2557 consing_since_gc
+= sizeof (struct Lisp_Float
);
2559 total_free_floats
--;
2565 /***********************************************************************
2567 ***********************************************************************/
2569 /* We store cons cells inside of cons_blocks, allocating a new
2570 cons_block with malloc whenever necessary. Cons cells reclaimed by
2571 GC are put on a free list to be reallocated before allocating
2572 any new cons cells from the latest cons_block. */
2574 #define CONS_BLOCK_SIZE \
2575 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2576 /* The compiler might add padding at the end. */ \
2577 - (sizeof (struct Lisp_Cons) - sizeof (bits_word))) * CHAR_BIT) \
2578 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2580 #define CONS_BLOCK(fptr) \
2581 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2583 #define CONS_INDEX(fptr) \
2584 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2588 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2589 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2590 bits_word gcmarkbits
[1 + CONS_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2591 struct cons_block
*next
;
2594 #define CONS_MARKED_P(fptr) \
2595 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2597 #define CONS_MARK(fptr) \
2598 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2600 #define CONS_UNMARK(fptr) \
2601 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2603 /* Current cons_block. */
2605 static struct cons_block
*cons_block
;
2607 /* Index of first unused Lisp_Cons in the current block. */
2609 static int cons_block_index
= CONS_BLOCK_SIZE
;
2611 /* Free-list of Lisp_Cons structures. */
2613 static struct Lisp_Cons
*cons_free_list
;
2615 /* Explicitly free a cons cell by putting it on the free-list. */
2618 free_cons (struct Lisp_Cons
*ptr
)
2620 ptr
->u
.chain
= cons_free_list
;
2622 cons_free_list
= ptr
;
2623 consing_since_gc
-= sizeof *ptr
;
2624 total_free_conses
++;
2627 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2628 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2629 (Lisp_Object car
, Lisp_Object cdr
)
2631 register Lisp_Object val
;
2637 /* We use the cdr for chaining the free list
2638 so that we won't use the same field that has the mark bit. */
2639 XSETCONS (val
, cons_free_list
);
2640 cons_free_list
= cons_free_list
->u
.chain
;
2644 if (cons_block_index
== CONS_BLOCK_SIZE
)
2646 struct cons_block
*new
2647 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2648 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2649 new->next
= cons_block
;
2651 cons_block_index
= 0;
2652 total_free_conses
+= CONS_BLOCK_SIZE
;
2654 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2658 MALLOC_UNBLOCK_INPUT
;
2662 eassert (!CONS_MARKED_P (XCONS (val
)));
2663 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2664 total_free_conses
--;
2665 cons_cells_consed
++;
2669 #ifdef GC_CHECK_CONS_LIST
2670 /* Get an error now if there's any junk in the cons free list. */
2672 check_cons_list (void)
2674 struct Lisp_Cons
*tail
= cons_free_list
;
2677 tail
= tail
->u
.chain
;
2681 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2684 list1 (Lisp_Object arg1
)
2686 return Fcons (arg1
, Qnil
);
2690 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2692 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2697 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2699 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2704 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2706 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2711 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2713 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2714 Fcons (arg5
, Qnil
)))));
2717 /* Make a list of COUNT Lisp_Objects, where ARG is the
2718 first one. Allocate conses from pure space if TYPE
2719 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2722 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2724 Lisp_Object (*cons
) (Lisp_Object
, Lisp_Object
);
2727 case CONSTYPE_PURE
: cons
= pure_cons
; break;
2728 case CONSTYPE_HEAP
: cons
= Fcons
; break;
2729 default: emacs_abort ();
2732 eassume (0 < count
);
2733 Lisp_Object val
= cons (arg
, Qnil
);
2734 Lisp_Object tail
= val
;
2738 for (ptrdiff_t i
= 1; i
< count
; i
++)
2740 Lisp_Object elem
= cons (va_arg (ap
, Lisp_Object
), Qnil
);
2741 XSETCDR (tail
, elem
);
2749 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2750 doc
: /* Return a newly created list with specified arguments as elements.
2751 Any number of arguments, even zero arguments, are allowed.
2752 usage: (list &rest OBJECTS) */)
2753 (ptrdiff_t nargs
, Lisp_Object
*args
)
2755 register Lisp_Object val
;
2761 val
= Fcons (args
[nargs
], val
);
2767 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2768 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2769 (register Lisp_Object length
, Lisp_Object init
)
2771 register Lisp_Object val
;
2772 register EMACS_INT size
;
2774 CHECK_NATNUM (length
);
2775 size
= XFASTINT (length
);
2780 val
= Fcons (init
, val
);
2785 val
= Fcons (init
, val
);
2790 val
= Fcons (init
, val
);
2795 val
= Fcons (init
, val
);
2800 val
= Fcons (init
, val
);
2815 /***********************************************************************
2817 ***********************************************************************/
2819 /* Sometimes a vector's contents are merely a pointer internally used
2820 in vector allocation code. On the rare platforms where a null
2821 pointer cannot be tagged, represent it with a Lisp 0.
2822 Usually you don't want to touch this. */
2824 static struct Lisp_Vector
*
2825 next_vector (struct Lisp_Vector
*v
)
2827 return XUNTAG (v
->contents
[0], Lisp_Int0
);
2831 set_next_vector (struct Lisp_Vector
*v
, struct Lisp_Vector
*p
)
2833 v
->contents
[0] = make_lisp_ptr (p
, Lisp_Int0
);
2836 /* This value is balanced well enough to avoid too much internal overhead
2837 for the most common cases; it's not required to be a power of two, but
2838 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2840 #define VECTOR_BLOCK_SIZE 4096
2844 /* Alignment of struct Lisp_Vector objects. */
2845 vector_alignment
= COMMON_MULTIPLE (ALIGNOF_STRUCT_LISP_VECTOR
,
2848 /* Vector size requests are a multiple of this. */
2849 roundup_size
= COMMON_MULTIPLE (vector_alignment
, word_size
)
2852 /* Verify assumptions described above. */
2853 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2854 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2856 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at compile time. */
2857 #define vroundup_ct(x) ROUNDUP (x, roundup_size)
2858 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at runtime. */
2859 #define vroundup(x) (eassume ((x) >= 0), vroundup_ct (x))
2861 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2863 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup_ct (sizeof (void *)))
2865 /* Size of the minimal vector allocated from block. */
2867 #define VBLOCK_BYTES_MIN vroundup_ct (header_size + sizeof (Lisp_Object))
2869 /* Size of the largest vector allocated from block. */
2871 #define VBLOCK_BYTES_MAX \
2872 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2874 /* We maintain one free list for each possible block-allocated
2875 vector size, and this is the number of free lists we have. */
2877 #define VECTOR_MAX_FREE_LIST_INDEX \
2878 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2880 /* Common shortcut to advance vector pointer over a block data. */
2882 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2884 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2886 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2888 /* Common shortcut to setup vector on a free list. */
2890 #define SETUP_ON_FREE_LIST(v, nbytes, tmp) \
2892 (tmp) = ((nbytes - header_size) / word_size); \
2893 XSETPVECTYPESIZE (v, PVEC_FREE, 0, (tmp)); \
2894 eassert ((nbytes) % roundup_size == 0); \
2895 (tmp) = VINDEX (nbytes); \
2896 eassert ((tmp) < VECTOR_MAX_FREE_LIST_INDEX); \
2897 set_next_vector (v, vector_free_lists[tmp]); \
2898 vector_free_lists[tmp] = (v); \
2899 total_free_vector_slots += (nbytes) / word_size; \
2902 /* This internal type is used to maintain the list of large vectors
2903 which are allocated at their own, e.g. outside of vector blocks.
2905 struct large_vector itself cannot contain a struct Lisp_Vector, as
2906 the latter contains a flexible array member and C99 does not allow
2907 such structs to be nested. Instead, each struct large_vector
2908 object LV is followed by a struct Lisp_Vector, which is at offset
2909 large_vector_offset from LV, and whose address is therefore
2910 large_vector_vec (&LV). */
2914 struct large_vector
*next
;
2919 large_vector_offset
= ROUNDUP (sizeof (struct large_vector
), vector_alignment
)
2922 static struct Lisp_Vector
*
2923 large_vector_vec (struct large_vector
*p
)
2925 return (struct Lisp_Vector
*) ((char *) p
+ large_vector_offset
);
2928 /* This internal type is used to maintain an underlying storage
2929 for small vectors. */
2933 char data
[VECTOR_BLOCK_BYTES
];
2934 struct vector_block
*next
;
2937 /* Chain of vector blocks. */
2939 static struct vector_block
*vector_blocks
;
2941 /* Vector free lists, where NTH item points to a chain of free
2942 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2944 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2946 /* Singly-linked list of large vectors. */
2948 static struct large_vector
*large_vectors
;
2950 /* The only vector with 0 slots, allocated from pure space. */
2952 Lisp_Object zero_vector
;
2954 /* Number of live vectors. */
2956 static EMACS_INT total_vectors
;
2958 /* Total size of live and free vectors, in Lisp_Object units. */
2960 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
2962 /* Get a new vector block. */
2964 static struct vector_block
*
2965 allocate_vector_block (void)
2967 struct vector_block
*block
= xmalloc (sizeof *block
);
2969 #ifndef GC_MALLOC_CHECK
2970 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
2971 MEM_TYPE_VECTOR_BLOCK
);
2974 block
->next
= vector_blocks
;
2975 vector_blocks
= block
;
2979 /* Called once to initialize vector allocation. */
2984 zero_vector
= make_pure_vector (0);
2987 /* Allocate vector from a vector block. */
2989 static struct Lisp_Vector
*
2990 allocate_vector_from_block (size_t nbytes
)
2992 struct Lisp_Vector
*vector
;
2993 struct vector_block
*block
;
2994 size_t index
, restbytes
;
2996 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
2997 eassert (nbytes
% roundup_size
== 0);
2999 /* First, try to allocate from a free list
3000 containing vectors of the requested size. */
3001 index
= VINDEX (nbytes
);
3002 if (vector_free_lists
[index
])
3004 vector
= vector_free_lists
[index
];
3005 vector_free_lists
[index
] = next_vector (vector
);
3006 total_free_vector_slots
-= nbytes
/ word_size
;
3010 /* Next, check free lists containing larger vectors. Since
3011 we will split the result, we should have remaining space
3012 large enough to use for one-slot vector at least. */
3013 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
3014 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
3015 if (vector_free_lists
[index
])
3017 /* This vector is larger than requested. */
3018 vector
= vector_free_lists
[index
];
3019 vector_free_lists
[index
] = next_vector (vector
);
3020 total_free_vector_slots
-= nbytes
/ word_size
;
3022 /* Excess bytes are used for the smaller vector,
3023 which should be set on an appropriate free list. */
3024 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
3025 eassert (restbytes
% roundup_size
== 0);
3026 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
3030 /* Finally, need a new vector block. */
3031 block
= allocate_vector_block ();
3033 /* New vector will be at the beginning of this block. */
3034 vector
= (struct Lisp_Vector
*) block
->data
;
3036 /* If the rest of space from this block is large enough
3037 for one-slot vector at least, set up it on a free list. */
3038 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
3039 if (restbytes
>= VBLOCK_BYTES_MIN
)
3041 eassert (restbytes
% roundup_size
== 0);
3042 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
3047 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
3049 #define VECTOR_IN_BLOCK(vector, block) \
3050 ((char *) (vector) <= (block)->data \
3051 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
3053 /* Return the memory footprint of V in bytes. */
3056 vector_nbytes (struct Lisp_Vector
*v
)
3058 ptrdiff_t size
= v
->header
.size
& ~ARRAY_MARK_FLAG
;
3061 if (size
& PSEUDOVECTOR_FLAG
)
3063 if (PSEUDOVECTOR_TYPEP (&v
->header
, PVEC_BOOL_VECTOR
))
3065 struct Lisp_Bool_Vector
*bv
= (struct Lisp_Bool_Vector
*) v
;
3066 ptrdiff_t word_bytes
= (bool_vector_words (bv
->size
)
3067 * sizeof (bits_word
));
3068 ptrdiff_t boolvec_bytes
= bool_header_size
+ word_bytes
;
3069 verify (header_size
<= bool_header_size
);
3070 nwords
= (boolvec_bytes
- header_size
+ word_size
- 1) / word_size
;
3073 nwords
= ((size
& PSEUDOVECTOR_SIZE_MASK
)
3074 + ((size
& PSEUDOVECTOR_REST_MASK
)
3075 >> PSEUDOVECTOR_SIZE_BITS
));
3079 return vroundup (header_size
+ word_size
* nwords
);
3082 /* Release extra resources still in use by VECTOR, which may be any
3083 vector-like object. For now, this is used just to free data in
3087 cleanup_vector (struct Lisp_Vector
*vector
)
3089 detect_suspicious_free (vector
);
3090 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FONT
)
3091 && ((vector
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
3092 == FONT_OBJECT_MAX
))
3094 struct font_driver
*drv
= ((struct font
*) vector
)->driver
;
3096 /* The font driver might sometimes be NULL, e.g. if Emacs was
3097 interrupted before it had time to set it up. */
3100 /* Attempt to catch subtle bugs like Bug#16140. */
3101 eassert (valid_font_driver (drv
));
3102 drv
->close ((struct font
*) vector
);
3107 /* Reclaim space used by unmarked vectors. */
3109 NO_INLINE
/* For better stack traces */
3111 sweep_vectors (void)
3113 struct vector_block
*block
, **bprev
= &vector_blocks
;
3114 struct large_vector
*lv
, **lvprev
= &large_vectors
;
3115 struct Lisp_Vector
*vector
, *next
;
3117 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
3118 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
3120 /* Looking through vector blocks. */
3122 for (block
= vector_blocks
; block
; block
= *bprev
)
3124 bool free_this_block
= 0;
3127 for (vector
= (struct Lisp_Vector
*) block
->data
;
3128 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
3130 if (VECTOR_MARKED_P (vector
))
3132 VECTOR_UNMARK (vector
);
3134 nbytes
= vector_nbytes (vector
);
3135 total_vector_slots
+= nbytes
/ word_size
;
3136 next
= ADVANCE (vector
, nbytes
);
3140 ptrdiff_t total_bytes
;
3142 cleanup_vector (vector
);
3143 nbytes
= vector_nbytes (vector
);
3144 total_bytes
= nbytes
;
3145 next
= ADVANCE (vector
, nbytes
);
3147 /* While NEXT is not marked, try to coalesce with VECTOR,
3148 thus making VECTOR of the largest possible size. */
3150 while (VECTOR_IN_BLOCK (next
, block
))
3152 if (VECTOR_MARKED_P (next
))
3154 cleanup_vector (next
);
3155 nbytes
= vector_nbytes (next
);
3156 total_bytes
+= nbytes
;
3157 next
= ADVANCE (next
, nbytes
);
3160 eassert (total_bytes
% roundup_size
== 0);
3162 if (vector
== (struct Lisp_Vector
*) block
->data
3163 && !VECTOR_IN_BLOCK (next
, block
))
3164 /* This block should be freed because all of its
3165 space was coalesced into the only free vector. */
3166 free_this_block
= 1;
3170 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
3175 if (free_this_block
)
3177 *bprev
= block
->next
;
3178 #ifndef GC_MALLOC_CHECK
3179 mem_delete (mem_find (block
->data
));
3184 bprev
= &block
->next
;
3187 /* Sweep large vectors. */
3189 for (lv
= large_vectors
; lv
; lv
= *lvprev
)
3191 vector
= large_vector_vec (lv
);
3192 if (VECTOR_MARKED_P (vector
))
3194 VECTOR_UNMARK (vector
);
3196 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
3198 /* All non-bool pseudovectors are small enough to be allocated
3199 from vector blocks. This code should be redesigned if some
3200 pseudovector type grows beyond VBLOCK_BYTES_MAX. */
3201 eassert (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_BOOL_VECTOR
));
3202 total_vector_slots
+= vector_nbytes (vector
) / word_size
;
3206 += header_size
/ word_size
+ vector
->header
.size
;
3217 /* Value is a pointer to a newly allocated Lisp_Vector structure
3218 with room for LEN Lisp_Objects. */
3220 static struct Lisp_Vector
*
3221 allocate_vectorlike (ptrdiff_t len
)
3223 struct Lisp_Vector
*p
;
3228 p
= XVECTOR (zero_vector
);
3231 size_t nbytes
= header_size
+ len
* word_size
;
3233 #ifdef DOUG_LEA_MALLOC
3234 if (!mmap_lisp_allowed_p ())
3235 mallopt (M_MMAP_MAX
, 0);
3238 if (nbytes
<= VBLOCK_BYTES_MAX
)
3239 p
= allocate_vector_from_block (vroundup (nbytes
));
3242 struct large_vector
*lv
3243 = lisp_malloc ((large_vector_offset
+ header_size
3245 MEM_TYPE_VECTORLIKE
);
3246 lv
->next
= large_vectors
;
3248 p
= large_vector_vec (lv
);
3251 #ifdef DOUG_LEA_MALLOC
3252 if (!mmap_lisp_allowed_p ())
3253 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3256 if (find_suspicious_object_in_range (p
, (char *) p
+ nbytes
))
3259 consing_since_gc
+= nbytes
;
3260 vector_cells_consed
+= len
;
3263 MALLOC_UNBLOCK_INPUT
;
3269 /* Allocate a vector with LEN slots. */
3271 struct Lisp_Vector
*
3272 allocate_vector (EMACS_INT len
)
3274 struct Lisp_Vector
*v
;
3275 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3277 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3278 memory_full (SIZE_MAX
);
3279 v
= allocate_vectorlike (len
);
3281 v
->header
.size
= len
;
3286 /* Allocate other vector-like structures. */
3288 struct Lisp_Vector
*
3289 allocate_pseudovector (int memlen
, int lisplen
,
3290 int zerolen
, enum pvec_type tag
)
3292 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3294 /* Catch bogus values. */
3295 eassert (0 <= tag
&& tag
<= PVEC_FONT
);
3296 eassert (0 <= lisplen
&& lisplen
<= zerolen
&& zerolen
<= memlen
);
3297 eassert (memlen
- lisplen
<= (1 << PSEUDOVECTOR_REST_BITS
) - 1);
3298 eassert (lisplen
<= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1);
3300 /* Only the first LISPLEN slots will be traced normally by the GC. */
3301 memclear (v
->contents
, zerolen
* word_size
);
3302 XSETPVECTYPESIZE (v
, tag
, lisplen
, memlen
- lisplen
);
3307 allocate_buffer (void)
3309 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3311 BUFFER_PVEC_INIT (b
);
3312 /* Put B on the chain of all buffers including killed ones. */
3313 b
->next
= all_buffers
;
3315 /* Note that the rest fields of B are not initialized. */
3319 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3320 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3321 See also the function `vector'. */)
3322 (Lisp_Object length
, Lisp_Object init
)
3324 CHECK_NATNUM (length
);
3325 struct Lisp_Vector
*p
= allocate_vector (XFASTINT (length
));
3326 for (ptrdiff_t i
= 0; i
< XFASTINT (length
); i
++)
3327 p
->contents
[i
] = init
;
3328 return make_lisp_ptr (p
, Lisp_Vectorlike
);
3331 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3332 doc
: /* Return a newly created vector with specified arguments as elements.
3333 Any number of arguments, even zero arguments, are allowed.
3334 usage: (vector &rest OBJECTS) */)
3335 (ptrdiff_t nargs
, Lisp_Object
*args
)
3337 Lisp_Object val
= make_uninit_vector (nargs
);
3338 struct Lisp_Vector
*p
= XVECTOR (val
);
3339 memcpy (p
->contents
, args
, nargs
* sizeof *args
);
3344 make_byte_code (struct Lisp_Vector
*v
)
3346 /* Don't allow the global zero_vector to become a byte code object. */
3347 eassert (0 < v
->header
.size
);
3349 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3350 && STRING_MULTIBYTE (v
->contents
[1]))
3351 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3352 earlier because they produced a raw 8-bit string for byte-code
3353 and now such a byte-code string is loaded as multibyte while
3354 raw 8-bit characters converted to multibyte form. Thus, now we
3355 must convert them back to the original unibyte form. */
3356 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3357 XSETPVECTYPE (v
, PVEC_COMPILED
);
3360 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3361 doc
: /* Create a byte-code object with specified arguments as elements.
3362 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3363 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3364 and (optional) INTERACTIVE-SPEC.
3365 The first four arguments are required; at most six have any
3367 The ARGLIST can be either like the one of `lambda', in which case the arguments
3368 will be dynamically bound before executing the byte code, or it can be an
3369 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3370 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3371 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3372 argument to catch the left-over arguments. If such an integer is used, the
3373 arguments will not be dynamically bound but will be instead pushed on the
3374 stack before executing the byte-code.
3375 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3376 (ptrdiff_t nargs
, Lisp_Object
*args
)
3378 Lisp_Object val
= make_uninit_vector (nargs
);
3379 struct Lisp_Vector
*p
= XVECTOR (val
);
3381 /* We used to purecopy everything here, if purify-flag was set. This worked
3382 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3383 dangerous, since make-byte-code is used during execution to build
3384 closures, so any closure built during the preload phase would end up
3385 copied into pure space, including its free variables, which is sometimes
3386 just wasteful and other times plainly wrong (e.g. those free vars may want
3389 memcpy (p
->contents
, args
, nargs
* sizeof *args
);
3391 XSETCOMPILED (val
, p
);
3397 /***********************************************************************
3399 ***********************************************************************/
3401 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3402 of the required alignment. */
3404 union aligned_Lisp_Symbol
3406 struct Lisp_Symbol s
;
3407 unsigned char c
[(sizeof (struct Lisp_Symbol
) + GCALIGNMENT
- 1)
3411 /* Each symbol_block is just under 1020 bytes long, since malloc
3412 really allocates in units of powers of two and uses 4 bytes for its
3415 #define SYMBOL_BLOCK_SIZE \
3416 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3420 /* Place `symbols' first, to preserve alignment. */
3421 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3422 struct symbol_block
*next
;
3425 /* Current symbol block and index of first unused Lisp_Symbol
3428 static struct symbol_block
*symbol_block
;
3429 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3430 /* Pointer to the first symbol_block that contains pinned symbols.
3431 Tests for 24.4 showed that at dump-time, Emacs contains about 15K symbols,
3432 10K of which are pinned (and all but 250 of them are interned in obarray),
3433 whereas a "typical session" has in the order of 30K symbols.
3434 `symbol_block_pinned' lets mark_pinned_symbols scan only 15K symbols rather
3435 than 30K to find the 10K symbols we need to mark. */
3436 static struct symbol_block
*symbol_block_pinned
;
3438 /* List of free symbols. */
3440 static struct Lisp_Symbol
*symbol_free_list
;
3443 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
3445 XSYMBOL (sym
)->name
= name
;
3449 init_symbol (Lisp_Object val
, Lisp_Object name
)
3451 struct Lisp_Symbol
*p
= XSYMBOL (val
);
3452 set_symbol_name (val
, name
);
3453 set_symbol_plist (val
, Qnil
);
3454 p
->redirect
= SYMBOL_PLAINVAL
;
3455 SET_SYMBOL_VAL (p
, Qunbound
);
3456 set_symbol_function (val
, Qnil
);
3457 set_symbol_next (val
, NULL
);
3458 p
->gcmarkbit
= false;
3459 p
->interned
= SYMBOL_UNINTERNED
;
3461 p
->declared_special
= false;
3465 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3466 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3467 Its value is void, and its function definition and property list are nil. */)
3472 CHECK_STRING (name
);
3476 if (symbol_free_list
)
3478 XSETSYMBOL (val
, symbol_free_list
);
3479 symbol_free_list
= symbol_free_list
->next
;
3483 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3485 struct symbol_block
*new
3486 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3487 new->next
= symbol_block
;
3489 symbol_block_index
= 0;
3490 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3492 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3493 symbol_block_index
++;
3496 MALLOC_UNBLOCK_INPUT
;
3498 init_symbol (val
, name
);
3499 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3501 total_free_symbols
--;
3507 /***********************************************************************
3508 Marker (Misc) Allocation
3509 ***********************************************************************/
3511 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3512 the required alignment. */
3514 union aligned_Lisp_Misc
3517 unsigned char c
[(sizeof (union Lisp_Misc
) + GCALIGNMENT
- 1)
3521 /* Allocation of markers and other objects that share that structure.
3522 Works like allocation of conses. */
3524 #define MARKER_BLOCK_SIZE \
3525 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3529 /* Place `markers' first, to preserve alignment. */
3530 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3531 struct marker_block
*next
;
3534 static struct marker_block
*marker_block
;
3535 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3537 static union Lisp_Misc
*marker_free_list
;
3539 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3542 allocate_misc (enum Lisp_Misc_Type type
)
3548 if (marker_free_list
)
3550 XSETMISC (val
, marker_free_list
);
3551 marker_free_list
= marker_free_list
->u_free
.chain
;
3555 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3557 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3558 new->next
= marker_block
;
3560 marker_block_index
= 0;
3561 total_free_markers
+= MARKER_BLOCK_SIZE
;
3563 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3564 marker_block_index
++;
3567 MALLOC_UNBLOCK_INPUT
;
3569 --total_free_markers
;
3570 consing_since_gc
+= sizeof (union Lisp_Misc
);
3571 misc_objects_consed
++;
3572 XMISCANY (val
)->type
= type
;
3573 XMISCANY (val
)->gcmarkbit
= 0;
3577 /* Free a Lisp_Misc object. */
3580 free_misc (Lisp_Object misc
)
3582 XMISCANY (misc
)->type
= Lisp_Misc_Free
;
3583 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3584 marker_free_list
= XMISC (misc
);
3585 consing_since_gc
-= sizeof (union Lisp_Misc
);
3586 total_free_markers
++;
3589 /* Verify properties of Lisp_Save_Value's representation
3590 that are assumed here and elsewhere. */
3592 verify (SAVE_UNUSED
== 0);
3593 verify (((SAVE_INTEGER
| SAVE_POINTER
| SAVE_FUNCPOINTER
| SAVE_OBJECT
)
3597 /* Return Lisp_Save_Value objects for the various combinations
3598 that callers need. */
3601 make_save_int_int_int (ptrdiff_t a
, ptrdiff_t b
, ptrdiff_t c
)
3603 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3604 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3605 p
->save_type
= SAVE_TYPE_INT_INT_INT
;
3606 p
->data
[0].integer
= a
;
3607 p
->data
[1].integer
= b
;
3608 p
->data
[2].integer
= c
;
3613 make_save_obj_obj_obj_obj (Lisp_Object a
, Lisp_Object b
, Lisp_Object c
,
3616 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3617 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3618 p
->save_type
= SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
;
3619 p
->data
[0].object
= a
;
3620 p
->data
[1].object
= b
;
3621 p
->data
[2].object
= c
;
3622 p
->data
[3].object
= d
;
3627 make_save_ptr (void *a
)
3629 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3630 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3631 p
->save_type
= SAVE_POINTER
;
3632 p
->data
[0].pointer
= a
;
3637 make_save_ptr_int (void *a
, ptrdiff_t b
)
3639 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3640 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3641 p
->save_type
= SAVE_TYPE_PTR_INT
;
3642 p
->data
[0].pointer
= a
;
3643 p
->data
[1].integer
= b
;
3647 #if ! (defined USE_X_TOOLKIT || defined USE_GTK)
3649 make_save_ptr_ptr (void *a
, void *b
)
3651 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3652 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3653 p
->save_type
= SAVE_TYPE_PTR_PTR
;
3654 p
->data
[0].pointer
= a
;
3655 p
->data
[1].pointer
= b
;
3661 make_save_funcptr_ptr_obj (void (*a
) (void), void *b
, Lisp_Object c
)
3663 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3664 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3665 p
->save_type
= SAVE_TYPE_FUNCPTR_PTR_OBJ
;
3666 p
->data
[0].funcpointer
= a
;
3667 p
->data
[1].pointer
= b
;
3668 p
->data
[2].object
= c
;
3672 /* Return a Lisp_Save_Value object that represents an array A
3673 of N Lisp objects. */
3676 make_save_memory (Lisp_Object
*a
, ptrdiff_t n
)
3678 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3679 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3680 p
->save_type
= SAVE_TYPE_MEMORY
;
3681 p
->data
[0].pointer
= a
;
3682 p
->data
[1].integer
= n
;
3686 /* Free a Lisp_Save_Value object. Do not use this function
3687 if SAVE contains pointer other than returned by xmalloc. */
3690 free_save_value (Lisp_Object save
)
3692 xfree (XSAVE_POINTER (save
, 0));
3696 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3699 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3701 register Lisp_Object overlay
;
3703 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3704 OVERLAY_START (overlay
) = start
;
3705 OVERLAY_END (overlay
) = end
;
3706 set_overlay_plist (overlay
, plist
);
3707 XOVERLAY (overlay
)->next
= NULL
;
3711 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3712 doc
: /* Return a newly allocated marker which does not point at any place. */)
3715 register Lisp_Object val
;
3716 register struct Lisp_Marker
*p
;
3718 val
= allocate_misc (Lisp_Misc_Marker
);
3724 p
->insertion_type
= 0;
3725 p
->need_adjustment
= 0;
3729 /* Return a newly allocated marker which points into BUF
3730 at character position CHARPOS and byte position BYTEPOS. */
3733 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3736 struct Lisp_Marker
*m
;
3738 /* No dead buffers here. */
3739 eassert (BUFFER_LIVE_P (buf
));
3741 /* Every character is at least one byte. */
3742 eassert (charpos
<= bytepos
);
3744 obj
= allocate_misc (Lisp_Misc_Marker
);
3747 m
->charpos
= charpos
;
3748 m
->bytepos
= bytepos
;
3749 m
->insertion_type
= 0;
3750 m
->need_adjustment
= 0;
3751 m
->next
= BUF_MARKERS (buf
);
3752 BUF_MARKERS (buf
) = m
;
3756 /* Put MARKER back on the free list after using it temporarily. */
3759 free_marker (Lisp_Object marker
)
3761 unchain_marker (XMARKER (marker
));
3766 /* Return a newly created vector or string with specified arguments as
3767 elements. If all the arguments are characters that can fit
3768 in a string of events, make a string; otherwise, make a vector.
3770 Any number of arguments, even zero arguments, are allowed. */
3773 make_event_array (ptrdiff_t nargs
, Lisp_Object
*args
)
3777 for (i
= 0; i
< nargs
; i
++)
3778 /* The things that fit in a string
3779 are characters that are in 0...127,
3780 after discarding the meta bit and all the bits above it. */
3781 if (!INTEGERP (args
[i
])
3782 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3783 return Fvector (nargs
, args
);
3785 /* Since the loop exited, we know that all the things in it are
3786 characters, so we can make a string. */
3790 result
= Fmake_string (make_number (nargs
), make_number (0));
3791 for (i
= 0; i
< nargs
; i
++)
3793 SSET (result
, i
, XINT (args
[i
]));
3794 /* Move the meta bit to the right place for a string char. */
3795 if (XINT (args
[i
]) & CHAR_META
)
3796 SSET (result
, i
, SREF (result
, i
) | 0x80);
3804 /* Create a new module user ptr object. */
3806 make_user_ptr (void (*finalizer
) (void *), void *p
)
3809 struct Lisp_User_Ptr
*uptr
;
3811 obj
= allocate_misc (Lisp_Misc_User_Ptr
);
3812 uptr
= XUSER_PTR (obj
);
3813 uptr
->finalizer
= finalizer
;
3821 init_finalizer_list (struct Lisp_Finalizer
*head
)
3823 head
->prev
= head
->next
= head
;
3826 /* Insert FINALIZER before ELEMENT. */
3829 finalizer_insert (struct Lisp_Finalizer
*element
,
3830 struct Lisp_Finalizer
*finalizer
)
3832 eassert (finalizer
->prev
== NULL
);
3833 eassert (finalizer
->next
== NULL
);
3834 finalizer
->next
= element
;
3835 finalizer
->prev
= element
->prev
;
3836 finalizer
->prev
->next
= finalizer
;
3837 element
->prev
= finalizer
;
3841 unchain_finalizer (struct Lisp_Finalizer
*finalizer
)
3843 if (finalizer
->prev
!= NULL
)
3845 eassert (finalizer
->next
!= NULL
);
3846 finalizer
->prev
->next
= finalizer
->next
;
3847 finalizer
->next
->prev
= finalizer
->prev
;
3848 finalizer
->prev
= finalizer
->next
= NULL
;
3853 mark_finalizer_list (struct Lisp_Finalizer
*head
)
3855 for (struct Lisp_Finalizer
*finalizer
= head
->next
;
3857 finalizer
= finalizer
->next
)
3859 finalizer
->base
.gcmarkbit
= true;
3860 mark_object (finalizer
->function
);
3864 /* Move doomed finalizers to list DEST from list SRC. A doomed
3865 finalizer is one that is not GC-reachable and whose
3866 finalizer->function is non-nil. */
3869 queue_doomed_finalizers (struct Lisp_Finalizer
*dest
,
3870 struct Lisp_Finalizer
*src
)
3872 struct Lisp_Finalizer
*finalizer
= src
->next
;
3873 while (finalizer
!= src
)
3875 struct Lisp_Finalizer
*next
= finalizer
->next
;
3876 if (!finalizer
->base
.gcmarkbit
&& !NILP (finalizer
->function
))
3878 unchain_finalizer (finalizer
);
3879 finalizer_insert (dest
, finalizer
);
3887 run_finalizer_handler (Lisp_Object args
)
3889 add_to_log ("finalizer failed: %S", args
);
3894 run_finalizer_function (Lisp_Object function
)
3896 ptrdiff_t count
= SPECPDL_INDEX ();
3898 specbind (Qinhibit_quit
, Qt
);
3899 internal_condition_case_1 (call0
, function
, Qt
, run_finalizer_handler
);
3900 unbind_to (count
, Qnil
);
3904 run_finalizers (struct Lisp_Finalizer
*finalizers
)
3906 struct Lisp_Finalizer
*finalizer
;
3907 Lisp_Object function
;
3909 while (finalizers
->next
!= finalizers
)
3911 finalizer
= finalizers
->next
;
3912 eassert (finalizer
->base
.type
== Lisp_Misc_Finalizer
);
3913 unchain_finalizer (finalizer
);
3914 function
= finalizer
->function
;
3915 if (!NILP (function
))
3917 finalizer
->function
= Qnil
;
3918 run_finalizer_function (function
);
3923 DEFUN ("make-finalizer", Fmake_finalizer
, Smake_finalizer
, 1, 1, 0,
3924 doc
: /* Make a finalizer that will run FUNCTION.
3925 FUNCTION will be called after garbage collection when the returned
3926 finalizer object becomes unreachable. If the finalizer object is
3927 reachable only through references from finalizer objects, it does not
3928 count as reachable for the purpose of deciding whether to run
3929 FUNCTION. FUNCTION will be run once per finalizer object. */)
3930 (Lisp_Object function
)
3932 Lisp_Object val
= allocate_misc (Lisp_Misc_Finalizer
);
3933 struct Lisp_Finalizer
*finalizer
= XFINALIZER (val
);
3934 finalizer
->function
= function
;
3935 finalizer
->prev
= finalizer
->next
= NULL
;
3936 finalizer_insert (&finalizers
, finalizer
);
3941 /************************************************************************
3942 Memory Full Handling
3943 ************************************************************************/
3946 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3947 there may have been size_t overflow so that malloc was never
3948 called, or perhaps malloc was invoked successfully but the
3949 resulting pointer had problems fitting into a tagged EMACS_INT. In
3950 either case this counts as memory being full even though malloc did
3954 memory_full (size_t nbytes
)
3956 /* Do not go into hysterics merely because a large request failed. */
3957 bool enough_free_memory
= 0;
3958 if (SPARE_MEMORY
< nbytes
)
3963 p
= malloc (SPARE_MEMORY
);
3967 enough_free_memory
= 1;
3969 MALLOC_UNBLOCK_INPUT
;
3972 if (! enough_free_memory
)
3978 memory_full_cons_threshold
= sizeof (struct cons_block
);
3980 /* The first time we get here, free the spare memory. */
3981 for (i
= 0; i
< ARRAYELTS (spare_memory
); i
++)
3982 if (spare_memory
[i
])
3985 free (spare_memory
[i
]);
3986 else if (i
>= 1 && i
<= 4)
3987 lisp_align_free (spare_memory
[i
]);
3989 lisp_free (spare_memory
[i
]);
3990 spare_memory
[i
] = 0;
3994 /* This used to call error, but if we've run out of memory, we could
3995 get infinite recursion trying to build the string. */
3996 xsignal (Qnil
, Vmemory_signal_data
);
3999 /* If we released our reserve (due to running out of memory),
4000 and we have a fair amount free once again,
4001 try to set aside another reserve in case we run out once more.
4003 This is called when a relocatable block is freed in ralloc.c,
4004 and also directly from this file, in case we're not using ralloc.c. */
4007 refill_memory_reserve (void)
4009 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
4010 if (spare_memory
[0] == 0)
4011 spare_memory
[0] = malloc (SPARE_MEMORY
);
4012 if (spare_memory
[1] == 0)
4013 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
4015 if (spare_memory
[2] == 0)
4016 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
4018 if (spare_memory
[3] == 0)
4019 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
4021 if (spare_memory
[4] == 0)
4022 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
4024 if (spare_memory
[5] == 0)
4025 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
4027 if (spare_memory
[6] == 0)
4028 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
4030 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
4031 Vmemory_full
= Qnil
;
4035 /************************************************************************
4037 ************************************************************************/
4039 /* Conservative C stack marking requires a method to identify possibly
4040 live Lisp objects given a pointer value. We do this by keeping
4041 track of blocks of Lisp data that are allocated in a red-black tree
4042 (see also the comment of mem_node which is the type of nodes in
4043 that tree). Function lisp_malloc adds information for an allocated
4044 block to the red-black tree with calls to mem_insert, and function
4045 lisp_free removes it with mem_delete. Functions live_string_p etc
4046 call mem_find to lookup information about a given pointer in the
4047 tree, and use that to determine if the pointer points to a Lisp
4050 /* Initialize this part of alloc.c. */
4055 mem_z
.left
= mem_z
.right
= MEM_NIL
;
4056 mem_z
.parent
= NULL
;
4057 mem_z
.color
= MEM_BLACK
;
4058 mem_z
.start
= mem_z
.end
= NULL
;
4063 /* Value is a pointer to the mem_node containing START. Value is
4064 MEM_NIL if there is no node in the tree containing START. */
4066 static struct mem_node
*
4067 mem_find (void *start
)
4071 if (start
< min_heap_address
|| start
> max_heap_address
)
4074 /* Make the search always successful to speed up the loop below. */
4075 mem_z
.start
= start
;
4076 mem_z
.end
= (char *) start
+ 1;
4079 while (start
< p
->start
|| start
>= p
->end
)
4080 p
= start
< p
->start
? p
->left
: p
->right
;
4085 /* Insert a new node into the tree for a block of memory with start
4086 address START, end address END, and type TYPE. Value is a
4087 pointer to the node that was inserted. */
4089 static struct mem_node
*
4090 mem_insert (void *start
, void *end
, enum mem_type type
)
4092 struct mem_node
*c
, *parent
, *x
;
4094 if (min_heap_address
== NULL
|| start
< min_heap_address
)
4095 min_heap_address
= start
;
4096 if (max_heap_address
== NULL
|| end
> max_heap_address
)
4097 max_heap_address
= end
;
4099 /* See where in the tree a node for START belongs. In this
4100 particular application, it shouldn't happen that a node is already
4101 present. For debugging purposes, let's check that. */
4105 while (c
!= MEM_NIL
)
4108 c
= start
< c
->start
? c
->left
: c
->right
;
4111 /* Create a new node. */
4112 #ifdef GC_MALLOC_CHECK
4113 x
= malloc (sizeof *x
);
4117 x
= xmalloc (sizeof *x
);
4123 x
->left
= x
->right
= MEM_NIL
;
4126 /* Insert it as child of PARENT or install it as root. */
4129 if (start
< parent
->start
)
4137 /* Re-establish red-black tree properties. */
4138 mem_insert_fixup (x
);
4144 /* Re-establish the red-black properties of the tree, and thereby
4145 balance the tree, after node X has been inserted; X is always red. */
4148 mem_insert_fixup (struct mem_node
*x
)
4150 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
4152 /* X is red and its parent is red. This is a violation of
4153 red-black tree property #3. */
4155 if (x
->parent
== x
->parent
->parent
->left
)
4157 /* We're on the left side of our grandparent, and Y is our
4159 struct mem_node
*y
= x
->parent
->parent
->right
;
4161 if (y
->color
== MEM_RED
)
4163 /* Uncle and parent are red but should be black because
4164 X is red. Change the colors accordingly and proceed
4165 with the grandparent. */
4166 x
->parent
->color
= MEM_BLACK
;
4167 y
->color
= MEM_BLACK
;
4168 x
->parent
->parent
->color
= MEM_RED
;
4169 x
= x
->parent
->parent
;
4173 /* Parent and uncle have different colors; parent is
4174 red, uncle is black. */
4175 if (x
== x
->parent
->right
)
4178 mem_rotate_left (x
);
4181 x
->parent
->color
= MEM_BLACK
;
4182 x
->parent
->parent
->color
= MEM_RED
;
4183 mem_rotate_right (x
->parent
->parent
);
4188 /* This is the symmetrical case of above. */
4189 struct mem_node
*y
= x
->parent
->parent
->left
;
4191 if (y
->color
== MEM_RED
)
4193 x
->parent
->color
= MEM_BLACK
;
4194 y
->color
= MEM_BLACK
;
4195 x
->parent
->parent
->color
= MEM_RED
;
4196 x
= x
->parent
->parent
;
4200 if (x
== x
->parent
->left
)
4203 mem_rotate_right (x
);
4206 x
->parent
->color
= MEM_BLACK
;
4207 x
->parent
->parent
->color
= MEM_RED
;
4208 mem_rotate_left (x
->parent
->parent
);
4213 /* The root may have been changed to red due to the algorithm. Set
4214 it to black so that property #5 is satisfied. */
4215 mem_root
->color
= MEM_BLACK
;
4226 mem_rotate_left (struct mem_node
*x
)
4230 /* Turn y's left sub-tree into x's right sub-tree. */
4233 if (y
->left
!= MEM_NIL
)
4234 y
->left
->parent
= x
;
4236 /* Y's parent was x's parent. */
4238 y
->parent
= x
->parent
;
4240 /* Get the parent to point to y instead of x. */
4243 if (x
== x
->parent
->left
)
4244 x
->parent
->left
= y
;
4246 x
->parent
->right
= y
;
4251 /* Put x on y's left. */
4265 mem_rotate_right (struct mem_node
*x
)
4267 struct mem_node
*y
= x
->left
;
4270 if (y
->right
!= MEM_NIL
)
4271 y
->right
->parent
= x
;
4274 y
->parent
= x
->parent
;
4277 if (x
== x
->parent
->right
)
4278 x
->parent
->right
= y
;
4280 x
->parent
->left
= y
;
4291 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4294 mem_delete (struct mem_node
*z
)
4296 struct mem_node
*x
, *y
;
4298 if (!z
|| z
== MEM_NIL
)
4301 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4306 while (y
->left
!= MEM_NIL
)
4310 if (y
->left
!= MEM_NIL
)
4315 x
->parent
= y
->parent
;
4318 if (y
== y
->parent
->left
)
4319 y
->parent
->left
= x
;
4321 y
->parent
->right
= x
;
4328 z
->start
= y
->start
;
4333 if (y
->color
== MEM_BLACK
)
4334 mem_delete_fixup (x
);
4336 #ifdef GC_MALLOC_CHECK
4344 /* Re-establish the red-black properties of the tree, after a
4348 mem_delete_fixup (struct mem_node
*x
)
4350 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4352 if (x
== x
->parent
->left
)
4354 struct mem_node
*w
= x
->parent
->right
;
4356 if (w
->color
== MEM_RED
)
4358 w
->color
= MEM_BLACK
;
4359 x
->parent
->color
= MEM_RED
;
4360 mem_rotate_left (x
->parent
);
4361 w
= x
->parent
->right
;
4364 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4371 if (w
->right
->color
== MEM_BLACK
)
4373 w
->left
->color
= MEM_BLACK
;
4375 mem_rotate_right (w
);
4376 w
= x
->parent
->right
;
4378 w
->color
= x
->parent
->color
;
4379 x
->parent
->color
= MEM_BLACK
;
4380 w
->right
->color
= MEM_BLACK
;
4381 mem_rotate_left (x
->parent
);
4387 struct mem_node
*w
= x
->parent
->left
;
4389 if (w
->color
== MEM_RED
)
4391 w
->color
= MEM_BLACK
;
4392 x
->parent
->color
= MEM_RED
;
4393 mem_rotate_right (x
->parent
);
4394 w
= x
->parent
->left
;
4397 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4404 if (w
->left
->color
== MEM_BLACK
)
4406 w
->right
->color
= MEM_BLACK
;
4408 mem_rotate_left (w
);
4409 w
= x
->parent
->left
;
4412 w
->color
= x
->parent
->color
;
4413 x
->parent
->color
= MEM_BLACK
;
4414 w
->left
->color
= MEM_BLACK
;
4415 mem_rotate_right (x
->parent
);
4421 x
->color
= MEM_BLACK
;
4425 /* Value is non-zero if P is a pointer to a live Lisp string on
4426 the heap. M is a pointer to the mem_block for P. */
4429 live_string_p (struct mem_node
*m
, void *p
)
4431 if (m
->type
== MEM_TYPE_STRING
)
4433 struct string_block
*b
= m
->start
;
4434 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4436 /* P must point to the start of a Lisp_String structure, and it
4437 must not be on the free-list. */
4439 && offset
% sizeof b
->strings
[0] == 0
4440 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4441 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4448 /* Value is non-zero if P is a pointer to a live Lisp cons on
4449 the heap. M is a pointer to the mem_block for P. */
4452 live_cons_p (struct mem_node
*m
, void *p
)
4454 if (m
->type
== MEM_TYPE_CONS
)
4456 struct cons_block
*b
= m
->start
;
4457 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4459 /* P must point to the start of a Lisp_Cons, not be
4460 one of the unused cells in the current cons block,
4461 and not be on the free-list. */
4463 && offset
% sizeof b
->conses
[0] == 0
4464 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4466 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4467 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
4474 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4475 the heap. M is a pointer to the mem_block for P. */
4478 live_symbol_p (struct mem_node
*m
, void *p
)
4480 if (m
->type
== MEM_TYPE_SYMBOL
)
4482 struct symbol_block
*b
= m
->start
;
4483 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4485 /* P must point to the start of a Lisp_Symbol, not be
4486 one of the unused cells in the current symbol block,
4487 and not be on the free-list. */
4489 && offset
% sizeof b
->symbols
[0] == 0
4490 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4491 && (b
!= symbol_block
4492 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4493 && !EQ (((struct Lisp_Symbol
*)p
)->function
, Vdead
));
4500 /* Value is non-zero if P is a pointer to a live Lisp float on
4501 the heap. M is a pointer to the mem_block for P. */
4504 live_float_p (struct mem_node
*m
, void *p
)
4506 if (m
->type
== MEM_TYPE_FLOAT
)
4508 struct float_block
*b
= m
->start
;
4509 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4511 /* P must point to the start of a Lisp_Float and not be
4512 one of the unused cells in the current float block. */
4514 && offset
% sizeof b
->floats
[0] == 0
4515 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4516 && (b
!= float_block
4517 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4524 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4525 the heap. M is a pointer to the mem_block for P. */
4528 live_misc_p (struct mem_node
*m
, void *p
)
4530 if (m
->type
== MEM_TYPE_MISC
)
4532 struct marker_block
*b
= m
->start
;
4533 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4535 /* P must point to the start of a Lisp_Misc, not be
4536 one of the unused cells in the current misc block,
4537 and not be on the free-list. */
4539 && offset
% sizeof b
->markers
[0] == 0
4540 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4541 && (b
!= marker_block
4542 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4543 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4550 /* Value is non-zero if P is a pointer to a live vector-like object.
4551 M is a pointer to the mem_block for P. */
4554 live_vector_p (struct mem_node
*m
, void *p
)
4556 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4558 /* This memory node corresponds to a vector block. */
4559 struct vector_block
*block
= m
->start
;
4560 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4562 /* P is in the block's allocation range. Scan the block
4563 up to P and see whether P points to the start of some
4564 vector which is not on a free list. FIXME: check whether
4565 some allocation patterns (probably a lot of short vectors)
4566 may cause a substantial overhead of this loop. */
4567 while (VECTOR_IN_BLOCK (vector
, block
)
4568 && vector
<= (struct Lisp_Vector
*) p
)
4570 if (!PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
) && vector
== p
)
4573 vector
= ADVANCE (vector
, vector_nbytes (vector
));
4576 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== large_vector_vec (m
->start
))
4577 /* This memory node corresponds to a large vector. */
4583 /* Value is non-zero if P is a pointer to a live buffer. M is a
4584 pointer to the mem_block for P. */
4587 live_buffer_p (struct mem_node
*m
, void *p
)
4589 /* P must point to the start of the block, and the buffer
4590 must not have been killed. */
4591 return (m
->type
== MEM_TYPE_BUFFER
4593 && !NILP (((struct buffer
*) p
)->name_
));
4596 /* Mark OBJ if we can prove it's a Lisp_Object. */
4599 mark_maybe_object (Lisp_Object obj
)
4603 VALGRIND_MAKE_MEM_DEFINED (&obj
, sizeof (obj
));
4609 void *po
= XPNTR (obj
);
4610 struct mem_node
*m
= mem_find (po
);
4614 bool mark_p
= false;
4616 switch (XTYPE (obj
))
4619 mark_p
= (live_string_p (m
, po
)
4620 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4624 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4628 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4632 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4635 case Lisp_Vectorlike
:
4636 /* Note: can't check BUFFERP before we know it's a
4637 buffer because checking that dereferences the pointer
4638 PO which might point anywhere. */
4639 if (live_vector_p (m
, po
))
4640 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4641 else if (live_buffer_p (m
, po
))
4642 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4646 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4658 /* Return true if P can point to Lisp data, and false otherwise.
4659 Symbols are implemented via offsets not pointers, but the offsets
4660 are also multiples of GCALIGNMENT. */
4663 maybe_lisp_pointer (void *p
)
4665 return (uintptr_t) p
% GCALIGNMENT
== 0;
4668 #ifndef HAVE_MODULES
4669 enum { HAVE_MODULES
= false };
4672 /* If P points to Lisp data, mark that as live if it isn't already
4676 mark_maybe_pointer (void *p
)
4682 VALGRIND_MAKE_MEM_DEFINED (&p
, sizeof (p
));
4685 if (sizeof (Lisp_Object
) == sizeof (void *) || !HAVE_MODULES
)
4687 if (!maybe_lisp_pointer (p
))
4692 /* For the wide-int case, also mark emacs_value tagged pointers,
4693 which can be generated by emacs-module.c's value_to_lisp. */
4694 p
= (void *) ((uintptr_t) p
& ~(GCALIGNMENT
- 1));
4700 Lisp_Object obj
= Qnil
;
4704 case MEM_TYPE_NON_LISP
:
4705 case MEM_TYPE_SPARE
:
4706 /* Nothing to do; not a pointer to Lisp memory. */
4709 case MEM_TYPE_BUFFER
:
4710 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4711 XSETVECTOR (obj
, p
);
4715 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4719 case MEM_TYPE_STRING
:
4720 if (live_string_p (m
, p
)
4721 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4722 XSETSTRING (obj
, p
);
4726 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4730 case MEM_TYPE_SYMBOL
:
4731 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4732 XSETSYMBOL (obj
, p
);
4735 case MEM_TYPE_FLOAT
:
4736 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4740 case MEM_TYPE_VECTORLIKE
:
4741 case MEM_TYPE_VECTOR_BLOCK
:
4742 if (live_vector_p (m
, p
))
4745 XSETVECTOR (tem
, p
);
4746 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4761 /* Alignment of pointer values. Use alignof, as it sometimes returns
4762 a smaller alignment than GCC's __alignof__ and mark_memory might
4763 miss objects if __alignof__ were used. */
4764 #define GC_POINTER_ALIGNMENT alignof (void *)
4766 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4767 or END+OFFSET..START. */
4769 static void ATTRIBUTE_NO_SANITIZE_ADDRESS
4770 mark_memory (void *start
, void *end
)
4774 /* Make START the pointer to the start of the memory region,
4775 if it isn't already. */
4783 eassert (((uintptr_t) start
) % GC_POINTER_ALIGNMENT
== 0);
4785 /* Mark Lisp data pointed to. This is necessary because, in some
4786 situations, the C compiler optimizes Lisp objects away, so that
4787 only a pointer to them remains. Example:
4789 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4792 Lisp_Object obj = build_string ("test");
4793 struct Lisp_String *s = XSTRING (obj);
4794 Fgarbage_collect ();
4795 fprintf (stderr, "test '%s'\n", s->data);
4799 Here, `obj' isn't really used, and the compiler optimizes it
4800 away. The only reference to the life string is through the
4803 for (pp
= start
; (void *) pp
< end
; pp
+= GC_POINTER_ALIGNMENT
)
4805 mark_maybe_pointer (*(void **) pp
);
4806 mark_maybe_object (*(Lisp_Object
*) pp
);
4810 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4812 static bool setjmp_tested_p
;
4813 static int longjmps_done
;
4815 #define SETJMP_WILL_LIKELY_WORK "\
4817 Emacs garbage collector has been changed to use conservative stack\n\
4818 marking. Emacs has determined that the method it uses to do the\n\
4819 marking will likely work on your system, but this isn't sure.\n\
4821 If you are a system-programmer, or can get the help of a local wizard\n\
4822 who is, please take a look at the function mark_stack in alloc.c, and\n\
4823 verify that the methods used are appropriate for your system.\n\
4825 Please mail the result to <emacs-devel@gnu.org>.\n\
4828 #define SETJMP_WILL_NOT_WORK "\
4830 Emacs garbage collector has been changed to use conservative stack\n\
4831 marking. Emacs has determined that the default method it uses to do the\n\
4832 marking will not work on your system. We will need a system-dependent\n\
4833 solution for your system.\n\
4835 Please take a look at the function mark_stack in alloc.c, and\n\
4836 try to find a way to make it work on your system.\n\
4838 Note that you may get false negatives, depending on the compiler.\n\
4839 In particular, you need to use -O with GCC for this test.\n\
4841 Please mail the result to <emacs-devel@gnu.org>.\n\
4845 /* Perform a quick check if it looks like setjmp saves registers in a
4846 jmp_buf. Print a message to stderr saying so. When this test
4847 succeeds, this is _not_ a proof that setjmp is sufficient for
4848 conservative stack marking. Only the sources or a disassembly
4858 /* Arrange for X to be put in a register. */
4864 if (longjmps_done
== 1)
4866 /* Came here after the longjmp at the end of the function.
4868 If x == 1, the longjmp has restored the register to its
4869 value before the setjmp, and we can hope that setjmp
4870 saves all such registers in the jmp_buf, although that
4873 For other values of X, either something really strange is
4874 taking place, or the setjmp just didn't save the register. */
4877 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4880 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4887 if (longjmps_done
== 1)
4888 sys_longjmp (jbuf
, 1);
4891 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4894 /* Mark live Lisp objects on the C stack.
4896 There are several system-dependent problems to consider when
4897 porting this to new architectures:
4901 We have to mark Lisp objects in CPU registers that can hold local
4902 variables or are used to pass parameters.
4904 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4905 something that either saves relevant registers on the stack, or
4906 calls mark_maybe_object passing it each register's contents.
4908 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4909 implementation assumes that calling setjmp saves registers we need
4910 to see in a jmp_buf which itself lies on the stack. This doesn't
4911 have to be true! It must be verified for each system, possibly
4912 by taking a look at the source code of setjmp.
4914 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4915 can use it as a machine independent method to store all registers
4916 to the stack. In this case the macros described in the previous
4917 two paragraphs are not used.
4921 Architectures differ in the way their processor stack is organized.
4922 For example, the stack might look like this
4925 | Lisp_Object | size = 4
4927 | something else | size = 2
4929 | Lisp_Object | size = 4
4933 In such a case, not every Lisp_Object will be aligned equally. To
4934 find all Lisp_Object on the stack it won't be sufficient to walk
4935 the stack in steps of 4 bytes. Instead, two passes will be
4936 necessary, one starting at the start of the stack, and a second
4937 pass starting at the start of the stack + 2. Likewise, if the
4938 minimal alignment of Lisp_Objects on the stack is 1, four passes
4939 would be necessary, each one starting with one byte more offset
4940 from the stack start. */
4943 mark_stack (void *end
)
4946 /* This assumes that the stack is a contiguous region in memory. If
4947 that's not the case, something has to be done here to iterate
4948 over the stack segments. */
4949 mark_memory (stack_base
, end
);
4951 /* Allow for marking a secondary stack, like the register stack on the
4953 #ifdef GC_MARK_SECONDARY_STACK
4954 GC_MARK_SECONDARY_STACK ();
4959 c_symbol_p (struct Lisp_Symbol
*sym
)
4961 char *lispsym_ptr
= (char *) lispsym
;
4962 char *sym_ptr
= (char *) sym
;
4963 ptrdiff_t lispsym_offset
= sym_ptr
- lispsym_ptr
;
4964 return 0 <= lispsym_offset
&& lispsym_offset
< sizeof lispsym
;
4967 /* Determine whether it is safe to access memory at address P. */
4969 valid_pointer_p (void *p
)
4972 return w32_valid_pointer_p (p
, 16);
4975 if (ADDRESS_SANITIZER
)
4980 /* Obviously, we cannot just access it (we would SEGV trying), so we
4981 trick the o/s to tell us whether p is a valid pointer.
4982 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4983 not validate p in that case. */
4985 if (emacs_pipe (fd
) == 0)
4987 bool valid
= emacs_write (fd
[1], p
, 16) == 16;
4988 emacs_close (fd
[1]);
4989 emacs_close (fd
[0]);
4997 /* Return 2 if OBJ is a killed or special buffer object, 1 if OBJ is a
4998 valid lisp object, 0 if OBJ is NOT a valid lisp object, or -1 if we
4999 cannot validate OBJ. This function can be quite slow, so its primary
5000 use is the manual debugging. The only exception is print_object, where
5001 we use it to check whether the memory referenced by the pointer of
5002 Lisp_Save_Value object contains valid objects. */
5005 valid_lisp_object_p (Lisp_Object obj
)
5010 void *p
= XPNTR (obj
);
5014 if (SYMBOLP (obj
) && c_symbol_p (p
))
5015 return ((char *) p
- (char *) lispsym
) % sizeof lispsym
[0] == 0;
5017 if (p
== &buffer_defaults
|| p
== &buffer_local_symbols
)
5020 struct mem_node
*m
= mem_find (p
);
5024 int valid
= valid_pointer_p (p
);
5036 case MEM_TYPE_NON_LISP
:
5037 case MEM_TYPE_SPARE
:
5040 case MEM_TYPE_BUFFER
:
5041 return live_buffer_p (m
, p
) ? 1 : 2;
5044 return live_cons_p (m
, p
);
5046 case MEM_TYPE_STRING
:
5047 return live_string_p (m
, p
);
5050 return live_misc_p (m
, p
);
5052 case MEM_TYPE_SYMBOL
:
5053 return live_symbol_p (m
, p
);
5055 case MEM_TYPE_FLOAT
:
5056 return live_float_p (m
, p
);
5058 case MEM_TYPE_VECTORLIKE
:
5059 case MEM_TYPE_VECTOR_BLOCK
:
5060 return live_vector_p (m
, p
);
5069 /***********************************************************************
5070 Pure Storage Management
5071 ***********************************************************************/
5073 /* Allocate room for SIZE bytes from pure Lisp storage and return a
5074 pointer to it. TYPE is the Lisp type for which the memory is
5075 allocated. TYPE < 0 means it's not used for a Lisp object. */
5078 pure_alloc (size_t size
, int type
)
5085 /* Allocate space for a Lisp object from the beginning of the free
5086 space with taking account of alignment. */
5087 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, GCALIGNMENT
);
5088 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
5092 /* Allocate space for a non-Lisp object from the end of the free
5094 pure_bytes_used_non_lisp
+= size
;
5095 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5097 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
5099 if (pure_bytes_used
<= pure_size
)
5102 /* Don't allocate a large amount here,
5103 because it might get mmap'd and then its address
5104 might not be usable. */
5105 purebeg
= xmalloc (10000);
5107 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
5108 pure_bytes_used
= 0;
5109 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
5114 /* Print a warning if PURESIZE is too small. */
5117 check_pure_size (void)
5119 if (pure_bytes_used_before_overflow
)
5120 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
5122 pure_bytes_used
+ pure_bytes_used_before_overflow
);
5126 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
5127 the non-Lisp data pool of the pure storage, and return its start
5128 address. Return NULL if not found. */
5131 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5134 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5135 const unsigned char *p
;
5138 if (pure_bytes_used_non_lisp
<= nbytes
)
5141 /* Set up the Boyer-Moore table. */
5143 for (i
= 0; i
< 256; i
++)
5146 p
= (const unsigned char *) data
;
5148 bm_skip
[*p
++] = skip
;
5150 last_char_skip
= bm_skip
['\0'];
5152 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5153 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5155 /* See the comments in the function `boyer_moore' (search.c) for the
5156 use of `infinity'. */
5157 infinity
= pure_bytes_used_non_lisp
+ 1;
5158 bm_skip
['\0'] = infinity
;
5160 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5164 /* Check the last character (== '\0'). */
5167 start
+= bm_skip
[*(p
+ start
)];
5169 while (start
<= start_max
);
5171 if (start
< infinity
)
5172 /* Couldn't find the last character. */
5175 /* No less than `infinity' means we could find the last
5176 character at `p[start - infinity]'. */
5179 /* Check the remaining characters. */
5180 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5182 return non_lisp_beg
+ start
;
5184 start
+= last_char_skip
;
5186 while (start
<= start_max
);
5192 /* Return a string allocated in pure space. DATA is a buffer holding
5193 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5194 means make the result string multibyte.
5196 Must get an error if pure storage is full, since if it cannot hold
5197 a large string it may be able to hold conses that point to that
5198 string; then the string is not protected from gc. */
5201 make_pure_string (const char *data
,
5202 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
5205 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5206 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5207 if (s
->data
== NULL
)
5209 s
->data
= pure_alloc (nbytes
+ 1, -1);
5210 memcpy (s
->data
, data
, nbytes
);
5211 s
->data
[nbytes
] = '\0';
5214 s
->size_byte
= multibyte
? nbytes
: -1;
5215 s
->intervals
= NULL
;
5216 XSETSTRING (string
, s
);
5220 /* Return a string allocated in pure space. Do not
5221 allocate the string data, just point to DATA. */
5224 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5227 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5230 s
->data
= (unsigned char *) data
;
5231 s
->intervals
= NULL
;
5232 XSETSTRING (string
, s
);
5236 static Lisp_Object
purecopy (Lisp_Object obj
);
5238 /* Return a cons allocated from pure space. Give it pure copies
5239 of CAR as car and CDR as cdr. */
5242 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5245 struct Lisp_Cons
*p
= pure_alloc (sizeof *p
, Lisp_Cons
);
5247 XSETCAR (new, purecopy (car
));
5248 XSETCDR (new, purecopy (cdr
));
5253 /* Value is a float object with value NUM allocated from pure space. */
5256 make_pure_float (double num
)
5259 struct Lisp_Float
*p
= pure_alloc (sizeof *p
, Lisp_Float
);
5261 XFLOAT_INIT (new, num
);
5266 /* Return a vector with room for LEN Lisp_Objects allocated from
5270 make_pure_vector (ptrdiff_t len
)
5273 size_t size
= header_size
+ len
* word_size
;
5274 struct Lisp_Vector
*p
= pure_alloc (size
, Lisp_Vectorlike
);
5275 XSETVECTOR (new, p
);
5276 XVECTOR (new)->header
.size
= len
;
5280 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5281 doc
: /* Make a copy of object OBJ in pure storage.
5282 Recursively copies contents of vectors and cons cells.
5283 Does not copy symbols. Copies strings without text properties. */)
5284 (register Lisp_Object obj
)
5286 if (NILP (Vpurify_flag
))
5288 else if (MARKERP (obj
) || OVERLAYP (obj
)
5289 || HASH_TABLE_P (obj
) || SYMBOLP (obj
))
5290 /* Can't purify those. */
5293 return purecopy (obj
);
5297 purecopy (Lisp_Object obj
)
5300 || (! SYMBOLP (obj
) && PURE_P (XPNTR_OR_SYMBOL_OFFSET (obj
)))
5302 return obj
; /* Already pure. */
5304 if (STRINGP (obj
) && XSTRING (obj
)->intervals
)
5305 message_with_string ("Dropping text-properties while making string `%s' pure",
5308 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5310 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5316 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5317 else if (FLOATP (obj
))
5318 obj
= make_pure_float (XFLOAT_DATA (obj
));
5319 else if (STRINGP (obj
))
5320 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5322 STRING_MULTIBYTE (obj
));
5323 else if (COMPILEDP (obj
) || VECTORP (obj
) || HASH_TABLE_P (obj
))
5325 struct Lisp_Vector
*objp
= XVECTOR (obj
);
5326 ptrdiff_t nbytes
= vector_nbytes (objp
);
5327 struct Lisp_Vector
*vec
= pure_alloc (nbytes
, Lisp_Vectorlike
);
5328 register ptrdiff_t i
;
5329 ptrdiff_t size
= ASIZE (obj
);
5330 if (size
& PSEUDOVECTOR_FLAG
)
5331 size
&= PSEUDOVECTOR_SIZE_MASK
;
5332 memcpy (vec
, objp
, nbytes
);
5333 for (i
= 0; i
< size
; i
++)
5334 vec
->contents
[i
] = purecopy (vec
->contents
[i
]);
5335 XSETVECTOR (obj
, vec
);
5337 else if (SYMBOLP (obj
))
5339 if (!XSYMBOL (obj
)->pinned
&& !c_symbol_p (XSYMBOL (obj
)))
5340 { /* We can't purify them, but they appear in many pure objects.
5341 Mark them as `pinned' so we know to mark them at every GC cycle. */
5342 XSYMBOL (obj
)->pinned
= true;
5343 symbol_block_pinned
= symbol_block
;
5345 /* Don't hash-cons it. */
5350 Lisp_Object fmt
= build_pure_c_string ("Don't know how to purify: %S");
5351 Fsignal (Qerror
, list1 (CALLN (Fformat
, fmt
, obj
)));
5354 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5355 Fputhash (obj
, obj
, Vpurify_flag
);
5362 /***********************************************************************
5364 ***********************************************************************/
5366 /* Put an entry in staticvec, pointing at the variable with address
5370 staticpro (Lisp_Object
*varaddress
)
5372 if (staticidx
>= NSTATICS
)
5373 fatal ("NSTATICS too small; try increasing and recompiling Emacs.");
5374 staticvec
[staticidx
++] = varaddress
;
5378 /***********************************************************************
5380 ***********************************************************************/
5382 /* Temporarily prevent garbage collection. */
5385 inhibit_garbage_collection (void)
5387 ptrdiff_t count
= SPECPDL_INDEX ();
5389 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5393 /* Used to avoid possible overflows when
5394 converting from C to Lisp integers. */
5397 bounded_number (EMACS_INT number
)
5399 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5402 /* Calculate total bytes of live objects. */
5405 total_bytes_of_live_objects (void)
5408 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5409 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5410 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5411 tot
+= total_string_bytes
;
5412 tot
+= total_vector_slots
* word_size
;
5413 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5414 tot
+= total_intervals
* sizeof (struct interval
);
5415 tot
+= total_strings
* sizeof (struct Lisp_String
);
5419 #ifdef HAVE_WINDOW_SYSTEM
5421 /* Remove unmarked font-spec and font-entity objects from ENTRY, which is
5422 (DRIVER-TYPE NUM-FRAMES FONT-CACHE-DATA ...), and return changed entry. */
5425 compact_font_cache_entry (Lisp_Object entry
)
5427 Lisp_Object tail
, *prev
= &entry
;
5429 for (tail
= entry
; CONSP (tail
); tail
= XCDR (tail
))
5432 Lisp_Object obj
= XCAR (tail
);
5434 /* Consider OBJ if it is (font-spec . [font-entity font-entity ...]). */
5435 if (CONSP (obj
) && GC_FONT_SPEC_P (XCAR (obj
))
5436 && !VECTOR_MARKED_P (GC_XFONT_SPEC (XCAR (obj
)))
5437 /* Don't use VECTORP here, as that calls ASIZE, which could
5438 hit assertion violation during GC. */
5439 && (VECTORLIKEP (XCDR (obj
))
5440 && ! (gc_asize (XCDR (obj
)) & PSEUDOVECTOR_FLAG
)))
5442 ptrdiff_t i
, size
= gc_asize (XCDR (obj
));
5443 Lisp_Object obj_cdr
= XCDR (obj
);
5445 /* If font-spec is not marked, most likely all font-entities
5446 are not marked too. But we must be sure that nothing is
5447 marked within OBJ before we really drop it. */
5448 for (i
= 0; i
< size
; i
++)
5450 Lisp_Object objlist
;
5452 if (VECTOR_MARKED_P (GC_XFONT_ENTITY (AREF (obj_cdr
, i
))))
5455 objlist
= AREF (AREF (obj_cdr
, i
), FONT_OBJLIST_INDEX
);
5456 for (; CONSP (objlist
); objlist
= XCDR (objlist
))
5458 Lisp_Object val
= XCAR (objlist
);
5459 struct font
*font
= GC_XFONT_OBJECT (val
);
5461 if (!NILP (AREF (val
, FONT_TYPE_INDEX
))
5462 && VECTOR_MARKED_P(font
))
5465 if (CONSP (objlist
))
5467 /* Found a marked font, bail out. */
5474 /* No marked fonts were found, so this entire font
5475 entity can be dropped. */
5480 *prev
= XCDR (tail
);
5482 prev
= xcdr_addr (tail
);
5487 /* Compact font caches on all terminals and mark
5488 everything which is still here after compaction. */
5491 compact_font_caches (void)
5495 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5497 Lisp_Object cache
= TERMINAL_FONT_CACHE (t
);
5502 for (entry
= XCDR (cache
); CONSP (entry
); entry
= XCDR (entry
))
5503 XSETCAR (entry
, compact_font_cache_entry (XCAR (entry
)));
5505 mark_object (cache
);
5509 #else /* not HAVE_WINDOW_SYSTEM */
5511 #define compact_font_caches() (void)(0)
5513 #endif /* HAVE_WINDOW_SYSTEM */
5515 /* Remove (MARKER . DATA) entries with unmarked MARKER
5516 from buffer undo LIST and return changed list. */
5519 compact_undo_list (Lisp_Object list
)
5521 Lisp_Object tail
, *prev
= &list
;
5523 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
5525 if (CONSP (XCAR (tail
))
5526 && MARKERP (XCAR (XCAR (tail
)))
5527 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5528 *prev
= XCDR (tail
);
5530 prev
= xcdr_addr (tail
);
5536 mark_pinned_symbols (void)
5538 struct symbol_block
*sblk
;
5539 int lim
= (symbol_block_pinned
== symbol_block
5540 ? symbol_block_index
: SYMBOL_BLOCK_SIZE
);
5542 for (sblk
= symbol_block_pinned
; sblk
; sblk
= sblk
->next
)
5544 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
, *end
= sym
+ lim
;
5545 for (; sym
< end
; ++sym
)
5547 mark_object (make_lisp_symbol (&sym
->s
));
5549 lim
= SYMBOL_BLOCK_SIZE
;
5553 /* Subroutine of Fgarbage_collect that does most of the work. It is a
5554 separate function so that we could limit mark_stack in searching
5555 the stack frames below this function, thus avoiding the rare cases
5556 where mark_stack finds values that look like live Lisp objects on
5557 portions of stack that couldn't possibly contain such live objects.
5558 For more details of this, see the discussion at
5559 http://lists.gnu.org/archive/html/emacs-devel/2014-05/msg00270.html. */
5561 garbage_collect_1 (void *end
)
5563 struct buffer
*nextb
;
5564 char stack_top_variable
;
5567 ptrdiff_t count
= SPECPDL_INDEX ();
5568 struct timespec start
;
5569 Lisp_Object retval
= Qnil
;
5570 size_t tot_before
= 0;
5575 /* Can't GC if pure storage overflowed because we can't determine
5576 if something is a pure object or not. */
5577 if (pure_bytes_used_before_overflow
)
5580 /* Record this function, so it appears on the profiler's backtraces. */
5581 record_in_backtrace (Qautomatic_gc
, 0, 0);
5585 /* Don't keep undo information around forever.
5586 Do this early on, so it is no problem if the user quits. */
5587 FOR_EACH_BUFFER (nextb
)
5588 compact_buffer (nextb
);
5590 if (profiler_memory_running
)
5591 tot_before
= total_bytes_of_live_objects ();
5593 start
= current_timespec ();
5595 /* In case user calls debug_print during GC,
5596 don't let that cause a recursive GC. */
5597 consing_since_gc
= 0;
5599 /* Save what's currently displayed in the echo area. Don't do that
5600 if we are GC'ing because we've run out of memory, since
5601 push_message will cons, and we might have no memory for that. */
5602 if (NILP (Vmemory_full
))
5604 message_p
= push_message ();
5605 record_unwind_protect_void (pop_message_unwind
);
5610 /* Save a copy of the contents of the stack, for debugging. */
5611 #if MAX_SAVE_STACK > 0
5612 if (NILP (Vpurify_flag
))
5615 ptrdiff_t stack_size
;
5616 if (&stack_top_variable
< stack_bottom
)
5618 stack
= &stack_top_variable
;
5619 stack_size
= stack_bottom
- &stack_top_variable
;
5623 stack
= stack_bottom
;
5624 stack_size
= &stack_top_variable
- stack_bottom
;
5626 if (stack_size
<= MAX_SAVE_STACK
)
5628 if (stack_copy_size
< stack_size
)
5630 stack_copy
= xrealloc (stack_copy
, stack_size
);
5631 stack_copy_size
= stack_size
;
5633 no_sanitize_memcpy (stack_copy
, stack
, stack_size
);
5636 #endif /* MAX_SAVE_STACK > 0 */
5638 if (garbage_collection_messages
)
5639 message1_nolog ("Garbage collecting...");
5643 shrink_regexp_cache ();
5647 /* Mark all the special slots that serve as the roots of accessibility. */
5649 mark_buffer (&buffer_defaults
);
5650 mark_buffer (&buffer_local_symbols
);
5652 for (i
= 0; i
< ARRAYELTS (lispsym
); i
++)
5653 mark_object (builtin_lisp_symbol (i
));
5655 for (i
= 0; i
< staticidx
; i
++)
5656 mark_object (*staticvec
[i
]);
5658 mark_pinned_symbols ();
5670 struct handler
*handler
;
5671 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5673 mark_object (handler
->tag_or_ch
);
5674 mark_object (handler
->val
);
5677 #ifdef HAVE_WINDOW_SYSTEM
5678 mark_fringe_data ();
5681 /* Everything is now marked, except for the data in font caches,
5682 undo lists, and finalizers. The first two are compacted by
5683 removing an items which aren't reachable otherwise. */
5685 compact_font_caches ();
5687 FOR_EACH_BUFFER (nextb
)
5689 if (!EQ (BVAR (nextb
, undo_list
), Qt
))
5690 bset_undo_list (nextb
, compact_undo_list (BVAR (nextb
, undo_list
)));
5691 /* Now that we have stripped the elements that need not be
5692 in the undo_list any more, we can finally mark the list. */
5693 mark_object (BVAR (nextb
, undo_list
));
5696 /* Now pre-sweep finalizers. Here, we add any unmarked finalizers
5697 to doomed_finalizers so we can run their associated functions
5698 after GC. It's important to scan finalizers at this stage so
5699 that we can be sure that unmarked finalizers are really
5700 unreachable except for references from their associated functions
5701 and from other finalizers. */
5703 queue_doomed_finalizers (&doomed_finalizers
, &finalizers
);
5704 mark_finalizer_list (&doomed_finalizers
);
5708 relocate_byte_stack ();
5710 /* Clear the mark bits that we set in certain root slots. */
5711 VECTOR_UNMARK (&buffer_defaults
);
5712 VECTOR_UNMARK (&buffer_local_symbols
);
5720 consing_since_gc
= 0;
5721 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
5722 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
5724 gc_relative_threshold
= 0;
5725 if (FLOATP (Vgc_cons_percentage
))
5726 { /* Set gc_cons_combined_threshold. */
5727 double tot
= total_bytes_of_live_objects ();
5729 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5732 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5733 gc_relative_threshold
= tot
;
5735 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5739 if (garbage_collection_messages
&& NILP (Vmemory_full
))
5741 if (message_p
|| minibuf_level
> 0)
5744 message1_nolog ("Garbage collecting...done");
5747 unbind_to (count
, Qnil
);
5749 Lisp_Object total
[] = {
5750 list4 (Qconses
, make_number (sizeof (struct Lisp_Cons
)),
5751 bounded_number (total_conses
),
5752 bounded_number (total_free_conses
)),
5753 list4 (Qsymbols
, make_number (sizeof (struct Lisp_Symbol
)),
5754 bounded_number (total_symbols
),
5755 bounded_number (total_free_symbols
)),
5756 list4 (Qmiscs
, make_number (sizeof (union Lisp_Misc
)),
5757 bounded_number (total_markers
),
5758 bounded_number (total_free_markers
)),
5759 list4 (Qstrings
, make_number (sizeof (struct Lisp_String
)),
5760 bounded_number (total_strings
),
5761 bounded_number (total_free_strings
)),
5762 list3 (Qstring_bytes
, make_number (1),
5763 bounded_number (total_string_bytes
)),
5765 make_number (header_size
+ sizeof (Lisp_Object
)),
5766 bounded_number (total_vectors
)),
5767 list4 (Qvector_slots
, make_number (word_size
),
5768 bounded_number (total_vector_slots
),
5769 bounded_number (total_free_vector_slots
)),
5770 list4 (Qfloats
, make_number (sizeof (struct Lisp_Float
)),
5771 bounded_number (total_floats
),
5772 bounded_number (total_free_floats
)),
5773 list4 (Qintervals
, make_number (sizeof (struct interval
)),
5774 bounded_number (total_intervals
),
5775 bounded_number (total_free_intervals
)),
5776 list3 (Qbuffers
, make_number (sizeof (struct buffer
)),
5777 bounded_number (total_buffers
)),
5779 #ifdef DOUG_LEA_MALLOC
5780 list4 (Qheap
, make_number (1024),
5781 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
5782 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10)),
5785 retval
= CALLMANY (Flist
, total
);
5787 /* GC is complete: now we can run our finalizer callbacks. */
5788 run_finalizers (&doomed_finalizers
);
5790 if (!NILP (Vpost_gc_hook
))
5792 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5793 safe_run_hooks (Qpost_gc_hook
);
5794 unbind_to (gc_count
, Qnil
);
5797 /* Accumulate statistics. */
5798 if (FLOATP (Vgc_elapsed
))
5800 struct timespec since_start
= timespec_sub (current_timespec (), start
);
5801 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5802 + timespectod (since_start
));
5807 /* Collect profiling data. */
5808 if (profiler_memory_running
)
5811 size_t tot_after
= total_bytes_of_live_objects ();
5812 if (tot_before
> tot_after
)
5813 swept
= tot_before
- tot_after
;
5814 malloc_probe (swept
);
5820 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5821 doc
: /* Reclaim storage for Lisp objects no longer needed.
5822 Garbage collection happens automatically if you cons more than
5823 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5824 `garbage-collect' normally returns a list with info on amount of space in use,
5825 where each entry has the form (NAME SIZE USED FREE), where:
5826 - NAME is a symbol describing the kind of objects this entry represents,
5827 - SIZE is the number of bytes used by each one,
5828 - USED is the number of those objects that were found live in the heap,
5829 - FREE is the number of those objects that are not live but that Emacs
5830 keeps around for future allocations (maybe because it does not know how
5831 to return them to the OS).
5832 However, if there was overflow in pure space, `garbage-collect'
5833 returns nil, because real GC can't be done.
5834 See Info node `(elisp)Garbage Collection'. */)
5839 #ifdef HAVE___BUILTIN_UNWIND_INIT
5840 /* Force callee-saved registers and register windows onto the stack.
5841 This is the preferred method if available, obviating the need for
5842 machine dependent methods. */
5843 __builtin_unwind_init ();
5845 #else /* not HAVE___BUILTIN_UNWIND_INIT */
5846 #ifndef GC_SAVE_REGISTERS_ON_STACK
5847 /* jmp_buf may not be aligned enough on darwin-ppc64 */
5848 union aligned_jmpbuf
{
5852 volatile bool stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
5854 /* This trick flushes the register windows so that all the state of
5855 the process is contained in the stack. */
5856 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
5857 needed on ia64 too. See mach_dep.c, where it also says inline
5858 assembler doesn't work with relevant proprietary compilers. */
5860 #if defined (__sparc64__) && defined (__FreeBSD__)
5861 /* FreeBSD does not have a ta 3 handler. */
5868 /* Save registers that we need to see on the stack. We need to see
5869 registers used to hold register variables and registers used to
5871 #ifdef GC_SAVE_REGISTERS_ON_STACK
5872 GC_SAVE_REGISTERS_ON_STACK (end
);
5873 #else /* not GC_SAVE_REGISTERS_ON_STACK */
5875 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
5876 setjmp will definitely work, test it
5877 and print a message with the result
5879 if (!setjmp_tested_p
)
5881 setjmp_tested_p
= 1;
5884 #endif /* GC_SETJMP_WORKS */
5887 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
5888 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
5889 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
5890 return garbage_collect_1 (end
);
5893 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5894 only interesting objects referenced from glyphs are strings. */
5897 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5899 struct glyph_row
*row
= matrix
->rows
;
5900 struct glyph_row
*end
= row
+ matrix
->nrows
;
5902 for (; row
< end
; ++row
)
5906 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5908 struct glyph
*glyph
= row
->glyphs
[area
];
5909 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5911 for (; glyph
< end_glyph
; ++glyph
)
5912 if (STRINGP (glyph
->object
)
5913 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5914 mark_object (glyph
->object
);
5919 /* Mark reference to a Lisp_Object.
5920 If the object referred to has not been seen yet, recursively mark
5921 all the references contained in it. */
5923 #define LAST_MARKED_SIZE 500
5924 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5925 static int last_marked_index
;
5927 /* For debugging--call abort when we cdr down this many
5928 links of a list, in mark_object. In debugging,
5929 the call to abort will hit a breakpoint.
5930 Normally this is zero and the check never goes off. */
5931 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5934 mark_vectorlike (struct Lisp_Vector
*ptr
)
5936 ptrdiff_t size
= ptr
->header
.size
;
5939 eassert (!VECTOR_MARKED_P (ptr
));
5940 VECTOR_MARK (ptr
); /* Else mark it. */
5941 if (size
& PSEUDOVECTOR_FLAG
)
5942 size
&= PSEUDOVECTOR_SIZE_MASK
;
5944 /* Note that this size is not the memory-footprint size, but only
5945 the number of Lisp_Object fields that we should trace.
5946 The distinction is used e.g. by Lisp_Process which places extra
5947 non-Lisp_Object fields at the end of the structure... */
5948 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
5949 mark_object (ptr
->contents
[i
]);
5952 /* Like mark_vectorlike but optimized for char-tables (and
5953 sub-char-tables) assuming that the contents are mostly integers or
5957 mark_char_table (struct Lisp_Vector
*ptr
, enum pvec_type pvectype
)
5959 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5960 /* Consult the Lisp_Sub_Char_Table layout before changing this. */
5961 int i
, idx
= (pvectype
== PVEC_SUB_CHAR_TABLE
? SUB_CHAR_TABLE_OFFSET
: 0);
5963 eassert (!VECTOR_MARKED_P (ptr
));
5965 for (i
= idx
; i
< size
; i
++)
5967 Lisp_Object val
= ptr
->contents
[i
];
5969 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5971 if (SUB_CHAR_TABLE_P (val
))
5973 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5974 mark_char_table (XVECTOR (val
), PVEC_SUB_CHAR_TABLE
);
5981 NO_INLINE
/* To reduce stack depth in mark_object. */
5983 mark_compiled (struct Lisp_Vector
*ptr
)
5985 int i
, size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5988 for (i
= 0; i
< size
; i
++)
5989 if (i
!= COMPILED_CONSTANTS
)
5990 mark_object (ptr
->contents
[i
]);
5991 return size
> COMPILED_CONSTANTS
? ptr
->contents
[COMPILED_CONSTANTS
] : Qnil
;
5994 /* Mark the chain of overlays starting at PTR. */
5997 mark_overlay (struct Lisp_Overlay
*ptr
)
5999 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
6002 /* These two are always markers and can be marked fast. */
6003 XMARKER (ptr
->start
)->gcmarkbit
= 1;
6004 XMARKER (ptr
->end
)->gcmarkbit
= 1;
6005 mark_object (ptr
->plist
);
6009 /* Mark Lisp_Objects and special pointers in BUFFER. */
6012 mark_buffer (struct buffer
*buffer
)
6014 /* This is handled much like other pseudovectors... */
6015 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
6017 /* ...but there are some buffer-specific things. */
6019 MARK_INTERVAL_TREE (buffer_intervals (buffer
));
6021 /* For now, we just don't mark the undo_list. It's done later in
6022 a special way just before the sweep phase, and after stripping
6023 some of its elements that are not needed any more. */
6025 mark_overlay (buffer
->overlays_before
);
6026 mark_overlay (buffer
->overlays_after
);
6028 /* If this is an indirect buffer, mark its base buffer. */
6029 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
6030 mark_buffer (buffer
->base_buffer
);
6033 /* Mark Lisp faces in the face cache C. */
6035 NO_INLINE
/* To reduce stack depth in mark_object. */
6037 mark_face_cache (struct face_cache
*c
)
6042 for (i
= 0; i
< c
->used
; ++i
)
6044 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
6048 if (face
->font
&& !VECTOR_MARKED_P (face
->font
))
6049 mark_vectorlike ((struct Lisp_Vector
*) face
->font
);
6051 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
6052 mark_object (face
->lface
[j
]);
6058 NO_INLINE
/* To reduce stack depth in mark_object. */
6060 mark_localized_symbol (struct Lisp_Symbol
*ptr
)
6062 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
6063 Lisp_Object where
= blv
->where
;
6064 /* If the value is set up for a killed buffer or deleted
6065 frame, restore its global binding. If the value is
6066 forwarded to a C variable, either it's not a Lisp_Object
6067 var, or it's staticpro'd already. */
6068 if ((BUFFERP (where
) && !BUFFER_LIVE_P (XBUFFER (where
)))
6069 || (FRAMEP (where
) && !FRAME_LIVE_P (XFRAME (where
))))
6070 swap_in_global_binding (ptr
);
6071 mark_object (blv
->where
);
6072 mark_object (blv
->valcell
);
6073 mark_object (blv
->defcell
);
6076 NO_INLINE
/* To reduce stack depth in mark_object. */
6078 mark_save_value (struct Lisp_Save_Value
*ptr
)
6080 /* If `save_type' is zero, `data[0].pointer' is the address
6081 of a memory area containing `data[1].integer' potential
6083 if (ptr
->save_type
== SAVE_TYPE_MEMORY
)
6085 Lisp_Object
*p
= ptr
->data
[0].pointer
;
6087 for (nelt
= ptr
->data
[1].integer
; nelt
> 0; nelt
--, p
++)
6088 mark_maybe_object (*p
);
6092 /* Find Lisp_Objects in `data[N]' slots and mark them. */
6094 for (i
= 0; i
< SAVE_VALUE_SLOTS
; i
++)
6095 if (save_type (ptr
, i
) == SAVE_OBJECT
)
6096 mark_object (ptr
->data
[i
].object
);
6100 /* Remove killed buffers or items whose car is a killed buffer from
6101 LIST, and mark other items. Return changed LIST, which is marked. */
6104 mark_discard_killed_buffers (Lisp_Object list
)
6106 Lisp_Object tail
, *prev
= &list
;
6108 for (tail
= list
; CONSP (tail
) && !CONS_MARKED_P (XCONS (tail
));
6111 Lisp_Object tem
= XCAR (tail
);
6114 if (BUFFERP (tem
) && !BUFFER_LIVE_P (XBUFFER (tem
)))
6115 *prev
= XCDR (tail
);
6118 CONS_MARK (XCONS (tail
));
6119 mark_object (XCAR (tail
));
6120 prev
= xcdr_addr (tail
);
6127 /* Determine type of generic Lisp_Object and mark it accordingly.
6129 This function implements a straightforward depth-first marking
6130 algorithm and so the recursion depth may be very high (a few
6131 tens of thousands is not uncommon). To minimize stack usage,
6132 a few cold paths are moved out to NO_INLINE functions above.
6133 In general, inlining them doesn't help you to gain more speed. */
6136 mark_object (Lisp_Object arg
)
6138 register Lisp_Object obj
;
6140 #ifdef GC_CHECK_MARKED_OBJECTS
6143 ptrdiff_t cdr_count
= 0;
6152 last_marked
[last_marked_index
++] = obj
;
6153 if (last_marked_index
== LAST_MARKED_SIZE
)
6154 last_marked_index
= 0;
6156 /* Perform some sanity checks on the objects marked here. Abort if
6157 we encounter an object we know is bogus. This increases GC time
6159 #ifdef GC_CHECK_MARKED_OBJECTS
6161 /* Check that the object pointed to by PO is known to be a Lisp
6162 structure allocated from the heap. */
6163 #define CHECK_ALLOCATED() \
6165 m = mem_find (po); \
6170 /* Check that the object pointed to by PO is live, using predicate
6172 #define CHECK_LIVE(LIVEP) \
6174 if (!LIVEP (m, po)) \
6178 /* Check both of the above conditions, for non-symbols. */
6179 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
6181 CHECK_ALLOCATED (); \
6182 CHECK_LIVE (LIVEP); \
6185 /* Check both of the above conditions, for symbols. */
6186 #define CHECK_ALLOCATED_AND_LIVE_SYMBOL() \
6188 if (!c_symbol_p (ptr)) \
6190 CHECK_ALLOCATED (); \
6191 CHECK_LIVE (live_symbol_p); \
6195 #else /* not GC_CHECK_MARKED_OBJECTS */
6197 #define CHECK_LIVE(LIVEP) ((void) 0)
6198 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) ((void) 0)
6199 #define CHECK_ALLOCATED_AND_LIVE_SYMBOL() ((void) 0)
6201 #endif /* not GC_CHECK_MARKED_OBJECTS */
6203 switch (XTYPE (obj
))
6207 register struct Lisp_String
*ptr
= XSTRING (obj
);
6208 if (STRING_MARKED_P (ptr
))
6210 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
6212 MARK_INTERVAL_TREE (ptr
->intervals
);
6213 #ifdef GC_CHECK_STRING_BYTES
6214 /* Check that the string size recorded in the string is the
6215 same as the one recorded in the sdata structure. */
6217 #endif /* GC_CHECK_STRING_BYTES */
6221 case Lisp_Vectorlike
:
6223 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
6224 register ptrdiff_t pvectype
;
6226 if (VECTOR_MARKED_P (ptr
))
6229 #ifdef GC_CHECK_MARKED_OBJECTS
6231 if (m
== MEM_NIL
&& !SUBRP (obj
))
6233 #endif /* GC_CHECK_MARKED_OBJECTS */
6235 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
6236 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
6237 >> PSEUDOVECTOR_AREA_BITS
);
6239 pvectype
= PVEC_NORMAL_VECTOR
;
6241 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
6242 CHECK_LIVE (live_vector_p
);
6247 #ifdef GC_CHECK_MARKED_OBJECTS
6256 #endif /* GC_CHECK_MARKED_OBJECTS */
6257 mark_buffer ((struct buffer
*) ptr
);
6261 /* Although we could treat this just like a vector, mark_compiled
6262 returns the COMPILED_CONSTANTS element, which is marked at the
6263 next iteration of goto-loop here. This is done to avoid a few
6264 recursive calls to mark_object. */
6265 obj
= mark_compiled (ptr
);
6272 struct frame
*f
= (struct frame
*) ptr
;
6274 mark_vectorlike (ptr
);
6275 mark_face_cache (f
->face_cache
);
6276 #ifdef HAVE_WINDOW_SYSTEM
6277 if (FRAME_WINDOW_P (f
) && FRAME_X_OUTPUT (f
))
6279 struct font
*font
= FRAME_FONT (f
);
6281 if (font
&& !VECTOR_MARKED_P (font
))
6282 mark_vectorlike ((struct Lisp_Vector
*) font
);
6290 struct window
*w
= (struct window
*) ptr
;
6292 mark_vectorlike (ptr
);
6294 /* Mark glyph matrices, if any. Marking window
6295 matrices is sufficient because frame matrices
6296 use the same glyph memory. */
6297 if (w
->current_matrix
)
6299 mark_glyph_matrix (w
->current_matrix
);
6300 mark_glyph_matrix (w
->desired_matrix
);
6303 /* Filter out killed buffers from both buffer lists
6304 in attempt to help GC to reclaim killed buffers faster.
6305 We can do it elsewhere for live windows, but this is the
6306 best place to do it for dead windows. */
6308 (w
, mark_discard_killed_buffers (w
->prev_buffers
));
6310 (w
, mark_discard_killed_buffers (w
->next_buffers
));
6314 case PVEC_HASH_TABLE
:
6316 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6318 mark_vectorlike (ptr
);
6319 mark_object (h
->test
.name
);
6320 mark_object (h
->test
.user_hash_function
);
6321 mark_object (h
->test
.user_cmp_function
);
6322 /* If hash table is not weak, mark all keys and values.
6323 For weak tables, mark only the vector. */
6325 mark_object (h
->key_and_value
);
6327 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6331 case PVEC_CHAR_TABLE
:
6332 case PVEC_SUB_CHAR_TABLE
:
6333 mark_char_table (ptr
, (enum pvec_type
) pvectype
);
6336 case PVEC_BOOL_VECTOR
:
6337 /* No Lisp_Objects to mark in a bool vector. */
6348 mark_vectorlike (ptr
);
6355 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6359 CHECK_ALLOCATED_AND_LIVE_SYMBOL ();
6361 /* Attempt to catch bogus objects. */
6362 eassert (valid_lisp_object_p (ptr
->function
));
6363 mark_object (ptr
->function
);
6364 mark_object (ptr
->plist
);
6365 switch (ptr
->redirect
)
6367 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6368 case SYMBOL_VARALIAS
:
6371 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6375 case SYMBOL_LOCALIZED
:
6376 mark_localized_symbol (ptr
);
6378 case SYMBOL_FORWARDED
:
6379 /* If the value is forwarded to a buffer or keyboard field,
6380 these are marked when we see the corresponding object.
6381 And if it's forwarded to a C variable, either it's not
6382 a Lisp_Object var, or it's staticpro'd already. */
6384 default: emacs_abort ();
6386 if (!PURE_P (XSTRING (ptr
->name
)))
6387 MARK_STRING (XSTRING (ptr
->name
));
6388 MARK_INTERVAL_TREE (string_intervals (ptr
->name
));
6389 /* Inner loop to mark next symbol in this bucket, if any. */
6390 po
= ptr
= ptr
->next
;
6397 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6399 if (XMISCANY (obj
)->gcmarkbit
)
6402 switch (XMISCTYPE (obj
))
6404 case Lisp_Misc_Marker
:
6405 /* DO NOT mark thru the marker's chain.
6406 The buffer's markers chain does not preserve markers from gc;
6407 instead, markers are removed from the chain when freed by gc. */
6408 XMISCANY (obj
)->gcmarkbit
= 1;
6411 case Lisp_Misc_Save_Value
:
6412 XMISCANY (obj
)->gcmarkbit
= 1;
6413 mark_save_value (XSAVE_VALUE (obj
));
6416 case Lisp_Misc_Overlay
:
6417 mark_overlay (XOVERLAY (obj
));
6420 case Lisp_Misc_Finalizer
:
6421 XMISCANY (obj
)->gcmarkbit
= true;
6422 mark_object (XFINALIZER (obj
)->function
);
6426 case Lisp_Misc_User_Ptr
:
6427 XMISCANY (obj
)->gcmarkbit
= true;
6438 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6439 if (CONS_MARKED_P (ptr
))
6441 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6443 /* If the cdr is nil, avoid recursion for the car. */
6444 if (EQ (ptr
->u
.cdr
, Qnil
))
6450 mark_object (ptr
->car
);
6453 if (cdr_count
== mark_object_loop_halt
)
6459 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6460 FLOAT_MARK (XFLOAT (obj
));
6471 #undef CHECK_ALLOCATED
6472 #undef CHECK_ALLOCATED_AND_LIVE
6474 /* Mark the Lisp pointers in the terminal objects.
6475 Called by Fgarbage_collect. */
6478 mark_terminals (void)
6481 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6483 eassert (t
->name
!= NULL
);
6484 #ifdef HAVE_WINDOW_SYSTEM
6485 /* If a terminal object is reachable from a stacpro'ed object,
6486 it might have been marked already. Make sure the image cache
6488 mark_image_cache (t
->image_cache
);
6489 #endif /* HAVE_WINDOW_SYSTEM */
6490 if (!VECTOR_MARKED_P (t
))
6491 mark_vectorlike ((struct Lisp_Vector
*)t
);
6497 /* Value is non-zero if OBJ will survive the current GC because it's
6498 either marked or does not need to be marked to survive. */
6501 survives_gc_p (Lisp_Object obj
)
6505 switch (XTYPE (obj
))
6512 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6516 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6520 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6523 case Lisp_Vectorlike
:
6524 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6528 survives_p
= CONS_MARKED_P (XCONS (obj
));
6532 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6539 return survives_p
|| PURE_P (XPNTR (obj
));
6545 NO_INLINE
/* For better stack traces */
6549 struct cons_block
*cblk
;
6550 struct cons_block
**cprev
= &cons_block
;
6551 int lim
= cons_block_index
;
6552 EMACS_INT num_free
= 0, num_used
= 0;
6556 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6560 int ilim
= (lim
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
6562 /* Scan the mark bits an int at a time. */
6563 for (i
= 0; i
< ilim
; i
++)
6565 if (cblk
->gcmarkbits
[i
] == BITS_WORD_MAX
)
6567 /* Fast path - all cons cells for this int are marked. */
6568 cblk
->gcmarkbits
[i
] = 0;
6569 num_used
+= BITS_PER_BITS_WORD
;
6573 /* Some cons cells for this int are not marked.
6574 Find which ones, and free them. */
6575 int start
, pos
, stop
;
6577 start
= i
* BITS_PER_BITS_WORD
;
6579 if (stop
> BITS_PER_BITS_WORD
)
6580 stop
= BITS_PER_BITS_WORD
;
6583 for (pos
= start
; pos
< stop
; pos
++)
6585 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6588 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6589 cons_free_list
= &cblk
->conses
[pos
];
6590 cons_free_list
->car
= Vdead
;
6595 CONS_UNMARK (&cblk
->conses
[pos
]);
6601 lim
= CONS_BLOCK_SIZE
;
6602 /* If this block contains only free conses and we have already
6603 seen more than two blocks worth of free conses then deallocate
6605 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6607 *cprev
= cblk
->next
;
6608 /* Unhook from the free list. */
6609 cons_free_list
= cblk
->conses
[0].u
.chain
;
6610 lisp_align_free (cblk
);
6614 num_free
+= this_free
;
6615 cprev
= &cblk
->next
;
6618 total_conses
= num_used
;
6619 total_free_conses
= num_free
;
6622 NO_INLINE
/* For better stack traces */
6626 register struct float_block
*fblk
;
6627 struct float_block
**fprev
= &float_block
;
6628 register int lim
= float_block_index
;
6629 EMACS_INT num_free
= 0, num_used
= 0;
6631 float_free_list
= 0;
6633 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6637 for (i
= 0; i
< lim
; i
++)
6638 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6641 fblk
->floats
[i
].u
.chain
= float_free_list
;
6642 float_free_list
= &fblk
->floats
[i
];
6647 FLOAT_UNMARK (&fblk
->floats
[i
]);
6649 lim
= FLOAT_BLOCK_SIZE
;
6650 /* If this block contains only free floats and we have already
6651 seen more than two blocks worth of free floats then deallocate
6653 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6655 *fprev
= fblk
->next
;
6656 /* Unhook from the free list. */
6657 float_free_list
= fblk
->floats
[0].u
.chain
;
6658 lisp_align_free (fblk
);
6662 num_free
+= this_free
;
6663 fprev
= &fblk
->next
;
6666 total_floats
= num_used
;
6667 total_free_floats
= num_free
;
6670 NO_INLINE
/* For better stack traces */
6672 sweep_intervals (void)
6674 register struct interval_block
*iblk
;
6675 struct interval_block
**iprev
= &interval_block
;
6676 register int lim
= interval_block_index
;
6677 EMACS_INT num_free
= 0, num_used
= 0;
6679 interval_free_list
= 0;
6681 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6686 for (i
= 0; i
< lim
; i
++)
6688 if (!iblk
->intervals
[i
].gcmarkbit
)
6690 set_interval_parent (&iblk
->intervals
[i
], interval_free_list
);
6691 interval_free_list
= &iblk
->intervals
[i
];
6697 iblk
->intervals
[i
].gcmarkbit
= 0;
6700 lim
= INTERVAL_BLOCK_SIZE
;
6701 /* If this block contains only free intervals and we have already
6702 seen more than two blocks worth of free intervals then
6703 deallocate this block. */
6704 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6706 *iprev
= iblk
->next
;
6707 /* Unhook from the free list. */
6708 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6713 num_free
+= this_free
;
6714 iprev
= &iblk
->next
;
6717 total_intervals
= num_used
;
6718 total_free_intervals
= num_free
;
6721 NO_INLINE
/* For better stack traces */
6723 sweep_symbols (void)
6725 struct symbol_block
*sblk
;
6726 struct symbol_block
**sprev
= &symbol_block
;
6727 int lim
= symbol_block_index
;
6728 EMACS_INT num_free
= 0, num_used
= ARRAYELTS (lispsym
);
6730 symbol_free_list
= NULL
;
6732 for (int i
= 0; i
< ARRAYELTS (lispsym
); i
++)
6733 lispsym
[i
].gcmarkbit
= 0;
6735 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6738 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6739 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6741 for (; sym
< end
; ++sym
)
6743 if (!sym
->s
.gcmarkbit
)
6745 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6746 xfree (SYMBOL_BLV (&sym
->s
));
6747 sym
->s
.next
= symbol_free_list
;
6748 symbol_free_list
= &sym
->s
;
6749 symbol_free_list
->function
= Vdead
;
6755 sym
->s
.gcmarkbit
= 0;
6756 /* Attempt to catch bogus objects. */
6757 eassert (valid_lisp_object_p (sym
->s
.function
));
6761 lim
= SYMBOL_BLOCK_SIZE
;
6762 /* If this block contains only free symbols and we have already
6763 seen more than two blocks worth of free symbols then deallocate
6765 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6767 *sprev
= sblk
->next
;
6768 /* Unhook from the free list. */
6769 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6774 num_free
+= this_free
;
6775 sprev
= &sblk
->next
;
6778 total_symbols
= num_used
;
6779 total_free_symbols
= num_free
;
6782 NO_INLINE
/* For better stack traces. */
6786 register struct marker_block
*mblk
;
6787 struct marker_block
**mprev
= &marker_block
;
6788 register int lim
= marker_block_index
;
6789 EMACS_INT num_free
= 0, num_used
= 0;
6791 /* Put all unmarked misc's on free list. For a marker, first
6792 unchain it from the buffer it points into. */
6794 marker_free_list
= 0;
6796 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6801 for (i
= 0; i
< lim
; i
++)
6803 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6805 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6806 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6807 else if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Finalizer
)
6808 unchain_finalizer (&mblk
->markers
[i
].m
.u_finalizer
);
6810 else if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_User_Ptr
)
6812 struct Lisp_User_Ptr
*uptr
= &mblk
->markers
[i
].m
.u_user_ptr
;
6813 uptr
->finalizer (uptr
->p
);
6816 /* Set the type of the freed object to Lisp_Misc_Free.
6817 We could leave the type alone, since nobody checks it,
6818 but this might catch bugs faster. */
6819 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6820 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6821 marker_free_list
= &mblk
->markers
[i
].m
;
6827 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6830 lim
= MARKER_BLOCK_SIZE
;
6831 /* If this block contains only free markers and we have already
6832 seen more than two blocks worth of free markers then deallocate
6834 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6836 *mprev
= mblk
->next
;
6837 /* Unhook from the free list. */
6838 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6843 num_free
+= this_free
;
6844 mprev
= &mblk
->next
;
6848 total_markers
= num_used
;
6849 total_free_markers
= num_free
;
6852 NO_INLINE
/* For better stack traces */
6854 sweep_buffers (void)
6856 register struct buffer
*buffer
, **bprev
= &all_buffers
;
6859 for (buffer
= all_buffers
; buffer
; buffer
= *bprev
)
6860 if (!VECTOR_MARKED_P (buffer
))
6862 *bprev
= buffer
->next
;
6867 VECTOR_UNMARK (buffer
);
6868 /* Do not use buffer_(set|get)_intervals here. */
6869 buffer
->text
->intervals
= balance_intervals (buffer
->text
->intervals
);
6871 bprev
= &buffer
->next
;
6875 /* Sweep: find all structures not marked, and free them. */
6879 /* Remove or mark entries in weak hash tables.
6880 This must be done before any object is unmarked. */
6881 sweep_weak_hash_tables ();
6884 check_string_bytes (!noninteractive
);
6892 check_string_bytes (!noninteractive
);
6895 DEFUN ("memory-info", Fmemory_info
, Smemory_info
, 0, 0, 0,
6896 doc
: /* Return a list of (TOTAL-RAM FREE-RAM TOTAL-SWAP FREE-SWAP).
6897 All values are in Kbytes. If there is no swap space,
6898 last two values are zero. If the system is not supported
6899 or memory information can't be obtained, return nil. */)
6902 #if defined HAVE_LINUX_SYSINFO
6908 #ifdef LINUX_SYSINFO_UNIT
6909 units
= si
.mem_unit
;
6913 return list4i ((uintmax_t) si
.totalram
* units
/ 1024,
6914 (uintmax_t) si
.freeram
* units
/ 1024,
6915 (uintmax_t) si
.totalswap
* units
/ 1024,
6916 (uintmax_t) si
.freeswap
* units
/ 1024);
6917 #elif defined WINDOWSNT
6918 unsigned long long totalram
, freeram
, totalswap
, freeswap
;
6920 if (w32_memory_info (&totalram
, &freeram
, &totalswap
, &freeswap
) == 0)
6921 return list4i ((uintmax_t) totalram
/ 1024,
6922 (uintmax_t) freeram
/ 1024,
6923 (uintmax_t) totalswap
/ 1024,
6924 (uintmax_t) freeswap
/ 1024);
6928 unsigned long totalram
, freeram
, totalswap
, freeswap
;
6930 if (dos_memory_info (&totalram
, &freeram
, &totalswap
, &freeswap
) == 0)
6931 return list4i ((uintmax_t) totalram
/ 1024,
6932 (uintmax_t) freeram
/ 1024,
6933 (uintmax_t) totalswap
/ 1024,
6934 (uintmax_t) freeswap
/ 1024);
6937 #else /* not HAVE_LINUX_SYSINFO, not WINDOWSNT, not MSDOS */
6938 /* FIXME: add more systems. */
6940 #endif /* HAVE_LINUX_SYSINFO, not WINDOWSNT, not MSDOS */
6943 /* Debugging aids. */
6945 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6946 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6947 This may be helpful in debugging Emacs's memory usage.
6948 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6954 /* Avoid warning. sbrk has no relation to memory allocated anyway. */
6957 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6963 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6964 doc
: /* Return a list of counters that measure how much consing there has been.
6965 Each of these counters increments for a certain kind of object.
6966 The counters wrap around from the largest positive integer to zero.
6967 Garbage collection does not decrease them.
6968 The elements of the value are as follows:
6969 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6970 All are in units of 1 = one object consed
6971 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6973 MISCS include overlays, markers, and some internal types.
6974 Frames, windows, buffers, and subprocesses count as vectors
6975 (but the contents of a buffer's text do not count here). */)
6978 return listn (CONSTYPE_HEAP
, 8,
6979 bounded_number (cons_cells_consed
),
6980 bounded_number (floats_consed
),
6981 bounded_number (vector_cells_consed
),
6982 bounded_number (symbols_consed
),
6983 bounded_number (string_chars_consed
),
6984 bounded_number (misc_objects_consed
),
6985 bounded_number (intervals_consed
),
6986 bounded_number (strings_consed
));
6990 symbol_uses_obj (Lisp_Object symbol
, Lisp_Object obj
)
6992 struct Lisp_Symbol
*sym
= XSYMBOL (symbol
);
6993 Lisp_Object val
= find_symbol_value (symbol
);
6994 return (EQ (val
, obj
)
6995 || EQ (sym
->function
, obj
)
6996 || (!NILP (sym
->function
)
6997 && COMPILEDP (sym
->function
)
6998 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
7001 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)));
7004 /* Find at most FIND_MAX symbols which have OBJ as their value or
7005 function. This is used in gdbinit's `xwhichsymbols' command. */
7008 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
7010 struct symbol_block
*sblk
;
7011 ptrdiff_t gc_count
= inhibit_garbage_collection ();
7012 Lisp_Object found
= Qnil
;
7016 for (int i
= 0; i
< ARRAYELTS (lispsym
); i
++)
7018 Lisp_Object sym
= builtin_lisp_symbol (i
);
7019 if (symbol_uses_obj (sym
, obj
))
7021 found
= Fcons (sym
, found
);
7022 if (--find_max
== 0)
7027 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
7029 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
7032 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
7034 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
7037 Lisp_Object sym
= make_lisp_symbol (&aligned_sym
->s
);
7038 if (symbol_uses_obj (sym
, obj
))
7040 found
= Fcons (sym
, found
);
7041 if (--find_max
== 0)
7049 unbind_to (gc_count
, Qnil
);
7053 #ifdef SUSPICIOUS_OBJECT_CHECKING
7056 find_suspicious_object_in_range (void *begin
, void *end
)
7058 char *begin_a
= begin
;
7062 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
7064 char *suspicious_object
= suspicious_objects
[i
];
7065 if (begin_a
<= suspicious_object
&& suspicious_object
< end_a
)
7066 return suspicious_object
;
7073 note_suspicious_free (void* ptr
)
7075 struct suspicious_free_record
* rec
;
7077 rec
= &suspicious_free_history
[suspicious_free_history_index
++];
7078 if (suspicious_free_history_index
==
7079 ARRAYELTS (suspicious_free_history
))
7081 suspicious_free_history_index
= 0;
7084 memset (rec
, 0, sizeof (*rec
));
7085 rec
->suspicious_object
= ptr
;
7086 backtrace (&rec
->backtrace
[0], ARRAYELTS (rec
->backtrace
));
7090 detect_suspicious_free (void* ptr
)
7094 eassert (ptr
!= NULL
);
7096 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
7097 if (suspicious_objects
[i
] == ptr
)
7099 note_suspicious_free (ptr
);
7100 suspicious_objects
[i
] = NULL
;
7104 #endif /* SUSPICIOUS_OBJECT_CHECKING */
7106 DEFUN ("suspicious-object", Fsuspicious_object
, Ssuspicious_object
, 1, 1, 0,
7107 doc
: /* Return OBJ, maybe marking it for extra scrutiny.
7108 If Emacs is compiled with suspicious object checking, capture
7109 a stack trace when OBJ is freed in order to help track down
7110 garbage collection bugs. Otherwise, do nothing and return OBJ. */)
7113 #ifdef SUSPICIOUS_OBJECT_CHECKING
7114 /* Right now, we care only about vectors. */
7115 if (VECTORLIKEP (obj
))
7117 suspicious_objects
[suspicious_object_index
++] = XVECTOR (obj
);
7118 if (suspicious_object_index
== ARRAYELTS (suspicious_objects
))
7119 suspicious_object_index
= 0;
7125 #ifdef ENABLE_CHECKING
7127 bool suppress_checking
;
7130 die (const char *msg
, const char *file
, int line
)
7132 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: assertion failed: %s\r\n",
7134 terminate_due_to_signal (SIGABRT
, INT_MAX
);
7137 #endif /* ENABLE_CHECKING */
7139 #if defined (ENABLE_CHECKING) && USE_STACK_LISP_OBJECTS
7141 /* Debugging check whether STR is ASCII-only. */
7144 verify_ascii (const char *str
)
7146 const unsigned char *ptr
= (unsigned char *) str
, *end
= ptr
+ strlen (str
);
7149 int c
= STRING_CHAR_ADVANCE (ptr
);
7150 if (!ASCII_CHAR_P (c
))
7156 /* Stress alloca with inconveniently sized requests and check
7157 whether all allocated areas may be used for Lisp_Object. */
7159 NO_INLINE
static void
7160 verify_alloca (void)
7163 enum { ALLOCA_CHECK_MAX
= 256 };
7164 /* Start from size of the smallest Lisp object. */
7165 for (i
= sizeof (struct Lisp_Cons
); i
<= ALLOCA_CHECK_MAX
; i
++)
7167 void *ptr
= alloca (i
);
7168 make_lisp_ptr (ptr
, Lisp_Cons
);
7172 #else /* not ENABLE_CHECKING && USE_STACK_LISP_OBJECTS */
7174 #define verify_alloca() ((void) 0)
7176 #endif /* ENABLE_CHECKING && USE_STACK_LISP_OBJECTS */
7178 /* Initialization. */
7181 init_alloc_once (void)
7183 /* Even though Qt's contents are not set up, its address is known. */
7187 pure_size
= PURESIZE
;
7190 init_finalizer_list (&finalizers
);
7191 init_finalizer_list (&doomed_finalizers
);
7194 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
7196 #ifdef DOUG_LEA_MALLOC
7197 mallopt (M_TRIM_THRESHOLD
, 128 * 1024); /* Trim threshold. */
7198 mallopt (M_MMAP_THRESHOLD
, 64 * 1024); /* Mmap threshold. */
7199 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* Max. number of mmap'ed areas. */
7204 refill_memory_reserve ();
7205 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
7211 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
7212 setjmp_tested_p
= longjmps_done
= 0;
7214 Vgc_elapsed
= make_float (0.0);
7218 valgrind_p
= RUNNING_ON_VALGRIND
!= 0;
7223 syms_of_alloc (void)
7225 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
7226 doc
: /* Number of bytes of consing between garbage collections.
7227 Garbage collection can happen automatically once this many bytes have been
7228 allocated since the last garbage collection. All data types count.
7230 Garbage collection happens automatically only when `eval' is called.
7232 By binding this temporarily to a large number, you can effectively
7233 prevent garbage collection during a part of the program.
7234 See also `gc-cons-percentage'. */);
7236 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
7237 doc
: /* Portion of the heap used for allocation.
7238 Garbage collection can happen automatically once this portion of the heap
7239 has been allocated since the last garbage collection.
7240 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
7241 Vgc_cons_percentage
= make_float (0.1);
7243 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
7244 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
7246 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
7247 doc
: /* Number of cons cells that have been consed so far. */);
7249 DEFVAR_INT ("floats-consed", floats_consed
,
7250 doc
: /* Number of floats that have been consed so far. */);
7252 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
7253 doc
: /* Number of vector cells that have been consed so far. */);
7255 DEFVAR_INT ("symbols-consed", symbols_consed
,
7256 doc
: /* Number of symbols that have been consed so far. */);
7257 symbols_consed
+= ARRAYELTS (lispsym
);
7259 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
7260 doc
: /* Number of string characters that have been consed so far. */);
7262 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
7263 doc
: /* Number of miscellaneous objects that have been consed so far.
7264 These include markers and overlays, plus certain objects not visible
7267 DEFVAR_INT ("intervals-consed", intervals_consed
,
7268 doc
: /* Number of intervals that have been consed so far. */);
7270 DEFVAR_INT ("strings-consed", strings_consed
,
7271 doc
: /* Number of strings that have been consed so far. */);
7273 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
7274 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
7275 This means that certain objects should be allocated in shared (pure) space.
7276 It can also be set to a hash-table, in which case this table is used to
7277 do hash-consing of the objects allocated to pure space. */);
7279 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
7280 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
7281 garbage_collection_messages
= 0;
7283 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
7284 doc
: /* Hook run after garbage collection has finished. */);
7285 Vpost_gc_hook
= Qnil
;
7286 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
7288 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
7289 doc
: /* Precomputed `signal' argument for memory-full error. */);
7290 /* We build this in advance because if we wait until we need it, we might
7291 not be able to allocate the memory to hold it. */
7293 = listn (CONSTYPE_PURE
, 2, Qerror
,
7294 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
7296 DEFVAR_LISP ("memory-full", Vmemory_full
,
7297 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
7298 Vmemory_full
= Qnil
;
7300 DEFSYM (Qconses
, "conses");
7301 DEFSYM (Qsymbols
, "symbols");
7302 DEFSYM (Qmiscs
, "miscs");
7303 DEFSYM (Qstrings
, "strings");
7304 DEFSYM (Qvectors
, "vectors");
7305 DEFSYM (Qfloats
, "floats");
7306 DEFSYM (Qintervals
, "intervals");
7307 DEFSYM (Qbuffers
, "buffers");
7308 DEFSYM (Qstring_bytes
, "string-bytes");
7309 DEFSYM (Qvector_slots
, "vector-slots");
7310 DEFSYM (Qheap
, "heap");
7311 DEFSYM (Qautomatic_gc
, "Automatic GC");
7313 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
7314 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
7316 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
7317 doc
: /* Accumulated time elapsed in garbage collections.
7318 The time is in seconds as a floating point value. */);
7319 DEFVAR_INT ("gcs-done", gcs_done
,
7320 doc
: /* Accumulated number of garbage collections done. */);
7325 defsubr (&Sbool_vector
);
7326 defsubr (&Smake_byte_code
);
7327 defsubr (&Smake_list
);
7328 defsubr (&Smake_vector
);
7329 defsubr (&Smake_string
);
7330 defsubr (&Smake_bool_vector
);
7331 defsubr (&Smake_symbol
);
7332 defsubr (&Smake_marker
);
7333 defsubr (&Smake_finalizer
);
7334 defsubr (&Spurecopy
);
7335 defsubr (&Sgarbage_collect
);
7336 defsubr (&Smemory_limit
);
7337 defsubr (&Smemory_info
);
7338 defsubr (&Smemory_use_counts
);
7339 defsubr (&Ssuspicious_object
);
7342 /* When compiled with GCC, GDB might say "No enum type named
7343 pvec_type" if we don't have at least one symbol with that type, and
7344 then xbacktrace could fail. Similarly for the other enums and
7345 their values. Some non-GCC compilers don't like these constructs. */
7349 enum CHARTAB_SIZE_BITS CHARTAB_SIZE_BITS
;
7350 enum char_table_specials char_table_specials
;
7351 enum char_bits char_bits
;
7352 enum CHECK_LISP_OBJECT_TYPE CHECK_LISP_OBJECT_TYPE
;
7353 enum DEFAULT_HASH_SIZE DEFAULT_HASH_SIZE
;
7354 enum Lisp_Bits Lisp_Bits
;
7355 enum Lisp_Compiled Lisp_Compiled
;
7356 enum maxargs maxargs
;
7357 enum MAX_ALLOCA MAX_ALLOCA
;
7358 enum More_Lisp_Bits More_Lisp_Bits
;
7359 enum pvec_type pvec_type
;
7360 } const EXTERNALLY_VISIBLE gdb_make_enums_visible
= {0};
7361 #endif /* __GNUC__ */