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 (at
11 your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <limits.h> /* For CHAR_BIT. */
26 #ifdef ENABLE_CHECKING
27 #include <signal.h> /* For SIGABRT. */
35 #include "dispextern.h"
36 #include "intervals.h"
39 #include "character.h"
44 #include "blockinput.h"
45 #include "termhooks.h" /* For struct terminal. */
46 #ifdef HAVE_WINDOW_SYSTEM
48 #endif /* HAVE_WINDOW_SYSTEM */
51 #include <execinfo.h> /* For backtrace. */
53 #ifdef HAVE_LINUX_SYSINFO
54 #include <sys/sysinfo.h>
58 #include "dosfns.h" /* For dos_memory_info. */
61 #if (defined ENABLE_CHECKING \
62 && defined HAVE_VALGRIND_VALGRIND_H \
63 && !defined USE_VALGRIND)
64 # define USE_VALGRIND 1
68 #include <valgrind/valgrind.h>
69 #include <valgrind/memcheck.h>
70 static bool valgrind_p
;
73 /* GC_CHECK_MARKED_OBJECTS means do sanity checks on allocated objects. */
75 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
76 memory. Can do this only if using gmalloc.c and if not checking
79 #if (defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC \
80 || defined HYBRID_MALLOC || defined GC_CHECK_MARKED_OBJECTS)
81 #undef GC_MALLOC_CHECK
92 #include "w32heap.h" /* for sbrk */
95 #if defined DOUG_LEA_MALLOC || defined GNU_LINUX
96 /* The address where the heap starts. */
107 #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 /* Get and free this pointer; useful around unexec. */
122 alloc_unexec_pre (void)
124 malloc_state_ptr
= malloc_get_state ();
127 alloc_unexec_post (void)
129 free (malloc_state_ptr
);
132 /* Restore the dumped malloc state. Because malloc can be invoked
133 even before main (e.g. by the dynamic linker), the dumped malloc
134 state must be restored as early as possible using this special hook. */
136 malloc_initialize_hook (void)
138 static bool malloc_using_checking
;
143 malloc_using_checking
= getenv ("MALLOC_CHECK_") != NULL
;
147 if (!malloc_using_checking
)
149 /* Work around a bug in glibc's malloc. MALLOC_CHECK_ must be
150 ignored if the heap to be restored was constructed without
151 malloc checking. Can't use unsetenv, since that calls malloc. */
155 if (strncmp (*p
, "MALLOC_CHECK_=", 14) == 0)
165 malloc_set_state (malloc_state_ptr
);
166 # ifndef XMALLOC_OVERRUN_CHECK
167 alloc_unexec_post ();
172 # ifndef __MALLOC_HOOK_VOLATILE
173 # define __MALLOC_HOOK_VOLATILE
175 voidfuncptr __MALLOC_HOOK_VOLATILE __malloc_initialize_hook
176 = malloc_initialize_hook
;
180 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
181 to a struct Lisp_String. */
183 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
184 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
185 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
187 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
188 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
189 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
191 /* Default value of gc_cons_threshold (see below). */
193 #define GC_DEFAULT_THRESHOLD (100000 * word_size)
195 /* Global variables. */
196 struct emacs_globals globals
;
198 /* Number of bytes of consing done since the last gc. */
200 EMACS_INT consing_since_gc
;
202 /* Similar minimum, computed from Vgc_cons_percentage. */
204 EMACS_INT gc_relative_threshold
;
206 /* Minimum number of bytes of consing since GC before next GC,
207 when memory is full. */
209 EMACS_INT memory_full_cons_threshold
;
211 /* True during GC. */
215 /* True means abort if try to GC.
216 This is for code which is written on the assumption that
217 no GC will happen, so as to verify that assumption. */
221 /* Number of live and free conses etc. */
223 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_buffers
;
224 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
225 static EMACS_INT total_free_floats
, total_floats
;
227 /* Points to memory space allocated as "spare", to be freed if we run
228 out of memory. We keep one large block, four cons-blocks, and
229 two string blocks. */
231 static char *spare_memory
[7];
233 /* Amount of spare memory to keep in large reserve block, or to see
234 whether this much is available when malloc fails on a larger request. */
236 #define SPARE_MEMORY (1 << 14)
238 /* Initialize it to a nonzero value to force it into data space
239 (rather than bss space). That way unexec will remap it into text
240 space (pure), on some systems. We have not implemented the
241 remapping on more recent systems because this is less important
242 nowadays than in the days of small memories and timesharing. */
244 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
245 #define PUREBEG (char *) pure
247 /* Pointer to the pure area, and its size. */
249 static char *purebeg
;
250 static ptrdiff_t pure_size
;
252 /* Number of bytes of pure storage used before pure storage overflowed.
253 If this is non-zero, this implies that an overflow occurred. */
255 static ptrdiff_t pure_bytes_used_before_overflow
;
257 /* Index in pure at which next pure Lisp object will be allocated.. */
259 static ptrdiff_t pure_bytes_used_lisp
;
261 /* Number of bytes allocated for non-Lisp objects in pure storage. */
263 static ptrdiff_t pure_bytes_used_non_lisp
;
265 /* If nonzero, this is a warning delivered by malloc and not yet
268 const char *pending_malloc_warning
;
270 #if 0 /* Normally, pointer sanity only on request... */
271 #ifdef ENABLE_CHECKING
272 #define SUSPICIOUS_OBJECT_CHECKING 1
276 /* ... but unconditionally use SUSPICIOUS_OBJECT_CHECKING while the GC
277 bug is unresolved. */
278 #define SUSPICIOUS_OBJECT_CHECKING 1
280 #ifdef SUSPICIOUS_OBJECT_CHECKING
281 struct suspicious_free_record
283 void *suspicious_object
;
284 void *backtrace
[128];
286 static void *suspicious_objects
[32];
287 static int suspicious_object_index
;
288 struct suspicious_free_record suspicious_free_history
[64] EXTERNALLY_VISIBLE
;
289 static int suspicious_free_history_index
;
290 /* Find the first currently-monitored suspicious pointer in range
291 [begin,end) or NULL if no such pointer exists. */
292 static void *find_suspicious_object_in_range (void *begin
, void *end
);
293 static void detect_suspicious_free (void *ptr
);
295 # define find_suspicious_object_in_range(begin, end) NULL
296 # define detect_suspicious_free(ptr) (void)
299 /* Maximum amount of C stack to save when a GC happens. */
301 #ifndef MAX_SAVE_STACK
302 #define MAX_SAVE_STACK 16000
305 /* Buffer in which we save a copy of the C stack at each GC. */
307 #if MAX_SAVE_STACK > 0
308 static char *stack_copy
;
309 static ptrdiff_t stack_copy_size
;
311 /* Copy to DEST a block of memory from SRC of size SIZE bytes,
312 avoiding any address sanitization. */
314 static void * ATTRIBUTE_NO_SANITIZE_ADDRESS
315 no_sanitize_memcpy (void *dest
, void const *src
, size_t size
)
317 if (! ADDRESS_SANITIZER
)
318 return memcpy (dest
, src
, size
);
324 for (i
= 0; i
< size
; i
++)
330 #endif /* MAX_SAVE_STACK > 0 */
332 static void mark_terminals (void);
333 static void gc_sweep (void);
334 static Lisp_Object
make_pure_vector (ptrdiff_t);
335 static void mark_buffer (struct buffer
*);
337 #if !defined REL_ALLOC || defined SYSTEM_MALLOC || defined HYBRID_MALLOC
338 static void refill_memory_reserve (void);
340 static void compact_small_strings (void);
341 static void free_large_strings (void);
342 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
344 /* When scanning the C stack for live Lisp objects, Emacs keeps track of
345 what memory allocated via lisp_malloc and lisp_align_malloc is intended
346 for what purpose. This enumeration specifies the type of memory. */
357 /* Since all non-bool pseudovectors are small enough to be
358 allocated from vector blocks, this memory type denotes
359 large regular vectors and large bool pseudovectors. */
361 /* Special type to denote vector blocks. */
362 MEM_TYPE_VECTOR_BLOCK
,
363 /* Special type to denote reserved memory. */
367 /* A unique object in pure space used to make some Lisp objects
368 on free lists recognizable in O(1). */
370 static Lisp_Object Vdead
;
371 #define DEADP(x) EQ (x, Vdead)
373 #ifdef GC_MALLOC_CHECK
375 enum mem_type allocated_mem_type
;
377 #endif /* GC_MALLOC_CHECK */
379 /* A node in the red-black tree describing allocated memory containing
380 Lisp data. Each such block is recorded with its start and end
381 address when it is allocated, and removed from the tree when it
384 A red-black tree is a balanced binary tree with the following
387 1. Every node is either red or black.
388 2. Every leaf is black.
389 3. If a node is red, then both of its children are black.
390 4. Every simple path from a node to a descendant leaf contains
391 the same number of black nodes.
392 5. The root is always black.
394 When nodes are inserted into the tree, or deleted from the tree,
395 the tree is "fixed" so that these properties are always true.
397 A red-black tree with N internal nodes has height at most 2
398 log(N+1). Searches, insertions and deletions are done in O(log N).
399 Please see a text book about data structures for a detailed
400 description of red-black trees. Any book worth its salt should
405 /* Children of this node. These pointers are never NULL. When there
406 is no child, the value is MEM_NIL, which points to a dummy node. */
407 struct mem_node
*left
, *right
;
409 /* The parent of this node. In the root node, this is NULL. */
410 struct mem_node
*parent
;
412 /* Start and end of allocated region. */
416 enum {MEM_BLACK
, MEM_RED
} color
;
422 /* Base address of stack. Set in main. */
424 Lisp_Object
*stack_base
;
426 /* Root of the tree describing allocated Lisp memory. */
428 static struct mem_node
*mem_root
;
430 /* Lowest and highest known address in the heap. */
432 static void *min_heap_address
, *max_heap_address
;
434 /* Sentinel node of the tree. */
436 static struct mem_node mem_z
;
437 #define MEM_NIL &mem_z
439 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
440 static void mem_insert_fixup (struct mem_node
*);
441 static void mem_rotate_left (struct mem_node
*);
442 static void mem_rotate_right (struct mem_node
*);
443 static void mem_delete (struct mem_node
*);
444 static void mem_delete_fixup (struct mem_node
*);
445 static struct mem_node
*mem_find (void *);
451 /* Addresses of staticpro'd variables. Initialize it to a nonzero
452 value; otherwise some compilers put it into BSS. */
454 enum { NSTATICS
= 2048 };
455 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
457 /* Index of next unused slot in staticvec. */
459 static int staticidx
;
461 static void *pure_alloc (size_t, int);
463 /* Return X rounded to the next multiple of Y. Arguments should not
464 have side effects, as they are evaluated more than once. Assume X
465 + Y - 1 does not overflow. Tune for Y being a power of 2. */
467 #define ROUNDUP(x, y) ((y) & ((y) - 1) \
468 ? ((x) + (y) - 1) - ((x) + (y) - 1) % (y) \
469 : ((x) + (y) - 1) & ~ ((y) - 1))
476 /* Return PTR rounded up to the next multiple of ALIGNMENT. */
479 ALIGN (void *ptr
, int alignment
)
481 return (void *) ROUNDUP ((uintptr_t) ptr
, alignment
);
484 /* Extract the pointer hidden within A, if A is not a symbol.
485 If A is a symbol, extract the hidden pointer's offset from lispsym,
486 converted to void *. */
488 #define macro_XPNTR_OR_SYMBOL_OFFSET(a) \
489 ((void *) (intptr_t) (USE_LSB_TAG ? XLI (a) - XTYPE (a) : XLI (a) & VALMASK))
491 /* Extract the pointer hidden within A. */
493 #define macro_XPNTR(a) \
494 ((void *) ((intptr_t) XPNTR_OR_SYMBOL_OFFSET (a) \
495 + (SYMBOLP (a) ? (char *) lispsym : NULL)))
497 /* For pointer access, define XPNTR and XPNTR_OR_SYMBOL_OFFSET as
498 functions, as functions are cleaner and can be used in debuggers.
499 Also, define them as macros if being compiled with GCC without
500 optimization, for performance in that case. The macro_* names are
501 private to this section of code. */
503 static ATTRIBUTE_UNUSED
void *
504 XPNTR_OR_SYMBOL_OFFSET (Lisp_Object a
)
506 return macro_XPNTR_OR_SYMBOL_OFFSET (a
);
508 static ATTRIBUTE_UNUSED
void *
509 XPNTR (Lisp_Object a
)
511 return macro_XPNTR (a
);
514 #if DEFINE_KEY_OPS_AS_MACROS
515 # define XPNTR_OR_SYMBOL_OFFSET(a) macro_XPNTR_OR_SYMBOL_OFFSET (a)
516 # define XPNTR(a) macro_XPNTR (a)
520 XFLOAT_INIT (Lisp_Object f
, double n
)
522 XFLOAT (f
)->u
.data
= n
;
525 #ifdef DOUG_LEA_MALLOC
527 pointers_fit_in_lispobj_p (void)
529 return (UINTPTR_MAX
<= VAL_MAX
) || USE_LSB_TAG
;
533 mmap_lisp_allowed_p (void)
535 /* If we can't store all memory addresses in our lisp objects, it's
536 risky to let the heap use mmap and give us addresses from all
537 over our address space. We also can't use mmap for lisp objects
538 if we might dump: unexec doesn't preserve the contents of mmapped
540 return pointers_fit_in_lispobj_p () && !might_dump
;
544 /* Head of a circularly-linked list of extant finalizers. */
545 static struct Lisp_Finalizer finalizers
;
547 /* Head of a circularly-linked list of finalizers that must be invoked
548 because we deemed them unreachable. This list must be global, and
549 not a local inside garbage_collect_1, in case we GC again while
550 running finalizers. */
551 static struct Lisp_Finalizer doomed_finalizers
;
554 /************************************************************************
556 ************************************************************************/
558 /* Function malloc calls this if it finds we are near exhausting storage. */
561 malloc_warning (const char *str
)
563 pending_malloc_warning
= str
;
567 /* Display an already-pending malloc warning. */
570 display_malloc_warning (void)
572 call3 (intern ("display-warning"),
574 build_string (pending_malloc_warning
),
575 intern ("emergency"));
576 pending_malloc_warning
= 0;
579 /* Called if we can't allocate relocatable space for a buffer. */
582 buffer_memory_full (ptrdiff_t nbytes
)
584 /* If buffers use the relocating allocator, no need to free
585 spare_memory, because we may have plenty of malloc space left
586 that we could get, and if we don't, the malloc that fails will
587 itself cause spare_memory to be freed. If buffers don't use the
588 relocating allocator, treat this like any other failing
592 memory_full (nbytes
);
594 /* This used to call error, but if we've run out of memory, we could
595 get infinite recursion trying to build the string. */
596 xsignal (Qnil
, Vmemory_signal_data
);
600 /* A common multiple of the positive integers A and B. Ideally this
601 would be the least common multiple, but there's no way to do that
602 as a constant expression in C, so do the best that we can easily do. */
603 #define COMMON_MULTIPLE(a, b) \
604 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
606 #ifndef XMALLOC_OVERRUN_CHECK
607 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
610 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
613 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
614 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
615 block size in little-endian order. The trailer consists of
616 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
618 The header is used to detect whether this block has been allocated
619 through these functions, as some low-level libc functions may
620 bypass the malloc hooks. */
622 #define XMALLOC_OVERRUN_CHECK_SIZE 16
623 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
624 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
626 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
627 hold a size_t value and (2) the header size is a multiple of the
628 alignment that Emacs needs for C types and for USE_LSB_TAG. */
629 #define XMALLOC_BASE_ALIGNMENT alignof (max_align_t)
631 #define XMALLOC_HEADER_ALIGNMENT \
632 COMMON_MULTIPLE (GCALIGNMENT, XMALLOC_BASE_ALIGNMENT)
633 #define XMALLOC_OVERRUN_SIZE_SIZE \
634 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
635 + XMALLOC_HEADER_ALIGNMENT - 1) \
636 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
637 - XMALLOC_OVERRUN_CHECK_SIZE)
639 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
640 { '\x9a', '\x9b', '\xae', '\xaf',
641 '\xbf', '\xbe', '\xce', '\xcf',
642 '\xea', '\xeb', '\xec', '\xed',
643 '\xdf', '\xde', '\x9c', '\x9d' };
645 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
646 { '\xaa', '\xab', '\xac', '\xad',
647 '\xba', '\xbb', '\xbc', '\xbd',
648 '\xca', '\xcb', '\xcc', '\xcd',
649 '\xda', '\xdb', '\xdc', '\xdd' };
651 /* Insert and extract the block size in the header. */
654 xmalloc_put_size (unsigned char *ptr
, size_t size
)
657 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
659 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
665 xmalloc_get_size (unsigned char *ptr
)
669 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
670 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
679 /* Like malloc, but wraps allocated block with header and trailer. */
682 overrun_check_malloc (size_t size
)
684 register unsigned char *val
;
685 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
688 val
= malloc (size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
691 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
692 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
693 xmalloc_put_size (val
, size
);
694 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
695 XMALLOC_OVERRUN_CHECK_SIZE
);
701 /* Like realloc, but checks old block for overrun, and wraps new block
702 with header and trailer. */
705 overrun_check_realloc (void *block
, size_t size
)
707 register unsigned char *val
= (unsigned char *) block
;
708 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
712 && memcmp (xmalloc_overrun_check_header
,
713 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
714 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
716 size_t osize
= xmalloc_get_size (val
);
717 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
718 XMALLOC_OVERRUN_CHECK_SIZE
))
720 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
721 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
722 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
725 val
= realloc (val
, size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
729 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
730 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
731 xmalloc_put_size (val
, size
);
732 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
733 XMALLOC_OVERRUN_CHECK_SIZE
);
738 /* Like free, but checks block for overrun. */
741 overrun_check_free (void *block
)
743 unsigned char *val
= (unsigned char *) block
;
746 && memcmp (xmalloc_overrun_check_header
,
747 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
748 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
750 size_t osize
= xmalloc_get_size (val
);
751 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
752 XMALLOC_OVERRUN_CHECK_SIZE
))
754 #ifdef XMALLOC_CLEAR_FREE_MEMORY
755 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
756 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
758 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
759 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
760 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
770 #define malloc overrun_check_malloc
771 #define realloc overrun_check_realloc
772 #define free overrun_check_free
775 /* If compiled with XMALLOC_BLOCK_INPUT_CHECK, define a symbol
776 BLOCK_INPUT_IN_MEMORY_ALLOCATORS that is visible to the debugger.
777 If that variable is set, block input while in one of Emacs's memory
778 allocation functions. There should be no need for this debugging
779 option, since signal handlers do not allocate memory, but Emacs
780 formerly allocated memory in signal handlers and this compile-time
781 option remains as a way to help debug the issue should it rear its
783 #ifdef XMALLOC_BLOCK_INPUT_CHECK
784 bool block_input_in_memory_allocators EXTERNALLY_VISIBLE
;
786 malloc_block_input (void)
788 if (block_input_in_memory_allocators
)
792 malloc_unblock_input (void)
794 if (block_input_in_memory_allocators
)
797 # define MALLOC_BLOCK_INPUT malloc_block_input ()
798 # define MALLOC_UNBLOCK_INPUT malloc_unblock_input ()
800 # define MALLOC_BLOCK_INPUT ((void) 0)
801 # define MALLOC_UNBLOCK_INPUT ((void) 0)
804 #define MALLOC_PROBE(size) \
806 if (profiler_memory_running) \
807 malloc_probe (size); \
810 static void *lmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
811 static void *lrealloc (void *, size_t);
813 /* Like malloc but check for no memory and block interrupt input. */
816 xmalloc (size_t size
)
821 val
= lmalloc (size
);
822 MALLOC_UNBLOCK_INPUT
;
830 /* Like the above, but zeroes out the memory just allocated. */
833 xzalloc (size_t size
)
838 val
= lmalloc (size
);
839 MALLOC_UNBLOCK_INPUT
;
843 memset (val
, 0, size
);
848 /* Like realloc but check for no memory and block interrupt input.. */
851 xrealloc (void *block
, size_t size
)
856 /* We must call malloc explicitly when BLOCK is 0, since some
857 reallocs don't do this. */
859 val
= lmalloc (size
);
861 val
= lrealloc (block
, size
);
862 MALLOC_UNBLOCK_INPUT
;
871 /* Like free but block interrupt input. */
880 MALLOC_UNBLOCK_INPUT
;
881 /* We don't call refill_memory_reserve here
882 because in practice the call in r_alloc_free seems to suffice. */
886 /* Other parts of Emacs pass large int values to allocator functions
887 expecting ptrdiff_t. This is portable in practice, but check it to
889 verify (INT_MAX
<= PTRDIFF_MAX
);
892 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
893 Signal an error on memory exhaustion, and block interrupt input. */
896 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
898 eassert (0 <= nitems
&& 0 < item_size
);
900 if (INT_MULTIPLY_WRAPV (nitems
, item_size
, &nbytes
) || SIZE_MAX
< nbytes
)
901 memory_full (SIZE_MAX
);
902 return xmalloc (nbytes
);
906 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
907 Signal an error on memory exhaustion, and block interrupt input. */
910 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
912 eassert (0 <= nitems
&& 0 < item_size
);
914 if (INT_MULTIPLY_WRAPV (nitems
, item_size
, &nbytes
) || SIZE_MAX
< nbytes
)
915 memory_full (SIZE_MAX
);
916 return xrealloc (pa
, nbytes
);
920 /* Grow PA, which points to an array of *NITEMS items, and return the
921 location of the reallocated array, updating *NITEMS to reflect its
922 new size. The new array will contain at least NITEMS_INCR_MIN more
923 items, but will not contain more than NITEMS_MAX items total.
924 ITEM_SIZE is the size of each item, in bytes.
926 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
927 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
930 If PA is null, then allocate a new array instead of reallocating
933 Block interrupt input as needed. If memory exhaustion occurs, set
934 *NITEMS to zero if PA is null, and signal an error (i.e., do not
937 Thus, to grow an array A without saving its old contents, do
938 { xfree (A); A = NULL; A = xpalloc (NULL, &AITEMS, ...); }.
939 The A = NULL avoids a dangling pointer if xpalloc exhausts memory
940 and signals an error, and later this code is reexecuted and
941 attempts to free A. */
944 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
945 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
947 ptrdiff_t n0
= *nitems
;
948 eassume (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n0
&& -1 <= nitems_max
);
950 /* The approximate size to use for initial small allocation
951 requests. This is the largest "small" request for the GNU C
953 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
955 /* If the array is tiny, grow it to about (but no greater than)
956 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%.
957 Adjust the growth according to three constraints: NITEMS_INCR_MIN,
958 NITEMS_MAX, and what the C language can represent safely. */
961 if (INT_ADD_WRAPV (n0
, n0
>> 1, &n
))
963 if (0 <= nitems_max
&& nitems_max
< n
)
966 ptrdiff_t adjusted_nbytes
967 = ((INT_MULTIPLY_WRAPV (n
, item_size
, &nbytes
) || SIZE_MAX
< nbytes
)
968 ? min (PTRDIFF_MAX
, SIZE_MAX
)
969 : nbytes
< DEFAULT_MXFAST
? DEFAULT_MXFAST
: 0);
972 n
= adjusted_nbytes
/ item_size
;
973 nbytes
= adjusted_nbytes
- adjusted_nbytes
% item_size
;
978 if (n
- n0
< nitems_incr_min
979 && (INT_ADD_WRAPV (n0
, nitems_incr_min
, &n
)
980 || (0 <= nitems_max
&& nitems_max
< n
)
981 || INT_MULTIPLY_WRAPV (n
, item_size
, &nbytes
)))
982 memory_full (SIZE_MAX
);
983 pa
= xrealloc (pa
, nbytes
);
989 /* Like strdup, but uses xmalloc. */
992 xstrdup (const char *s
)
996 size
= strlen (s
) + 1;
997 return memcpy (xmalloc (size
), s
, size
);
1000 /* Like above, but duplicates Lisp string to C string. */
1003 xlispstrdup (Lisp_Object string
)
1005 ptrdiff_t size
= SBYTES (string
) + 1;
1006 return memcpy (xmalloc (size
), SSDATA (string
), size
);
1009 /* Assign to *PTR a copy of STRING, freeing any storage *PTR formerly
1010 pointed to. If STRING is null, assign it without copying anything.
1011 Allocate before freeing, to avoid a dangling pointer if allocation
1015 dupstring (char **ptr
, char const *string
)
1018 *ptr
= string
? xstrdup (string
) : 0;
1023 /* Like putenv, but (1) use the equivalent of xmalloc and (2) the
1024 argument is a const pointer. */
1027 xputenv (char const *string
)
1029 if (putenv ((char *) string
) != 0)
1033 /* Return a newly allocated memory block of SIZE bytes, remembering
1034 to free it when unwinding. */
1036 record_xmalloc (size_t size
)
1038 void *p
= xmalloc (size
);
1039 record_unwind_protect_ptr (xfree
, p
);
1044 /* Like malloc but used for allocating Lisp data. NBYTES is the
1045 number of bytes to allocate, TYPE describes the intended use of the
1046 allocated memory block (for strings, for conses, ...). */
1049 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
1053 lisp_malloc (size_t nbytes
, enum mem_type type
)
1059 #ifdef GC_MALLOC_CHECK
1060 allocated_mem_type
= type
;
1063 val
= lmalloc (nbytes
);
1066 /* If the memory just allocated cannot be addressed thru a Lisp
1067 object's pointer, and it needs to be,
1068 that's equivalent to running out of memory. */
1069 if (val
&& type
!= MEM_TYPE_NON_LISP
)
1072 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
1073 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
1075 lisp_malloc_loser
= val
;
1082 #ifndef GC_MALLOC_CHECK
1083 if (val
&& type
!= MEM_TYPE_NON_LISP
)
1084 mem_insert (val
, (char *) val
+ nbytes
, type
);
1087 MALLOC_UNBLOCK_INPUT
;
1089 memory_full (nbytes
);
1090 MALLOC_PROBE (nbytes
);
1094 /* Free BLOCK. This must be called to free memory allocated with a
1095 call to lisp_malloc. */
1098 lisp_free (void *block
)
1102 #ifndef GC_MALLOC_CHECK
1103 mem_delete (mem_find (block
));
1105 MALLOC_UNBLOCK_INPUT
;
1108 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
1110 /* The entry point is lisp_align_malloc which returns blocks of at most
1111 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
1113 /* Use aligned_alloc if it or a simple substitute is available.
1114 Address sanitization breaks aligned allocation, as of gcc 4.8.2 and
1115 clang 3.3 anyway. Aligned allocation is incompatible with
1116 unexmacosx.c, so don't use it on Darwin. */
1118 #if ! ADDRESS_SANITIZER && !defined DARWIN_OS
1119 # if !defined SYSTEM_MALLOC && !defined DOUG_LEA_MALLOC && !defined HYBRID_MALLOC
1120 # define USE_ALIGNED_ALLOC 1
1121 # ifndef HAVE_ALIGNED_ALLOC
1122 /* Defined in gmalloc.c. */
1123 void *aligned_alloc (size_t, size_t);
1125 # elif defined HYBRID_MALLOC
1126 # if defined HAVE_ALIGNED_ALLOC || defined HAVE_POSIX_MEMALIGN
1127 # define USE_ALIGNED_ALLOC 1
1128 # define aligned_alloc hybrid_aligned_alloc
1129 /* Defined in gmalloc.c. */
1130 void *aligned_alloc (size_t, size_t);
1132 # elif defined HAVE_ALIGNED_ALLOC
1133 # define USE_ALIGNED_ALLOC 1
1134 # elif defined HAVE_POSIX_MEMALIGN
1135 # define USE_ALIGNED_ALLOC 1
1137 aligned_alloc (size_t alignment
, size_t size
)
1140 return posix_memalign (&p
, alignment
, size
) == 0 ? p
: 0;
1145 /* BLOCK_ALIGN has to be a power of 2. */
1146 #define BLOCK_ALIGN (1 << 10)
1148 /* Padding to leave at the end of a malloc'd block. This is to give
1149 malloc a chance to minimize the amount of memory wasted to alignment.
1150 It should be tuned to the particular malloc library used.
1151 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
1152 aligned_alloc on the other hand would ideally prefer a value of 4
1153 because otherwise, there's 1020 bytes wasted between each ablocks.
1154 In Emacs, testing shows that those 1020 can most of the time be
1155 efficiently used by malloc to place other objects, so a value of 0 can
1156 still preferable unless you have a lot of aligned blocks and virtually
1158 #define BLOCK_PADDING 0
1159 #define BLOCK_BYTES \
1160 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
1162 /* Internal data structures and constants. */
1164 #define ABLOCKS_SIZE 16
1166 /* An aligned block of memory. */
1171 char payload
[BLOCK_BYTES
];
1172 struct ablock
*next_free
;
1174 /* `abase' is the aligned base of the ablocks. */
1175 /* It is overloaded to hold the virtual `busy' field that counts
1176 the number of used ablock in the parent ablocks.
1177 The first ablock has the `busy' field, the others have the `abase'
1178 field. To tell the difference, we assume that pointers will have
1179 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1180 is used to tell whether the real base of the parent ablocks is `abase'
1181 (if not, the word before the first ablock holds a pointer to the
1183 struct ablocks
*abase
;
1184 /* The padding of all but the last ablock is unused. The padding of
1185 the last ablock in an ablocks is not allocated. */
1187 char padding
[BLOCK_PADDING
];
1191 /* A bunch of consecutive aligned blocks. */
1194 struct ablock blocks
[ABLOCKS_SIZE
];
1197 /* Size of the block requested from malloc or aligned_alloc. */
1198 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1200 #define ABLOCK_ABASE(block) \
1201 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1202 ? (struct ablocks *)(block) \
1205 /* Virtual `busy' field. */
1206 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1208 /* Pointer to the (not necessarily aligned) malloc block. */
1209 #ifdef USE_ALIGNED_ALLOC
1210 #define ABLOCKS_BASE(abase) (abase)
1212 #define ABLOCKS_BASE(abase) \
1213 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void **)abase)[-1])
1216 /* The list of free ablock. */
1217 static struct ablock
*free_ablock
;
1219 /* Allocate an aligned block of nbytes.
1220 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1221 smaller or equal to BLOCK_BYTES. */
1223 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1226 struct ablocks
*abase
;
1228 eassert (nbytes
<= BLOCK_BYTES
);
1232 #ifdef GC_MALLOC_CHECK
1233 allocated_mem_type
= type
;
1239 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1241 #ifdef DOUG_LEA_MALLOC
1242 if (!mmap_lisp_allowed_p ())
1243 mallopt (M_MMAP_MAX
, 0);
1246 #ifdef USE_ALIGNED_ALLOC
1247 abase
= base
= aligned_alloc (BLOCK_ALIGN
, ABLOCKS_BYTES
);
1249 base
= malloc (ABLOCKS_BYTES
);
1250 abase
= ALIGN (base
, BLOCK_ALIGN
);
1255 MALLOC_UNBLOCK_INPUT
;
1256 memory_full (ABLOCKS_BYTES
);
1259 aligned
= (base
== abase
);
1261 ((void **) abase
)[-1] = base
;
1263 #ifdef DOUG_LEA_MALLOC
1264 if (!mmap_lisp_allowed_p ())
1265 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1269 /* If the memory just allocated cannot be addressed thru a Lisp
1270 object's pointer, and it needs to be, that's equivalent to
1271 running out of memory. */
1272 if (type
!= MEM_TYPE_NON_LISP
)
1275 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1276 XSETCONS (tem
, end
);
1277 if ((char *) XCONS (tem
) != end
)
1279 lisp_malloc_loser
= base
;
1281 MALLOC_UNBLOCK_INPUT
;
1282 memory_full (SIZE_MAX
);
1287 /* Initialize the blocks and put them on the free list.
1288 If `base' was not properly aligned, we can't use the last block. */
1289 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1291 abase
->blocks
[i
].abase
= abase
;
1292 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1293 free_ablock
= &abase
->blocks
[i
];
1295 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1297 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1298 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1299 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1300 eassert (ABLOCKS_BASE (abase
) == base
);
1301 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1304 abase
= ABLOCK_ABASE (free_ablock
);
1305 ABLOCKS_BUSY (abase
)
1306 = (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1308 free_ablock
= free_ablock
->x
.next_free
;
1310 #ifndef GC_MALLOC_CHECK
1311 if (type
!= MEM_TYPE_NON_LISP
)
1312 mem_insert (val
, (char *) val
+ nbytes
, type
);
1315 MALLOC_UNBLOCK_INPUT
;
1317 MALLOC_PROBE (nbytes
);
1319 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1324 lisp_align_free (void *block
)
1326 struct ablock
*ablock
= block
;
1327 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1330 #ifndef GC_MALLOC_CHECK
1331 mem_delete (mem_find (block
));
1333 /* Put on free list. */
1334 ablock
->x
.next_free
= free_ablock
;
1335 free_ablock
= ablock
;
1336 /* Update busy count. */
1337 ABLOCKS_BUSY (abase
)
1338 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1340 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1341 { /* All the blocks are free. */
1342 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1343 struct ablock
**tem
= &free_ablock
;
1344 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1348 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1351 *tem
= (*tem
)->x
.next_free
;
1354 tem
= &(*tem
)->x
.next_free
;
1356 eassert ((aligned
& 1) == aligned
);
1357 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1358 #ifdef USE_POSIX_MEMALIGN
1359 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1361 free (ABLOCKS_BASE (abase
));
1363 MALLOC_UNBLOCK_INPUT
;
1366 #if !defined __GNUC__ && !defined __alignof__
1367 # define __alignof__(type) alignof (type)
1370 /* True if malloc returns a multiple of GCALIGNMENT. In practice this
1371 holds if __alignof__ (max_align_t) is a multiple. Use __alignof__
1372 if available, as otherwise this check would fail with GCC x86.
1373 This is a macro, not an enum constant, for portability to HP-UX
1374 10.20 cc and AIX 3.2.5 xlc. */
1375 #define MALLOC_IS_GC_ALIGNED (__alignof__ (max_align_t) % GCALIGNMENT == 0)
1377 /* True if P is suitably aligned for SIZE, where Lisp alignment may be
1378 needed if SIZE is Lisp-aligned. */
1381 laligned (void *p
, size_t size
)
1383 return (MALLOC_IS_GC_ALIGNED
|| (intptr_t) p
% GCALIGNMENT
== 0
1384 || size
% GCALIGNMENT
!= 0);
1387 /* Like malloc and realloc except that if SIZE is Lisp-aligned, make
1388 sure the result is too, if necessary by reallocating (typically
1389 with larger and larger sizes) until the allocator returns a
1390 Lisp-aligned pointer. Code that needs to allocate C heap memory
1391 for a Lisp object should use one of these functions to obtain a
1392 pointer P; that way, if T is an enum Lisp_Type value and L ==
1393 make_lisp_ptr (P, T), then XPNTR (L) == P and XTYPE (L) == T.
1395 On typical modern platforms these functions' loops do not iterate.
1396 On now-rare (and perhaps nonexistent) platforms, the loops in
1397 theory could repeat forever. If an infinite loop is possible on a
1398 platform, a build would surely loop and the builder can then send
1399 us a bug report. Adding a counter to try to detect any such loop
1400 would complicate the code (and possibly introduce bugs, in code
1401 that's never really exercised) for little benefit. */
1404 lmalloc (size_t size
)
1406 #if USE_ALIGNED_ALLOC
1407 if (! MALLOC_IS_GC_ALIGNED
)
1408 return aligned_alloc (GCALIGNMENT
, size
);
1415 if (laligned (p
, size
))
1418 size_t bigger
= size
+ GCALIGNMENT
;
1423 eassert ((intptr_t) p
% GCALIGNMENT
== 0);
1428 lrealloc (void *p
, size_t size
)
1432 p
= realloc (p
, size
);
1433 if (laligned (p
, size
))
1435 size_t bigger
= size
+ GCALIGNMENT
;
1440 eassert ((intptr_t) p
% GCALIGNMENT
== 0);
1445 /***********************************************************************
1447 ***********************************************************************/
1449 /* Number of intervals allocated in an interval_block structure.
1450 The 1020 is 1024 minus malloc overhead. */
1452 #define INTERVAL_BLOCK_SIZE \
1453 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1455 /* Intervals are allocated in chunks in the form of an interval_block
1458 struct interval_block
1460 /* Place `intervals' first, to preserve alignment. */
1461 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1462 struct interval_block
*next
;
1465 /* Current interval block. Its `next' pointer points to older
1468 static struct interval_block
*interval_block
;
1470 /* Index in interval_block above of the next unused interval
1473 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1475 /* Number of free and live intervals. */
1477 static EMACS_INT total_free_intervals
, total_intervals
;
1479 /* List of free intervals. */
1481 static INTERVAL interval_free_list
;
1483 /* Return a new interval. */
1486 make_interval (void)
1492 if (interval_free_list
)
1494 val
= interval_free_list
;
1495 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1499 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1501 struct interval_block
*newi
1502 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1504 newi
->next
= interval_block
;
1505 interval_block
= newi
;
1506 interval_block_index
= 0;
1507 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1509 val
= &interval_block
->intervals
[interval_block_index
++];
1512 MALLOC_UNBLOCK_INPUT
;
1514 consing_since_gc
+= sizeof (struct interval
);
1516 total_free_intervals
--;
1517 RESET_INTERVAL (val
);
1523 /* Mark Lisp objects in interval I. */
1526 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1528 /* Intervals should never be shared. So, if extra internal checking is
1529 enabled, GC aborts if it seems to have visited an interval twice. */
1530 eassert (!i
->gcmarkbit
);
1532 mark_object (i
->plist
);
1535 /* Mark the interval tree rooted in I. */
1537 #define MARK_INTERVAL_TREE(i) \
1539 if (i && !i->gcmarkbit) \
1540 traverse_intervals_noorder (i, mark_interval, Qnil); \
1543 /***********************************************************************
1545 ***********************************************************************/
1547 /* Lisp_Strings are allocated in string_block structures. When a new
1548 string_block is allocated, all the Lisp_Strings it contains are
1549 added to a free-list string_free_list. When a new Lisp_String is
1550 needed, it is taken from that list. During the sweep phase of GC,
1551 string_blocks that are entirely free are freed, except two which
1554 String data is allocated from sblock structures. Strings larger
1555 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1556 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1558 Sblocks consist internally of sdata structures, one for each
1559 Lisp_String. The sdata structure points to the Lisp_String it
1560 belongs to. The Lisp_String points back to the `u.data' member of
1561 its sdata structure.
1563 When a Lisp_String is freed during GC, it is put back on
1564 string_free_list, and its `data' member and its sdata's `string'
1565 pointer is set to null. The size of the string is recorded in the
1566 `n.nbytes' member of the sdata. So, sdata structures that are no
1567 longer used, can be easily recognized, and it's easy to compact the
1568 sblocks of small strings which we do in compact_small_strings. */
1570 /* Size in bytes of an sblock structure used for small strings. This
1571 is 8192 minus malloc overhead. */
1573 #define SBLOCK_SIZE 8188
1575 /* Strings larger than this are considered large strings. String data
1576 for large strings is allocated from individual sblocks. */
1578 #define LARGE_STRING_BYTES 1024
1580 /* The SDATA typedef is a struct or union describing string memory
1581 sub-allocated from an sblock. This is where the contents of Lisp
1582 strings are stored. */
1586 /* Back-pointer to the string this sdata belongs to. If null, this
1587 structure is free, and NBYTES (in this structure or in the union below)
1588 contains the string's byte size (the same value that STRING_BYTES
1589 would return if STRING were non-null). If non-null, STRING_BYTES
1590 (STRING) is the size of the data, and DATA contains the string's
1592 struct Lisp_String
*string
;
1594 #ifdef GC_CHECK_STRING_BYTES
1598 unsigned char data
[FLEXIBLE_ARRAY_MEMBER
];
1601 #ifdef GC_CHECK_STRING_BYTES
1603 typedef struct sdata sdata
;
1604 #define SDATA_NBYTES(S) (S)->nbytes
1605 #define SDATA_DATA(S) (S)->data
1611 struct Lisp_String
*string
;
1613 /* When STRING is nonnull, this union is actually of type 'struct sdata',
1614 which has a flexible array member. However, if implemented by
1615 giving this union a member of type 'struct sdata', the union
1616 could not be the last (flexible) member of 'struct sblock',
1617 because C99 prohibits a flexible array member from having a type
1618 that is itself a flexible array. So, comment this member out here,
1619 but remember that the option's there when using this union. */
1624 /* When STRING is null. */
1627 struct Lisp_String
*string
;
1632 #define SDATA_NBYTES(S) (S)->n.nbytes
1633 #define SDATA_DATA(S) ((struct sdata *) (S))->data
1635 #endif /* not GC_CHECK_STRING_BYTES */
1637 enum { SDATA_DATA_OFFSET
= offsetof (struct sdata
, data
) };
1639 /* Structure describing a block of memory which is sub-allocated to
1640 obtain string data memory for strings. Blocks for small strings
1641 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1642 as large as needed. */
1647 struct sblock
*next
;
1649 /* Pointer to the next free sdata block. This points past the end
1650 of the sblock if there isn't any space left in this block. */
1654 sdata data
[FLEXIBLE_ARRAY_MEMBER
];
1657 /* Number of Lisp strings in a string_block structure. The 1020 is
1658 1024 minus malloc overhead. */
1660 #define STRING_BLOCK_SIZE \
1661 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1663 /* Structure describing a block from which Lisp_String structures
1668 /* Place `strings' first, to preserve alignment. */
1669 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1670 struct string_block
*next
;
1673 /* Head and tail of the list of sblock structures holding Lisp string
1674 data. We always allocate from current_sblock. The NEXT pointers
1675 in the sblock structures go from oldest_sblock to current_sblock. */
1677 static struct sblock
*oldest_sblock
, *current_sblock
;
1679 /* List of sblocks for large strings. */
1681 static struct sblock
*large_sblocks
;
1683 /* List of string_block structures. */
1685 static struct string_block
*string_blocks
;
1687 /* Free-list of Lisp_Strings. */
1689 static struct Lisp_String
*string_free_list
;
1691 /* Number of live and free Lisp_Strings. */
1693 static EMACS_INT total_strings
, total_free_strings
;
1695 /* Number of bytes used by live strings. */
1697 static EMACS_INT total_string_bytes
;
1699 /* Given a pointer to a Lisp_String S which is on the free-list
1700 string_free_list, return a pointer to its successor in the
1703 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1705 /* Return a pointer to the sdata structure belonging to Lisp string S.
1706 S must be live, i.e. S->data must not be null. S->data is actually
1707 a pointer to the `u.data' member of its sdata structure; the
1708 structure starts at a constant offset in front of that. */
1710 #define SDATA_OF_STRING(S) ((sdata *) ((S)->data - SDATA_DATA_OFFSET))
1713 #ifdef GC_CHECK_STRING_OVERRUN
1715 /* We check for overrun in string data blocks by appending a small
1716 "cookie" after each allocated string data block, and check for the
1717 presence of this cookie during GC. */
1719 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1720 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1721 { '\xde', '\xad', '\xbe', '\xef' };
1724 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1727 /* Value is the size of an sdata structure large enough to hold NBYTES
1728 bytes of string data. The value returned includes a terminating
1729 NUL byte, the size of the sdata structure, and padding. */
1731 #ifdef GC_CHECK_STRING_BYTES
1733 #define SDATA_SIZE(NBYTES) \
1734 ((SDATA_DATA_OFFSET \
1736 + sizeof (ptrdiff_t) - 1) \
1737 & ~(sizeof (ptrdiff_t) - 1))
1739 #else /* not GC_CHECK_STRING_BYTES */
1741 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1742 less than the size of that member. The 'max' is not needed when
1743 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1744 alignment code reserves enough space. */
1746 #define SDATA_SIZE(NBYTES) \
1747 ((SDATA_DATA_OFFSET \
1748 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1750 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1752 + sizeof (ptrdiff_t) - 1) \
1753 & ~(sizeof (ptrdiff_t) - 1))
1755 #endif /* not GC_CHECK_STRING_BYTES */
1757 /* Extra bytes to allocate for each string. */
1759 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1761 /* Exact bound on the number of bytes in a string, not counting the
1762 terminating null. A string cannot contain more bytes than
1763 STRING_BYTES_BOUND, nor can it be so long that the size_t
1764 arithmetic in allocate_string_data would overflow while it is
1765 calculating a value to be passed to malloc. */
1766 static ptrdiff_t const STRING_BYTES_MAX
=
1767 min (STRING_BYTES_BOUND
,
1768 ((SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
1770 - offsetof (struct sblock
, data
)
1771 - SDATA_DATA_OFFSET
)
1772 & ~(sizeof (EMACS_INT
) - 1)));
1774 /* Initialize string allocation. Called from init_alloc_once. */
1779 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1780 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1784 #ifdef GC_CHECK_STRING_BYTES
1786 static int check_string_bytes_count
;
1788 /* Like STRING_BYTES, but with debugging check. Can be
1789 called during GC, so pay attention to the mark bit. */
1792 string_bytes (struct Lisp_String
*s
)
1795 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1797 if (!PURE_P (s
) && s
->data
&& nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1802 /* Check validity of Lisp strings' string_bytes member in B. */
1805 check_sblock (struct sblock
*b
)
1807 sdata
*from
, *end
, *from_end
;
1811 for (from
= b
->data
; from
< end
; from
= from_end
)
1813 /* Compute the next FROM here because copying below may
1814 overwrite data we need to compute it. */
1817 /* Check that the string size recorded in the string is the
1818 same as the one recorded in the sdata structure. */
1819 nbytes
= SDATA_SIZE (from
->string
? string_bytes (from
->string
)
1820 : SDATA_NBYTES (from
));
1821 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1826 /* Check validity of Lisp strings' string_bytes member. ALL_P
1827 means check all strings, otherwise check only most
1828 recently allocated strings. Used for hunting a bug. */
1831 check_string_bytes (bool all_p
)
1837 for (b
= large_sblocks
; b
; b
= b
->next
)
1839 struct Lisp_String
*s
= b
->data
[0].string
;
1844 for (b
= oldest_sblock
; b
; b
= b
->next
)
1847 else if (current_sblock
)
1848 check_sblock (current_sblock
);
1851 #else /* not GC_CHECK_STRING_BYTES */
1853 #define check_string_bytes(all) ((void) 0)
1855 #endif /* GC_CHECK_STRING_BYTES */
1857 #ifdef GC_CHECK_STRING_FREE_LIST
1859 /* Walk through the string free list looking for bogus next pointers.
1860 This may catch buffer overrun from a previous string. */
1863 check_string_free_list (void)
1865 struct Lisp_String
*s
;
1867 /* Pop a Lisp_String off the free-list. */
1868 s
= string_free_list
;
1871 if ((uintptr_t) s
< 1024)
1873 s
= NEXT_FREE_LISP_STRING (s
);
1877 #define check_string_free_list()
1880 /* Return a new Lisp_String. */
1882 static struct Lisp_String
*
1883 allocate_string (void)
1885 struct Lisp_String
*s
;
1889 /* If the free-list is empty, allocate a new string_block, and
1890 add all the Lisp_Strings in it to the free-list. */
1891 if (string_free_list
== NULL
)
1893 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1896 b
->next
= string_blocks
;
1899 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1902 /* Every string on a free list should have NULL data pointer. */
1904 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1905 string_free_list
= s
;
1908 total_free_strings
+= STRING_BLOCK_SIZE
;
1911 check_string_free_list ();
1913 /* Pop a Lisp_String off the free-list. */
1914 s
= string_free_list
;
1915 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1917 MALLOC_UNBLOCK_INPUT
;
1919 --total_free_strings
;
1922 consing_since_gc
+= sizeof *s
;
1924 #ifdef GC_CHECK_STRING_BYTES
1925 if (!noninteractive
)
1927 if (++check_string_bytes_count
== 200)
1929 check_string_bytes_count
= 0;
1930 check_string_bytes (1);
1933 check_string_bytes (0);
1935 #endif /* GC_CHECK_STRING_BYTES */
1941 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1942 plus a NUL byte at the end. Allocate an sdata structure for S, and
1943 set S->data to its `u.data' member. Store a NUL byte at the end of
1944 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1945 S->data if it was initially non-null. */
1948 allocate_string_data (struct Lisp_String
*s
,
1949 EMACS_INT nchars
, EMACS_INT nbytes
)
1951 sdata
*data
, *old_data
;
1953 ptrdiff_t needed
, old_nbytes
;
1955 if (STRING_BYTES_MAX
< nbytes
)
1958 /* Determine the number of bytes needed to store NBYTES bytes
1960 needed
= SDATA_SIZE (nbytes
);
1963 old_data
= SDATA_OF_STRING (s
);
1964 old_nbytes
= STRING_BYTES (s
);
1971 if (nbytes
> LARGE_STRING_BYTES
)
1973 size_t size
= offsetof (struct sblock
, data
) + needed
;
1975 #ifdef DOUG_LEA_MALLOC
1976 if (!mmap_lisp_allowed_p ())
1977 mallopt (M_MMAP_MAX
, 0);
1980 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
1982 #ifdef DOUG_LEA_MALLOC
1983 if (!mmap_lisp_allowed_p ())
1984 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1987 b
->next_free
= b
->data
;
1988 b
->data
[0].string
= NULL
;
1989 b
->next
= large_sblocks
;
1992 else if (current_sblock
== NULL
1993 || (((char *) current_sblock
+ SBLOCK_SIZE
1994 - (char *) current_sblock
->next_free
)
1995 < (needed
+ GC_STRING_EXTRA
)))
1997 /* Not enough room in the current sblock. */
1998 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
1999 b
->next_free
= b
->data
;
2000 b
->data
[0].string
= NULL
;
2004 current_sblock
->next
= b
;
2012 data
= b
->next_free
;
2013 b
->next_free
= (sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
2015 MALLOC_UNBLOCK_INPUT
;
2018 s
->data
= SDATA_DATA (data
);
2019 #ifdef GC_CHECK_STRING_BYTES
2020 SDATA_NBYTES (data
) = nbytes
;
2023 s
->size_byte
= nbytes
;
2024 s
->data
[nbytes
] = '\0';
2025 #ifdef GC_CHECK_STRING_OVERRUN
2026 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
2027 GC_STRING_OVERRUN_COOKIE_SIZE
);
2030 /* Note that Faset may call to this function when S has already data
2031 assigned. In this case, mark data as free by setting it's string
2032 back-pointer to null, and record the size of the data in it. */
2035 SDATA_NBYTES (old_data
) = old_nbytes
;
2036 old_data
->string
= NULL
;
2039 consing_since_gc
+= needed
;
2043 /* Sweep and compact strings. */
2045 NO_INLINE
/* For better stack traces */
2047 sweep_strings (void)
2049 struct string_block
*b
, *next
;
2050 struct string_block
*live_blocks
= NULL
;
2052 string_free_list
= NULL
;
2053 total_strings
= total_free_strings
= 0;
2054 total_string_bytes
= 0;
2056 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
2057 for (b
= string_blocks
; b
; b
= next
)
2060 struct Lisp_String
*free_list_before
= string_free_list
;
2064 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
2066 struct Lisp_String
*s
= b
->strings
+ i
;
2070 /* String was not on free-list before. */
2071 if (STRING_MARKED_P (s
))
2073 /* String is live; unmark it and its intervals. */
2076 /* Do not use string_(set|get)_intervals here. */
2077 s
->intervals
= balance_intervals (s
->intervals
);
2080 total_string_bytes
+= STRING_BYTES (s
);
2084 /* String is dead. Put it on the free-list. */
2085 sdata
*data
= SDATA_OF_STRING (s
);
2087 /* Save the size of S in its sdata so that we know
2088 how large that is. Reset the sdata's string
2089 back-pointer so that we know it's free. */
2090 #ifdef GC_CHECK_STRING_BYTES
2091 if (string_bytes (s
) != SDATA_NBYTES (data
))
2094 data
->n
.nbytes
= STRING_BYTES (s
);
2096 data
->string
= NULL
;
2098 /* Reset the strings's `data' member so that we
2102 /* Put the string on the free-list. */
2103 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2104 string_free_list
= s
;
2110 /* S was on the free-list before. Put it there again. */
2111 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2112 string_free_list
= s
;
2117 /* Free blocks that contain free Lisp_Strings only, except
2118 the first two of them. */
2119 if (nfree
== STRING_BLOCK_SIZE
2120 && total_free_strings
> STRING_BLOCK_SIZE
)
2123 string_free_list
= free_list_before
;
2127 total_free_strings
+= nfree
;
2128 b
->next
= live_blocks
;
2133 check_string_free_list ();
2135 string_blocks
= live_blocks
;
2136 free_large_strings ();
2137 compact_small_strings ();
2139 check_string_free_list ();
2143 /* Free dead large strings. */
2146 free_large_strings (void)
2148 struct sblock
*b
, *next
;
2149 struct sblock
*live_blocks
= NULL
;
2151 for (b
= large_sblocks
; b
; b
= next
)
2155 if (b
->data
[0].string
== NULL
)
2159 b
->next
= live_blocks
;
2164 large_sblocks
= live_blocks
;
2168 /* Compact data of small strings. Free sblocks that don't contain
2169 data of live strings after compaction. */
2172 compact_small_strings (void)
2174 struct sblock
*b
, *tb
, *next
;
2175 sdata
*from
, *to
, *end
, *tb_end
;
2176 sdata
*to_end
, *from_end
;
2178 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2179 to, and TB_END is the end of TB. */
2181 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2184 /* Step through the blocks from the oldest to the youngest. We
2185 expect that old blocks will stabilize over time, so that less
2186 copying will happen this way. */
2187 for (b
= oldest_sblock
; b
; b
= b
->next
)
2190 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2192 for (from
= b
->data
; from
< end
; from
= from_end
)
2194 /* Compute the next FROM here because copying below may
2195 overwrite data we need to compute it. */
2197 struct Lisp_String
*s
= from
->string
;
2199 #ifdef GC_CHECK_STRING_BYTES
2200 /* Check that the string size recorded in the string is the
2201 same as the one recorded in the sdata structure. */
2202 if (s
&& string_bytes (s
) != SDATA_NBYTES (from
))
2204 #endif /* GC_CHECK_STRING_BYTES */
2206 nbytes
= s
? STRING_BYTES (s
) : SDATA_NBYTES (from
);
2207 eassert (nbytes
<= LARGE_STRING_BYTES
);
2209 nbytes
= SDATA_SIZE (nbytes
);
2210 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2212 #ifdef GC_CHECK_STRING_OVERRUN
2213 if (memcmp (string_overrun_cookie
,
2214 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2215 GC_STRING_OVERRUN_COOKIE_SIZE
))
2219 /* Non-NULL S means it's alive. Copy its data. */
2222 /* If TB is full, proceed with the next sblock. */
2223 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2224 if (to_end
> tb_end
)
2228 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2230 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2233 /* Copy, and update the string's `data' pointer. */
2236 eassert (tb
!= b
|| to
< from
);
2237 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2238 to
->string
->data
= SDATA_DATA (to
);
2241 /* Advance past the sdata we copied to. */
2247 /* The rest of the sblocks following TB don't contain live data, so
2248 we can free them. */
2249 for (b
= tb
->next
; b
; b
= next
)
2257 current_sblock
= tb
;
2261 string_overflow (void)
2263 error ("Maximum string size exceeded");
2266 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2267 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2268 LENGTH must be an integer.
2269 INIT must be an integer that represents a character. */)
2270 (Lisp_Object length
, Lisp_Object init
)
2272 register Lisp_Object val
;
2276 CHECK_NATNUM (length
);
2277 CHECK_CHARACTER (init
);
2279 c
= XFASTINT (init
);
2280 if (ASCII_CHAR_P (c
))
2282 nbytes
= XINT (length
);
2283 val
= make_uninit_string (nbytes
);
2286 memset (SDATA (val
), c
, nbytes
);
2287 SDATA (val
)[nbytes
] = 0;
2292 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2293 ptrdiff_t len
= CHAR_STRING (c
, str
);
2294 EMACS_INT string_len
= XINT (length
);
2295 unsigned char *p
, *beg
, *end
;
2297 if (INT_MULTIPLY_WRAPV (len
, string_len
, &nbytes
))
2299 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2300 for (beg
= SDATA (val
), p
= beg
, end
= beg
+ nbytes
; p
< end
; p
+= len
)
2302 /* First time we just copy `str' to the data of `val'. */
2304 memcpy (p
, str
, len
);
2307 /* Next time we copy largest possible chunk from
2308 initialized to uninitialized part of `val'. */
2309 len
= min (p
- beg
, end
- p
);
2310 memcpy (p
, beg
, len
);
2320 /* Fill A with 1 bits if INIT is non-nil, and with 0 bits otherwise.
2324 bool_vector_fill (Lisp_Object a
, Lisp_Object init
)
2326 EMACS_INT nbits
= bool_vector_size (a
);
2329 unsigned char *data
= bool_vector_uchar_data (a
);
2330 int pattern
= NILP (init
) ? 0 : (1 << BOOL_VECTOR_BITS_PER_CHAR
) - 1;
2331 ptrdiff_t nbytes
= bool_vector_bytes (nbits
);
2332 int last_mask
= ~ (~0u << ((nbits
- 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1));
2333 memset (data
, pattern
, nbytes
- 1);
2334 data
[nbytes
- 1] = pattern
& last_mask
;
2339 /* Return a newly allocated, uninitialized bool vector of size NBITS. */
2342 make_uninit_bool_vector (EMACS_INT nbits
)
2345 EMACS_INT words
= bool_vector_words (nbits
);
2346 EMACS_INT word_bytes
= words
* sizeof (bits_word
);
2347 EMACS_INT needed_elements
= ((bool_header_size
- header_size
+ word_bytes
2350 struct Lisp_Bool_Vector
*p
2351 = (struct Lisp_Bool_Vector
*) allocate_vector (needed_elements
);
2352 XSETVECTOR (val
, p
);
2353 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0, 0);
2356 /* Clear padding at the end. */
2358 p
->data
[words
- 1] = 0;
2363 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2364 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2365 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2366 (Lisp_Object length
, Lisp_Object init
)
2370 CHECK_NATNUM (length
);
2371 val
= make_uninit_bool_vector (XFASTINT (length
));
2372 return bool_vector_fill (val
, init
);
2375 DEFUN ("bool-vector", Fbool_vector
, Sbool_vector
, 0, MANY
, 0,
2376 doc
: /* Return a new bool-vector with specified arguments as elements.
2377 Any number of arguments, even zero arguments, are allowed.
2378 usage: (bool-vector &rest OBJECTS) */)
2379 (ptrdiff_t nargs
, Lisp_Object
*args
)
2384 vector
= make_uninit_bool_vector (nargs
);
2385 for (i
= 0; i
< nargs
; i
++)
2386 bool_vector_set (vector
, i
, !NILP (args
[i
]));
2391 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2392 of characters from the contents. This string may be unibyte or
2393 multibyte, depending on the contents. */
2396 make_string (const char *contents
, ptrdiff_t nbytes
)
2398 register Lisp_Object val
;
2399 ptrdiff_t nchars
, multibyte_nbytes
;
2401 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2402 &nchars
, &multibyte_nbytes
);
2403 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2404 /* CONTENTS contains no multibyte sequences or contains an invalid
2405 multibyte sequence. We must make unibyte string. */
2406 val
= make_unibyte_string (contents
, nbytes
);
2408 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2412 /* Make a unibyte string from LENGTH bytes at CONTENTS. */
2415 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2417 register Lisp_Object val
;
2418 val
= make_uninit_string (length
);
2419 memcpy (SDATA (val
), contents
, length
);
2424 /* Make a multibyte string from NCHARS characters occupying NBYTES
2425 bytes at CONTENTS. */
2428 make_multibyte_string (const char *contents
,
2429 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2431 register Lisp_Object val
;
2432 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2433 memcpy (SDATA (val
), contents
, nbytes
);
2438 /* Make a string from NCHARS characters occupying NBYTES bytes at
2439 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2442 make_string_from_bytes (const char *contents
,
2443 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2445 register Lisp_Object val
;
2446 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2447 memcpy (SDATA (val
), contents
, nbytes
);
2448 if (SBYTES (val
) == SCHARS (val
))
2449 STRING_SET_UNIBYTE (val
);
2454 /* Make a string from NCHARS characters occupying NBYTES bytes at
2455 CONTENTS. The argument MULTIBYTE controls whether to label the
2456 string as multibyte. If NCHARS is negative, it counts the number of
2457 characters by itself. */
2460 make_specified_string (const char *contents
,
2461 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
2468 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2473 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2474 memcpy (SDATA (val
), contents
, nbytes
);
2476 STRING_SET_UNIBYTE (val
);
2481 /* Return a unibyte Lisp_String set up to hold LENGTH characters
2482 occupying LENGTH bytes. */
2485 make_uninit_string (EMACS_INT length
)
2490 return empty_unibyte_string
;
2491 val
= make_uninit_multibyte_string (length
, length
);
2492 STRING_SET_UNIBYTE (val
);
2497 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2498 which occupy NBYTES bytes. */
2501 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2504 struct Lisp_String
*s
;
2509 return empty_multibyte_string
;
2511 s
= allocate_string ();
2512 s
->intervals
= NULL
;
2513 allocate_string_data (s
, nchars
, nbytes
);
2514 XSETSTRING (string
, s
);
2515 string_chars_consed
+= nbytes
;
2519 /* Print arguments to BUF according to a FORMAT, then return
2520 a Lisp_String initialized with the data from BUF. */
2523 make_formatted_string (char *buf
, const char *format
, ...)
2528 va_start (ap
, format
);
2529 length
= vsprintf (buf
, format
, ap
);
2531 return make_string (buf
, length
);
2535 /***********************************************************************
2537 ***********************************************************************/
2539 /* We store float cells inside of float_blocks, allocating a new
2540 float_block with malloc whenever necessary. Float cells reclaimed
2541 by GC are put on a free list to be reallocated before allocating
2542 any new float cells from the latest float_block. */
2544 #define FLOAT_BLOCK_SIZE \
2545 (((BLOCK_BYTES - sizeof (struct float_block *) \
2546 /* The compiler might add padding at the end. */ \
2547 - (sizeof (struct Lisp_Float) - sizeof (bits_word))) * CHAR_BIT) \
2548 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2550 #define GETMARKBIT(block,n) \
2551 (((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2552 >> ((n) % BITS_PER_BITS_WORD)) \
2555 #define SETMARKBIT(block,n) \
2556 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2557 |= (bits_word) 1 << ((n) % BITS_PER_BITS_WORD))
2559 #define UNSETMARKBIT(block,n) \
2560 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2561 &= ~((bits_word) 1 << ((n) % BITS_PER_BITS_WORD)))
2563 #define FLOAT_BLOCK(fptr) \
2564 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2566 #define FLOAT_INDEX(fptr) \
2567 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2571 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2572 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2573 bits_word gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2574 struct float_block
*next
;
2577 #define FLOAT_MARKED_P(fptr) \
2578 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2580 #define FLOAT_MARK(fptr) \
2581 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2583 #define FLOAT_UNMARK(fptr) \
2584 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2586 /* Current float_block. */
2588 static struct float_block
*float_block
;
2590 /* Index of first unused Lisp_Float in the current float_block. */
2592 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2594 /* Free-list of Lisp_Floats. */
2596 static struct Lisp_Float
*float_free_list
;
2598 /* Return a new float object with value FLOAT_VALUE. */
2601 make_float (double float_value
)
2603 register Lisp_Object val
;
2607 if (float_free_list
)
2609 /* We use the data field for chaining the free list
2610 so that we won't use the same field that has the mark bit. */
2611 XSETFLOAT (val
, float_free_list
);
2612 float_free_list
= float_free_list
->u
.chain
;
2616 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2618 struct float_block
*new
2619 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2620 new->next
= float_block
;
2621 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2623 float_block_index
= 0;
2624 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2626 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2627 float_block_index
++;
2630 MALLOC_UNBLOCK_INPUT
;
2632 XFLOAT_INIT (val
, float_value
);
2633 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2634 consing_since_gc
+= sizeof (struct Lisp_Float
);
2636 total_free_floats
--;
2642 /***********************************************************************
2644 ***********************************************************************/
2646 /* We store cons cells inside of cons_blocks, allocating a new
2647 cons_block with malloc whenever necessary. Cons cells reclaimed by
2648 GC are put on a free list to be reallocated before allocating
2649 any new cons cells from the latest cons_block. */
2651 #define CONS_BLOCK_SIZE \
2652 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2653 /* The compiler might add padding at the end. */ \
2654 - (sizeof (struct Lisp_Cons) - sizeof (bits_word))) * CHAR_BIT) \
2655 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2657 #define CONS_BLOCK(fptr) \
2658 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2660 #define CONS_INDEX(fptr) \
2661 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2665 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2666 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2667 bits_word gcmarkbits
[1 + CONS_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2668 struct cons_block
*next
;
2671 #define CONS_MARKED_P(fptr) \
2672 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2674 #define CONS_MARK(fptr) \
2675 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2677 #define CONS_UNMARK(fptr) \
2678 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2680 /* Current cons_block. */
2682 static struct cons_block
*cons_block
;
2684 /* Index of first unused Lisp_Cons in the current block. */
2686 static int cons_block_index
= CONS_BLOCK_SIZE
;
2688 /* Free-list of Lisp_Cons structures. */
2690 static struct Lisp_Cons
*cons_free_list
;
2692 /* Explicitly free a cons cell by putting it on the free-list. */
2695 free_cons (struct Lisp_Cons
*ptr
)
2697 ptr
->u
.chain
= cons_free_list
;
2699 cons_free_list
= ptr
;
2700 consing_since_gc
-= sizeof *ptr
;
2701 total_free_conses
++;
2704 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2705 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2706 (Lisp_Object car
, Lisp_Object cdr
)
2708 register Lisp_Object val
;
2714 /* We use the cdr for chaining the free list
2715 so that we won't use the same field that has the mark bit. */
2716 XSETCONS (val
, cons_free_list
);
2717 cons_free_list
= cons_free_list
->u
.chain
;
2721 if (cons_block_index
== CONS_BLOCK_SIZE
)
2723 struct cons_block
*new
2724 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2725 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2726 new->next
= cons_block
;
2728 cons_block_index
= 0;
2729 total_free_conses
+= CONS_BLOCK_SIZE
;
2731 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2735 MALLOC_UNBLOCK_INPUT
;
2739 eassert (!CONS_MARKED_P (XCONS (val
)));
2740 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2741 total_free_conses
--;
2742 cons_cells_consed
++;
2746 #ifdef GC_CHECK_CONS_LIST
2747 /* Get an error now if there's any junk in the cons free list. */
2749 check_cons_list (void)
2751 struct Lisp_Cons
*tail
= cons_free_list
;
2754 tail
= tail
->u
.chain
;
2758 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2761 list1 (Lisp_Object arg1
)
2763 return Fcons (arg1
, Qnil
);
2767 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2769 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2774 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2776 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2781 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2783 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2788 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2790 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2791 Fcons (arg5
, Qnil
)))));
2794 /* Make a list of COUNT Lisp_Objects, where ARG is the
2795 first one. Allocate conses from pure space if TYPE
2796 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2799 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2801 Lisp_Object (*cons
) (Lisp_Object
, Lisp_Object
);
2804 case CONSTYPE_PURE
: cons
= pure_cons
; break;
2805 case CONSTYPE_HEAP
: cons
= Fcons
; break;
2806 default: emacs_abort ();
2809 eassume (0 < count
);
2810 Lisp_Object val
= cons (arg
, Qnil
);
2811 Lisp_Object tail
= val
;
2815 for (ptrdiff_t i
= 1; i
< count
; i
++)
2817 Lisp_Object elem
= cons (va_arg (ap
, Lisp_Object
), Qnil
);
2818 XSETCDR (tail
, elem
);
2826 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2827 doc
: /* Return a newly created list with specified arguments as elements.
2828 Any number of arguments, even zero arguments, are allowed.
2829 usage: (list &rest OBJECTS) */)
2830 (ptrdiff_t nargs
, Lisp_Object
*args
)
2832 register Lisp_Object val
;
2838 val
= Fcons (args
[nargs
], val
);
2844 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2845 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2846 (register Lisp_Object length
, Lisp_Object init
)
2848 register Lisp_Object val
;
2849 register EMACS_INT size
;
2851 CHECK_NATNUM (length
);
2852 size
= XFASTINT (length
);
2857 val
= Fcons (init
, val
);
2862 val
= Fcons (init
, val
);
2867 val
= Fcons (init
, val
);
2872 val
= Fcons (init
, val
);
2877 val
= Fcons (init
, val
);
2892 /***********************************************************************
2894 ***********************************************************************/
2896 /* Sometimes a vector's contents are merely a pointer internally used
2897 in vector allocation code. On the rare platforms where a null
2898 pointer cannot be tagged, represent it with a Lisp 0.
2899 Usually you don't want to touch this. */
2901 static struct Lisp_Vector
*
2902 next_vector (struct Lisp_Vector
*v
)
2904 return XUNTAG (v
->contents
[0], Lisp_Int0
);
2908 set_next_vector (struct Lisp_Vector
*v
, struct Lisp_Vector
*p
)
2910 v
->contents
[0] = make_lisp_ptr (p
, Lisp_Int0
);
2913 /* This value is balanced well enough to avoid too much internal overhead
2914 for the most common cases; it's not required to be a power of two, but
2915 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2917 #define VECTOR_BLOCK_SIZE 4096
2921 /* Alignment of struct Lisp_Vector objects. */
2922 vector_alignment
= COMMON_MULTIPLE (ALIGNOF_STRUCT_LISP_VECTOR
,
2925 /* Vector size requests are a multiple of this. */
2926 roundup_size
= COMMON_MULTIPLE (vector_alignment
, word_size
)
2929 /* Verify assumptions described above. */
2930 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2931 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2933 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at compile time. */
2934 #define vroundup_ct(x) ROUNDUP (x, roundup_size)
2935 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at runtime. */
2936 #define vroundup(x) (eassume ((x) >= 0), vroundup_ct (x))
2938 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2940 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup_ct (sizeof (void *)))
2942 /* Size of the minimal vector allocated from block. */
2944 #define VBLOCK_BYTES_MIN vroundup_ct (header_size + sizeof (Lisp_Object))
2946 /* Size of the largest vector allocated from block. */
2948 #define VBLOCK_BYTES_MAX \
2949 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2951 /* We maintain one free list for each possible block-allocated
2952 vector size, and this is the number of free lists we have. */
2954 #define VECTOR_MAX_FREE_LIST_INDEX \
2955 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2957 /* Common shortcut to advance vector pointer over a block data. */
2959 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2961 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2963 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2965 /* Common shortcut to setup vector on a free list. */
2967 #define SETUP_ON_FREE_LIST(v, nbytes, tmp) \
2969 (tmp) = ((nbytes - header_size) / word_size); \
2970 XSETPVECTYPESIZE (v, PVEC_FREE, 0, (tmp)); \
2971 eassert ((nbytes) % roundup_size == 0); \
2972 (tmp) = VINDEX (nbytes); \
2973 eassert ((tmp) < VECTOR_MAX_FREE_LIST_INDEX); \
2974 set_next_vector (v, vector_free_lists[tmp]); \
2975 vector_free_lists[tmp] = (v); \
2976 total_free_vector_slots += (nbytes) / word_size; \
2979 /* This internal type is used to maintain the list of large vectors
2980 which are allocated at their own, e.g. outside of vector blocks.
2982 struct large_vector itself cannot contain a struct Lisp_Vector, as
2983 the latter contains a flexible array member and C99 does not allow
2984 such structs to be nested. Instead, each struct large_vector
2985 object LV is followed by a struct Lisp_Vector, which is at offset
2986 large_vector_offset from LV, and whose address is therefore
2987 large_vector_vec (&LV). */
2991 struct large_vector
*next
;
2996 large_vector_offset
= ROUNDUP (sizeof (struct large_vector
), vector_alignment
)
2999 static struct Lisp_Vector
*
3000 large_vector_vec (struct large_vector
*p
)
3002 return (struct Lisp_Vector
*) ((char *) p
+ large_vector_offset
);
3005 /* This internal type is used to maintain an underlying storage
3006 for small vectors. */
3010 char data
[VECTOR_BLOCK_BYTES
];
3011 struct vector_block
*next
;
3014 /* Chain of vector blocks. */
3016 static struct vector_block
*vector_blocks
;
3018 /* Vector free lists, where NTH item points to a chain of free
3019 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
3021 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
3023 /* Singly-linked list of large vectors. */
3025 static struct large_vector
*large_vectors
;
3027 /* The only vector with 0 slots, allocated from pure space. */
3029 Lisp_Object zero_vector
;
3031 /* Number of live vectors. */
3033 static EMACS_INT total_vectors
;
3035 /* Total size of live and free vectors, in Lisp_Object units. */
3037 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
3039 /* Get a new vector block. */
3041 static struct vector_block
*
3042 allocate_vector_block (void)
3044 struct vector_block
*block
= xmalloc (sizeof *block
);
3046 #ifndef GC_MALLOC_CHECK
3047 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
3048 MEM_TYPE_VECTOR_BLOCK
);
3051 block
->next
= vector_blocks
;
3052 vector_blocks
= block
;
3056 /* Called once to initialize vector allocation. */
3061 zero_vector
= make_pure_vector (0);
3064 /* Allocate vector from a vector block. */
3066 static struct Lisp_Vector
*
3067 allocate_vector_from_block (size_t nbytes
)
3069 struct Lisp_Vector
*vector
;
3070 struct vector_block
*block
;
3071 size_t index
, restbytes
;
3073 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
3074 eassert (nbytes
% roundup_size
== 0);
3076 /* First, try to allocate from a free list
3077 containing vectors of the requested size. */
3078 index
= VINDEX (nbytes
);
3079 if (vector_free_lists
[index
])
3081 vector
= vector_free_lists
[index
];
3082 vector_free_lists
[index
] = next_vector (vector
);
3083 total_free_vector_slots
-= nbytes
/ word_size
;
3087 /* Next, check free lists containing larger vectors. Since
3088 we will split the result, we should have remaining space
3089 large enough to use for one-slot vector at least. */
3090 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
3091 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
3092 if (vector_free_lists
[index
])
3094 /* This vector is larger than requested. */
3095 vector
= vector_free_lists
[index
];
3096 vector_free_lists
[index
] = next_vector (vector
);
3097 total_free_vector_slots
-= nbytes
/ word_size
;
3099 /* Excess bytes are used for the smaller vector,
3100 which should be set on an appropriate free list. */
3101 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
3102 eassert (restbytes
% roundup_size
== 0);
3103 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
3107 /* Finally, need a new vector block. */
3108 block
= allocate_vector_block ();
3110 /* New vector will be at the beginning of this block. */
3111 vector
= (struct Lisp_Vector
*) block
->data
;
3113 /* If the rest of space from this block is large enough
3114 for one-slot vector at least, set up it on a free list. */
3115 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
3116 if (restbytes
>= VBLOCK_BYTES_MIN
)
3118 eassert (restbytes
% roundup_size
== 0);
3119 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
3124 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
3126 #define VECTOR_IN_BLOCK(vector, block) \
3127 ((char *) (vector) <= (block)->data \
3128 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
3130 /* Return the memory footprint of V in bytes. */
3133 vector_nbytes (struct Lisp_Vector
*v
)
3135 ptrdiff_t size
= v
->header
.size
& ~ARRAY_MARK_FLAG
;
3138 if (size
& PSEUDOVECTOR_FLAG
)
3140 if (PSEUDOVECTOR_TYPEP (&v
->header
, PVEC_BOOL_VECTOR
))
3142 struct Lisp_Bool_Vector
*bv
= (struct Lisp_Bool_Vector
*) v
;
3143 ptrdiff_t word_bytes
= (bool_vector_words (bv
->size
)
3144 * sizeof (bits_word
));
3145 ptrdiff_t boolvec_bytes
= bool_header_size
+ word_bytes
;
3146 verify (header_size
<= bool_header_size
);
3147 nwords
= (boolvec_bytes
- header_size
+ word_size
- 1) / word_size
;
3150 nwords
= ((size
& PSEUDOVECTOR_SIZE_MASK
)
3151 + ((size
& PSEUDOVECTOR_REST_MASK
)
3152 >> PSEUDOVECTOR_SIZE_BITS
));
3156 return vroundup (header_size
+ word_size
* nwords
);
3159 /* Release extra resources still in use by VECTOR, which may be any
3160 vector-like object. For now, this is used just to free data in
3164 cleanup_vector (struct Lisp_Vector
*vector
)
3166 detect_suspicious_free (vector
);
3167 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FONT
)
3168 && ((vector
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
3169 == FONT_OBJECT_MAX
))
3171 struct font_driver
*drv
= ((struct font
*) vector
)->driver
;
3173 /* The font driver might sometimes be NULL, e.g. if Emacs was
3174 interrupted before it had time to set it up. */
3177 /* Attempt to catch subtle bugs like Bug#16140. */
3178 eassert (valid_font_driver (drv
));
3179 drv
->close ((struct font
*) vector
);
3184 /* Reclaim space used by unmarked vectors. */
3186 NO_INLINE
/* For better stack traces */
3188 sweep_vectors (void)
3190 struct vector_block
*block
, **bprev
= &vector_blocks
;
3191 struct large_vector
*lv
, **lvprev
= &large_vectors
;
3192 struct Lisp_Vector
*vector
, *next
;
3194 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
3195 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
3197 /* Looking through vector blocks. */
3199 for (block
= vector_blocks
; block
; block
= *bprev
)
3201 bool free_this_block
= 0;
3204 for (vector
= (struct Lisp_Vector
*) block
->data
;
3205 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
3207 if (VECTOR_MARKED_P (vector
))
3209 VECTOR_UNMARK (vector
);
3211 nbytes
= vector_nbytes (vector
);
3212 total_vector_slots
+= nbytes
/ word_size
;
3213 next
= ADVANCE (vector
, nbytes
);
3217 ptrdiff_t total_bytes
;
3219 cleanup_vector (vector
);
3220 nbytes
= vector_nbytes (vector
);
3221 total_bytes
= nbytes
;
3222 next
= ADVANCE (vector
, nbytes
);
3224 /* While NEXT is not marked, try to coalesce with VECTOR,
3225 thus making VECTOR of the largest possible size. */
3227 while (VECTOR_IN_BLOCK (next
, block
))
3229 if (VECTOR_MARKED_P (next
))
3231 cleanup_vector (next
);
3232 nbytes
= vector_nbytes (next
);
3233 total_bytes
+= nbytes
;
3234 next
= ADVANCE (next
, nbytes
);
3237 eassert (total_bytes
% roundup_size
== 0);
3239 if (vector
== (struct Lisp_Vector
*) block
->data
3240 && !VECTOR_IN_BLOCK (next
, block
))
3241 /* This block should be freed because all of its
3242 space was coalesced into the only free vector. */
3243 free_this_block
= 1;
3247 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
3252 if (free_this_block
)
3254 *bprev
= block
->next
;
3255 #ifndef GC_MALLOC_CHECK
3256 mem_delete (mem_find (block
->data
));
3261 bprev
= &block
->next
;
3264 /* Sweep large vectors. */
3266 for (lv
= large_vectors
; lv
; lv
= *lvprev
)
3268 vector
= large_vector_vec (lv
);
3269 if (VECTOR_MARKED_P (vector
))
3271 VECTOR_UNMARK (vector
);
3273 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
3275 /* All non-bool pseudovectors are small enough to be allocated
3276 from vector blocks. This code should be redesigned if some
3277 pseudovector type grows beyond VBLOCK_BYTES_MAX. */
3278 eassert (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_BOOL_VECTOR
));
3279 total_vector_slots
+= vector_nbytes (vector
) / word_size
;
3283 += header_size
/ word_size
+ vector
->header
.size
;
3294 /* Value is a pointer to a newly allocated Lisp_Vector structure
3295 with room for LEN Lisp_Objects. */
3297 static struct Lisp_Vector
*
3298 allocate_vectorlike (ptrdiff_t len
)
3300 struct Lisp_Vector
*p
;
3305 p
= XVECTOR (zero_vector
);
3308 size_t nbytes
= header_size
+ len
* word_size
;
3310 #ifdef DOUG_LEA_MALLOC
3311 if (!mmap_lisp_allowed_p ())
3312 mallopt (M_MMAP_MAX
, 0);
3315 if (nbytes
<= VBLOCK_BYTES_MAX
)
3316 p
= allocate_vector_from_block (vroundup (nbytes
));
3319 struct large_vector
*lv
3320 = lisp_malloc ((large_vector_offset
+ header_size
3322 MEM_TYPE_VECTORLIKE
);
3323 lv
->next
= large_vectors
;
3325 p
= large_vector_vec (lv
);
3328 #ifdef DOUG_LEA_MALLOC
3329 if (!mmap_lisp_allowed_p ())
3330 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3333 if (find_suspicious_object_in_range (p
, (char *) p
+ nbytes
))
3336 consing_since_gc
+= nbytes
;
3337 vector_cells_consed
+= len
;
3340 MALLOC_UNBLOCK_INPUT
;
3346 /* Allocate a vector with LEN slots. */
3348 struct Lisp_Vector
*
3349 allocate_vector (EMACS_INT len
)
3351 struct Lisp_Vector
*v
;
3352 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3354 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3355 memory_full (SIZE_MAX
);
3356 v
= allocate_vectorlike (len
);
3358 v
->header
.size
= len
;
3363 /* Allocate other vector-like structures. */
3365 struct Lisp_Vector
*
3366 allocate_pseudovector (int memlen
, int lisplen
,
3367 int zerolen
, enum pvec_type tag
)
3369 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3371 /* Catch bogus values. */
3372 eassert (0 <= tag
&& tag
<= PVEC_FONT
);
3373 eassert (0 <= lisplen
&& lisplen
<= zerolen
&& zerolen
<= memlen
);
3374 eassert (memlen
- lisplen
<= (1 << PSEUDOVECTOR_REST_BITS
) - 1);
3375 eassert (lisplen
<= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1);
3377 /* Only the first LISPLEN slots will be traced normally by the GC. */
3378 memclear (v
->contents
, zerolen
* word_size
);
3379 XSETPVECTYPESIZE (v
, tag
, lisplen
, memlen
- lisplen
);
3384 allocate_buffer (void)
3386 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3388 BUFFER_PVEC_INIT (b
);
3389 /* Put B on the chain of all buffers including killed ones. */
3390 b
->next
= all_buffers
;
3392 /* Note that the rest fields of B are not initialized. */
3396 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3397 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3398 See also the function `vector'. */)
3399 (register Lisp_Object length
, Lisp_Object init
)
3402 register ptrdiff_t sizei
;
3403 register ptrdiff_t i
;
3404 register struct Lisp_Vector
*p
;
3406 CHECK_NATNUM (length
);
3408 p
= allocate_vector (XFASTINT (length
));
3409 sizei
= XFASTINT (length
);
3410 for (i
= 0; i
< sizei
; i
++)
3411 p
->contents
[i
] = init
;
3413 XSETVECTOR (vector
, p
);
3417 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3418 doc
: /* Return a newly created vector with specified arguments as elements.
3419 Any number of arguments, even zero arguments, are allowed.
3420 usage: (vector &rest OBJECTS) */)
3421 (ptrdiff_t nargs
, Lisp_Object
*args
)
3424 register Lisp_Object val
= make_uninit_vector (nargs
);
3425 register struct Lisp_Vector
*p
= XVECTOR (val
);
3427 for (i
= 0; i
< nargs
; i
++)
3428 p
->contents
[i
] = args
[i
];
3433 make_byte_code (struct Lisp_Vector
*v
)
3435 /* Don't allow the global zero_vector to become a byte code object. */
3436 eassert (0 < v
->header
.size
);
3438 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3439 && STRING_MULTIBYTE (v
->contents
[1]))
3440 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3441 earlier because they produced a raw 8-bit string for byte-code
3442 and now such a byte-code string is loaded as multibyte while
3443 raw 8-bit characters converted to multibyte form. Thus, now we
3444 must convert them back to the original unibyte form. */
3445 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3446 XSETPVECTYPE (v
, PVEC_COMPILED
);
3449 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3450 doc
: /* Create a byte-code object with specified arguments as elements.
3451 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3452 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3453 and (optional) INTERACTIVE-SPEC.
3454 The first four arguments are required; at most six have any
3456 The ARGLIST can be either like the one of `lambda', in which case the arguments
3457 will be dynamically bound before executing the byte code, or it can be an
3458 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3459 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3460 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3461 argument to catch the left-over arguments. If such an integer is used, the
3462 arguments will not be dynamically bound but will be instead pushed on the
3463 stack before executing the byte-code.
3464 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3465 (ptrdiff_t nargs
, Lisp_Object
*args
)
3468 register Lisp_Object val
= make_uninit_vector (nargs
);
3469 register struct Lisp_Vector
*p
= XVECTOR (val
);
3471 /* We used to purecopy everything here, if purify-flag was set. This worked
3472 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3473 dangerous, since make-byte-code is used during execution to build
3474 closures, so any closure built during the preload phase would end up
3475 copied into pure space, including its free variables, which is sometimes
3476 just wasteful and other times plainly wrong (e.g. those free vars may want
3479 for (i
= 0; i
< nargs
; i
++)
3480 p
->contents
[i
] = args
[i
];
3482 XSETCOMPILED (val
, p
);
3488 /***********************************************************************
3490 ***********************************************************************/
3492 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3493 of the required alignment. */
3495 union aligned_Lisp_Symbol
3497 struct Lisp_Symbol s
;
3498 unsigned char c
[(sizeof (struct Lisp_Symbol
) + GCALIGNMENT
- 1)
3502 /* Each symbol_block is just under 1020 bytes long, since malloc
3503 really allocates in units of powers of two and uses 4 bytes for its
3506 #define SYMBOL_BLOCK_SIZE \
3507 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3511 /* Place `symbols' first, to preserve alignment. */
3512 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3513 struct symbol_block
*next
;
3516 /* Current symbol block and index of first unused Lisp_Symbol
3519 static struct symbol_block
*symbol_block
;
3520 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3521 /* Pointer to the first symbol_block that contains pinned symbols.
3522 Tests for 24.4 showed that at dump-time, Emacs contains about 15K symbols,
3523 10K of which are pinned (and all but 250 of them are interned in obarray),
3524 whereas a "typical session" has in the order of 30K symbols.
3525 `symbol_block_pinned' lets mark_pinned_symbols scan only 15K symbols rather
3526 than 30K to find the 10K symbols we need to mark. */
3527 static struct symbol_block
*symbol_block_pinned
;
3529 /* List of free symbols. */
3531 static struct Lisp_Symbol
*symbol_free_list
;
3534 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
3536 XSYMBOL (sym
)->name
= name
;
3540 init_symbol (Lisp_Object val
, Lisp_Object name
)
3542 struct Lisp_Symbol
*p
= XSYMBOL (val
);
3543 set_symbol_name (val
, name
);
3544 set_symbol_plist (val
, Qnil
);
3545 p
->redirect
= SYMBOL_PLAINVAL
;
3546 SET_SYMBOL_VAL (p
, Qunbound
);
3547 set_symbol_function (val
, Qnil
);
3548 set_symbol_next (val
, NULL
);
3549 p
->gcmarkbit
= false;
3550 p
->interned
= SYMBOL_UNINTERNED
;
3552 p
->declared_special
= false;
3556 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3557 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3558 Its value is void, and its function definition and property list are nil. */)
3563 CHECK_STRING (name
);
3567 if (symbol_free_list
)
3569 XSETSYMBOL (val
, symbol_free_list
);
3570 symbol_free_list
= symbol_free_list
->next
;
3574 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3576 struct symbol_block
*new
3577 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3578 new->next
= symbol_block
;
3580 symbol_block_index
= 0;
3581 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3583 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3584 symbol_block_index
++;
3587 MALLOC_UNBLOCK_INPUT
;
3589 init_symbol (val
, name
);
3590 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3592 total_free_symbols
--;
3598 /***********************************************************************
3599 Marker (Misc) Allocation
3600 ***********************************************************************/
3602 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3603 the required alignment. */
3605 union aligned_Lisp_Misc
3608 unsigned char c
[(sizeof (union Lisp_Misc
) + GCALIGNMENT
- 1)
3612 /* Allocation of markers and other objects that share that structure.
3613 Works like allocation of conses. */
3615 #define MARKER_BLOCK_SIZE \
3616 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3620 /* Place `markers' first, to preserve alignment. */
3621 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3622 struct marker_block
*next
;
3625 static struct marker_block
*marker_block
;
3626 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3628 static union Lisp_Misc
*marker_free_list
;
3630 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3633 allocate_misc (enum Lisp_Misc_Type type
)
3639 if (marker_free_list
)
3641 XSETMISC (val
, marker_free_list
);
3642 marker_free_list
= marker_free_list
->u_free
.chain
;
3646 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3648 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3649 new->next
= marker_block
;
3651 marker_block_index
= 0;
3652 total_free_markers
+= MARKER_BLOCK_SIZE
;
3654 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3655 marker_block_index
++;
3658 MALLOC_UNBLOCK_INPUT
;
3660 --total_free_markers
;
3661 consing_since_gc
+= sizeof (union Lisp_Misc
);
3662 misc_objects_consed
++;
3663 XMISCANY (val
)->type
= type
;
3664 XMISCANY (val
)->gcmarkbit
= 0;
3668 /* Free a Lisp_Misc object. */
3671 free_misc (Lisp_Object misc
)
3673 XMISCANY (misc
)->type
= Lisp_Misc_Free
;
3674 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3675 marker_free_list
= XMISC (misc
);
3676 consing_since_gc
-= sizeof (union Lisp_Misc
);
3677 total_free_markers
++;
3680 /* Verify properties of Lisp_Save_Value's representation
3681 that are assumed here and elsewhere. */
3683 verify (SAVE_UNUSED
== 0);
3684 verify (((SAVE_INTEGER
| SAVE_POINTER
| SAVE_FUNCPOINTER
| SAVE_OBJECT
)
3688 /* Return Lisp_Save_Value objects for the various combinations
3689 that callers need. */
3692 make_save_int_int_int (ptrdiff_t a
, ptrdiff_t b
, ptrdiff_t c
)
3694 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3695 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3696 p
->save_type
= SAVE_TYPE_INT_INT_INT
;
3697 p
->data
[0].integer
= a
;
3698 p
->data
[1].integer
= b
;
3699 p
->data
[2].integer
= c
;
3704 make_save_obj_obj_obj_obj (Lisp_Object a
, Lisp_Object b
, Lisp_Object c
,
3707 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3708 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3709 p
->save_type
= SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
;
3710 p
->data
[0].object
= a
;
3711 p
->data
[1].object
= b
;
3712 p
->data
[2].object
= c
;
3713 p
->data
[3].object
= d
;
3718 make_save_ptr (void *a
)
3720 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3721 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3722 p
->save_type
= SAVE_POINTER
;
3723 p
->data
[0].pointer
= a
;
3728 make_save_ptr_int (void *a
, ptrdiff_t b
)
3730 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3731 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3732 p
->save_type
= SAVE_TYPE_PTR_INT
;
3733 p
->data
[0].pointer
= a
;
3734 p
->data
[1].integer
= b
;
3739 make_save_ptr_ptr (void *a
, void *b
)
3741 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3742 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3743 p
->save_type
= SAVE_TYPE_PTR_PTR
;
3744 p
->data
[0].pointer
= a
;
3745 p
->data
[1].pointer
= b
;
3750 make_save_funcptr_ptr_obj (void (*a
) (void), void *b
, Lisp_Object c
)
3752 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3753 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3754 p
->save_type
= SAVE_TYPE_FUNCPTR_PTR_OBJ
;
3755 p
->data
[0].funcpointer
= a
;
3756 p
->data
[1].pointer
= b
;
3757 p
->data
[2].object
= c
;
3761 /* Return a Lisp_Save_Value object that represents an array A
3762 of N Lisp objects. */
3765 make_save_memory (Lisp_Object
*a
, ptrdiff_t n
)
3767 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3768 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3769 p
->save_type
= SAVE_TYPE_MEMORY
;
3770 p
->data
[0].pointer
= a
;
3771 p
->data
[1].integer
= n
;
3775 /* Free a Lisp_Save_Value object. Do not use this function
3776 if SAVE contains pointer other than returned by xmalloc. */
3779 free_save_value (Lisp_Object save
)
3781 xfree (XSAVE_POINTER (save
, 0));
3785 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3788 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3790 register Lisp_Object overlay
;
3792 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3793 OVERLAY_START (overlay
) = start
;
3794 OVERLAY_END (overlay
) = end
;
3795 set_overlay_plist (overlay
, plist
);
3796 XOVERLAY (overlay
)->next
= NULL
;
3800 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3801 doc
: /* Return a newly allocated marker which does not point at any place. */)
3804 register Lisp_Object val
;
3805 register struct Lisp_Marker
*p
;
3807 val
= allocate_misc (Lisp_Misc_Marker
);
3813 p
->insertion_type
= 0;
3814 p
->need_adjustment
= 0;
3818 /* Return a newly allocated marker which points into BUF
3819 at character position CHARPOS and byte position BYTEPOS. */
3822 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3825 struct Lisp_Marker
*m
;
3827 /* No dead buffers here. */
3828 eassert (BUFFER_LIVE_P (buf
));
3830 /* Every character is at least one byte. */
3831 eassert (charpos
<= bytepos
);
3833 obj
= allocate_misc (Lisp_Misc_Marker
);
3836 m
->charpos
= charpos
;
3837 m
->bytepos
= bytepos
;
3838 m
->insertion_type
= 0;
3839 m
->need_adjustment
= 0;
3840 m
->next
= BUF_MARKERS (buf
);
3841 BUF_MARKERS (buf
) = m
;
3845 /* Put MARKER back on the free list after using it temporarily. */
3848 free_marker (Lisp_Object marker
)
3850 unchain_marker (XMARKER (marker
));
3855 /* Return a newly created vector or string with specified arguments as
3856 elements. If all the arguments are characters that can fit
3857 in a string of events, make a string; otherwise, make a vector.
3859 Any number of arguments, even zero arguments, are allowed. */
3862 make_event_array (ptrdiff_t nargs
, Lisp_Object
*args
)
3866 for (i
= 0; i
< nargs
; i
++)
3867 /* The things that fit in a string
3868 are characters that are in 0...127,
3869 after discarding the meta bit and all the bits above it. */
3870 if (!INTEGERP (args
[i
])
3871 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3872 return Fvector (nargs
, args
);
3874 /* Since the loop exited, we know that all the things in it are
3875 characters, so we can make a string. */
3879 result
= Fmake_string (make_number (nargs
), make_number (0));
3880 for (i
= 0; i
< nargs
; i
++)
3882 SSET (result
, i
, XINT (args
[i
]));
3883 /* Move the meta bit to the right place for a string char. */
3884 if (XINT (args
[i
]) & CHAR_META
)
3885 SSET (result
, i
, SREF (result
, i
) | 0x80);
3893 /* Create a new module user ptr object. */
3895 make_user_ptr (void (*finalizer
) (void *), void *p
)
3898 struct Lisp_User_Ptr
*uptr
;
3900 obj
= allocate_misc (Lisp_Misc_User_Ptr
);
3901 uptr
= XUSER_PTR (obj
);
3902 uptr
->finalizer
= finalizer
;
3910 init_finalizer_list (struct Lisp_Finalizer
*head
)
3912 head
->prev
= head
->next
= head
;
3915 /* Insert FINALIZER before ELEMENT. */
3918 finalizer_insert (struct Lisp_Finalizer
*element
,
3919 struct Lisp_Finalizer
*finalizer
)
3921 eassert (finalizer
->prev
== NULL
);
3922 eassert (finalizer
->next
== NULL
);
3923 finalizer
->next
= element
;
3924 finalizer
->prev
= element
->prev
;
3925 finalizer
->prev
->next
= finalizer
;
3926 element
->prev
= finalizer
;
3930 unchain_finalizer (struct Lisp_Finalizer
*finalizer
)
3932 if (finalizer
->prev
!= NULL
)
3934 eassert (finalizer
->next
!= NULL
);
3935 finalizer
->prev
->next
= finalizer
->next
;
3936 finalizer
->next
->prev
= finalizer
->prev
;
3937 finalizer
->prev
= finalizer
->next
= NULL
;
3942 mark_finalizer_list (struct Lisp_Finalizer
*head
)
3944 for (struct Lisp_Finalizer
*finalizer
= head
->next
;
3946 finalizer
= finalizer
->next
)
3948 finalizer
->base
.gcmarkbit
= true;
3949 mark_object (finalizer
->function
);
3953 /* Move doomed finalizers to list DEST from list SRC. A doomed
3954 finalizer is one that is not GC-reachable and whose
3955 finalizer->function is non-nil. */
3958 queue_doomed_finalizers (struct Lisp_Finalizer
*dest
,
3959 struct Lisp_Finalizer
*src
)
3961 struct Lisp_Finalizer
*finalizer
= src
->next
;
3962 while (finalizer
!= src
)
3964 struct Lisp_Finalizer
*next
= finalizer
->next
;
3965 if (!finalizer
->base
.gcmarkbit
&& !NILP (finalizer
->function
))
3967 unchain_finalizer (finalizer
);
3968 finalizer_insert (dest
, finalizer
);
3976 run_finalizer_handler (Lisp_Object args
)
3978 add_to_log ("finalizer failed: %S", args
);
3983 run_finalizer_function (Lisp_Object function
)
3985 ptrdiff_t count
= SPECPDL_INDEX ();
3987 specbind (Qinhibit_quit
, Qt
);
3988 internal_condition_case_1 (call0
, function
, Qt
, run_finalizer_handler
);
3989 unbind_to (count
, Qnil
);
3993 run_finalizers (struct Lisp_Finalizer
*finalizers
)
3995 struct Lisp_Finalizer
*finalizer
;
3996 Lisp_Object function
;
3998 while (finalizers
->next
!= finalizers
)
4000 finalizer
= finalizers
->next
;
4001 eassert (finalizer
->base
.type
== Lisp_Misc_Finalizer
);
4002 unchain_finalizer (finalizer
);
4003 function
= finalizer
->function
;
4004 if (!NILP (function
))
4006 finalizer
->function
= Qnil
;
4007 run_finalizer_function (function
);
4012 DEFUN ("make-finalizer", Fmake_finalizer
, Smake_finalizer
, 1, 1, 0,
4013 doc
: /* Make a finalizer that will run FUNCTION.
4014 FUNCTION will be called after garbage collection when the returned
4015 finalizer object becomes unreachable. If the finalizer object is
4016 reachable only through references from finalizer objects, it does not
4017 count as reachable for the purpose of deciding whether to run
4018 FUNCTION. FUNCTION will be run once per finalizer object. */)
4019 (Lisp_Object function
)
4021 Lisp_Object val
= allocate_misc (Lisp_Misc_Finalizer
);
4022 struct Lisp_Finalizer
*finalizer
= XFINALIZER (val
);
4023 finalizer
->function
= function
;
4024 finalizer
->prev
= finalizer
->next
= NULL
;
4025 finalizer_insert (&finalizers
, finalizer
);
4030 /************************************************************************
4031 Memory Full Handling
4032 ************************************************************************/
4035 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
4036 there may have been size_t overflow so that malloc was never
4037 called, or perhaps malloc was invoked successfully but the
4038 resulting pointer had problems fitting into a tagged EMACS_INT. In
4039 either case this counts as memory being full even though malloc did
4043 memory_full (size_t nbytes
)
4045 /* Do not go into hysterics merely because a large request failed. */
4046 bool enough_free_memory
= 0;
4047 if (SPARE_MEMORY
< nbytes
)
4052 p
= malloc (SPARE_MEMORY
);
4056 enough_free_memory
= 1;
4058 MALLOC_UNBLOCK_INPUT
;
4061 if (! enough_free_memory
)
4067 memory_full_cons_threshold
= sizeof (struct cons_block
);
4069 /* The first time we get here, free the spare memory. */
4070 for (i
= 0; i
< ARRAYELTS (spare_memory
); i
++)
4071 if (spare_memory
[i
])
4074 free (spare_memory
[i
]);
4075 else if (i
>= 1 && i
<= 4)
4076 lisp_align_free (spare_memory
[i
]);
4078 lisp_free (spare_memory
[i
]);
4079 spare_memory
[i
] = 0;
4083 /* This used to call error, but if we've run out of memory, we could
4084 get infinite recursion trying to build the string. */
4085 xsignal (Qnil
, Vmemory_signal_data
);
4088 /* If we released our reserve (due to running out of memory),
4089 and we have a fair amount free once again,
4090 try to set aside another reserve in case we run out once more.
4092 This is called when a relocatable block is freed in ralloc.c,
4093 and also directly from this file, in case we're not using ralloc.c. */
4096 refill_memory_reserve (void)
4098 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
4099 if (spare_memory
[0] == 0)
4100 spare_memory
[0] = malloc (SPARE_MEMORY
);
4101 if (spare_memory
[1] == 0)
4102 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
4104 if (spare_memory
[2] == 0)
4105 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
4107 if (spare_memory
[3] == 0)
4108 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
4110 if (spare_memory
[4] == 0)
4111 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
4113 if (spare_memory
[5] == 0)
4114 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
4116 if (spare_memory
[6] == 0)
4117 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
4119 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
4120 Vmemory_full
= Qnil
;
4124 /************************************************************************
4126 ************************************************************************/
4128 /* Conservative C stack marking requires a method to identify possibly
4129 live Lisp objects given a pointer value. We do this by keeping
4130 track of blocks of Lisp data that are allocated in a red-black tree
4131 (see also the comment of mem_node which is the type of nodes in
4132 that tree). Function lisp_malloc adds information for an allocated
4133 block to the red-black tree with calls to mem_insert, and function
4134 lisp_free removes it with mem_delete. Functions live_string_p etc
4135 call mem_find to lookup information about a given pointer in the
4136 tree, and use that to determine if the pointer points to a Lisp
4139 /* Initialize this part of alloc.c. */
4144 mem_z
.left
= mem_z
.right
= MEM_NIL
;
4145 mem_z
.parent
= NULL
;
4146 mem_z
.color
= MEM_BLACK
;
4147 mem_z
.start
= mem_z
.end
= NULL
;
4152 /* Value is a pointer to the mem_node containing START. Value is
4153 MEM_NIL if there is no node in the tree containing START. */
4155 static struct mem_node
*
4156 mem_find (void *start
)
4160 if (start
< min_heap_address
|| start
> max_heap_address
)
4163 /* Make the search always successful to speed up the loop below. */
4164 mem_z
.start
= start
;
4165 mem_z
.end
= (char *) start
+ 1;
4168 while (start
< p
->start
|| start
>= p
->end
)
4169 p
= start
< p
->start
? p
->left
: p
->right
;
4174 /* Insert a new node into the tree for a block of memory with start
4175 address START, end address END, and type TYPE. Value is a
4176 pointer to the node that was inserted. */
4178 static struct mem_node
*
4179 mem_insert (void *start
, void *end
, enum mem_type type
)
4181 struct mem_node
*c
, *parent
, *x
;
4183 if (min_heap_address
== NULL
|| start
< min_heap_address
)
4184 min_heap_address
= start
;
4185 if (max_heap_address
== NULL
|| end
> max_heap_address
)
4186 max_heap_address
= end
;
4188 /* See where in the tree a node for START belongs. In this
4189 particular application, it shouldn't happen that a node is already
4190 present. For debugging purposes, let's check that. */
4194 while (c
!= MEM_NIL
)
4197 c
= start
< c
->start
? c
->left
: c
->right
;
4200 /* Create a new node. */
4201 #ifdef GC_MALLOC_CHECK
4202 x
= malloc (sizeof *x
);
4206 x
= xmalloc (sizeof *x
);
4212 x
->left
= x
->right
= MEM_NIL
;
4215 /* Insert it as child of PARENT or install it as root. */
4218 if (start
< parent
->start
)
4226 /* Re-establish red-black tree properties. */
4227 mem_insert_fixup (x
);
4233 /* Re-establish the red-black properties of the tree, and thereby
4234 balance the tree, after node X has been inserted; X is always red. */
4237 mem_insert_fixup (struct mem_node
*x
)
4239 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
4241 /* X is red and its parent is red. This is a violation of
4242 red-black tree property #3. */
4244 if (x
->parent
== x
->parent
->parent
->left
)
4246 /* We're on the left side of our grandparent, and Y is our
4248 struct mem_node
*y
= x
->parent
->parent
->right
;
4250 if (y
->color
== MEM_RED
)
4252 /* Uncle and parent are red but should be black because
4253 X is red. Change the colors accordingly and proceed
4254 with the grandparent. */
4255 x
->parent
->color
= MEM_BLACK
;
4256 y
->color
= MEM_BLACK
;
4257 x
->parent
->parent
->color
= MEM_RED
;
4258 x
= x
->parent
->parent
;
4262 /* Parent and uncle have different colors; parent is
4263 red, uncle is black. */
4264 if (x
== x
->parent
->right
)
4267 mem_rotate_left (x
);
4270 x
->parent
->color
= MEM_BLACK
;
4271 x
->parent
->parent
->color
= MEM_RED
;
4272 mem_rotate_right (x
->parent
->parent
);
4277 /* This is the symmetrical case of above. */
4278 struct mem_node
*y
= x
->parent
->parent
->left
;
4280 if (y
->color
== MEM_RED
)
4282 x
->parent
->color
= MEM_BLACK
;
4283 y
->color
= MEM_BLACK
;
4284 x
->parent
->parent
->color
= MEM_RED
;
4285 x
= x
->parent
->parent
;
4289 if (x
== x
->parent
->left
)
4292 mem_rotate_right (x
);
4295 x
->parent
->color
= MEM_BLACK
;
4296 x
->parent
->parent
->color
= MEM_RED
;
4297 mem_rotate_left (x
->parent
->parent
);
4302 /* The root may have been changed to red due to the algorithm. Set
4303 it to black so that property #5 is satisfied. */
4304 mem_root
->color
= MEM_BLACK
;
4315 mem_rotate_left (struct mem_node
*x
)
4319 /* Turn y's left sub-tree into x's right sub-tree. */
4322 if (y
->left
!= MEM_NIL
)
4323 y
->left
->parent
= x
;
4325 /* Y's parent was x's parent. */
4327 y
->parent
= x
->parent
;
4329 /* Get the parent to point to y instead of x. */
4332 if (x
== x
->parent
->left
)
4333 x
->parent
->left
= y
;
4335 x
->parent
->right
= y
;
4340 /* Put x on y's left. */
4354 mem_rotate_right (struct mem_node
*x
)
4356 struct mem_node
*y
= x
->left
;
4359 if (y
->right
!= MEM_NIL
)
4360 y
->right
->parent
= x
;
4363 y
->parent
= x
->parent
;
4366 if (x
== x
->parent
->right
)
4367 x
->parent
->right
= y
;
4369 x
->parent
->left
= y
;
4380 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4383 mem_delete (struct mem_node
*z
)
4385 struct mem_node
*x
, *y
;
4387 if (!z
|| z
== MEM_NIL
)
4390 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4395 while (y
->left
!= MEM_NIL
)
4399 if (y
->left
!= MEM_NIL
)
4404 x
->parent
= y
->parent
;
4407 if (y
== y
->parent
->left
)
4408 y
->parent
->left
= x
;
4410 y
->parent
->right
= x
;
4417 z
->start
= y
->start
;
4422 if (y
->color
== MEM_BLACK
)
4423 mem_delete_fixup (x
);
4425 #ifdef GC_MALLOC_CHECK
4433 /* Re-establish the red-black properties of the tree, after a
4437 mem_delete_fixup (struct mem_node
*x
)
4439 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4441 if (x
== x
->parent
->left
)
4443 struct mem_node
*w
= x
->parent
->right
;
4445 if (w
->color
== MEM_RED
)
4447 w
->color
= MEM_BLACK
;
4448 x
->parent
->color
= MEM_RED
;
4449 mem_rotate_left (x
->parent
);
4450 w
= x
->parent
->right
;
4453 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4460 if (w
->right
->color
== MEM_BLACK
)
4462 w
->left
->color
= MEM_BLACK
;
4464 mem_rotate_right (w
);
4465 w
= x
->parent
->right
;
4467 w
->color
= x
->parent
->color
;
4468 x
->parent
->color
= MEM_BLACK
;
4469 w
->right
->color
= MEM_BLACK
;
4470 mem_rotate_left (x
->parent
);
4476 struct mem_node
*w
= x
->parent
->left
;
4478 if (w
->color
== MEM_RED
)
4480 w
->color
= MEM_BLACK
;
4481 x
->parent
->color
= MEM_RED
;
4482 mem_rotate_right (x
->parent
);
4483 w
= x
->parent
->left
;
4486 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4493 if (w
->left
->color
== MEM_BLACK
)
4495 w
->right
->color
= MEM_BLACK
;
4497 mem_rotate_left (w
);
4498 w
= x
->parent
->left
;
4501 w
->color
= x
->parent
->color
;
4502 x
->parent
->color
= MEM_BLACK
;
4503 w
->left
->color
= MEM_BLACK
;
4504 mem_rotate_right (x
->parent
);
4510 x
->color
= MEM_BLACK
;
4514 /* Value is non-zero if P is a pointer to a live Lisp string on
4515 the heap. M is a pointer to the mem_block for P. */
4518 live_string_p (struct mem_node
*m
, void *p
)
4520 if (m
->type
== MEM_TYPE_STRING
)
4522 struct string_block
*b
= m
->start
;
4523 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4525 /* P must point to the start of a Lisp_String structure, and it
4526 must not be on the free-list. */
4528 && offset
% sizeof b
->strings
[0] == 0
4529 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4530 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4537 /* Value is non-zero if P is a pointer to a live Lisp cons on
4538 the heap. M is a pointer to the mem_block for P. */
4541 live_cons_p (struct mem_node
*m
, void *p
)
4543 if (m
->type
== MEM_TYPE_CONS
)
4545 struct cons_block
*b
= m
->start
;
4546 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4548 /* P must point to the start of a Lisp_Cons, not be
4549 one of the unused cells in the current cons block,
4550 and not be on the free-list. */
4552 && offset
% sizeof b
->conses
[0] == 0
4553 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4555 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4556 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
4563 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4564 the heap. M is a pointer to the mem_block for P. */
4567 live_symbol_p (struct mem_node
*m
, void *p
)
4569 if (m
->type
== MEM_TYPE_SYMBOL
)
4571 struct symbol_block
*b
= m
->start
;
4572 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4574 /* P must point to the start of a Lisp_Symbol, not be
4575 one of the unused cells in the current symbol block,
4576 and not be on the free-list. */
4578 && offset
% sizeof b
->symbols
[0] == 0
4579 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4580 && (b
!= symbol_block
4581 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4582 && !EQ (((struct Lisp_Symbol
*)p
)->function
, Vdead
));
4589 /* Value is non-zero if P is a pointer to a live Lisp float on
4590 the heap. M is a pointer to the mem_block for P. */
4593 live_float_p (struct mem_node
*m
, void *p
)
4595 if (m
->type
== MEM_TYPE_FLOAT
)
4597 struct float_block
*b
= m
->start
;
4598 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4600 /* P must point to the start of a Lisp_Float and not be
4601 one of the unused cells in the current float block. */
4603 && offset
% sizeof b
->floats
[0] == 0
4604 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4605 && (b
!= float_block
4606 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4613 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4614 the heap. M is a pointer to the mem_block for P. */
4617 live_misc_p (struct mem_node
*m
, void *p
)
4619 if (m
->type
== MEM_TYPE_MISC
)
4621 struct marker_block
*b
= m
->start
;
4622 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4624 /* P must point to the start of a Lisp_Misc, not be
4625 one of the unused cells in the current misc block,
4626 and not be on the free-list. */
4628 && offset
% sizeof b
->markers
[0] == 0
4629 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4630 && (b
!= marker_block
4631 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4632 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4639 /* Value is non-zero if P is a pointer to a live vector-like object.
4640 M is a pointer to the mem_block for P. */
4643 live_vector_p (struct mem_node
*m
, void *p
)
4645 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4647 /* This memory node corresponds to a vector block. */
4648 struct vector_block
*block
= m
->start
;
4649 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4651 /* P is in the block's allocation range. Scan the block
4652 up to P and see whether P points to the start of some
4653 vector which is not on a free list. FIXME: check whether
4654 some allocation patterns (probably a lot of short vectors)
4655 may cause a substantial overhead of this loop. */
4656 while (VECTOR_IN_BLOCK (vector
, block
)
4657 && vector
<= (struct Lisp_Vector
*) p
)
4659 if (!PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
) && vector
== p
)
4662 vector
= ADVANCE (vector
, vector_nbytes (vector
));
4665 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== large_vector_vec (m
->start
))
4666 /* This memory node corresponds to a large vector. */
4672 /* Value is non-zero if P is a pointer to a live buffer. M is a
4673 pointer to the mem_block for P. */
4676 live_buffer_p (struct mem_node
*m
, void *p
)
4678 /* P must point to the start of the block, and the buffer
4679 must not have been killed. */
4680 return (m
->type
== MEM_TYPE_BUFFER
4682 && !NILP (((struct buffer
*) p
)->name_
));
4685 /* Mark OBJ if we can prove it's a Lisp_Object. */
4688 mark_maybe_object (Lisp_Object obj
)
4692 VALGRIND_MAKE_MEM_DEFINED (&obj
, sizeof (obj
));
4698 void *po
= XPNTR (obj
);
4699 struct mem_node
*m
= mem_find (po
);
4703 bool mark_p
= false;
4705 switch (XTYPE (obj
))
4708 mark_p
= (live_string_p (m
, po
)
4709 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4713 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4717 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4721 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4724 case Lisp_Vectorlike
:
4725 /* Note: can't check BUFFERP before we know it's a
4726 buffer because checking that dereferences the pointer
4727 PO which might point anywhere. */
4728 if (live_vector_p (m
, po
))
4729 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4730 else if (live_buffer_p (m
, po
))
4731 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4735 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4747 /* Return true if P can point to Lisp data, and false otherwise.
4748 Symbols are implemented via offsets not pointers, but the offsets
4749 are also multiples of GCALIGNMENT. */
4752 maybe_lisp_pointer (void *p
)
4754 return (uintptr_t) p
% GCALIGNMENT
== 0;
4757 #ifndef HAVE_MODULES
4758 enum { HAVE_MODULES
= false };
4761 /* If P points to Lisp data, mark that as live if it isn't already
4765 mark_maybe_pointer (void *p
)
4771 VALGRIND_MAKE_MEM_DEFINED (&p
, sizeof (p
));
4774 if (sizeof (Lisp_Object
) == sizeof (void *) || !HAVE_MODULES
)
4776 if (!maybe_lisp_pointer (p
))
4781 /* For the wide-int case, also mark emacs_value tagged pointers,
4782 which can be generated by emacs-module.c's value_to_lisp. */
4783 p
= (void *) ((uintptr_t) p
& ~(GCALIGNMENT
- 1));
4789 Lisp_Object obj
= Qnil
;
4793 case MEM_TYPE_NON_LISP
:
4794 case MEM_TYPE_SPARE
:
4795 /* Nothing to do; not a pointer to Lisp memory. */
4798 case MEM_TYPE_BUFFER
:
4799 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4800 XSETVECTOR (obj
, p
);
4804 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4808 case MEM_TYPE_STRING
:
4809 if (live_string_p (m
, p
)
4810 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4811 XSETSTRING (obj
, p
);
4815 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4819 case MEM_TYPE_SYMBOL
:
4820 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4821 XSETSYMBOL (obj
, p
);
4824 case MEM_TYPE_FLOAT
:
4825 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4829 case MEM_TYPE_VECTORLIKE
:
4830 case MEM_TYPE_VECTOR_BLOCK
:
4831 if (live_vector_p (m
, p
))
4834 XSETVECTOR (tem
, p
);
4835 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4850 /* Alignment of pointer values. Use alignof, as it sometimes returns
4851 a smaller alignment than GCC's __alignof__ and mark_memory might
4852 miss objects if __alignof__ were used. */
4853 #define GC_POINTER_ALIGNMENT alignof (void *)
4855 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4856 or END+OFFSET..START. */
4858 static void ATTRIBUTE_NO_SANITIZE_ADDRESS
4859 mark_memory (void *start
, void *end
)
4863 /* Make START the pointer to the start of the memory region,
4864 if it isn't already. */
4872 eassert (((uintptr_t) start
) % GC_POINTER_ALIGNMENT
== 0);
4874 /* Mark Lisp data pointed to. This is necessary because, in some
4875 situations, the C compiler optimizes Lisp objects away, so that
4876 only a pointer to them remains. Example:
4878 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4881 Lisp_Object obj = build_string ("test");
4882 struct Lisp_String *s = XSTRING (obj);
4883 Fgarbage_collect ();
4884 fprintf (stderr, "test '%s'\n", s->data);
4888 Here, `obj' isn't really used, and the compiler optimizes it
4889 away. The only reference to the life string is through the
4892 for (pp
= start
; (void *) pp
< end
; pp
+= GC_POINTER_ALIGNMENT
)
4894 mark_maybe_pointer (*(void **) pp
);
4895 mark_maybe_object (*(Lisp_Object
*) pp
);
4899 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4901 static bool setjmp_tested_p
;
4902 static int longjmps_done
;
4904 #define SETJMP_WILL_LIKELY_WORK "\
4906 Emacs garbage collector has been changed to use conservative stack\n\
4907 marking. Emacs has determined that the method it uses to do the\n\
4908 marking will likely work on your system, but this isn't sure.\n\
4910 If you are a system-programmer, or can get the help of a local wizard\n\
4911 who is, please take a look at the function mark_stack in alloc.c, and\n\
4912 verify that the methods used are appropriate for your system.\n\
4914 Please mail the result to <emacs-devel@gnu.org>.\n\
4917 #define SETJMP_WILL_NOT_WORK "\
4919 Emacs garbage collector has been changed to use conservative stack\n\
4920 marking. Emacs has determined that the default method it uses to do the\n\
4921 marking will not work on your system. We will need a system-dependent\n\
4922 solution for your system.\n\
4924 Please take a look at the function mark_stack in alloc.c, and\n\
4925 try to find a way to make it work on your system.\n\
4927 Note that you may get false negatives, depending on the compiler.\n\
4928 In particular, you need to use -O with GCC for this test.\n\
4930 Please mail the result to <emacs-devel@gnu.org>.\n\
4934 /* Perform a quick check if it looks like setjmp saves registers in a
4935 jmp_buf. Print a message to stderr saying so. When this test
4936 succeeds, this is _not_ a proof that setjmp is sufficient for
4937 conservative stack marking. Only the sources or a disassembly
4947 /* Arrange for X to be put in a register. */
4953 if (longjmps_done
== 1)
4955 /* Came here after the longjmp at the end of the function.
4957 If x == 1, the longjmp has restored the register to its
4958 value before the setjmp, and we can hope that setjmp
4959 saves all such registers in the jmp_buf, although that
4962 For other values of X, either something really strange is
4963 taking place, or the setjmp just didn't save the register. */
4966 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4969 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4976 if (longjmps_done
== 1)
4977 sys_longjmp (jbuf
, 1);
4980 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4983 /* Mark live Lisp objects on the C stack.
4985 There are several system-dependent problems to consider when
4986 porting this to new architectures:
4990 We have to mark Lisp objects in CPU registers that can hold local
4991 variables or are used to pass parameters.
4993 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4994 something that either saves relevant registers on the stack, or
4995 calls mark_maybe_object passing it each register's contents.
4997 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4998 implementation assumes that calling setjmp saves registers we need
4999 to see in a jmp_buf which itself lies on the stack. This doesn't
5000 have to be true! It must be verified for each system, possibly
5001 by taking a look at the source code of setjmp.
5003 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
5004 can use it as a machine independent method to store all registers
5005 to the stack. In this case the macros described in the previous
5006 two paragraphs are not used.
5010 Architectures differ in the way their processor stack is organized.
5011 For example, the stack might look like this
5014 | Lisp_Object | size = 4
5016 | something else | size = 2
5018 | Lisp_Object | size = 4
5022 In such a case, not every Lisp_Object will be aligned equally. To
5023 find all Lisp_Object on the stack it won't be sufficient to walk
5024 the stack in steps of 4 bytes. Instead, two passes will be
5025 necessary, one starting at the start of the stack, and a second
5026 pass starting at the start of the stack + 2. Likewise, if the
5027 minimal alignment of Lisp_Objects on the stack is 1, four passes
5028 would be necessary, each one starting with one byte more offset
5029 from the stack start. */
5032 mark_stack (void *end
)
5035 /* This assumes that the stack is a contiguous region in memory. If
5036 that's not the case, something has to be done here to iterate
5037 over the stack segments. */
5038 mark_memory (stack_base
, end
);
5040 /* Allow for marking a secondary stack, like the register stack on the
5042 #ifdef GC_MARK_SECONDARY_STACK
5043 GC_MARK_SECONDARY_STACK ();
5048 c_symbol_p (struct Lisp_Symbol
*sym
)
5050 char *lispsym_ptr
= (char *) lispsym
;
5051 char *sym_ptr
= (char *) sym
;
5052 ptrdiff_t lispsym_offset
= sym_ptr
- lispsym_ptr
;
5053 return 0 <= lispsym_offset
&& lispsym_offset
< sizeof lispsym
;
5056 /* Determine whether it is safe to access memory at address P. */
5058 valid_pointer_p (void *p
)
5061 return w32_valid_pointer_p (p
, 16);
5064 if (ADDRESS_SANITIZER
)
5069 /* Obviously, we cannot just access it (we would SEGV trying), so we
5070 trick the o/s to tell us whether p is a valid pointer.
5071 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
5072 not validate p in that case. */
5074 if (emacs_pipe (fd
) == 0)
5076 bool valid
= emacs_write (fd
[1], p
, 16) == 16;
5077 emacs_close (fd
[1]);
5078 emacs_close (fd
[0]);
5086 /* Return 2 if OBJ is a killed or special buffer object, 1 if OBJ is a
5087 valid lisp object, 0 if OBJ is NOT a valid lisp object, or -1 if we
5088 cannot validate OBJ. This function can be quite slow, so its primary
5089 use is the manual debugging. The only exception is print_object, where
5090 we use it to check whether the memory referenced by the pointer of
5091 Lisp_Save_Value object contains valid objects. */
5094 valid_lisp_object_p (Lisp_Object obj
)
5099 void *p
= XPNTR (obj
);
5103 if (SYMBOLP (obj
) && c_symbol_p (p
))
5104 return ((char *) p
- (char *) lispsym
) % sizeof lispsym
[0] == 0;
5106 if (p
== &buffer_defaults
|| p
== &buffer_local_symbols
)
5109 struct mem_node
*m
= mem_find (p
);
5113 int valid
= valid_pointer_p (p
);
5125 case MEM_TYPE_NON_LISP
:
5126 case MEM_TYPE_SPARE
:
5129 case MEM_TYPE_BUFFER
:
5130 return live_buffer_p (m
, p
) ? 1 : 2;
5133 return live_cons_p (m
, p
);
5135 case MEM_TYPE_STRING
:
5136 return live_string_p (m
, p
);
5139 return live_misc_p (m
, p
);
5141 case MEM_TYPE_SYMBOL
:
5142 return live_symbol_p (m
, p
);
5144 case MEM_TYPE_FLOAT
:
5145 return live_float_p (m
, p
);
5147 case MEM_TYPE_VECTORLIKE
:
5148 case MEM_TYPE_VECTOR_BLOCK
:
5149 return live_vector_p (m
, p
);
5158 /***********************************************************************
5159 Pure Storage Management
5160 ***********************************************************************/
5162 /* Allocate room for SIZE bytes from pure Lisp storage and return a
5163 pointer to it. TYPE is the Lisp type for which the memory is
5164 allocated. TYPE < 0 means it's not used for a Lisp object. */
5167 pure_alloc (size_t size
, int type
)
5174 /* Allocate space for a Lisp object from the beginning of the free
5175 space with taking account of alignment. */
5176 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, GCALIGNMENT
);
5177 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
5181 /* Allocate space for a non-Lisp object from the end of the free
5183 pure_bytes_used_non_lisp
+= size
;
5184 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5186 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
5188 if (pure_bytes_used
<= pure_size
)
5191 /* Don't allocate a large amount here,
5192 because it might get mmap'd and then its address
5193 might not be usable. */
5194 purebeg
= xmalloc (10000);
5196 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
5197 pure_bytes_used
= 0;
5198 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
5203 /* Print a warning if PURESIZE is too small. */
5206 check_pure_size (void)
5208 if (pure_bytes_used_before_overflow
)
5209 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
5211 pure_bytes_used
+ pure_bytes_used_before_overflow
);
5215 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
5216 the non-Lisp data pool of the pure storage, and return its start
5217 address. Return NULL if not found. */
5220 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5223 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5224 const unsigned char *p
;
5227 if (pure_bytes_used_non_lisp
<= nbytes
)
5230 /* Set up the Boyer-Moore table. */
5232 for (i
= 0; i
< 256; i
++)
5235 p
= (const unsigned char *) data
;
5237 bm_skip
[*p
++] = skip
;
5239 last_char_skip
= bm_skip
['\0'];
5241 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5242 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5244 /* See the comments in the function `boyer_moore' (search.c) for the
5245 use of `infinity'. */
5246 infinity
= pure_bytes_used_non_lisp
+ 1;
5247 bm_skip
['\0'] = infinity
;
5249 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5253 /* Check the last character (== '\0'). */
5256 start
+= bm_skip
[*(p
+ start
)];
5258 while (start
<= start_max
);
5260 if (start
< infinity
)
5261 /* Couldn't find the last character. */
5264 /* No less than `infinity' means we could find the last
5265 character at `p[start - infinity]'. */
5268 /* Check the remaining characters. */
5269 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5271 return non_lisp_beg
+ start
;
5273 start
+= last_char_skip
;
5275 while (start
<= start_max
);
5281 /* Return a string allocated in pure space. DATA is a buffer holding
5282 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5283 means make the result string multibyte.
5285 Must get an error if pure storage is full, since if it cannot hold
5286 a large string it may be able to hold conses that point to that
5287 string; then the string is not protected from gc. */
5290 make_pure_string (const char *data
,
5291 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
5294 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5295 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5296 if (s
->data
== NULL
)
5298 s
->data
= pure_alloc (nbytes
+ 1, -1);
5299 memcpy (s
->data
, data
, nbytes
);
5300 s
->data
[nbytes
] = '\0';
5303 s
->size_byte
= multibyte
? nbytes
: -1;
5304 s
->intervals
= NULL
;
5305 XSETSTRING (string
, s
);
5309 /* Return a string allocated in pure space. Do not
5310 allocate the string data, just point to DATA. */
5313 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5316 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5319 s
->data
= (unsigned char *) data
;
5320 s
->intervals
= NULL
;
5321 XSETSTRING (string
, s
);
5325 static Lisp_Object
purecopy (Lisp_Object obj
);
5327 /* Return a cons allocated from pure space. Give it pure copies
5328 of CAR as car and CDR as cdr. */
5331 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5334 struct Lisp_Cons
*p
= pure_alloc (sizeof *p
, Lisp_Cons
);
5336 XSETCAR (new, purecopy (car
));
5337 XSETCDR (new, purecopy (cdr
));
5342 /* Value is a float object with value NUM allocated from pure space. */
5345 make_pure_float (double num
)
5348 struct Lisp_Float
*p
= pure_alloc (sizeof *p
, Lisp_Float
);
5350 XFLOAT_INIT (new, num
);
5355 /* Return a vector with room for LEN Lisp_Objects allocated from
5359 make_pure_vector (ptrdiff_t len
)
5362 size_t size
= header_size
+ len
* word_size
;
5363 struct Lisp_Vector
*p
= pure_alloc (size
, Lisp_Vectorlike
);
5364 XSETVECTOR (new, p
);
5365 XVECTOR (new)->header
.size
= len
;
5369 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5370 doc
: /* Make a copy of object OBJ in pure storage.
5371 Recursively copies contents of vectors and cons cells.
5372 Does not copy symbols. Copies strings without text properties. */)
5373 (register Lisp_Object obj
)
5375 if (NILP (Vpurify_flag
))
5377 else if (MARKERP (obj
) || OVERLAYP (obj
)
5378 || HASH_TABLE_P (obj
) || SYMBOLP (obj
))
5379 /* Can't purify those. */
5382 return purecopy (obj
);
5386 purecopy (Lisp_Object obj
)
5389 || (! SYMBOLP (obj
) && PURE_P (XPNTR_OR_SYMBOL_OFFSET (obj
)))
5391 return obj
; /* Already pure. */
5393 if (STRINGP (obj
) && XSTRING (obj
)->intervals
)
5394 message_with_string ("Dropping text-properties while making string `%s' pure",
5397 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5399 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5405 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5406 else if (FLOATP (obj
))
5407 obj
= make_pure_float (XFLOAT_DATA (obj
));
5408 else if (STRINGP (obj
))
5409 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5411 STRING_MULTIBYTE (obj
));
5412 else if (COMPILEDP (obj
) || VECTORP (obj
) || HASH_TABLE_P (obj
))
5414 struct Lisp_Vector
*objp
= XVECTOR (obj
);
5415 ptrdiff_t nbytes
= vector_nbytes (objp
);
5416 struct Lisp_Vector
*vec
= pure_alloc (nbytes
, Lisp_Vectorlike
);
5417 register ptrdiff_t i
;
5418 ptrdiff_t size
= ASIZE (obj
);
5419 if (size
& PSEUDOVECTOR_FLAG
)
5420 size
&= PSEUDOVECTOR_SIZE_MASK
;
5421 memcpy (vec
, objp
, nbytes
);
5422 for (i
= 0; i
< size
; i
++)
5423 vec
->contents
[i
] = purecopy (vec
->contents
[i
]);
5424 XSETVECTOR (obj
, vec
);
5426 else if (SYMBOLP (obj
))
5428 if (!XSYMBOL (obj
)->pinned
&& !c_symbol_p (XSYMBOL (obj
)))
5429 { /* We can't purify them, but they appear in many pure objects.
5430 Mark them as `pinned' so we know to mark them at every GC cycle. */
5431 XSYMBOL (obj
)->pinned
= true;
5432 symbol_block_pinned
= symbol_block
;
5434 /* Don't hash-cons it. */
5439 Lisp_Object fmt
= build_pure_c_string ("Don't know how to purify: %S");
5440 Fsignal (Qerror
, list1 (CALLN (Fformat
, fmt
, obj
)));
5443 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5444 Fputhash (obj
, obj
, Vpurify_flag
);
5451 /***********************************************************************
5453 ***********************************************************************/
5455 /* Put an entry in staticvec, pointing at the variable with address
5459 staticpro (Lisp_Object
*varaddress
)
5461 if (staticidx
>= NSTATICS
)
5462 fatal ("NSTATICS too small; try increasing and recompiling Emacs.");
5463 staticvec
[staticidx
++] = varaddress
;
5467 /***********************************************************************
5469 ***********************************************************************/
5471 /* Temporarily prevent garbage collection. */
5474 inhibit_garbage_collection (void)
5476 ptrdiff_t count
= SPECPDL_INDEX ();
5478 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5482 /* Used to avoid possible overflows when
5483 converting from C to Lisp integers. */
5486 bounded_number (EMACS_INT number
)
5488 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5491 /* Calculate total bytes of live objects. */
5494 total_bytes_of_live_objects (void)
5497 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5498 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5499 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5500 tot
+= total_string_bytes
;
5501 tot
+= total_vector_slots
* word_size
;
5502 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5503 tot
+= total_intervals
* sizeof (struct interval
);
5504 tot
+= total_strings
* sizeof (struct Lisp_String
);
5508 #ifdef HAVE_WINDOW_SYSTEM
5510 /* Remove unmarked font-spec and font-entity objects from ENTRY, which is
5511 (DRIVER-TYPE NUM-FRAMES FONT-CACHE-DATA ...), and return changed entry. */
5514 compact_font_cache_entry (Lisp_Object entry
)
5516 Lisp_Object tail
, *prev
= &entry
;
5518 for (tail
= entry
; CONSP (tail
); tail
= XCDR (tail
))
5521 Lisp_Object obj
= XCAR (tail
);
5523 /* Consider OBJ if it is (font-spec . [font-entity font-entity ...]). */
5524 if (CONSP (obj
) && GC_FONT_SPEC_P (XCAR (obj
))
5525 && !VECTOR_MARKED_P (GC_XFONT_SPEC (XCAR (obj
)))
5526 /* Don't use VECTORP here, as that calls ASIZE, which could
5527 hit assertion violation during GC. */
5528 && (VECTORLIKEP (XCDR (obj
))
5529 && ! (gc_asize (XCDR (obj
)) & PSEUDOVECTOR_FLAG
)))
5531 ptrdiff_t i
, size
= gc_asize (XCDR (obj
));
5532 Lisp_Object obj_cdr
= XCDR (obj
);
5534 /* If font-spec is not marked, most likely all font-entities
5535 are not marked too. But we must be sure that nothing is
5536 marked within OBJ before we really drop it. */
5537 for (i
= 0; i
< size
; i
++)
5539 Lisp_Object objlist
;
5541 if (VECTOR_MARKED_P (GC_XFONT_ENTITY (AREF (obj_cdr
, i
))))
5544 objlist
= AREF (AREF (obj_cdr
, i
), FONT_OBJLIST_INDEX
);
5545 for (; CONSP (objlist
); objlist
= XCDR (objlist
))
5547 Lisp_Object val
= XCAR (objlist
);
5548 struct font
*font
= GC_XFONT_OBJECT (val
);
5550 if (!NILP (AREF (val
, FONT_TYPE_INDEX
))
5551 && VECTOR_MARKED_P(font
))
5554 if (CONSP (objlist
))
5556 /* Found a marked font, bail out. */
5563 /* No marked fonts were found, so this entire font
5564 entity can be dropped. */
5569 *prev
= XCDR (tail
);
5571 prev
= xcdr_addr (tail
);
5576 /* Compact font caches on all terminals and mark
5577 everything which is still here after compaction. */
5580 compact_font_caches (void)
5584 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5586 Lisp_Object cache
= TERMINAL_FONT_CACHE (t
);
5587 /* Inhibit compacting the caches if the user so wishes. Some of
5588 the users don't mind a larger memory footprint, but do mind
5589 slower redisplay. */
5590 if (!inhibit_compacting_font_caches
5595 for (entry
= XCDR (cache
); CONSP (entry
); entry
= XCDR (entry
))
5596 XSETCAR (entry
, compact_font_cache_entry (XCAR (entry
)));
5598 mark_object (cache
);
5602 #else /* not HAVE_WINDOW_SYSTEM */
5604 #define compact_font_caches() (void)(0)
5606 #endif /* HAVE_WINDOW_SYSTEM */
5608 /* Remove (MARKER . DATA) entries with unmarked MARKER
5609 from buffer undo LIST and return changed list. */
5612 compact_undo_list (Lisp_Object list
)
5614 Lisp_Object tail
, *prev
= &list
;
5616 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
5618 if (CONSP (XCAR (tail
))
5619 && MARKERP (XCAR (XCAR (tail
)))
5620 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5621 *prev
= XCDR (tail
);
5623 prev
= xcdr_addr (tail
);
5629 mark_pinned_symbols (void)
5631 struct symbol_block
*sblk
;
5632 int lim
= (symbol_block_pinned
== symbol_block
5633 ? symbol_block_index
: SYMBOL_BLOCK_SIZE
);
5635 for (sblk
= symbol_block_pinned
; sblk
; sblk
= sblk
->next
)
5637 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
, *end
= sym
+ lim
;
5638 for (; sym
< end
; ++sym
)
5640 mark_object (make_lisp_symbol (&sym
->s
));
5642 lim
= SYMBOL_BLOCK_SIZE
;
5646 /* Subroutine of Fgarbage_collect that does most of the work. It is a
5647 separate function so that we could limit mark_stack in searching
5648 the stack frames below this function, thus avoiding the rare cases
5649 where mark_stack finds values that look like live Lisp objects on
5650 portions of stack that couldn't possibly contain such live objects.
5651 For more details of this, see the discussion at
5652 http://lists.gnu.org/archive/html/emacs-devel/2014-05/msg00270.html. */
5654 garbage_collect_1 (void *end
)
5656 struct buffer
*nextb
;
5657 char stack_top_variable
;
5660 ptrdiff_t count
= SPECPDL_INDEX ();
5661 struct timespec start
;
5662 Lisp_Object retval
= Qnil
;
5663 size_t tot_before
= 0;
5668 /* Can't GC if pure storage overflowed because we can't determine
5669 if something is a pure object or not. */
5670 if (pure_bytes_used_before_overflow
)
5673 /* Record this function, so it appears on the profiler's backtraces. */
5674 record_in_backtrace (Qautomatic_gc
, 0, 0);
5678 /* Don't keep undo information around forever.
5679 Do this early on, so it is no problem if the user quits. */
5680 FOR_EACH_BUFFER (nextb
)
5681 compact_buffer (nextb
);
5683 if (profiler_memory_running
)
5684 tot_before
= total_bytes_of_live_objects ();
5686 start
= current_timespec ();
5688 /* In case user calls debug_print during GC,
5689 don't let that cause a recursive GC. */
5690 consing_since_gc
= 0;
5692 /* Save what's currently displayed in the echo area. Don't do that
5693 if we are GC'ing because we've run out of memory, since
5694 push_message will cons, and we might have no memory for that. */
5695 if (NILP (Vmemory_full
))
5697 message_p
= push_message ();
5698 record_unwind_protect_void (pop_message_unwind
);
5703 /* Save a copy of the contents of the stack, for debugging. */
5704 #if MAX_SAVE_STACK > 0
5705 if (NILP (Vpurify_flag
))
5708 ptrdiff_t stack_size
;
5709 if (&stack_top_variable
< stack_bottom
)
5711 stack
= &stack_top_variable
;
5712 stack_size
= stack_bottom
- &stack_top_variable
;
5716 stack
= stack_bottom
;
5717 stack_size
= &stack_top_variable
- stack_bottom
;
5719 if (stack_size
<= MAX_SAVE_STACK
)
5721 if (stack_copy_size
< stack_size
)
5723 stack_copy
= xrealloc (stack_copy
, stack_size
);
5724 stack_copy_size
= stack_size
;
5726 no_sanitize_memcpy (stack_copy
, stack
, stack_size
);
5729 #endif /* MAX_SAVE_STACK > 0 */
5731 if (garbage_collection_messages
)
5732 message1_nolog ("Garbage collecting...");
5736 shrink_regexp_cache ();
5740 /* Mark all the special slots that serve as the roots of accessibility. */
5742 mark_buffer (&buffer_defaults
);
5743 mark_buffer (&buffer_local_symbols
);
5745 for (i
= 0; i
< ARRAYELTS (lispsym
); i
++)
5746 mark_object (builtin_lisp_symbol (i
));
5748 for (i
= 0; i
< staticidx
; i
++)
5749 mark_object (*staticvec
[i
]);
5751 mark_pinned_symbols ();
5763 struct handler
*handler
;
5764 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5766 mark_object (handler
->tag_or_ch
);
5767 mark_object (handler
->val
);
5770 #ifdef HAVE_WINDOW_SYSTEM
5771 mark_fringe_data ();
5774 /* Everything is now marked, except for the data in font caches,
5775 undo lists, and finalizers. The first two are compacted by
5776 removing an items which aren't reachable otherwise. */
5778 compact_font_caches ();
5780 FOR_EACH_BUFFER (nextb
)
5782 if (!EQ (BVAR (nextb
, undo_list
), Qt
))
5783 bset_undo_list (nextb
, compact_undo_list (BVAR (nextb
, undo_list
)));
5784 /* Now that we have stripped the elements that need not be
5785 in the undo_list any more, we can finally mark the list. */
5786 mark_object (BVAR (nextb
, undo_list
));
5789 /* Now pre-sweep finalizers. Here, we add any unmarked finalizers
5790 to doomed_finalizers so we can run their associated functions
5791 after GC. It's important to scan finalizers at this stage so
5792 that we can be sure that unmarked finalizers are really
5793 unreachable except for references from their associated functions
5794 and from other finalizers. */
5796 queue_doomed_finalizers (&doomed_finalizers
, &finalizers
);
5797 mark_finalizer_list (&doomed_finalizers
);
5801 relocate_byte_stack ();
5803 /* Clear the mark bits that we set in certain root slots. */
5804 VECTOR_UNMARK (&buffer_defaults
);
5805 VECTOR_UNMARK (&buffer_local_symbols
);
5813 consing_since_gc
= 0;
5814 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
5815 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
5817 gc_relative_threshold
= 0;
5818 if (FLOATP (Vgc_cons_percentage
))
5819 { /* Set gc_cons_combined_threshold. */
5820 double tot
= total_bytes_of_live_objects ();
5822 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5825 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5826 gc_relative_threshold
= tot
;
5828 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5832 if (garbage_collection_messages
&& NILP (Vmemory_full
))
5834 if (message_p
|| minibuf_level
> 0)
5837 message1_nolog ("Garbage collecting...done");
5840 unbind_to (count
, Qnil
);
5842 Lisp_Object total
[] = {
5843 list4 (Qconses
, make_number (sizeof (struct Lisp_Cons
)),
5844 bounded_number (total_conses
),
5845 bounded_number (total_free_conses
)),
5846 list4 (Qsymbols
, make_number (sizeof (struct Lisp_Symbol
)),
5847 bounded_number (total_symbols
),
5848 bounded_number (total_free_symbols
)),
5849 list4 (Qmiscs
, make_number (sizeof (union Lisp_Misc
)),
5850 bounded_number (total_markers
),
5851 bounded_number (total_free_markers
)),
5852 list4 (Qstrings
, make_number (sizeof (struct Lisp_String
)),
5853 bounded_number (total_strings
),
5854 bounded_number (total_free_strings
)),
5855 list3 (Qstring_bytes
, make_number (1),
5856 bounded_number (total_string_bytes
)),
5858 make_number (header_size
+ sizeof (Lisp_Object
)),
5859 bounded_number (total_vectors
)),
5860 list4 (Qvector_slots
, make_number (word_size
),
5861 bounded_number (total_vector_slots
),
5862 bounded_number (total_free_vector_slots
)),
5863 list4 (Qfloats
, make_number (sizeof (struct Lisp_Float
)),
5864 bounded_number (total_floats
),
5865 bounded_number (total_free_floats
)),
5866 list4 (Qintervals
, make_number (sizeof (struct interval
)),
5867 bounded_number (total_intervals
),
5868 bounded_number (total_free_intervals
)),
5869 list3 (Qbuffers
, make_number (sizeof (struct buffer
)),
5870 bounded_number (total_buffers
)),
5872 #ifdef DOUG_LEA_MALLOC
5873 list4 (Qheap
, make_number (1024),
5874 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
5875 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10)),
5878 retval
= CALLMANY (Flist
, total
);
5880 /* GC is complete: now we can run our finalizer callbacks. */
5881 run_finalizers (&doomed_finalizers
);
5883 if (!NILP (Vpost_gc_hook
))
5885 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5886 safe_run_hooks (Qpost_gc_hook
);
5887 unbind_to (gc_count
, Qnil
);
5890 /* Accumulate statistics. */
5891 if (FLOATP (Vgc_elapsed
))
5893 struct timespec since_start
= timespec_sub (current_timespec (), start
);
5894 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5895 + timespectod (since_start
));
5900 /* Collect profiling data. */
5901 if (profiler_memory_running
)
5904 size_t tot_after
= total_bytes_of_live_objects ();
5905 if (tot_before
> tot_after
)
5906 swept
= tot_before
- tot_after
;
5907 malloc_probe (swept
);
5913 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5914 doc
: /* Reclaim storage for Lisp objects no longer needed.
5915 Garbage collection happens automatically if you cons more than
5916 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5917 `garbage-collect' normally returns a list with info on amount of space in use,
5918 where each entry has the form (NAME SIZE USED FREE), where:
5919 - NAME is a symbol describing the kind of objects this entry represents,
5920 - SIZE is the number of bytes used by each one,
5921 - USED is the number of those objects that were found live in the heap,
5922 - FREE is the number of those objects that are not live but that Emacs
5923 keeps around for future allocations (maybe because it does not know how
5924 to return them to the OS).
5925 However, if there was overflow in pure space, `garbage-collect'
5926 returns nil, because real GC can't be done.
5927 See Info node `(elisp)Garbage Collection'. */)
5932 #ifdef HAVE___BUILTIN_UNWIND_INIT
5933 /* Force callee-saved registers and register windows onto the stack.
5934 This is the preferred method if available, obviating the need for
5935 machine dependent methods. */
5936 __builtin_unwind_init ();
5938 #else /* not HAVE___BUILTIN_UNWIND_INIT */
5939 #ifndef GC_SAVE_REGISTERS_ON_STACK
5940 /* jmp_buf may not be aligned enough on darwin-ppc64 */
5941 union aligned_jmpbuf
{
5945 volatile bool stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
5947 /* This trick flushes the register windows so that all the state of
5948 the process is contained in the stack. */
5949 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
5950 needed on ia64 too. See mach_dep.c, where it also says inline
5951 assembler doesn't work with relevant proprietary compilers. */
5953 #if defined (__sparc64__) && defined (__FreeBSD__)
5954 /* FreeBSD does not have a ta 3 handler. */
5961 /* Save registers that we need to see on the stack. We need to see
5962 registers used to hold register variables and registers used to
5964 #ifdef GC_SAVE_REGISTERS_ON_STACK
5965 GC_SAVE_REGISTERS_ON_STACK (end
);
5966 #else /* not GC_SAVE_REGISTERS_ON_STACK */
5968 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
5969 setjmp will definitely work, test it
5970 and print a message with the result
5972 if (!setjmp_tested_p
)
5974 setjmp_tested_p
= 1;
5977 #endif /* GC_SETJMP_WORKS */
5980 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
5981 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
5982 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
5983 return garbage_collect_1 (end
);
5986 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5987 only interesting objects referenced from glyphs are strings. */
5990 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5992 struct glyph_row
*row
= matrix
->rows
;
5993 struct glyph_row
*end
= row
+ matrix
->nrows
;
5995 for (; row
< end
; ++row
)
5999 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
6001 struct glyph
*glyph
= row
->glyphs
[area
];
6002 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
6004 for (; glyph
< end_glyph
; ++glyph
)
6005 if (STRINGP (glyph
->object
)
6006 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
6007 mark_object (glyph
->object
);
6012 /* Mark reference to a Lisp_Object.
6013 If the object referred to has not been seen yet, recursively mark
6014 all the references contained in it. */
6016 #define LAST_MARKED_SIZE 500
6017 Lisp_Object last_marked
[LAST_MARKED_SIZE
] EXTERNALLY_VISIBLE
;
6018 static int last_marked_index
;
6020 /* For debugging--call abort when we cdr down this many
6021 links of a list, in mark_object. In debugging,
6022 the call to abort will hit a breakpoint.
6023 Normally this is zero and the check never goes off. */
6024 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
6027 mark_vectorlike (struct Lisp_Vector
*ptr
)
6029 ptrdiff_t size
= ptr
->header
.size
;
6032 eassert (!VECTOR_MARKED_P (ptr
));
6033 VECTOR_MARK (ptr
); /* Else mark it. */
6034 if (size
& PSEUDOVECTOR_FLAG
)
6035 size
&= PSEUDOVECTOR_SIZE_MASK
;
6037 /* Note that this size is not the memory-footprint size, but only
6038 the number of Lisp_Object fields that we should trace.
6039 The distinction is used e.g. by Lisp_Process which places extra
6040 non-Lisp_Object fields at the end of the structure... */
6041 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
6042 mark_object (ptr
->contents
[i
]);
6045 /* Like mark_vectorlike but optimized for char-tables (and
6046 sub-char-tables) assuming that the contents are mostly integers or
6050 mark_char_table (struct Lisp_Vector
*ptr
, enum pvec_type pvectype
)
6052 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
6053 /* Consult the Lisp_Sub_Char_Table layout before changing this. */
6054 int i
, idx
= (pvectype
== PVEC_SUB_CHAR_TABLE
? SUB_CHAR_TABLE_OFFSET
: 0);
6056 eassert (!VECTOR_MARKED_P (ptr
));
6058 for (i
= idx
; i
< size
; i
++)
6060 Lisp_Object val
= ptr
->contents
[i
];
6062 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
6064 if (SUB_CHAR_TABLE_P (val
))
6066 if (! VECTOR_MARKED_P (XVECTOR (val
)))
6067 mark_char_table (XVECTOR (val
), PVEC_SUB_CHAR_TABLE
);
6074 NO_INLINE
/* To reduce stack depth in mark_object. */
6076 mark_compiled (struct Lisp_Vector
*ptr
)
6078 int i
, size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
6081 for (i
= 0; i
< size
; i
++)
6082 if (i
!= COMPILED_CONSTANTS
)
6083 mark_object (ptr
->contents
[i
]);
6084 return size
> COMPILED_CONSTANTS
? ptr
->contents
[COMPILED_CONSTANTS
] : Qnil
;
6087 /* Mark the chain of overlays starting at PTR. */
6090 mark_overlay (struct Lisp_Overlay
*ptr
)
6092 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
6095 /* These two are always markers and can be marked fast. */
6096 XMARKER (ptr
->start
)->gcmarkbit
= 1;
6097 XMARKER (ptr
->end
)->gcmarkbit
= 1;
6098 mark_object (ptr
->plist
);
6102 /* Mark Lisp_Objects and special pointers in BUFFER. */
6105 mark_buffer (struct buffer
*buffer
)
6107 /* This is handled much like other pseudovectors... */
6108 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
6110 /* ...but there are some buffer-specific things. */
6112 MARK_INTERVAL_TREE (buffer_intervals (buffer
));
6114 /* For now, we just don't mark the undo_list. It's done later in
6115 a special way just before the sweep phase, and after stripping
6116 some of its elements that are not needed any more. */
6118 mark_overlay (buffer
->overlays_before
);
6119 mark_overlay (buffer
->overlays_after
);
6121 /* If this is an indirect buffer, mark its base buffer. */
6122 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
6123 mark_buffer (buffer
->base_buffer
);
6126 /* Mark Lisp faces in the face cache C. */
6128 NO_INLINE
/* To reduce stack depth in mark_object. */
6130 mark_face_cache (struct face_cache
*c
)
6135 for (i
= 0; i
< c
->used
; ++i
)
6137 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
6141 if (face
->font
&& !VECTOR_MARKED_P (face
->font
))
6142 mark_vectorlike ((struct Lisp_Vector
*) face
->font
);
6144 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
6145 mark_object (face
->lface
[j
]);
6151 NO_INLINE
/* To reduce stack depth in mark_object. */
6153 mark_localized_symbol (struct Lisp_Symbol
*ptr
)
6155 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
6156 Lisp_Object where
= blv
->where
;
6157 /* If the value is set up for a killed buffer or deleted
6158 frame, restore its global binding. If the value is
6159 forwarded to a C variable, either it's not a Lisp_Object
6160 var, or it's staticpro'd already. */
6161 if ((BUFFERP (where
) && !BUFFER_LIVE_P (XBUFFER (where
)))
6162 || (FRAMEP (where
) && !FRAME_LIVE_P (XFRAME (where
))))
6163 swap_in_global_binding (ptr
);
6164 mark_object (blv
->where
);
6165 mark_object (blv
->valcell
);
6166 mark_object (blv
->defcell
);
6169 NO_INLINE
/* To reduce stack depth in mark_object. */
6171 mark_save_value (struct Lisp_Save_Value
*ptr
)
6173 /* If `save_type' is zero, `data[0].pointer' is the address
6174 of a memory area containing `data[1].integer' potential
6176 if (ptr
->save_type
== SAVE_TYPE_MEMORY
)
6178 Lisp_Object
*p
= ptr
->data
[0].pointer
;
6180 for (nelt
= ptr
->data
[1].integer
; nelt
> 0; nelt
--, p
++)
6181 mark_maybe_object (*p
);
6185 /* Find Lisp_Objects in `data[N]' slots and mark them. */
6187 for (i
= 0; i
< SAVE_VALUE_SLOTS
; i
++)
6188 if (save_type (ptr
, i
) == SAVE_OBJECT
)
6189 mark_object (ptr
->data
[i
].object
);
6193 /* Remove killed buffers or items whose car is a killed buffer from
6194 LIST, and mark other items. Return changed LIST, which is marked. */
6197 mark_discard_killed_buffers (Lisp_Object list
)
6199 Lisp_Object tail
, *prev
= &list
;
6201 for (tail
= list
; CONSP (tail
) && !CONS_MARKED_P (XCONS (tail
));
6204 Lisp_Object tem
= XCAR (tail
);
6207 if (BUFFERP (tem
) && !BUFFER_LIVE_P (XBUFFER (tem
)))
6208 *prev
= XCDR (tail
);
6211 CONS_MARK (XCONS (tail
));
6212 mark_object (XCAR (tail
));
6213 prev
= xcdr_addr (tail
);
6220 /* Determine type of generic Lisp_Object and mark it accordingly.
6222 This function implements a straightforward depth-first marking
6223 algorithm and so the recursion depth may be very high (a few
6224 tens of thousands is not uncommon). To minimize stack usage,
6225 a few cold paths are moved out to NO_INLINE functions above.
6226 In general, inlining them doesn't help you to gain more speed. */
6229 mark_object (Lisp_Object arg
)
6231 register Lisp_Object obj
;
6233 #ifdef GC_CHECK_MARKED_OBJECTS
6236 ptrdiff_t cdr_count
= 0;
6245 last_marked
[last_marked_index
++] = obj
;
6246 if (last_marked_index
== LAST_MARKED_SIZE
)
6247 last_marked_index
= 0;
6249 /* Perform some sanity checks on the objects marked here. Abort if
6250 we encounter an object we know is bogus. This increases GC time
6252 #ifdef GC_CHECK_MARKED_OBJECTS
6254 /* Check that the object pointed to by PO is known to be a Lisp
6255 structure allocated from the heap. */
6256 #define CHECK_ALLOCATED() \
6258 m = mem_find (po); \
6263 /* Check that the object pointed to by PO is live, using predicate
6265 #define CHECK_LIVE(LIVEP) \
6267 if (!LIVEP (m, po)) \
6271 /* Check both of the above conditions, for non-symbols. */
6272 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
6274 CHECK_ALLOCATED (); \
6275 CHECK_LIVE (LIVEP); \
6278 /* Check both of the above conditions, for symbols. */
6279 #define CHECK_ALLOCATED_AND_LIVE_SYMBOL() \
6281 if (!c_symbol_p (ptr)) \
6283 CHECK_ALLOCATED (); \
6284 CHECK_LIVE (live_symbol_p); \
6288 #else /* not GC_CHECK_MARKED_OBJECTS */
6290 #define CHECK_LIVE(LIVEP) ((void) 0)
6291 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) ((void) 0)
6292 #define CHECK_ALLOCATED_AND_LIVE_SYMBOL() ((void) 0)
6294 #endif /* not GC_CHECK_MARKED_OBJECTS */
6296 switch (XTYPE (obj
))
6300 register struct Lisp_String
*ptr
= XSTRING (obj
);
6301 if (STRING_MARKED_P (ptr
))
6303 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
6305 MARK_INTERVAL_TREE (ptr
->intervals
);
6306 #ifdef GC_CHECK_STRING_BYTES
6307 /* Check that the string size recorded in the string is the
6308 same as the one recorded in the sdata structure. */
6310 #endif /* GC_CHECK_STRING_BYTES */
6314 case Lisp_Vectorlike
:
6316 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
6317 register ptrdiff_t pvectype
;
6319 if (VECTOR_MARKED_P (ptr
))
6322 #ifdef GC_CHECK_MARKED_OBJECTS
6324 if (m
== MEM_NIL
&& !SUBRP (obj
))
6326 #endif /* GC_CHECK_MARKED_OBJECTS */
6328 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
6329 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
6330 >> PSEUDOVECTOR_AREA_BITS
);
6332 pvectype
= PVEC_NORMAL_VECTOR
;
6334 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
6335 CHECK_LIVE (live_vector_p
);
6340 #ifdef GC_CHECK_MARKED_OBJECTS
6349 #endif /* GC_CHECK_MARKED_OBJECTS */
6350 mark_buffer ((struct buffer
*) ptr
);
6354 /* Although we could treat this just like a vector, mark_compiled
6355 returns the COMPILED_CONSTANTS element, which is marked at the
6356 next iteration of goto-loop here. This is done to avoid a few
6357 recursive calls to mark_object. */
6358 obj
= mark_compiled (ptr
);
6365 struct frame
*f
= (struct frame
*) ptr
;
6367 mark_vectorlike (ptr
);
6368 mark_face_cache (f
->face_cache
);
6369 #ifdef HAVE_WINDOW_SYSTEM
6370 if (FRAME_WINDOW_P (f
) && FRAME_X_OUTPUT (f
))
6372 struct font
*font
= FRAME_FONT (f
);
6374 if (font
&& !VECTOR_MARKED_P (font
))
6375 mark_vectorlike ((struct Lisp_Vector
*) font
);
6383 struct window
*w
= (struct window
*) ptr
;
6385 mark_vectorlike (ptr
);
6387 /* Mark glyph matrices, if any. Marking window
6388 matrices is sufficient because frame matrices
6389 use the same glyph memory. */
6390 if (w
->current_matrix
)
6392 mark_glyph_matrix (w
->current_matrix
);
6393 mark_glyph_matrix (w
->desired_matrix
);
6396 /* Filter out killed buffers from both buffer lists
6397 in attempt to help GC to reclaim killed buffers faster.
6398 We can do it elsewhere for live windows, but this is the
6399 best place to do it for dead windows. */
6401 (w
, mark_discard_killed_buffers (w
->prev_buffers
));
6403 (w
, mark_discard_killed_buffers (w
->next_buffers
));
6407 case PVEC_HASH_TABLE
:
6409 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6411 mark_vectorlike (ptr
);
6412 mark_object (h
->test
.name
);
6413 mark_object (h
->test
.user_hash_function
);
6414 mark_object (h
->test
.user_cmp_function
);
6415 /* If hash table is not weak, mark all keys and values.
6416 For weak tables, mark only the vector. */
6418 mark_object (h
->key_and_value
);
6420 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6424 case PVEC_CHAR_TABLE
:
6425 case PVEC_SUB_CHAR_TABLE
:
6426 mark_char_table (ptr
, (enum pvec_type
) pvectype
);
6429 case PVEC_BOOL_VECTOR
:
6430 /* No Lisp_Objects to mark in a bool vector. */
6441 mark_vectorlike (ptr
);
6448 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6452 CHECK_ALLOCATED_AND_LIVE_SYMBOL ();
6454 /* Attempt to catch bogus objects. */
6455 eassert (valid_lisp_object_p (ptr
->function
));
6456 mark_object (ptr
->function
);
6457 mark_object (ptr
->plist
);
6458 switch (ptr
->redirect
)
6460 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6461 case SYMBOL_VARALIAS
:
6464 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6468 case SYMBOL_LOCALIZED
:
6469 mark_localized_symbol (ptr
);
6471 case SYMBOL_FORWARDED
:
6472 /* If the value is forwarded to a buffer or keyboard field,
6473 these are marked when we see the corresponding object.
6474 And if it's forwarded to a C variable, either it's not
6475 a Lisp_Object var, or it's staticpro'd already. */
6477 default: emacs_abort ();
6479 if (!PURE_P (XSTRING (ptr
->name
)))
6480 MARK_STRING (XSTRING (ptr
->name
));
6481 MARK_INTERVAL_TREE (string_intervals (ptr
->name
));
6482 /* Inner loop to mark next symbol in this bucket, if any. */
6483 po
= ptr
= ptr
->next
;
6490 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6492 if (XMISCANY (obj
)->gcmarkbit
)
6495 switch (XMISCTYPE (obj
))
6497 case Lisp_Misc_Marker
:
6498 /* DO NOT mark thru the marker's chain.
6499 The buffer's markers chain does not preserve markers from gc;
6500 instead, markers are removed from the chain when freed by gc. */
6501 XMISCANY (obj
)->gcmarkbit
= 1;
6504 case Lisp_Misc_Save_Value
:
6505 XMISCANY (obj
)->gcmarkbit
= 1;
6506 mark_save_value (XSAVE_VALUE (obj
));
6509 case Lisp_Misc_Overlay
:
6510 mark_overlay (XOVERLAY (obj
));
6513 case Lisp_Misc_Finalizer
:
6514 XMISCANY (obj
)->gcmarkbit
= true;
6515 mark_object (XFINALIZER (obj
)->function
);
6519 case Lisp_Misc_User_Ptr
:
6520 XMISCANY (obj
)->gcmarkbit
= true;
6531 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6532 if (CONS_MARKED_P (ptr
))
6534 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6536 /* If the cdr is nil, avoid recursion for the car. */
6537 if (EQ (ptr
->u
.cdr
, Qnil
))
6543 mark_object (ptr
->car
);
6546 if (cdr_count
== mark_object_loop_halt
)
6552 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6553 FLOAT_MARK (XFLOAT (obj
));
6564 #undef CHECK_ALLOCATED
6565 #undef CHECK_ALLOCATED_AND_LIVE
6567 /* Mark the Lisp pointers in the terminal objects.
6568 Called by Fgarbage_collect. */
6571 mark_terminals (void)
6574 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6576 eassert (t
->name
!= NULL
);
6577 #ifdef HAVE_WINDOW_SYSTEM
6578 /* If a terminal object is reachable from a stacpro'ed object,
6579 it might have been marked already. Make sure the image cache
6581 mark_image_cache (t
->image_cache
);
6582 #endif /* HAVE_WINDOW_SYSTEM */
6583 if (!VECTOR_MARKED_P (t
))
6584 mark_vectorlike ((struct Lisp_Vector
*)t
);
6590 /* Value is non-zero if OBJ will survive the current GC because it's
6591 either marked or does not need to be marked to survive. */
6594 survives_gc_p (Lisp_Object obj
)
6598 switch (XTYPE (obj
))
6605 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6609 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6613 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6616 case Lisp_Vectorlike
:
6617 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6621 survives_p
= CONS_MARKED_P (XCONS (obj
));
6625 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6632 return survives_p
|| PURE_P (XPNTR (obj
));
6638 NO_INLINE
/* For better stack traces */
6642 struct cons_block
*cblk
;
6643 struct cons_block
**cprev
= &cons_block
;
6644 int lim
= cons_block_index
;
6645 EMACS_INT num_free
= 0, num_used
= 0;
6649 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6653 int ilim
= (lim
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
6655 /* Scan the mark bits an int at a time. */
6656 for (i
= 0; i
< ilim
; i
++)
6658 if (cblk
->gcmarkbits
[i
] == BITS_WORD_MAX
)
6660 /* Fast path - all cons cells for this int are marked. */
6661 cblk
->gcmarkbits
[i
] = 0;
6662 num_used
+= BITS_PER_BITS_WORD
;
6666 /* Some cons cells for this int are not marked.
6667 Find which ones, and free them. */
6668 int start
, pos
, stop
;
6670 start
= i
* BITS_PER_BITS_WORD
;
6672 if (stop
> BITS_PER_BITS_WORD
)
6673 stop
= BITS_PER_BITS_WORD
;
6676 for (pos
= start
; pos
< stop
; pos
++)
6678 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6681 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6682 cons_free_list
= &cblk
->conses
[pos
];
6683 cons_free_list
->car
= Vdead
;
6688 CONS_UNMARK (&cblk
->conses
[pos
]);
6694 lim
= CONS_BLOCK_SIZE
;
6695 /* If this block contains only free conses and we have already
6696 seen more than two blocks worth of free conses then deallocate
6698 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6700 *cprev
= cblk
->next
;
6701 /* Unhook from the free list. */
6702 cons_free_list
= cblk
->conses
[0].u
.chain
;
6703 lisp_align_free (cblk
);
6707 num_free
+= this_free
;
6708 cprev
= &cblk
->next
;
6711 total_conses
= num_used
;
6712 total_free_conses
= num_free
;
6715 NO_INLINE
/* For better stack traces */
6719 register struct float_block
*fblk
;
6720 struct float_block
**fprev
= &float_block
;
6721 register int lim
= float_block_index
;
6722 EMACS_INT num_free
= 0, num_used
= 0;
6724 float_free_list
= 0;
6726 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6730 for (i
= 0; i
< lim
; i
++)
6731 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6734 fblk
->floats
[i
].u
.chain
= float_free_list
;
6735 float_free_list
= &fblk
->floats
[i
];
6740 FLOAT_UNMARK (&fblk
->floats
[i
]);
6742 lim
= FLOAT_BLOCK_SIZE
;
6743 /* If this block contains only free floats and we have already
6744 seen more than two blocks worth of free floats then deallocate
6746 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6748 *fprev
= fblk
->next
;
6749 /* Unhook from the free list. */
6750 float_free_list
= fblk
->floats
[0].u
.chain
;
6751 lisp_align_free (fblk
);
6755 num_free
+= this_free
;
6756 fprev
= &fblk
->next
;
6759 total_floats
= num_used
;
6760 total_free_floats
= num_free
;
6763 NO_INLINE
/* For better stack traces */
6765 sweep_intervals (void)
6767 register struct interval_block
*iblk
;
6768 struct interval_block
**iprev
= &interval_block
;
6769 register int lim
= interval_block_index
;
6770 EMACS_INT num_free
= 0, num_used
= 0;
6772 interval_free_list
= 0;
6774 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6779 for (i
= 0; i
< lim
; i
++)
6781 if (!iblk
->intervals
[i
].gcmarkbit
)
6783 set_interval_parent (&iblk
->intervals
[i
], interval_free_list
);
6784 interval_free_list
= &iblk
->intervals
[i
];
6790 iblk
->intervals
[i
].gcmarkbit
= 0;
6793 lim
= INTERVAL_BLOCK_SIZE
;
6794 /* If this block contains only free intervals and we have already
6795 seen more than two blocks worth of free intervals then
6796 deallocate this block. */
6797 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6799 *iprev
= iblk
->next
;
6800 /* Unhook from the free list. */
6801 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6806 num_free
+= this_free
;
6807 iprev
= &iblk
->next
;
6810 total_intervals
= num_used
;
6811 total_free_intervals
= num_free
;
6814 NO_INLINE
/* For better stack traces */
6816 sweep_symbols (void)
6818 struct symbol_block
*sblk
;
6819 struct symbol_block
**sprev
= &symbol_block
;
6820 int lim
= symbol_block_index
;
6821 EMACS_INT num_free
= 0, num_used
= ARRAYELTS (lispsym
);
6823 symbol_free_list
= NULL
;
6825 for (int i
= 0; i
< ARRAYELTS (lispsym
); i
++)
6826 lispsym
[i
].gcmarkbit
= 0;
6828 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6831 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6832 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6834 for (; sym
< end
; ++sym
)
6836 if (!sym
->s
.gcmarkbit
)
6838 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6839 xfree (SYMBOL_BLV (&sym
->s
));
6840 sym
->s
.next
= symbol_free_list
;
6841 symbol_free_list
= &sym
->s
;
6842 symbol_free_list
->function
= Vdead
;
6848 sym
->s
.gcmarkbit
= 0;
6849 /* Attempt to catch bogus objects. */
6850 eassert (valid_lisp_object_p (sym
->s
.function
));
6854 lim
= SYMBOL_BLOCK_SIZE
;
6855 /* If this block contains only free symbols and we have already
6856 seen more than two blocks worth of free symbols then deallocate
6858 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6860 *sprev
= sblk
->next
;
6861 /* Unhook from the free list. */
6862 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6867 num_free
+= this_free
;
6868 sprev
= &sblk
->next
;
6871 total_symbols
= num_used
;
6872 total_free_symbols
= num_free
;
6875 NO_INLINE
/* For better stack traces. */
6879 register struct marker_block
*mblk
;
6880 struct marker_block
**mprev
= &marker_block
;
6881 register int lim
= marker_block_index
;
6882 EMACS_INT num_free
= 0, num_used
= 0;
6884 /* Put all unmarked misc's on free list. For a marker, first
6885 unchain it from the buffer it points into. */
6887 marker_free_list
= 0;
6889 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6894 for (i
= 0; i
< lim
; i
++)
6896 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6898 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6899 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6900 else if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Finalizer
)
6901 unchain_finalizer (&mblk
->markers
[i
].m
.u_finalizer
);
6903 else if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_User_Ptr
)
6905 struct Lisp_User_Ptr
*uptr
= &mblk
->markers
[i
].m
.u_user_ptr
;
6906 if (uptr
->finalizer
)
6907 uptr
->finalizer (uptr
->p
);
6910 /* Set the type of the freed object to Lisp_Misc_Free.
6911 We could leave the type alone, since nobody checks it,
6912 but this might catch bugs faster. */
6913 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6914 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6915 marker_free_list
= &mblk
->markers
[i
].m
;
6921 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6924 lim
= MARKER_BLOCK_SIZE
;
6925 /* If this block contains only free markers and we have already
6926 seen more than two blocks worth of free markers then deallocate
6928 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6930 *mprev
= mblk
->next
;
6931 /* Unhook from the free list. */
6932 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6937 num_free
+= this_free
;
6938 mprev
= &mblk
->next
;
6942 total_markers
= num_used
;
6943 total_free_markers
= num_free
;
6946 NO_INLINE
/* For better stack traces */
6948 sweep_buffers (void)
6950 register struct buffer
*buffer
, **bprev
= &all_buffers
;
6953 for (buffer
= all_buffers
; buffer
; buffer
= *bprev
)
6954 if (!VECTOR_MARKED_P (buffer
))
6956 *bprev
= buffer
->next
;
6961 VECTOR_UNMARK (buffer
);
6962 /* Do not use buffer_(set|get)_intervals here. */
6963 buffer
->text
->intervals
= balance_intervals (buffer
->text
->intervals
);
6965 bprev
= &buffer
->next
;
6969 /* Sweep: find all structures not marked, and free them. */
6973 /* Remove or mark entries in weak hash tables.
6974 This must be done before any object is unmarked. */
6975 sweep_weak_hash_tables ();
6978 check_string_bytes (!noninteractive
);
6986 check_string_bytes (!noninteractive
);
6989 DEFUN ("memory-info", Fmemory_info
, Smemory_info
, 0, 0, 0,
6990 doc
: /* Return a list of (TOTAL-RAM FREE-RAM TOTAL-SWAP FREE-SWAP).
6991 All values are in Kbytes. If there is no swap space,
6992 last two values are zero. If the system is not supported
6993 or memory information can't be obtained, return nil. */)
6996 #if defined HAVE_LINUX_SYSINFO
7002 #ifdef LINUX_SYSINFO_UNIT
7003 units
= si
.mem_unit
;
7007 return list4i ((uintmax_t) si
.totalram
* units
/ 1024,
7008 (uintmax_t) si
.freeram
* units
/ 1024,
7009 (uintmax_t) si
.totalswap
* units
/ 1024,
7010 (uintmax_t) si
.freeswap
* units
/ 1024);
7011 #elif defined WINDOWSNT
7012 unsigned long long totalram
, freeram
, totalswap
, freeswap
;
7014 if (w32_memory_info (&totalram
, &freeram
, &totalswap
, &freeswap
) == 0)
7015 return list4i ((uintmax_t) totalram
/ 1024,
7016 (uintmax_t) freeram
/ 1024,
7017 (uintmax_t) totalswap
/ 1024,
7018 (uintmax_t) freeswap
/ 1024);
7022 unsigned long totalram
, freeram
, totalswap
, freeswap
;
7024 if (dos_memory_info (&totalram
, &freeram
, &totalswap
, &freeswap
) == 0)
7025 return list4i ((uintmax_t) totalram
/ 1024,
7026 (uintmax_t) freeram
/ 1024,
7027 (uintmax_t) totalswap
/ 1024,
7028 (uintmax_t) freeswap
/ 1024);
7031 #else /* not HAVE_LINUX_SYSINFO, not WINDOWSNT, not MSDOS */
7032 /* FIXME: add more systems. */
7034 #endif /* HAVE_LINUX_SYSINFO, not WINDOWSNT, not MSDOS */
7037 /* Debugging aids. */
7039 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
7040 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
7041 This may be helpful in debugging Emacs's memory usage.
7042 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
7048 /* Avoid warning. sbrk has no relation to memory allocated anyway. */
7051 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
7057 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
7058 doc
: /* Return a list of counters that measure how much consing there has been.
7059 Each of these counters increments for a certain kind of object.
7060 The counters wrap around from the largest positive integer to zero.
7061 Garbage collection does not decrease them.
7062 The elements of the value are as follows:
7063 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
7064 All are in units of 1 = one object consed
7065 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
7067 MISCS include overlays, markers, and some internal types.
7068 Frames, windows, buffers, and subprocesses count as vectors
7069 (but the contents of a buffer's text do not count here). */)
7072 return listn (CONSTYPE_HEAP
, 8,
7073 bounded_number (cons_cells_consed
),
7074 bounded_number (floats_consed
),
7075 bounded_number (vector_cells_consed
),
7076 bounded_number (symbols_consed
),
7077 bounded_number (string_chars_consed
),
7078 bounded_number (misc_objects_consed
),
7079 bounded_number (intervals_consed
),
7080 bounded_number (strings_consed
));
7084 symbol_uses_obj (Lisp_Object symbol
, Lisp_Object obj
)
7086 struct Lisp_Symbol
*sym
= XSYMBOL (symbol
);
7087 Lisp_Object val
= find_symbol_value (symbol
);
7088 return (EQ (val
, obj
)
7089 || EQ (sym
->function
, obj
)
7090 || (!NILP (sym
->function
)
7091 && COMPILEDP (sym
->function
)
7092 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
7095 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)));
7098 /* Find at most FIND_MAX symbols which have OBJ as their value or
7099 function. This is used in gdbinit's `xwhichsymbols' command. */
7102 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
7104 struct symbol_block
*sblk
;
7105 ptrdiff_t gc_count
= inhibit_garbage_collection ();
7106 Lisp_Object found
= Qnil
;
7110 for (int i
= 0; i
< ARRAYELTS (lispsym
); i
++)
7112 Lisp_Object sym
= builtin_lisp_symbol (i
);
7113 if (symbol_uses_obj (sym
, obj
))
7115 found
= Fcons (sym
, found
);
7116 if (--find_max
== 0)
7121 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
7123 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
7126 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
7128 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
7131 Lisp_Object sym
= make_lisp_symbol (&aligned_sym
->s
);
7132 if (symbol_uses_obj (sym
, obj
))
7134 found
= Fcons (sym
, found
);
7135 if (--find_max
== 0)
7143 unbind_to (gc_count
, Qnil
);
7147 #ifdef SUSPICIOUS_OBJECT_CHECKING
7150 find_suspicious_object_in_range (void *begin
, void *end
)
7152 char *begin_a
= begin
;
7156 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
7158 char *suspicious_object
= suspicious_objects
[i
];
7159 if (begin_a
<= suspicious_object
&& suspicious_object
< end_a
)
7160 return suspicious_object
;
7167 note_suspicious_free (void* ptr
)
7169 struct suspicious_free_record
* rec
;
7171 rec
= &suspicious_free_history
[suspicious_free_history_index
++];
7172 if (suspicious_free_history_index
==
7173 ARRAYELTS (suspicious_free_history
))
7175 suspicious_free_history_index
= 0;
7178 memset (rec
, 0, sizeof (*rec
));
7179 rec
->suspicious_object
= ptr
;
7180 backtrace (&rec
->backtrace
[0], ARRAYELTS (rec
->backtrace
));
7184 detect_suspicious_free (void* ptr
)
7188 eassert (ptr
!= NULL
);
7190 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
7191 if (suspicious_objects
[i
] == ptr
)
7193 note_suspicious_free (ptr
);
7194 suspicious_objects
[i
] = NULL
;
7198 #endif /* SUSPICIOUS_OBJECT_CHECKING */
7200 DEFUN ("suspicious-object", Fsuspicious_object
, Ssuspicious_object
, 1, 1, 0,
7201 doc
: /* Return OBJ, maybe marking it for extra scrutiny.
7202 If Emacs is compiled with suspicious object checking, capture
7203 a stack trace when OBJ is freed in order to help track down
7204 garbage collection bugs. Otherwise, do nothing and return OBJ. */)
7207 #ifdef SUSPICIOUS_OBJECT_CHECKING
7208 /* Right now, we care only about vectors. */
7209 if (VECTORLIKEP (obj
))
7211 suspicious_objects
[suspicious_object_index
++] = XVECTOR (obj
);
7212 if (suspicious_object_index
== ARRAYELTS (suspicious_objects
))
7213 suspicious_object_index
= 0;
7219 #ifdef ENABLE_CHECKING
7221 bool suppress_checking
;
7224 die (const char *msg
, const char *file
, int line
)
7226 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: assertion failed: %s\r\n",
7228 terminate_due_to_signal (SIGABRT
, INT_MAX
);
7231 #endif /* ENABLE_CHECKING */
7233 #if defined (ENABLE_CHECKING) && USE_STACK_LISP_OBJECTS
7235 /* Debugging check whether STR is ASCII-only. */
7238 verify_ascii (const char *str
)
7240 const unsigned char *ptr
= (unsigned char *) str
, *end
= ptr
+ strlen (str
);
7243 int c
= STRING_CHAR_ADVANCE (ptr
);
7244 if (!ASCII_CHAR_P (c
))
7250 /* Stress alloca with inconveniently sized requests and check
7251 whether all allocated areas may be used for Lisp_Object. */
7253 NO_INLINE
static void
7254 verify_alloca (void)
7257 enum { ALLOCA_CHECK_MAX
= 256 };
7258 /* Start from size of the smallest Lisp object. */
7259 for (i
= sizeof (struct Lisp_Cons
); i
<= ALLOCA_CHECK_MAX
; i
++)
7261 void *ptr
= alloca (i
);
7262 make_lisp_ptr (ptr
, Lisp_Cons
);
7266 #else /* not ENABLE_CHECKING && USE_STACK_LISP_OBJECTS */
7268 #define verify_alloca() ((void) 0)
7270 #endif /* ENABLE_CHECKING && USE_STACK_LISP_OBJECTS */
7272 /* Initialization. */
7275 init_alloc_once (void)
7277 /* Even though Qt's contents are not set up, its address is known. */
7281 pure_size
= PURESIZE
;
7284 init_finalizer_list (&finalizers
);
7285 init_finalizer_list (&doomed_finalizers
);
7288 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
7290 #ifdef DOUG_LEA_MALLOC
7291 mallopt (M_TRIM_THRESHOLD
, 128 * 1024); /* Trim threshold. */
7292 mallopt (M_MMAP_THRESHOLD
, 64 * 1024); /* Mmap threshold. */
7293 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* Max. number of mmap'ed areas. */
7298 refill_memory_reserve ();
7299 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
7305 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
7306 setjmp_tested_p
= longjmps_done
= 0;
7308 Vgc_elapsed
= make_float (0.0);
7312 valgrind_p
= RUNNING_ON_VALGRIND
!= 0;
7317 syms_of_alloc (void)
7319 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
7320 doc
: /* Number of bytes of consing between garbage collections.
7321 Garbage collection can happen automatically once this many bytes have been
7322 allocated since the last garbage collection. All data types count.
7324 Garbage collection happens automatically only when `eval' is called.
7326 By binding this temporarily to a large number, you can effectively
7327 prevent garbage collection during a part of the program.
7328 See also `gc-cons-percentage'. */);
7330 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
7331 doc
: /* Portion of the heap used for allocation.
7332 Garbage collection can happen automatically once this portion of the heap
7333 has been allocated since the last garbage collection.
7334 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
7335 Vgc_cons_percentage
= make_float (0.1);
7337 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
7338 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
7340 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
7341 doc
: /* Number of cons cells that have been consed so far. */);
7343 DEFVAR_INT ("floats-consed", floats_consed
,
7344 doc
: /* Number of floats that have been consed so far. */);
7346 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
7347 doc
: /* Number of vector cells that have been consed so far. */);
7349 DEFVAR_INT ("symbols-consed", symbols_consed
,
7350 doc
: /* Number of symbols that have been consed so far. */);
7351 symbols_consed
+= ARRAYELTS (lispsym
);
7353 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
7354 doc
: /* Number of string characters that have been consed so far. */);
7356 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
7357 doc
: /* Number of miscellaneous objects that have been consed so far.
7358 These include markers and overlays, plus certain objects not visible
7361 DEFVAR_INT ("intervals-consed", intervals_consed
,
7362 doc
: /* Number of intervals that have been consed so far. */);
7364 DEFVAR_INT ("strings-consed", strings_consed
,
7365 doc
: /* Number of strings that have been consed so far. */);
7367 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
7368 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
7369 This means that certain objects should be allocated in shared (pure) space.
7370 It can also be set to a hash-table, in which case this table is used to
7371 do hash-consing of the objects allocated to pure space. */);
7373 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
7374 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
7375 garbage_collection_messages
= 0;
7377 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
7378 doc
: /* Hook run after garbage collection has finished. */);
7379 Vpost_gc_hook
= Qnil
;
7380 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
7382 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
7383 doc
: /* Precomputed `signal' argument for memory-full error. */);
7384 /* We build this in advance because if we wait until we need it, we might
7385 not be able to allocate the memory to hold it. */
7387 = listn (CONSTYPE_PURE
, 2, Qerror
,
7388 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
7390 DEFVAR_LISP ("memory-full", Vmemory_full
,
7391 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
7392 Vmemory_full
= Qnil
;
7394 DEFSYM (Qconses
, "conses");
7395 DEFSYM (Qsymbols
, "symbols");
7396 DEFSYM (Qmiscs
, "miscs");
7397 DEFSYM (Qstrings
, "strings");
7398 DEFSYM (Qvectors
, "vectors");
7399 DEFSYM (Qfloats
, "floats");
7400 DEFSYM (Qintervals
, "intervals");
7401 DEFSYM (Qbuffers
, "buffers");
7402 DEFSYM (Qstring_bytes
, "string-bytes");
7403 DEFSYM (Qvector_slots
, "vector-slots");
7404 DEFSYM (Qheap
, "heap");
7405 DEFSYM (Qautomatic_gc
, "Automatic GC");
7407 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
7408 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
7410 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
7411 doc
: /* Accumulated time elapsed in garbage collections.
7412 The time is in seconds as a floating point value. */);
7413 DEFVAR_INT ("gcs-done", gcs_done
,
7414 doc
: /* Accumulated number of garbage collections done. */);
7419 defsubr (&Sbool_vector
);
7420 defsubr (&Smake_byte_code
);
7421 defsubr (&Smake_list
);
7422 defsubr (&Smake_vector
);
7423 defsubr (&Smake_string
);
7424 defsubr (&Smake_bool_vector
);
7425 defsubr (&Smake_symbol
);
7426 defsubr (&Smake_marker
);
7427 defsubr (&Smake_finalizer
);
7428 defsubr (&Spurecopy
);
7429 defsubr (&Sgarbage_collect
);
7430 defsubr (&Smemory_limit
);
7431 defsubr (&Smemory_info
);
7432 defsubr (&Smemory_use_counts
);
7433 defsubr (&Ssuspicious_object
);
7436 /* When compiled with GCC, GDB might say "No enum type named
7437 pvec_type" if we don't have at least one symbol with that type, and
7438 then xbacktrace could fail. Similarly for the other enums and
7439 their values. Some non-GCC compilers don't like these constructs. */
7443 enum CHARTAB_SIZE_BITS CHARTAB_SIZE_BITS
;
7444 enum char_table_specials char_table_specials
;
7445 enum char_bits char_bits
;
7446 enum CHECK_LISP_OBJECT_TYPE CHECK_LISP_OBJECT_TYPE
;
7447 enum DEFAULT_HASH_SIZE DEFAULT_HASH_SIZE
;
7448 enum Lisp_Bits Lisp_Bits
;
7449 enum Lisp_Compiled Lisp_Compiled
;
7450 enum maxargs maxargs
;
7451 enum MAX_ALLOCA MAX_ALLOCA
;
7452 enum More_Lisp_Bits More_Lisp_Bits
;
7453 enum pvec_type pvec_type
;
7454 } const EXTERNALLY_VISIBLE gdb_make_enums_visible
= {0};
7455 #endif /* __GNUC__ */