1 /* Storage allocation and gc for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2014 Free Software
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <limits.h> /* For CHAR_BIT. */
26 #ifdef ENABLE_CHECKING
27 #include <signal.h> /* For SIGABRT. */
36 #include "intervals.h"
38 #include "character.h"
43 #include "blockinput.h"
44 #include "termhooks.h" /* For struct terminal. */
45 #ifdef HAVE_WINDOW_SYSTEM
47 #endif /* HAVE_WINDOW_SYSTEM */
50 #include <execinfo.h> /* For backtrace. */
52 #if (defined ENABLE_CHECKING \
53 && defined HAVE_VALGRIND_VALGRIND_H \
54 && !defined USE_VALGRIND)
55 # define USE_VALGRIND 1
59 #include <valgrind/valgrind.h>
60 #include <valgrind/memcheck.h>
61 static bool valgrind_p
;
64 /* GC_CHECK_MARKED_OBJECTS means do sanity checks on allocated objects.
65 Doable only if GC_MARK_STACK. */
67 # undef GC_CHECK_MARKED_OBJECTS
70 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
71 memory. Can do this only if using gmalloc.c and if not checking
74 #if (defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC \
75 || defined GC_CHECK_MARKED_OBJECTS)
76 #undef GC_MALLOC_CHECK
87 #include "w32heap.h" /* for sbrk */
90 #ifdef DOUG_LEA_MALLOC
94 /* Specify maximum number of areas to mmap. It would be nice to use a
95 value that explicitly means "no limit". */
97 #define MMAP_MAX_AREAS 100000000
99 #endif /* not DOUG_LEA_MALLOC */
101 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
102 to a struct Lisp_String. */
104 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
105 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
106 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
108 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
109 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
110 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
112 /* Default value of gc_cons_threshold (see below). */
114 #define GC_DEFAULT_THRESHOLD (100000 * word_size)
116 /* Global variables. */
117 struct emacs_globals globals
;
119 /* Number of bytes of consing done since the last gc. */
121 EMACS_INT consing_since_gc
;
123 /* Similar minimum, computed from Vgc_cons_percentage. */
125 EMACS_INT gc_relative_threshold
;
127 /* Minimum number of bytes of consing since GC before next GC,
128 when memory is full. */
130 EMACS_INT memory_full_cons_threshold
= 1 << 10;
132 /* True during GC. */
136 /* True means abort if try to GC.
137 This is for code which is written on the assumption that
138 no GC will happen, so as to verify that assumption. */
142 /* Number of live and free conses etc. */
144 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_buffers
;
145 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
146 static EMACS_INT total_free_floats
, total_floats
;
148 /* Points to memory space allocated as "spare", to be freed if we run
151 static void *spare_memory
;
153 /* Amount of spare memory to keep in large reserve block, or to see
154 whether this much is available when malloc fails on a larger request. */
156 #define SPARE_MEMORY (1 << 15)
158 /* Initialize it to a nonzero value to force it into data space
159 (rather than bss space). That way unexec will remap it into text
160 space (pure), on some systems. We have not implemented the
161 remapping on more recent systems because this is less important
162 nowadays than in the days of small memories and timesharing. */
164 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
165 #define PUREBEG (char *) pure
167 /* Pointer to the pure area, and its size. */
169 static char *purebeg
;
170 static ptrdiff_t pure_size
;
172 /* Number of bytes of pure storage used before pure storage overflowed.
173 If this is non-zero, this implies that an overflow occurred. */
175 static ptrdiff_t pure_bytes_used_before_overflow
;
177 /* True if P points into pure space. */
179 #define PURE_POINTER_P(P) \
180 ((uintptr_t) (P) - (uintptr_t) purebeg <= pure_size)
182 /* Index in pure at which next pure Lisp object will be allocated.. */
184 static ptrdiff_t pure_bytes_used_lisp
;
186 /* Number of bytes allocated for non-Lisp objects in pure storage. */
188 static ptrdiff_t pure_bytes_used_non_lisp
;
190 /* If nonzero, this is a warning delivered by malloc and not yet
193 const char *pending_malloc_warning
;
195 #if 0 /* Normally, pointer sanity only on request... */
196 #ifdef ENABLE_CHECKING
197 #define SUSPICIOUS_OBJECT_CHECKING 1
201 /* ... but unconditionally use SUSPICIOUS_OBJECT_CHECKING while the GC
202 bug is unresolved. */
203 #define SUSPICIOUS_OBJECT_CHECKING 1
205 #ifdef SUSPICIOUS_OBJECT_CHECKING
206 struct suspicious_free_record
208 void *suspicious_object
;
209 void *backtrace
[128];
211 static void *suspicious_objects
[32];
212 static int suspicious_object_index
;
213 struct suspicious_free_record suspicious_free_history
[64] EXTERNALLY_VISIBLE
;
214 static int suspicious_free_history_index
;
215 /* Find the first currently-monitored suspicious pointer in range
216 [begin,end) or NULL if no such pointer exists. */
217 static void *find_suspicious_object_in_range (void *begin
, void *end
);
218 static void detect_suspicious_free (void *ptr
);
220 # define find_suspicious_object_in_range(begin, end) NULL
221 # define detect_suspicious_free(ptr) (void)
224 /* Maximum amount of C stack to save when a GC happens. */
226 #ifndef MAX_SAVE_STACK
227 #define MAX_SAVE_STACK 16000
230 /* Buffer in which we save a copy of the C stack at each GC. */
232 #if MAX_SAVE_STACK > 0
233 static char *stack_copy
;
234 static ptrdiff_t stack_copy_size
;
236 /* Copy to DEST a block of memory from SRC of size SIZE bytes,
237 avoiding any address sanitization. */
239 static void * ATTRIBUTE_NO_SANITIZE_ADDRESS
240 no_sanitize_memcpy (void *dest
, void const *src
, size_t size
)
242 if (! ADDRESS_SANITIZER
)
243 return memcpy (dest
, src
, size
);
249 for (i
= 0; i
< size
; i
++)
255 #endif /* MAX_SAVE_STACK > 0 */
257 static Lisp_Object Qconses
;
258 static Lisp_Object Qsymbols
;
259 static Lisp_Object Qmiscs
;
260 static Lisp_Object Qstrings
;
261 static Lisp_Object Qvectors
;
262 static Lisp_Object Qfloats
;
263 static Lisp_Object Qintervals
;
264 static Lisp_Object Qbuffers
;
265 static Lisp_Object Qstring_bytes
, Qvector_slots
, Qheap
;
266 static Lisp_Object Qgc_cons_threshold
;
267 Lisp_Object Qautomatic_gc
;
268 Lisp_Object Qchar_table_extra_slots
;
270 /* Hook run after GC has finished. */
272 static Lisp_Object Qpost_gc_hook
;
274 static void mark_terminals (void);
275 static void gc_sweep (void);
276 static Lisp_Object
make_pure_vector (ptrdiff_t);
277 static void mark_buffer (struct buffer
*);
279 #if !defined REL_ALLOC || defined SYSTEM_MALLOC
280 static void refill_memory_reserve (void);
282 static void compact_small_strings (void);
283 static void free_large_strings (void);
284 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
286 /* When scanning the C stack for live Lisp objects, Emacs keeps track of
287 what memory allocated via lisp_malloc and lisp_align_malloc is intended
288 for what purpose. This enumeration specifies the type of memory. */
299 /* Since all non-bool pseudovectors are small enough to be
300 allocated from vector blocks, this memory type denotes
301 large regular vectors and large bool pseudovectors. */
303 /* Special type to denote vector blocks. */
304 MEM_TYPE_VECTOR_BLOCK
,
305 /* Special type to denote reserved memory. */
309 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
311 /* A unique object in pure space used to make some Lisp objects
312 on free lists recognizable in O(1). */
314 static Lisp_Object Vdead
;
315 #define DEADP(x) EQ (x, Vdead)
317 #ifdef GC_MALLOC_CHECK
319 enum mem_type allocated_mem_type
;
321 #endif /* GC_MALLOC_CHECK */
323 /* A node in the red-black tree describing allocated memory containing
324 Lisp data. Each such block is recorded with its start and end
325 address when it is allocated, and removed from the tree when it
328 A red-black tree is a balanced binary tree with the following
331 1. Every node is either red or black.
332 2. Every leaf is black.
333 3. If a node is red, then both of its children are black.
334 4. Every simple path from a node to a descendant leaf contains
335 the same number of black nodes.
336 5. The root is always black.
338 When nodes are inserted into the tree, or deleted from the tree,
339 the tree is "fixed" so that these properties are always true.
341 A red-black tree with N internal nodes has height at most 2
342 log(N+1). Searches, insertions and deletions are done in O(log N).
343 Please see a text book about data structures for a detailed
344 description of red-black trees. Any book worth its salt should
349 /* Children of this node. These pointers are never NULL. When there
350 is no child, the value is MEM_NIL, which points to a dummy node. */
351 struct mem_node
*left
, *right
;
353 /* The parent of this node. In the root node, this is NULL. */
354 struct mem_node
*parent
;
356 /* Start and end of allocated region. */
360 enum {MEM_BLACK
, MEM_RED
} color
;
366 /* Base address of stack. Set in main. */
368 Lisp_Object
*stack_base
;
370 /* Root of the tree describing allocated Lisp memory. */
372 static struct mem_node
*mem_root
;
374 /* Lowest and highest known address in the heap. */
376 static void *min_heap_address
, *max_heap_address
;
378 /* Sentinel node of the tree. */
380 static struct mem_node mem_z
;
381 #define MEM_NIL &mem_z
383 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
384 static void mem_insert_fixup (struct mem_node
*);
385 static void mem_rotate_left (struct mem_node
*);
386 static void mem_rotate_right (struct mem_node
*);
387 static void mem_delete (struct mem_node
*);
388 static void mem_delete_fixup (struct mem_node
*);
389 static struct mem_node
*mem_find (void *);
391 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
397 /* Recording what needs to be marked for gc. */
399 struct gcpro
*gcprolist
;
401 /* Addresses of staticpro'd variables. Initialize it to a nonzero
402 value; otherwise some compilers put it into BSS. */
404 enum { NSTATICS
= 2048 };
405 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
407 /* Index of next unused slot in staticvec. */
409 static int staticidx
;
411 static void *pure_alloc (size_t, int);
413 /* Return X rounded to the next multiple of Y. Arguments should not
414 have side effects, as they are evaluated more than once. Assume X
415 + Y - 1 does not overflow. Tune for Y being a power of 2. */
417 #define ROUNDUP(x, y) ((y) & ((y) - 1) \
418 ? ((x) + (y) - 1) - ((x) + (y) - 1) % (y) \
419 : ((x) + (y) - 1) & ~ ((y) - 1))
421 /* Return PTR rounded up to the next multiple of ALIGNMENT. */
424 ALIGN (void *ptr
, int alignment
)
426 return (void *) ROUNDUP ((uintptr_t) ptr
, alignment
);
430 XFLOAT_INIT (Lisp_Object f
, double n
)
432 XFLOAT (f
)->u
.data
= n
;
436 pointers_fit_in_lispobj_p (void)
438 return (UINTPTR_MAX
<= VAL_MAX
) || USE_LSB_TAG
;
442 mmap_lisp_allowed_p (void)
444 /* If we can't store all memory addresses in our lisp objects, it's
445 risky to let the heap use mmap and give us addresses from all
446 over our address space. We also can't use mmap for lisp objects
447 if we might dump: unexec doesn't preserve the contents of mmaped
449 return pointers_fit_in_lispobj_p () && !might_dump
;
453 /************************************************************************
455 ************************************************************************/
457 /* Function malloc calls this if it finds we are near exhausting storage. */
460 malloc_warning (const char *str
)
462 pending_malloc_warning
= str
;
466 /* Display an already-pending malloc warning. */
469 display_malloc_warning (void)
471 call3 (intern ("display-warning"),
473 build_string (pending_malloc_warning
),
474 intern ("emergency"));
475 pending_malloc_warning
= 0;
478 /* Called if we can't allocate relocatable space for a buffer. */
481 buffer_memory_full (ptrdiff_t nbytes
)
483 /* If buffers use the relocating allocator, no need to free
484 spare_memory, because we may have plenty of malloc space left
485 that we could get, and if we don't, the malloc that fails will
486 itself cause spare_memory to be freed. If buffers don't use the
487 relocating allocator, treat this like any other failing
491 memory_full (nbytes
);
493 /* This used to call error, but if we've run out of memory, we could
494 get infinite recursion trying to build the string. */
495 xsignal (Qnil
, Vmemory_signal_data
);
499 /* A common multiple of the positive integers A and B. Ideally this
500 would be the least common multiple, but there's no way to do that
501 as a constant expression in C, so do the best that we can easily do. */
502 #define COMMON_MULTIPLE(a, b) \
503 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
505 #ifndef XMALLOC_OVERRUN_CHECK
506 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
509 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
512 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
513 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
514 block size in little-endian order. The trailer consists of
515 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
517 The header is used to detect whether this block has been allocated
518 through these functions, as some low-level libc functions may
519 bypass the malloc hooks. */
521 #define XMALLOC_OVERRUN_CHECK_SIZE 16
522 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
523 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
525 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
526 hold a size_t value and (2) the header size is a multiple of the
527 alignment that Emacs needs for C types and for USE_LSB_TAG. */
528 #define XMALLOC_BASE_ALIGNMENT \
529 alignof (union { long double d; intmax_t i; void *p; })
532 # define XMALLOC_HEADER_ALIGNMENT \
533 COMMON_MULTIPLE (GCALIGNMENT, XMALLOC_BASE_ALIGNMENT)
535 # define XMALLOC_HEADER_ALIGNMENT XMALLOC_BASE_ALIGNMENT
537 #define XMALLOC_OVERRUN_SIZE_SIZE \
538 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
539 + XMALLOC_HEADER_ALIGNMENT - 1) \
540 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
541 - XMALLOC_OVERRUN_CHECK_SIZE)
543 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
544 { '\x9a', '\x9b', '\xae', '\xaf',
545 '\xbf', '\xbe', '\xce', '\xcf',
546 '\xea', '\xeb', '\xec', '\xed',
547 '\xdf', '\xde', '\x9c', '\x9d' };
549 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
550 { '\xaa', '\xab', '\xac', '\xad',
551 '\xba', '\xbb', '\xbc', '\xbd',
552 '\xca', '\xcb', '\xcc', '\xcd',
553 '\xda', '\xdb', '\xdc', '\xdd' };
555 /* Insert and extract the block size in the header. */
558 xmalloc_put_size (unsigned char *ptr
, size_t size
)
561 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
563 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
569 xmalloc_get_size (unsigned char *ptr
)
573 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
574 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
583 /* Like malloc, but wraps allocated block with header and trailer. */
586 overrun_check_malloc (size_t size
)
588 register unsigned char *val
;
589 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
592 val
= malloc (size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
595 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
596 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
597 xmalloc_put_size (val
, size
);
598 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
599 XMALLOC_OVERRUN_CHECK_SIZE
);
605 /* Like realloc, but checks old block for overrun, and wraps new block
606 with header and trailer. */
609 overrun_check_realloc (void *block
, size_t size
)
611 register unsigned char *val
= (unsigned char *) block
;
612 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
616 && memcmp (xmalloc_overrun_check_header
,
617 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
618 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
620 size_t osize
= xmalloc_get_size (val
);
621 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
622 XMALLOC_OVERRUN_CHECK_SIZE
))
624 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
625 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
626 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
629 val
= realloc (val
, size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
633 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
634 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
635 xmalloc_put_size (val
, size
);
636 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
637 XMALLOC_OVERRUN_CHECK_SIZE
);
642 /* Like free, but checks block for overrun. */
645 overrun_check_free (void *block
)
647 unsigned char *val
= (unsigned char *) block
;
650 && memcmp (xmalloc_overrun_check_header
,
651 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
652 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
654 size_t osize
= xmalloc_get_size (val
);
655 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
656 XMALLOC_OVERRUN_CHECK_SIZE
))
658 #ifdef XMALLOC_CLEAR_FREE_MEMORY
659 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
660 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
662 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
663 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
664 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
674 #define malloc overrun_check_malloc
675 #define realloc overrun_check_realloc
676 #define free overrun_check_free
679 /* Like malloc but check for no memory and block interrupt input.. */
682 xmalloc (size_t size
)
693 /* Like the above, but zeroes out the memory just allocated. */
696 xzalloc (size_t size
)
704 memset (val
, 0, size
);
708 /* Like realloc but check for no memory and block interrupt input.. */
711 xrealloc (void *block
, size_t size
)
715 /* We must call malloc explicitly when BLOCK is 0, since some
716 reallocs don't do this. */
720 val
= realloc (block
, size
);
728 /* Like free but block interrupt input. */
738 /* We don't call refill_memory_reserve here
739 because in practice the call in r_alloc_free seems to suffice. */
743 /* Other parts of Emacs pass large int values to allocator functions
744 expecting ptrdiff_t. This is portable in practice, but check it to
746 verify (INT_MAX
<= PTRDIFF_MAX
);
749 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
750 Signal an error on memory exhaustion, and block interrupt input. */
753 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
755 eassert (0 <= nitems
&& 0 < item_size
);
756 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
757 memory_full (SIZE_MAX
);
758 return xmalloc (nitems
* item_size
);
762 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
763 Signal an error on memory exhaustion, and block interrupt input. */
766 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
768 eassert (0 <= nitems
&& 0 < item_size
);
769 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
770 memory_full (SIZE_MAX
);
771 return xrealloc (pa
, nitems
* item_size
);
775 /* Grow PA, which points to an array of *NITEMS items, and return the
776 location of the reallocated array, updating *NITEMS to reflect its
777 new size. The new array will contain at least NITEMS_INCR_MIN more
778 items, but will not contain more than NITEMS_MAX items total.
779 ITEM_SIZE is the size of each item, in bytes.
781 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
782 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
785 If PA is null, then allocate a new array instead of reallocating
788 Block interrupt input as needed. If memory exhaustion occurs, set
789 *NITEMS to zero if PA is null, and signal an error (i.e., do not
792 Thus, to grow an array A without saving its old contents, do
793 { xfree (A); A = NULL; A = xpalloc (NULL, &AITEMS, ...); }.
794 The A = NULL avoids a dangling pointer if xpalloc exhausts memory
795 and signals an error, and later this code is reexecuted and
796 attempts to free A. */
799 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
800 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
802 /* The approximate size to use for initial small allocation
803 requests. This is the largest "small" request for the GNU C
805 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
807 /* If the array is tiny, grow it to about (but no greater than)
808 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
809 ptrdiff_t n
= *nitems
;
810 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
811 ptrdiff_t half_again
= n
>> 1;
812 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
814 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
815 NITEMS_MAX, and what the C language can represent safely. */
816 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
817 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
818 ? nitems_max
: C_language_max
);
819 ptrdiff_t nitems_incr_max
= n_max
- n
;
820 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
822 eassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
825 if (nitems_incr_max
< incr
)
826 memory_full (SIZE_MAX
);
828 pa
= xrealloc (pa
, n
* item_size
);
834 /* Like strdup, but uses xmalloc. */
837 xstrdup (const char *s
)
841 size
= strlen (s
) + 1;
842 return memcpy (xmalloc (size
), s
, size
);
845 /* Like above, but duplicates Lisp string to C string. */
848 xlispstrdup (Lisp_Object string
)
850 ptrdiff_t size
= SBYTES (string
) + 1;
851 return memcpy (xmalloc (size
), SSDATA (string
), size
);
854 /* Assign to *PTR a copy of STRING, freeing any storage *PTR formerly
855 pointed to. If STRING is null, assign it without copying anything.
856 Allocate before freeing, to avoid a dangling pointer if allocation
860 dupstring (char **ptr
, char const *string
)
863 *ptr
= string
? xstrdup (string
) : 0;
868 /* Like putenv, but (1) use the equivalent of xmalloc and (2) the
869 argument is a const pointer. */
872 xputenv (char const *string
)
874 if (putenv ((char *) string
) != 0)
878 /* Return a newly allocated memory block of SIZE bytes, remembering
879 to free it when unwinding. */
881 record_xmalloc (size_t size
)
883 void *p
= xmalloc (size
);
884 record_unwind_protect_ptr (xfree
, p
);
889 /* Like malloc but used for allocating Lisp data. NBYTES is the
890 number of bytes to allocate, TYPE describes the intended use of the
891 allocated memory block (for strings, for conses, ...). */
894 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
898 lisp_malloc (size_t nbytes
, enum mem_type type
)
902 #ifdef GC_MALLOC_CHECK
903 allocated_mem_type
= type
;
906 val
= malloc (nbytes
);
909 /* If the memory just allocated cannot be addressed thru a Lisp
910 object's pointer, and it needs to be,
911 that's equivalent to running out of memory. */
912 if (val
&& type
!= MEM_TYPE_NON_LISP
)
915 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
916 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
918 lisp_malloc_loser
= val
;
925 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
926 if (val
&& type
!= MEM_TYPE_NON_LISP
)
927 mem_insert (val
, (char *) val
+ nbytes
, type
);
931 memory_full (nbytes
);
935 /* Free BLOCK. This must be called to free memory allocated with a
936 call to lisp_malloc. */
939 lisp_free (void *block
)
942 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
943 mem_delete (mem_find (block
));
947 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
949 /* The entry point is lisp_align_malloc which returns blocks of at most
950 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
952 /* Use aligned_alloc if it or a simple substitute is available.
953 Address sanitization breaks aligned allocation, as of gcc 4.8.2 and
956 #if ! ADDRESS_SANITIZER
957 # if !defined SYSTEM_MALLOC && !defined DOUG_LEA_MALLOC
958 # define USE_ALIGNED_ALLOC 1
959 /* Defined in gmalloc.c. */
960 void *aligned_alloc (size_t, size_t);
961 # elif defined HAVE_ALIGNED_ALLOC
962 # define USE_ALIGNED_ALLOC 1
963 # elif defined HAVE_POSIX_MEMALIGN
964 # define USE_ALIGNED_ALLOC 1
966 aligned_alloc (size_t alignment
, size_t size
)
969 return posix_memalign (&p
, alignment
, size
) == 0 ? p
: 0;
974 /* BLOCK_ALIGN has to be a power of 2. */
975 #define BLOCK_ALIGN (1 << 10)
977 /* Padding to leave at the end of a malloc'd block. This is to give
978 malloc a chance to minimize the amount of memory wasted to alignment.
979 It should be tuned to the particular malloc library used.
980 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
981 aligned_alloc on the other hand would ideally prefer a value of 4
982 because otherwise, there's 1020 bytes wasted between each ablocks.
983 In Emacs, testing shows that those 1020 can most of the time be
984 efficiently used by malloc to place other objects, so a value of 0 can
985 still preferable unless you have a lot of aligned blocks and virtually
987 #define BLOCK_PADDING 0
988 #define BLOCK_BYTES \
989 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
991 /* Internal data structures and constants. */
993 #define ABLOCKS_SIZE 16
995 /* An aligned block of memory. */
1000 char payload
[BLOCK_BYTES
];
1001 struct ablock
*next_free
;
1003 /* `abase' is the aligned base of the ablocks. */
1004 /* It is overloaded to hold the virtual `busy' field that counts
1005 the number of used ablock in the parent ablocks.
1006 The first ablock has the `busy' field, the others have the `abase'
1007 field. To tell the difference, we assume that pointers will have
1008 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1009 is used to tell whether the real base of the parent ablocks is `abase'
1010 (if not, the word before the first ablock holds a pointer to the
1012 struct ablocks
*abase
;
1013 /* The padding of all but the last ablock is unused. The padding of
1014 the last ablock in an ablocks is not allocated. */
1016 char padding
[BLOCK_PADDING
];
1020 /* A bunch of consecutive aligned blocks. */
1023 struct ablock blocks
[ABLOCKS_SIZE
];
1026 /* Size of the block requested from malloc or aligned_alloc. */
1027 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1029 #define ABLOCK_ABASE(block) \
1030 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1031 ? (struct ablocks *)(block) \
1034 /* Virtual `busy' field. */
1035 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1037 /* Pointer to the (not necessarily aligned) malloc block. */
1038 #ifdef USE_ALIGNED_ALLOC
1039 #define ABLOCKS_BASE(abase) (abase)
1041 #define ABLOCKS_BASE(abase) \
1042 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void **)abase)[-1])
1045 /* The list of free ablock. */
1046 static struct ablock
*free_ablock
;
1048 /* Allocate an aligned block of nbytes.
1049 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1050 smaller or equal to BLOCK_BYTES. */
1052 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1055 struct ablocks
*abase
;
1057 eassert (nbytes
<= BLOCK_BYTES
);
1059 #ifdef GC_MALLOC_CHECK
1060 allocated_mem_type
= type
;
1066 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1068 #ifdef DOUG_LEA_MALLOC
1069 if (!mmap_lisp_allowed_p ())
1070 mallopt (M_MMAP_MAX
, 0);
1073 #ifdef USE_ALIGNED_ALLOC
1074 abase
= base
= aligned_alloc (BLOCK_ALIGN
, ABLOCKS_BYTES
);
1076 base
= malloc (ABLOCKS_BYTES
);
1077 abase
= ALIGN (base
, BLOCK_ALIGN
);
1081 memory_full (ABLOCKS_BYTES
);
1083 aligned
= (base
== abase
);
1085 ((void **) abase
)[-1] = base
;
1087 #ifdef DOUG_LEA_MALLOC
1088 if (!mmap_lisp_allowed_p ())
1089 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1093 /* If the memory just allocated cannot be addressed thru a Lisp
1094 object's pointer, and it needs to be, that's equivalent to
1095 running out of memory. */
1096 if (type
!= MEM_TYPE_NON_LISP
)
1099 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1100 XSETCONS (tem
, end
);
1101 if ((char *) XCONS (tem
) != end
)
1103 lisp_malloc_loser
= base
;
1105 memory_full (SIZE_MAX
);
1110 /* Initialize the blocks and put them on the free list.
1111 If `base' was not properly aligned, we can't use the last block. */
1112 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1114 abase
->blocks
[i
].abase
= abase
;
1115 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1116 free_ablock
= &abase
->blocks
[i
];
1118 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1120 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1121 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1122 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1123 eassert (ABLOCKS_BASE (abase
) == base
);
1124 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1127 abase
= ABLOCK_ABASE (free_ablock
);
1128 ABLOCKS_BUSY (abase
)
1129 = (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1131 free_ablock
= free_ablock
->x
.next_free
;
1133 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1134 if (type
!= MEM_TYPE_NON_LISP
)
1135 mem_insert (val
, (char *) val
+ nbytes
, type
);
1138 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1143 lisp_align_free (void *block
)
1145 struct ablock
*ablock
= block
;
1146 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1148 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1149 mem_delete (mem_find (block
));
1152 /* Put on free list. */
1153 ablock
->x
.next_free
= free_ablock
;
1154 free_ablock
= ablock
;
1155 /* Update busy count. */
1156 ABLOCKS_BUSY (abase
)
1157 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1159 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1160 { /* All the blocks are free. */
1161 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1162 struct ablock
**tem
= &free_ablock
;
1163 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1167 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1170 *tem
= (*tem
)->x
.next_free
;
1173 tem
= &(*tem
)->x
.next_free
;
1175 eassert ((aligned
& 1) == aligned
);
1176 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1177 #ifdef USE_POSIX_MEMALIGN
1178 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1180 free (ABLOCKS_BASE (abase
));
1184 /***********************************************************************
1186 ***********************************************************************/
1188 /* Number of intervals allocated in an interval_block structure.
1189 The 1020 is 1024 minus malloc overhead. */
1191 #define INTERVAL_BLOCK_SIZE \
1192 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1194 /* Intervals are allocated in chunks in the form of an interval_block
1197 struct interval_block
1199 /* Place `intervals' first, to preserve alignment. */
1200 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1201 struct interval_block
*next
;
1204 /* Current interval block. Its `next' pointer points to older
1207 static struct interval_block
*interval_block
;
1209 /* Index in interval_block above of the next unused interval
1212 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1214 /* Number of free and live intervals. */
1216 static EMACS_INT total_free_intervals
, total_intervals
;
1218 /* List of free intervals. */
1220 static INTERVAL interval_free_list
;
1222 /* Return a new interval. */
1225 make_interval (void)
1229 if (interval_free_list
)
1231 val
= interval_free_list
;
1232 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1236 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1238 struct interval_block
*newi
1239 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1241 newi
->next
= interval_block
;
1242 interval_block
= newi
;
1243 interval_block_index
= 0;
1244 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1246 val
= &interval_block
->intervals
[interval_block_index
++];
1249 consing_since_gc
+= sizeof (struct interval
);
1251 total_free_intervals
--;
1252 RESET_INTERVAL (val
);
1258 /* Mark Lisp objects in interval I. */
1261 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1263 /* Intervals should never be shared. So, if extra internal checking is
1264 enabled, GC aborts if it seems to have visited an interval twice. */
1265 eassert (!i
->gcmarkbit
);
1267 mark_object (i
->plist
);
1270 /* Mark the interval tree rooted in I. */
1272 #define MARK_INTERVAL_TREE(i) \
1274 if (i && !i->gcmarkbit) \
1275 traverse_intervals_noorder (i, mark_interval, Qnil); \
1278 /***********************************************************************
1280 ***********************************************************************/
1282 /* Lisp_Strings are allocated in string_block structures. When a new
1283 string_block is allocated, all the Lisp_Strings it contains are
1284 added to a free-list string_free_list. When a new Lisp_String is
1285 needed, it is taken from that list. During the sweep phase of GC,
1286 string_blocks that are entirely free are freed, except two which
1289 String data is allocated from sblock structures. Strings larger
1290 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1291 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1293 Sblocks consist internally of sdata structures, one for each
1294 Lisp_String. The sdata structure points to the Lisp_String it
1295 belongs to. The Lisp_String points back to the `u.data' member of
1296 its sdata structure.
1298 When a Lisp_String is freed during GC, it is put back on
1299 string_free_list, and its `data' member and its sdata's `string'
1300 pointer is set to null. The size of the string is recorded in the
1301 `n.nbytes' member of the sdata. So, sdata structures that are no
1302 longer used, can be easily recognized, and it's easy to compact the
1303 sblocks of small strings which we do in compact_small_strings. */
1305 /* Size in bytes of an sblock structure used for small strings. This
1306 is 8192 minus malloc overhead. */
1308 #define SBLOCK_SIZE 8188
1310 /* Strings larger than this are considered large strings. String data
1311 for large strings is allocated from individual sblocks. */
1313 #define LARGE_STRING_BYTES 1024
1315 /* The SDATA typedef is a struct or union describing string memory
1316 sub-allocated from an sblock. This is where the contents of Lisp
1317 strings are stored. */
1321 /* Back-pointer to the string this sdata belongs to. If null, this
1322 structure is free, and NBYTES (in this structure or in the union below)
1323 contains the string's byte size (the same value that STRING_BYTES
1324 would return if STRING were non-null). If non-null, STRING_BYTES
1325 (STRING) is the size of the data, and DATA contains the string's
1327 struct Lisp_String
*string
;
1329 #ifdef GC_CHECK_STRING_BYTES
1333 unsigned char data
[FLEXIBLE_ARRAY_MEMBER
];
1336 #ifdef GC_CHECK_STRING_BYTES
1338 typedef struct sdata sdata
;
1339 #define SDATA_NBYTES(S) (S)->nbytes
1340 #define SDATA_DATA(S) (S)->data
1346 struct Lisp_String
*string
;
1348 /* When STRING is nonnull, this union is actually of type 'struct sdata',
1349 which has a flexible array member. However, if implemented by
1350 giving this union a member of type 'struct sdata', the union
1351 could not be the last (flexible) member of 'struct sblock',
1352 because C99 prohibits a flexible array member from having a type
1353 that is itself a flexible array. So, comment this member out here,
1354 but remember that the option's there when using this union. */
1359 /* When STRING is null. */
1362 struct Lisp_String
*string
;
1367 #define SDATA_NBYTES(S) (S)->n.nbytes
1368 #define SDATA_DATA(S) ((struct sdata *) (S))->data
1370 #endif /* not GC_CHECK_STRING_BYTES */
1372 enum { SDATA_DATA_OFFSET
= offsetof (struct sdata
, data
) };
1374 /* Structure describing a block of memory which is sub-allocated to
1375 obtain string data memory for strings. Blocks for small strings
1376 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1377 as large as needed. */
1382 struct sblock
*next
;
1384 /* Pointer to the next free sdata block. This points past the end
1385 of the sblock if there isn't any space left in this block. */
1389 sdata data
[FLEXIBLE_ARRAY_MEMBER
];
1392 /* Number of Lisp strings in a string_block structure. The 1020 is
1393 1024 minus malloc overhead. */
1395 #define STRING_BLOCK_SIZE \
1396 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1398 /* Structure describing a block from which Lisp_String structures
1403 /* Place `strings' first, to preserve alignment. */
1404 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1405 struct string_block
*next
;
1408 /* Head and tail of the list of sblock structures holding Lisp string
1409 data. We always allocate from current_sblock. The NEXT pointers
1410 in the sblock structures go from oldest_sblock to current_sblock. */
1412 static struct sblock
*oldest_sblock
, *current_sblock
;
1414 /* List of sblocks for large strings. */
1416 static struct sblock
*large_sblocks
;
1418 /* List of string_block structures. */
1420 static struct string_block
*string_blocks
;
1422 /* Free-list of Lisp_Strings. */
1424 static struct Lisp_String
*string_free_list
;
1426 /* Number of live and free Lisp_Strings. */
1428 static EMACS_INT total_strings
, total_free_strings
;
1430 /* Number of bytes used by live strings. */
1432 static EMACS_INT total_string_bytes
;
1434 /* Given a pointer to a Lisp_String S which is on the free-list
1435 string_free_list, return a pointer to its successor in the
1438 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1440 /* Return a pointer to the sdata structure belonging to Lisp string S.
1441 S must be live, i.e. S->data must not be null. S->data is actually
1442 a pointer to the `u.data' member of its sdata structure; the
1443 structure starts at a constant offset in front of that. */
1445 #define SDATA_OF_STRING(S) ((sdata *) ((S)->data - SDATA_DATA_OFFSET))
1448 #ifdef GC_CHECK_STRING_OVERRUN
1450 /* We check for overrun in string data blocks by appending a small
1451 "cookie" after each allocated string data block, and check for the
1452 presence of this cookie during GC. */
1454 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1455 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1456 { '\xde', '\xad', '\xbe', '\xef' };
1459 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1462 /* Value is the size of an sdata structure large enough to hold NBYTES
1463 bytes of string data. The value returned includes a terminating
1464 NUL byte, the size of the sdata structure, and padding. */
1466 #ifdef GC_CHECK_STRING_BYTES
1468 #define SDATA_SIZE(NBYTES) \
1469 ((SDATA_DATA_OFFSET \
1471 + sizeof (ptrdiff_t) - 1) \
1472 & ~(sizeof (ptrdiff_t) - 1))
1474 #else /* not GC_CHECK_STRING_BYTES */
1476 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1477 less than the size of that member. The 'max' is not needed when
1478 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1479 alignment code reserves enough space. */
1481 #define SDATA_SIZE(NBYTES) \
1482 ((SDATA_DATA_OFFSET \
1483 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1485 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1487 + sizeof (ptrdiff_t) - 1) \
1488 & ~(sizeof (ptrdiff_t) - 1))
1490 #endif /* not GC_CHECK_STRING_BYTES */
1492 /* Extra bytes to allocate for each string. */
1494 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1496 /* Exact bound on the number of bytes in a string, not counting the
1497 terminating null. A string cannot contain more bytes than
1498 STRING_BYTES_BOUND, nor can it be so long that the size_t
1499 arithmetic in allocate_string_data would overflow while it is
1500 calculating a value to be passed to malloc. */
1501 static ptrdiff_t const STRING_BYTES_MAX
=
1502 min (STRING_BYTES_BOUND
,
1503 ((SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
1505 - offsetof (struct sblock
, data
)
1506 - SDATA_DATA_OFFSET
)
1507 & ~(sizeof (EMACS_INT
) - 1)));
1509 /* Initialize string allocation. Called from init_alloc_once. */
1514 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1515 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1519 #ifdef GC_CHECK_STRING_BYTES
1521 static int check_string_bytes_count
;
1523 /* Like STRING_BYTES, but with debugging check. Can be
1524 called during GC, so pay attention to the mark bit. */
1527 string_bytes (struct Lisp_String
*s
)
1530 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1532 if (!PURE_POINTER_P (s
)
1534 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1539 /* Check validity of Lisp strings' string_bytes member in B. */
1542 check_sblock (struct sblock
*b
)
1544 sdata
*from
, *end
, *from_end
;
1548 for (from
= b
->data
; from
< end
; from
= from_end
)
1550 /* Compute the next FROM here because copying below may
1551 overwrite data we need to compute it. */
1554 /* Check that the string size recorded in the string is the
1555 same as the one recorded in the sdata structure. */
1556 nbytes
= SDATA_SIZE (from
->string
? string_bytes (from
->string
)
1557 : SDATA_NBYTES (from
));
1558 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1563 /* Check validity of Lisp strings' string_bytes member. ALL_P
1564 means check all strings, otherwise check only most
1565 recently allocated strings. Used for hunting a bug. */
1568 check_string_bytes (bool all_p
)
1574 for (b
= large_sblocks
; b
; b
= b
->next
)
1576 struct Lisp_String
*s
= b
->data
[0].string
;
1581 for (b
= oldest_sblock
; b
; b
= b
->next
)
1584 else if (current_sblock
)
1585 check_sblock (current_sblock
);
1588 #else /* not GC_CHECK_STRING_BYTES */
1590 #define check_string_bytes(all) ((void) 0)
1592 #endif /* GC_CHECK_STRING_BYTES */
1594 #ifdef GC_CHECK_STRING_FREE_LIST
1596 /* Walk through the string free list looking for bogus next pointers.
1597 This may catch buffer overrun from a previous string. */
1600 check_string_free_list (void)
1602 struct Lisp_String
*s
;
1604 /* Pop a Lisp_String off the free-list. */
1605 s
= string_free_list
;
1608 if ((uintptr_t) s
< 1024)
1610 s
= NEXT_FREE_LISP_STRING (s
);
1614 #define check_string_free_list()
1617 /* Return a new Lisp_String. */
1619 static struct Lisp_String
*
1620 allocate_string (void)
1622 struct Lisp_String
*s
;
1624 /* If the free-list is empty, allocate a new string_block, and
1625 add all the Lisp_Strings in it to the free-list. */
1626 if (string_free_list
== NULL
)
1628 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1631 b
->next
= string_blocks
;
1634 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1637 /* Every string on a free list should have NULL data pointer. */
1639 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1640 string_free_list
= s
;
1643 total_free_strings
+= STRING_BLOCK_SIZE
;
1646 check_string_free_list ();
1648 /* Pop a Lisp_String off the free-list. */
1649 s
= string_free_list
;
1650 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1652 --total_free_strings
;
1655 consing_since_gc
+= sizeof *s
;
1657 #ifdef GC_CHECK_STRING_BYTES
1658 if (!noninteractive
)
1660 if (++check_string_bytes_count
== 200)
1662 check_string_bytes_count
= 0;
1663 check_string_bytes (1);
1666 check_string_bytes (0);
1668 #endif /* GC_CHECK_STRING_BYTES */
1674 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1675 plus a NUL byte at the end. Allocate an sdata structure for S, and
1676 set S->data to its `u.data' member. Store a NUL byte at the end of
1677 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1678 S->data if it was initially non-null. */
1681 allocate_string_data (struct Lisp_String
*s
,
1682 EMACS_INT nchars
, EMACS_INT nbytes
)
1684 sdata
*data
, *old_data
;
1686 ptrdiff_t needed
, old_nbytes
;
1688 if (STRING_BYTES_MAX
< nbytes
)
1691 /* Determine the number of bytes needed to store NBYTES bytes
1693 needed
= SDATA_SIZE (nbytes
);
1696 old_data
= SDATA_OF_STRING (s
);
1697 old_nbytes
= STRING_BYTES (s
);
1702 if (nbytes
> LARGE_STRING_BYTES
)
1704 size_t size
= offsetof (struct sblock
, data
) + needed
;
1706 #ifdef DOUG_LEA_MALLOC
1707 if (!mmap_lisp_allowed_p ())
1708 mallopt (M_MMAP_MAX
, 0);
1711 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
1713 #ifdef DOUG_LEA_MALLOC
1714 if (!mmap_lisp_allowed_p ())
1715 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1718 b
->next_free
= b
->data
;
1719 b
->data
[0].string
= NULL
;
1720 b
->next
= large_sblocks
;
1723 else if (current_sblock
== NULL
1724 || (((char *) current_sblock
+ SBLOCK_SIZE
1725 - (char *) current_sblock
->next_free
)
1726 < (needed
+ GC_STRING_EXTRA
)))
1728 /* Not enough room in the current sblock. */
1729 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
1730 b
->next_free
= b
->data
;
1731 b
->data
[0].string
= NULL
;
1735 current_sblock
->next
= b
;
1743 data
= b
->next_free
;
1744 b
->next_free
= (sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
1747 s
->data
= SDATA_DATA (data
);
1748 #ifdef GC_CHECK_STRING_BYTES
1749 SDATA_NBYTES (data
) = nbytes
;
1752 s
->size_byte
= nbytes
;
1753 s
->data
[nbytes
] = '\0';
1754 #ifdef GC_CHECK_STRING_OVERRUN
1755 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
1756 GC_STRING_OVERRUN_COOKIE_SIZE
);
1759 /* Note that Faset may call to this function when S has already data
1760 assigned. In this case, mark data as free by setting it's string
1761 back-pointer to null, and record the size of the data in it. */
1764 SDATA_NBYTES (old_data
) = old_nbytes
;
1765 old_data
->string
= NULL
;
1768 consing_since_gc
+= needed
;
1772 /* Sweep and compact strings. */
1774 NO_INLINE
/* For better stack traces */
1776 sweep_strings (void)
1778 struct string_block
*b
, *next
;
1779 struct string_block
*live_blocks
= NULL
;
1781 string_free_list
= NULL
;
1782 total_strings
= total_free_strings
= 0;
1783 total_string_bytes
= 0;
1785 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
1786 for (b
= string_blocks
; b
; b
= next
)
1789 struct Lisp_String
*free_list_before
= string_free_list
;
1793 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
1795 struct Lisp_String
*s
= b
->strings
+ i
;
1799 /* String was not on free-list before. */
1800 if (STRING_MARKED_P (s
))
1802 /* String is live; unmark it and its intervals. */
1805 /* Do not use string_(set|get)_intervals here. */
1806 s
->intervals
= balance_intervals (s
->intervals
);
1809 total_string_bytes
+= STRING_BYTES (s
);
1813 /* String is dead. Put it on the free-list. */
1814 sdata
*data
= SDATA_OF_STRING (s
);
1816 /* Save the size of S in its sdata so that we know
1817 how large that is. Reset the sdata's string
1818 back-pointer so that we know it's free. */
1819 #ifdef GC_CHECK_STRING_BYTES
1820 if (string_bytes (s
) != SDATA_NBYTES (data
))
1823 data
->n
.nbytes
= STRING_BYTES (s
);
1825 data
->string
= NULL
;
1827 /* Reset the strings's `data' member so that we
1831 /* Put the string on the free-list. */
1832 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1833 string_free_list
= s
;
1839 /* S was on the free-list before. Put it there again. */
1840 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1841 string_free_list
= s
;
1846 /* Free blocks that contain free Lisp_Strings only, except
1847 the first two of them. */
1848 if (nfree
== STRING_BLOCK_SIZE
1849 && total_free_strings
> STRING_BLOCK_SIZE
)
1852 string_free_list
= free_list_before
;
1856 total_free_strings
+= nfree
;
1857 b
->next
= live_blocks
;
1862 check_string_free_list ();
1864 string_blocks
= live_blocks
;
1865 free_large_strings ();
1866 compact_small_strings ();
1868 check_string_free_list ();
1872 /* Free dead large strings. */
1875 free_large_strings (void)
1877 struct sblock
*b
, *next
;
1878 struct sblock
*live_blocks
= NULL
;
1880 for (b
= large_sblocks
; b
; b
= next
)
1884 if (b
->data
[0].string
== NULL
)
1888 b
->next
= live_blocks
;
1893 large_sblocks
= live_blocks
;
1897 /* Compact data of small strings. Free sblocks that don't contain
1898 data of live strings after compaction. */
1901 compact_small_strings (void)
1903 struct sblock
*b
, *tb
, *next
;
1904 sdata
*from
, *to
, *end
, *tb_end
;
1905 sdata
*to_end
, *from_end
;
1907 /* TB is the sblock we copy to, TO is the sdata within TB we copy
1908 to, and TB_END is the end of TB. */
1910 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
1913 /* Step through the blocks from the oldest to the youngest. We
1914 expect that old blocks will stabilize over time, so that less
1915 copying will happen this way. */
1916 for (b
= oldest_sblock
; b
; b
= b
->next
)
1919 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
1921 for (from
= b
->data
; from
< end
; from
= from_end
)
1923 /* Compute the next FROM here because copying below may
1924 overwrite data we need to compute it. */
1926 struct Lisp_String
*s
= from
->string
;
1928 #ifdef GC_CHECK_STRING_BYTES
1929 /* Check that the string size recorded in the string is the
1930 same as the one recorded in the sdata structure. */
1931 if (s
&& string_bytes (s
) != SDATA_NBYTES (from
))
1933 #endif /* GC_CHECK_STRING_BYTES */
1935 nbytes
= s
? STRING_BYTES (s
) : SDATA_NBYTES (from
);
1936 eassert (nbytes
<= LARGE_STRING_BYTES
);
1938 nbytes
= SDATA_SIZE (nbytes
);
1939 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1941 #ifdef GC_CHECK_STRING_OVERRUN
1942 if (memcmp (string_overrun_cookie
,
1943 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
1944 GC_STRING_OVERRUN_COOKIE_SIZE
))
1948 /* Non-NULL S means it's alive. Copy its data. */
1951 /* If TB is full, proceed with the next sblock. */
1952 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
1953 if (to_end
> tb_end
)
1957 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
1959 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
1962 /* Copy, and update the string's `data' pointer. */
1965 eassert (tb
!= b
|| to
< from
);
1966 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
1967 to
->string
->data
= SDATA_DATA (to
);
1970 /* Advance past the sdata we copied to. */
1976 /* The rest of the sblocks following TB don't contain live data, so
1977 we can free them. */
1978 for (b
= tb
->next
; b
; b
= next
)
1986 current_sblock
= tb
;
1990 string_overflow (void)
1992 error ("Maximum string size exceeded");
1995 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
1996 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
1997 LENGTH must be an integer.
1998 INIT must be an integer that represents a character. */)
1999 (Lisp_Object length
, Lisp_Object init
)
2001 register Lisp_Object val
;
2005 CHECK_NATNUM (length
);
2006 CHECK_CHARACTER (init
);
2008 c
= XFASTINT (init
);
2009 if (ASCII_CHAR_P (c
))
2011 nbytes
= XINT (length
);
2012 val
= make_uninit_string (nbytes
);
2013 memset (SDATA (val
), c
, nbytes
);
2014 SDATA (val
)[nbytes
] = 0;
2018 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2019 ptrdiff_t len
= CHAR_STRING (c
, str
);
2020 EMACS_INT string_len
= XINT (length
);
2021 unsigned char *p
, *beg
, *end
;
2023 if (string_len
> STRING_BYTES_MAX
/ len
)
2025 nbytes
= len
* string_len
;
2026 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2027 for (beg
= SDATA (val
), p
= beg
, end
= beg
+ nbytes
; p
< end
; p
+= len
)
2029 /* First time we just copy `str' to the data of `val'. */
2031 memcpy (p
, str
, len
);
2034 /* Next time we copy largest possible chunk from
2035 initialized to uninitialized part of `val'. */
2036 len
= min (p
- beg
, end
- p
);
2037 memcpy (p
, beg
, len
);
2046 /* Fill A with 1 bits if INIT is non-nil, and with 0 bits otherwise.
2050 bool_vector_fill (Lisp_Object a
, Lisp_Object init
)
2052 EMACS_INT nbits
= bool_vector_size (a
);
2055 unsigned char *data
= bool_vector_uchar_data (a
);
2056 int pattern
= NILP (init
) ? 0 : (1 << BOOL_VECTOR_BITS_PER_CHAR
) - 1;
2057 ptrdiff_t nbytes
= bool_vector_bytes (nbits
);
2058 int last_mask
= ~ (~0u << ((nbits
- 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1));
2059 memset (data
, pattern
, nbytes
- 1);
2060 data
[nbytes
- 1] = pattern
& last_mask
;
2065 /* Return a newly allocated, uninitialized bool vector of size NBITS. */
2068 make_uninit_bool_vector (EMACS_INT nbits
)
2071 EMACS_INT words
= bool_vector_words (nbits
);
2072 EMACS_INT word_bytes
= words
* sizeof (bits_word
);
2073 EMACS_INT needed_elements
= ((bool_header_size
- header_size
+ word_bytes
2076 struct Lisp_Bool_Vector
*p
2077 = (struct Lisp_Bool_Vector
*) allocate_vector (needed_elements
);
2078 XSETVECTOR (val
, p
);
2079 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0, 0);
2082 /* Clear padding at the end. */
2084 p
->data
[words
- 1] = 0;
2089 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2090 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2091 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2092 (Lisp_Object length
, Lisp_Object init
)
2096 CHECK_NATNUM (length
);
2097 val
= make_uninit_bool_vector (XFASTINT (length
));
2098 return bool_vector_fill (val
, init
);
2101 DEFUN ("bool-vector", Fbool_vector
, Sbool_vector
, 0, MANY
, 0,
2102 doc
: /* Return a new bool-vector with specified arguments as elements.
2103 Any number of arguments, even zero arguments, are allowed.
2104 usage: (bool-vector &rest OBJECTS) */)
2105 (ptrdiff_t nargs
, Lisp_Object
*args
)
2110 vector
= make_uninit_bool_vector (nargs
);
2111 for (i
= 0; i
< nargs
; i
++)
2112 bool_vector_set (vector
, i
, !NILP (args
[i
]));
2117 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2118 of characters from the contents. This string may be unibyte or
2119 multibyte, depending on the contents. */
2122 make_string (const char *contents
, ptrdiff_t nbytes
)
2124 register Lisp_Object val
;
2125 ptrdiff_t nchars
, multibyte_nbytes
;
2127 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2128 &nchars
, &multibyte_nbytes
);
2129 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2130 /* CONTENTS contains no multibyte sequences or contains an invalid
2131 multibyte sequence. We must make unibyte string. */
2132 val
= make_unibyte_string (contents
, nbytes
);
2134 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2139 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2142 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2144 register Lisp_Object val
;
2145 val
= make_uninit_string (length
);
2146 memcpy (SDATA (val
), contents
, length
);
2151 /* Make a multibyte string from NCHARS characters occupying NBYTES
2152 bytes at CONTENTS. */
2155 make_multibyte_string (const char *contents
,
2156 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2158 register Lisp_Object val
;
2159 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2160 memcpy (SDATA (val
), contents
, nbytes
);
2165 /* Make a string from NCHARS characters occupying NBYTES bytes at
2166 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2169 make_string_from_bytes (const char *contents
,
2170 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2172 register Lisp_Object val
;
2173 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2174 memcpy (SDATA (val
), contents
, nbytes
);
2175 if (SBYTES (val
) == SCHARS (val
))
2176 STRING_SET_UNIBYTE (val
);
2181 /* Make a string from NCHARS characters occupying NBYTES bytes at
2182 CONTENTS. The argument MULTIBYTE controls whether to label the
2183 string as multibyte. If NCHARS is negative, it counts the number of
2184 characters by itself. */
2187 make_specified_string (const char *contents
,
2188 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
2195 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2200 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2201 memcpy (SDATA (val
), contents
, nbytes
);
2203 STRING_SET_UNIBYTE (val
);
2208 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2209 occupying LENGTH bytes. */
2212 make_uninit_string (EMACS_INT length
)
2217 return empty_unibyte_string
;
2218 val
= make_uninit_multibyte_string (length
, length
);
2219 STRING_SET_UNIBYTE (val
);
2224 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2225 which occupy NBYTES bytes. */
2228 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2231 struct Lisp_String
*s
;
2236 return empty_multibyte_string
;
2238 s
= allocate_string ();
2239 s
->intervals
= NULL
;
2240 allocate_string_data (s
, nchars
, nbytes
);
2241 XSETSTRING (string
, s
);
2242 string_chars_consed
+= nbytes
;
2246 /* Print arguments to BUF according to a FORMAT, then return
2247 a Lisp_String initialized with the data from BUF. */
2250 make_formatted_string (char *buf
, const char *format
, ...)
2255 va_start (ap
, format
);
2256 length
= vsprintf (buf
, format
, ap
);
2258 return make_string (buf
, length
);
2262 /***********************************************************************
2264 ***********************************************************************/
2266 /* We store float cells inside of float_blocks, allocating a new
2267 float_block with malloc whenever necessary. Float cells reclaimed
2268 by GC are put on a free list to be reallocated before allocating
2269 any new float cells from the latest float_block. */
2271 #define FLOAT_BLOCK_SIZE \
2272 (((BLOCK_BYTES - sizeof (struct float_block *) \
2273 /* The compiler might add padding at the end. */ \
2274 - (sizeof (struct Lisp_Float) - sizeof (bits_word))) * CHAR_BIT) \
2275 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2277 #define GETMARKBIT(block,n) \
2278 (((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2279 >> ((n) % BITS_PER_BITS_WORD)) \
2282 #define SETMARKBIT(block,n) \
2283 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2284 |= (bits_word) 1 << ((n) % BITS_PER_BITS_WORD))
2286 #define UNSETMARKBIT(block,n) \
2287 ((block)->gcmarkbits[(n) / BITS_PER_BITS_WORD] \
2288 &= ~((bits_word) 1 << ((n) % BITS_PER_BITS_WORD)))
2290 #define FLOAT_BLOCK(fptr) \
2291 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2293 #define FLOAT_INDEX(fptr) \
2294 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2298 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2299 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2300 bits_word gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2301 struct float_block
*next
;
2304 #define FLOAT_MARKED_P(fptr) \
2305 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2307 #define FLOAT_MARK(fptr) \
2308 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2310 #define FLOAT_UNMARK(fptr) \
2311 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2313 /* Current float_block. */
2315 static struct float_block
*float_block
;
2317 /* Index of first unused Lisp_Float in the current float_block. */
2319 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2321 /* Free-list of Lisp_Floats. */
2323 static struct Lisp_Float
*float_free_list
;
2325 /* Return a new float object with value FLOAT_VALUE. */
2328 make_float (double float_value
)
2330 register Lisp_Object val
;
2332 if (float_free_list
)
2334 /* We use the data field for chaining the free list
2335 so that we won't use the same field that has the mark bit. */
2336 XSETFLOAT (val
, float_free_list
);
2337 float_free_list
= float_free_list
->u
.chain
;
2341 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2343 struct float_block
*new
2344 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2345 new->next
= float_block
;
2346 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2348 float_block_index
= 0;
2349 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2351 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2352 float_block_index
++;
2355 XFLOAT_INIT (val
, float_value
);
2356 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2357 consing_since_gc
+= sizeof (struct Lisp_Float
);
2359 total_free_floats
--;
2365 /***********************************************************************
2367 ***********************************************************************/
2369 /* We store cons cells inside of cons_blocks, allocating a new
2370 cons_block with malloc whenever necessary. Cons cells reclaimed by
2371 GC are put on a free list to be reallocated before allocating
2372 any new cons cells from the latest cons_block. */
2374 #define CONS_BLOCK_SIZE \
2375 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2376 /* The compiler might add padding at the end. */ \
2377 - (sizeof (struct Lisp_Cons) - sizeof (bits_word))) * CHAR_BIT) \
2378 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2380 #define CONS_BLOCK(fptr) \
2381 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2383 #define CONS_INDEX(fptr) \
2384 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2388 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2389 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2390 bits_word gcmarkbits
[1 + CONS_BLOCK_SIZE
/ BITS_PER_BITS_WORD
];
2391 struct cons_block
*next
;
2394 #define CONS_MARKED_P(fptr) \
2395 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2397 #define CONS_MARK(fptr) \
2398 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2400 #define CONS_UNMARK(fptr) \
2401 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2403 /* Current cons_block. */
2405 static struct cons_block
*cons_block
;
2407 /* Index of first unused Lisp_Cons in the current block. */
2409 static int cons_block_index
= CONS_BLOCK_SIZE
;
2411 /* Free-list of Lisp_Cons structures. */
2413 static struct Lisp_Cons
*cons_free_list
;
2415 /* Explicitly free a cons cell by putting it on the free-list. */
2418 free_cons (struct Lisp_Cons
*ptr
)
2420 ptr
->u
.chain
= cons_free_list
;
2424 cons_free_list
= ptr
;
2425 consing_since_gc
-= sizeof *ptr
;
2426 total_free_conses
++;
2429 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2430 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2431 (Lisp_Object car
, Lisp_Object cdr
)
2433 register Lisp_Object val
;
2437 /* We use the cdr for chaining the free list
2438 so that we won't use the same field that has the mark bit. */
2439 XSETCONS (val
, cons_free_list
);
2440 cons_free_list
= cons_free_list
->u
.chain
;
2444 if (cons_block_index
== CONS_BLOCK_SIZE
)
2446 struct cons_block
*new
2447 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2448 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2449 new->next
= cons_block
;
2451 cons_block_index
= 0;
2452 total_free_conses
+= CONS_BLOCK_SIZE
;
2454 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2460 eassert (!CONS_MARKED_P (XCONS (val
)));
2461 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2462 total_free_conses
--;
2463 cons_cells_consed
++;
2467 #ifdef GC_CHECK_CONS_LIST
2468 /* Get an error now if there's any junk in the cons free list. */
2470 check_cons_list (void)
2472 struct Lisp_Cons
*tail
= cons_free_list
;
2475 tail
= tail
->u
.chain
;
2479 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2482 list1 (Lisp_Object arg1
)
2484 return Fcons (arg1
, Qnil
);
2488 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2490 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2495 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2497 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2502 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2504 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2509 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2511 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2512 Fcons (arg5
, Qnil
)))));
2515 /* Make a list of COUNT Lisp_Objects, where ARG is the
2516 first one. Allocate conses from pure space if TYPE
2517 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2520 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2524 Lisp_Object val
, *objp
;
2526 /* Change to SAFE_ALLOCA if you hit this eassert. */
2527 eassert (count
<= MAX_ALLOCA
/ word_size
);
2529 objp
= alloca (count
* word_size
);
2532 for (i
= 1; i
< count
; i
++)
2533 objp
[i
] = va_arg (ap
, Lisp_Object
);
2536 for (val
= Qnil
, i
= count
- 1; i
>= 0; i
--)
2538 if (type
== CONSTYPE_PURE
)
2539 val
= pure_cons (objp
[i
], val
);
2540 else if (type
== CONSTYPE_HEAP
)
2541 val
= Fcons (objp
[i
], val
);
2548 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2549 doc
: /* Return a newly created list with specified arguments as elements.
2550 Any number of arguments, even zero arguments, are allowed.
2551 usage: (list &rest OBJECTS) */)
2552 (ptrdiff_t nargs
, Lisp_Object
*args
)
2554 register Lisp_Object val
;
2560 val
= Fcons (args
[nargs
], val
);
2566 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2567 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2568 (register Lisp_Object length
, Lisp_Object init
)
2570 register Lisp_Object val
;
2571 register EMACS_INT size
;
2573 CHECK_NATNUM (length
);
2574 size
= XFASTINT (length
);
2579 val
= Fcons (init
, val
);
2584 val
= Fcons (init
, val
);
2589 val
= Fcons (init
, val
);
2594 val
= Fcons (init
, val
);
2599 val
= Fcons (init
, val
);
2614 /***********************************************************************
2616 ***********************************************************************/
2618 /* Sometimes a vector's contents are merely a pointer internally used
2619 in vector allocation code. On the rare platforms where a null
2620 pointer cannot be tagged, represent it with a Lisp 0.
2621 Usually you don't want to touch this. */
2623 static struct Lisp_Vector
*
2624 next_vector (struct Lisp_Vector
*v
)
2626 return XUNTAG (v
->contents
[0], 0);
2630 set_next_vector (struct Lisp_Vector
*v
, struct Lisp_Vector
*p
)
2632 v
->contents
[0] = make_lisp_ptr (p
, 0);
2635 /* This value is balanced well enough to avoid too much internal overhead
2636 for the most common cases; it's not required to be a power of two, but
2637 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2639 #define VECTOR_BLOCK_SIZE 4096
2643 /* Alignment of struct Lisp_Vector objects. */
2644 vector_alignment
= COMMON_MULTIPLE (ALIGNOF_STRUCT_LISP_VECTOR
,
2645 USE_LSB_TAG
? GCALIGNMENT
: 1),
2647 /* Vector size requests are a multiple of this. */
2648 roundup_size
= COMMON_MULTIPLE (vector_alignment
, word_size
)
2651 /* Verify assumptions described above. */
2652 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2653 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2655 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at compile time. */
2656 #define vroundup_ct(x) ROUNDUP (x, roundup_size)
2657 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at runtime. */
2658 #define vroundup(x) (eassume ((x) >= 0), vroundup_ct (x))
2660 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2662 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup_ct (sizeof (void *)))
2664 /* Size of the minimal vector allocated from block. */
2666 #define VBLOCK_BYTES_MIN vroundup_ct (header_size + sizeof (Lisp_Object))
2668 /* Size of the largest vector allocated from block. */
2670 #define VBLOCK_BYTES_MAX \
2671 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2673 /* We maintain one free list for each possible block-allocated
2674 vector size, and this is the number of free lists we have. */
2676 #define VECTOR_MAX_FREE_LIST_INDEX \
2677 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2679 /* Common shortcut to advance vector pointer over a block data. */
2681 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2683 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2685 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2687 /* Common shortcut to setup vector on a free list. */
2689 #define SETUP_ON_FREE_LIST(v, nbytes, tmp) \
2691 (tmp) = ((nbytes - header_size) / word_size); \
2692 XSETPVECTYPESIZE (v, PVEC_FREE, 0, (tmp)); \
2693 eassert ((nbytes) % roundup_size == 0); \
2694 (tmp) = VINDEX (nbytes); \
2695 eassert ((tmp) < VECTOR_MAX_FREE_LIST_INDEX); \
2696 set_next_vector (v, vector_free_lists[tmp]); \
2697 vector_free_lists[tmp] = (v); \
2698 total_free_vector_slots += (nbytes) / word_size; \
2701 /* This internal type is used to maintain the list of large vectors
2702 which are allocated at their own, e.g. outside of vector blocks.
2704 struct large_vector itself cannot contain a struct Lisp_Vector, as
2705 the latter contains a flexible array member and C99 does not allow
2706 such structs to be nested. Instead, each struct large_vector
2707 object LV is followed by a struct Lisp_Vector, which is at offset
2708 large_vector_offset from LV, and whose address is therefore
2709 large_vector_vec (&LV). */
2713 struct large_vector
*next
;
2718 large_vector_offset
= ROUNDUP (sizeof (struct large_vector
), vector_alignment
)
2721 static struct Lisp_Vector
*
2722 large_vector_vec (struct large_vector
*p
)
2724 return (struct Lisp_Vector
*) ((char *) p
+ large_vector_offset
);
2727 /* This internal type is used to maintain an underlying storage
2728 for small vectors. */
2732 char data
[VECTOR_BLOCK_BYTES
];
2733 struct vector_block
*next
;
2736 /* Chain of vector blocks. */
2738 static struct vector_block
*vector_blocks
;
2740 /* Vector free lists, where NTH item points to a chain of free
2741 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2743 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2745 /* Singly-linked list of large vectors. */
2747 static struct large_vector
*large_vectors
;
2749 /* The only vector with 0 slots, allocated from pure space. */
2751 Lisp_Object zero_vector
;
2753 /* Number of live vectors. */
2755 static EMACS_INT total_vectors
;
2757 /* Total size of live and free vectors, in Lisp_Object units. */
2759 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
2761 /* Get a new vector block. */
2763 static struct vector_block
*
2764 allocate_vector_block (void)
2766 struct vector_block
*block
= xmalloc (sizeof *block
);
2768 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
2769 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
2770 MEM_TYPE_VECTOR_BLOCK
);
2773 block
->next
= vector_blocks
;
2774 vector_blocks
= block
;
2778 /* Called once to initialize vector allocation. */
2783 zero_vector
= make_pure_vector (0);
2786 /* Allocate vector from a vector block. */
2788 static struct Lisp_Vector
*
2789 allocate_vector_from_block (size_t nbytes
)
2791 struct Lisp_Vector
*vector
;
2792 struct vector_block
*block
;
2793 size_t index
, restbytes
;
2795 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
2796 eassert (nbytes
% roundup_size
== 0);
2798 /* First, try to allocate from a free list
2799 containing vectors of the requested size. */
2800 index
= VINDEX (nbytes
);
2801 if (vector_free_lists
[index
])
2803 vector
= vector_free_lists
[index
];
2804 vector_free_lists
[index
] = next_vector (vector
);
2805 total_free_vector_slots
-= nbytes
/ word_size
;
2809 /* Next, check free lists containing larger vectors. Since
2810 we will split the result, we should have remaining space
2811 large enough to use for one-slot vector at least. */
2812 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
2813 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
2814 if (vector_free_lists
[index
])
2816 /* This vector is larger than requested. */
2817 vector
= vector_free_lists
[index
];
2818 vector_free_lists
[index
] = next_vector (vector
);
2819 total_free_vector_slots
-= nbytes
/ word_size
;
2821 /* Excess bytes are used for the smaller vector,
2822 which should be set on an appropriate free list. */
2823 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
2824 eassert (restbytes
% roundup_size
== 0);
2825 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
2829 /* Finally, need a new vector block. */
2830 block
= allocate_vector_block ();
2832 /* New vector will be at the beginning of this block. */
2833 vector
= (struct Lisp_Vector
*) block
->data
;
2835 /* If the rest of space from this block is large enough
2836 for one-slot vector at least, set up it on a free list. */
2837 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
2838 if (restbytes
>= VBLOCK_BYTES_MIN
)
2840 eassert (restbytes
% roundup_size
== 0);
2841 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
2846 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
2848 #define VECTOR_IN_BLOCK(vector, block) \
2849 ((char *) (vector) <= (block)->data \
2850 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
2852 /* Return the memory footprint of V in bytes. */
2855 vector_nbytes (struct Lisp_Vector
*v
)
2857 ptrdiff_t size
= v
->header
.size
& ~ARRAY_MARK_FLAG
;
2860 if (size
& PSEUDOVECTOR_FLAG
)
2862 if (PSEUDOVECTOR_TYPEP (&v
->header
, PVEC_BOOL_VECTOR
))
2864 struct Lisp_Bool_Vector
*bv
= (struct Lisp_Bool_Vector
*) v
;
2865 ptrdiff_t word_bytes
= (bool_vector_words (bv
->size
)
2866 * sizeof (bits_word
));
2867 ptrdiff_t boolvec_bytes
= bool_header_size
+ word_bytes
;
2868 verify (header_size
<= bool_header_size
);
2869 nwords
= (boolvec_bytes
- header_size
+ word_size
- 1) / word_size
;
2872 nwords
= ((size
& PSEUDOVECTOR_SIZE_MASK
)
2873 + ((size
& PSEUDOVECTOR_REST_MASK
)
2874 >> PSEUDOVECTOR_SIZE_BITS
));
2878 return vroundup (header_size
+ word_size
* nwords
);
2881 /* Release extra resources still in use by VECTOR, which may be any
2882 vector-like object. For now, this is used just to free data in
2886 cleanup_vector (struct Lisp_Vector
*vector
)
2888 detect_suspicious_free (vector
);
2889 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FONT
)
2890 && ((vector
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
2891 == FONT_OBJECT_MAX
))
2893 struct font_driver
*drv
= ((struct font
*) vector
)->driver
;
2895 /* The font driver might sometimes be NULL, e.g. if Emacs was
2896 interrupted before it had time to set it up. */
2899 /* Attempt to catch subtle bugs like Bug#16140. */
2900 eassert (valid_font_driver (drv
));
2901 drv
->close ((struct font
*) vector
);
2906 /* Reclaim space used by unmarked vectors. */
2908 NO_INLINE
/* For better stack traces */
2910 sweep_vectors (void)
2912 struct vector_block
*block
, **bprev
= &vector_blocks
;
2913 struct large_vector
*lv
, **lvprev
= &large_vectors
;
2914 struct Lisp_Vector
*vector
, *next
;
2916 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
2917 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
2919 /* Looking through vector blocks. */
2921 for (block
= vector_blocks
; block
; block
= *bprev
)
2923 bool free_this_block
= 0;
2926 for (vector
= (struct Lisp_Vector
*) block
->data
;
2927 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
2929 if (VECTOR_MARKED_P (vector
))
2931 VECTOR_UNMARK (vector
);
2933 nbytes
= vector_nbytes (vector
);
2934 total_vector_slots
+= nbytes
/ word_size
;
2935 next
= ADVANCE (vector
, nbytes
);
2939 ptrdiff_t total_bytes
;
2941 cleanup_vector (vector
);
2942 nbytes
= vector_nbytes (vector
);
2943 total_bytes
= nbytes
;
2944 next
= ADVANCE (vector
, nbytes
);
2946 /* While NEXT is not marked, try to coalesce with VECTOR,
2947 thus making VECTOR of the largest possible size. */
2949 while (VECTOR_IN_BLOCK (next
, block
))
2951 if (VECTOR_MARKED_P (next
))
2953 cleanup_vector (next
);
2954 nbytes
= vector_nbytes (next
);
2955 total_bytes
+= nbytes
;
2956 next
= ADVANCE (next
, nbytes
);
2959 eassert (total_bytes
% roundup_size
== 0);
2961 if (vector
== (struct Lisp_Vector
*) block
->data
2962 && !VECTOR_IN_BLOCK (next
, block
))
2963 /* This block should be freed because all of its
2964 space was coalesced into the only free vector. */
2965 free_this_block
= 1;
2969 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
2974 if (free_this_block
)
2976 *bprev
= block
->next
;
2977 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
2978 mem_delete (mem_find (block
->data
));
2983 bprev
= &block
->next
;
2986 /* Sweep large vectors. */
2988 for (lv
= large_vectors
; lv
; lv
= *lvprev
)
2990 vector
= large_vector_vec (lv
);
2991 if (VECTOR_MARKED_P (vector
))
2993 VECTOR_UNMARK (vector
);
2995 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
2997 /* All non-bool pseudovectors are small enough to be allocated
2998 from vector blocks. This code should be redesigned if some
2999 pseudovector type grows beyond VBLOCK_BYTES_MAX. */
3000 eassert (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_BOOL_VECTOR
));
3001 total_vector_slots
+= vector_nbytes (vector
) / word_size
;
3005 += header_size
/ word_size
+ vector
->header
.size
;
3016 /* Value is a pointer to a newly allocated Lisp_Vector structure
3017 with room for LEN Lisp_Objects. */
3019 static struct Lisp_Vector
*
3020 allocate_vectorlike (ptrdiff_t len
)
3022 struct Lisp_Vector
*p
;
3024 #ifdef DOUG_LEA_MALLOC
3025 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
3026 because mapped region contents are not preserved in
3028 mallopt (M_MMAP_MAX
, 0);
3032 p
= XVECTOR (zero_vector
);
3035 size_t nbytes
= header_size
+ len
* word_size
;
3037 #ifdef DOUG_LEA_MALLOC
3038 if (!mmap_lisp_allowed_p ())
3039 mallopt (M_MMAP_MAX
, 0);
3042 if (nbytes
<= VBLOCK_BYTES_MAX
)
3043 p
= allocate_vector_from_block (vroundup (nbytes
));
3046 struct large_vector
*lv
3047 = lisp_malloc ((large_vector_offset
+ header_size
3049 MEM_TYPE_VECTORLIKE
);
3050 lv
->next
= large_vectors
;
3052 p
= large_vector_vec (lv
);
3055 #ifdef DOUG_LEA_MALLOC
3056 if (!mmap_lisp_allowed_p ())
3057 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3060 if (find_suspicious_object_in_range (p
, (char *) p
+ nbytes
))
3063 consing_since_gc
+= nbytes
;
3064 vector_cells_consed
+= len
;
3071 /* Allocate a vector with LEN slots. */
3073 struct Lisp_Vector
*
3074 allocate_vector (EMACS_INT len
)
3076 struct Lisp_Vector
*v
;
3077 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3079 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3080 memory_full (SIZE_MAX
);
3081 v
= allocate_vectorlike (len
);
3082 v
->header
.size
= len
;
3087 /* Allocate other vector-like structures. */
3089 struct Lisp_Vector
*
3090 allocate_pseudovector (int memlen
, int lisplen
, enum pvec_type tag
)
3092 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3095 /* Catch bogus values. */
3096 eassert (tag
<= PVEC_FONT
);
3097 eassert (memlen
- lisplen
<= (1 << PSEUDOVECTOR_REST_BITS
) - 1);
3098 eassert (lisplen
<= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1);
3100 /* Only the first lisplen slots will be traced normally by the GC. */
3101 for (i
= 0; i
< lisplen
; ++i
)
3102 v
->contents
[i
] = Qnil
;
3104 XSETPVECTYPESIZE (v
, tag
, lisplen
, memlen
- lisplen
);
3109 allocate_buffer (void)
3111 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3113 BUFFER_PVEC_INIT (b
);
3114 /* Put B on the chain of all buffers including killed ones. */
3115 b
->next
= all_buffers
;
3117 /* Note that the rest fields of B are not initialized. */
3121 struct Lisp_Hash_Table
*
3122 allocate_hash_table (void)
3124 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
3128 allocate_window (void)
3132 w
= ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
3133 /* Users assumes that non-Lisp data is zeroed. */
3134 memset (&w
->current_matrix
, 0,
3135 sizeof (*w
) - offsetof (struct window
, current_matrix
));
3140 allocate_terminal (void)
3144 t
= ALLOCATE_PSEUDOVECTOR (struct terminal
, next_terminal
, PVEC_TERMINAL
);
3145 /* Users assumes that non-Lisp data is zeroed. */
3146 memset (&t
->next_terminal
, 0,
3147 sizeof (*t
) - offsetof (struct terminal
, next_terminal
));
3152 allocate_frame (void)
3156 f
= ALLOCATE_PSEUDOVECTOR (struct frame
, face_cache
, PVEC_FRAME
);
3157 /* Users assumes that non-Lisp data is zeroed. */
3158 memset (&f
->face_cache
, 0,
3159 sizeof (*f
) - offsetof (struct frame
, face_cache
));
3163 struct Lisp_Process
*
3164 allocate_process (void)
3166 struct Lisp_Process
*p
;
3168 p
= ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3169 /* Users assumes that non-Lisp data is zeroed. */
3171 sizeof (*p
) - offsetof (struct Lisp_Process
, pid
));
3175 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3176 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3177 See also the function `vector'. */)
3178 (register Lisp_Object length
, Lisp_Object init
)
3181 register ptrdiff_t sizei
;
3182 register ptrdiff_t i
;
3183 register struct Lisp_Vector
*p
;
3185 CHECK_NATNUM (length
);
3187 p
= allocate_vector (XFASTINT (length
));
3188 sizei
= XFASTINT (length
);
3189 for (i
= 0; i
< sizei
; i
++)
3190 p
->contents
[i
] = init
;
3192 XSETVECTOR (vector
, p
);
3197 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3198 doc
: /* Return a newly created vector with specified arguments as elements.
3199 Any number of arguments, even zero arguments, are allowed.
3200 usage: (vector &rest OBJECTS) */)
3201 (ptrdiff_t nargs
, Lisp_Object
*args
)
3204 register Lisp_Object val
= make_uninit_vector (nargs
);
3205 register struct Lisp_Vector
*p
= XVECTOR (val
);
3207 for (i
= 0; i
< nargs
; i
++)
3208 p
->contents
[i
] = args
[i
];
3213 make_byte_code (struct Lisp_Vector
*v
)
3215 /* Don't allow the global zero_vector to become a byte code object. */
3216 eassert (0 < v
->header
.size
);
3218 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3219 && STRING_MULTIBYTE (v
->contents
[1]))
3220 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3221 earlier because they produced a raw 8-bit string for byte-code
3222 and now such a byte-code string is loaded as multibyte while
3223 raw 8-bit characters converted to multibyte form. Thus, now we
3224 must convert them back to the original unibyte form. */
3225 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3226 XSETPVECTYPE (v
, PVEC_COMPILED
);
3229 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3230 doc
: /* Create a byte-code object with specified arguments as elements.
3231 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3232 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3233 and (optional) INTERACTIVE-SPEC.
3234 The first four arguments are required; at most six have any
3236 The ARGLIST can be either like the one of `lambda', in which case the arguments
3237 will be dynamically bound before executing the byte code, or it can be an
3238 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3239 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3240 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3241 argument to catch the left-over arguments. If such an integer is used, the
3242 arguments will not be dynamically bound but will be instead pushed on the
3243 stack before executing the byte-code.
3244 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3245 (ptrdiff_t nargs
, Lisp_Object
*args
)
3248 register Lisp_Object val
= make_uninit_vector (nargs
);
3249 register struct Lisp_Vector
*p
= XVECTOR (val
);
3251 /* We used to purecopy everything here, if purify-flag was set. This worked
3252 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3253 dangerous, since make-byte-code is used during execution to build
3254 closures, so any closure built during the preload phase would end up
3255 copied into pure space, including its free variables, which is sometimes
3256 just wasteful and other times plainly wrong (e.g. those free vars may want
3259 for (i
= 0; i
< nargs
; i
++)
3260 p
->contents
[i
] = args
[i
];
3262 XSETCOMPILED (val
, p
);
3268 /***********************************************************************
3270 ***********************************************************************/
3272 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3273 of the required alignment if LSB tags are used. */
3275 union aligned_Lisp_Symbol
3277 struct Lisp_Symbol s
;
3279 unsigned char c
[(sizeof (struct Lisp_Symbol
) + GCALIGNMENT
- 1)
3284 /* Each symbol_block is just under 1020 bytes long, since malloc
3285 really allocates in units of powers of two and uses 4 bytes for its
3288 #define SYMBOL_BLOCK_SIZE \
3289 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3293 /* Place `symbols' first, to preserve alignment. */
3294 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3295 struct symbol_block
*next
;
3298 /* Current symbol block and index of first unused Lisp_Symbol
3301 static struct symbol_block
*symbol_block
;
3302 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3303 /* Pointer to the first symbol_block that contains pinned symbols.
3304 Tests for 24.4 showed that at dump-time, Emacs contains about 15K symbols,
3305 10K of which are pinned (and all but 250 of them are interned in obarray),
3306 whereas a "typical session" has in the order of 30K symbols.
3307 `symbol_block_pinned' lets mark_pinned_symbols scan only 15K symbols rather
3308 than 30K to find the 10K symbols we need to mark. */
3309 static struct symbol_block
*symbol_block_pinned
;
3311 /* List of free symbols. */
3313 static struct Lisp_Symbol
*symbol_free_list
;
3316 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
3318 XSYMBOL (sym
)->name
= name
;
3321 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3322 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3323 Its value is void, and its function definition and property list are nil. */)
3326 register Lisp_Object val
;
3327 register struct Lisp_Symbol
*p
;
3329 CHECK_STRING (name
);
3331 if (symbol_free_list
)
3333 XSETSYMBOL (val
, symbol_free_list
);
3334 symbol_free_list
= symbol_free_list
->next
;
3338 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3340 struct symbol_block
*new
3341 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3342 new->next
= symbol_block
;
3344 symbol_block_index
= 0;
3345 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3347 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3348 symbol_block_index
++;
3352 set_symbol_name (val
, name
);
3353 set_symbol_plist (val
, Qnil
);
3354 p
->redirect
= SYMBOL_PLAINVAL
;
3355 SET_SYMBOL_VAL (p
, Qunbound
);
3356 set_symbol_function (val
, Qnil
);
3357 set_symbol_next (val
, NULL
);
3358 p
->gcmarkbit
= false;
3359 p
->interned
= SYMBOL_UNINTERNED
;
3361 p
->declared_special
= false;
3363 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3365 total_free_symbols
--;
3371 /***********************************************************************
3372 Marker (Misc) Allocation
3373 ***********************************************************************/
3375 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3376 the required alignment when LSB tags are used. */
3378 union aligned_Lisp_Misc
3382 unsigned char c
[(sizeof (union Lisp_Misc
) + GCALIGNMENT
- 1)
3387 /* Allocation of markers and other objects that share that structure.
3388 Works like allocation of conses. */
3390 #define MARKER_BLOCK_SIZE \
3391 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3395 /* Place `markers' first, to preserve alignment. */
3396 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3397 struct marker_block
*next
;
3400 static struct marker_block
*marker_block
;
3401 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3403 static union Lisp_Misc
*marker_free_list
;
3405 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3408 allocate_misc (enum Lisp_Misc_Type type
)
3412 if (marker_free_list
)
3414 XSETMISC (val
, marker_free_list
);
3415 marker_free_list
= marker_free_list
->u_free
.chain
;
3419 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3421 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3422 new->next
= marker_block
;
3424 marker_block_index
= 0;
3425 total_free_markers
+= MARKER_BLOCK_SIZE
;
3427 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3428 marker_block_index
++;
3431 --total_free_markers
;
3432 consing_since_gc
+= sizeof (union Lisp_Misc
);
3433 misc_objects_consed
++;
3434 XMISCANY (val
)->type
= type
;
3435 XMISCANY (val
)->gcmarkbit
= 0;
3439 /* Free a Lisp_Misc object. */
3442 free_misc (Lisp_Object misc
)
3444 XMISCANY (misc
)->type
= Lisp_Misc_Free
;
3445 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3446 marker_free_list
= XMISC (misc
);
3447 consing_since_gc
-= sizeof (union Lisp_Misc
);
3448 total_free_markers
++;
3451 /* Verify properties of Lisp_Save_Value's representation
3452 that are assumed here and elsewhere. */
3454 verify (SAVE_UNUSED
== 0);
3455 verify (((SAVE_INTEGER
| SAVE_POINTER
| SAVE_FUNCPOINTER
| SAVE_OBJECT
)
3459 /* Return Lisp_Save_Value objects for the various combinations
3460 that callers need. */
3463 make_save_int_int_int (ptrdiff_t a
, ptrdiff_t b
, ptrdiff_t c
)
3465 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3466 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3467 p
->save_type
= SAVE_TYPE_INT_INT_INT
;
3468 p
->data
[0].integer
= a
;
3469 p
->data
[1].integer
= b
;
3470 p
->data
[2].integer
= c
;
3475 make_save_obj_obj_obj_obj (Lisp_Object a
, Lisp_Object b
, Lisp_Object c
,
3478 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3479 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3480 p
->save_type
= SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
;
3481 p
->data
[0].object
= a
;
3482 p
->data
[1].object
= b
;
3483 p
->data
[2].object
= c
;
3484 p
->data
[3].object
= d
;
3489 make_save_ptr (void *a
)
3491 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3492 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3493 p
->save_type
= SAVE_POINTER
;
3494 p
->data
[0].pointer
= a
;
3499 make_save_ptr_int (void *a
, ptrdiff_t b
)
3501 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3502 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3503 p
->save_type
= SAVE_TYPE_PTR_INT
;
3504 p
->data
[0].pointer
= a
;
3505 p
->data
[1].integer
= b
;
3509 #if ! (defined USE_X_TOOLKIT || defined USE_GTK)
3511 make_save_ptr_ptr (void *a
, void *b
)
3513 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3514 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3515 p
->save_type
= SAVE_TYPE_PTR_PTR
;
3516 p
->data
[0].pointer
= a
;
3517 p
->data
[1].pointer
= b
;
3523 make_save_funcptr_ptr_obj (void (*a
) (void), void *b
, Lisp_Object c
)
3525 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3526 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3527 p
->save_type
= SAVE_TYPE_FUNCPTR_PTR_OBJ
;
3528 p
->data
[0].funcpointer
= a
;
3529 p
->data
[1].pointer
= b
;
3530 p
->data
[2].object
= c
;
3534 /* Return a Lisp_Save_Value object that represents an array A
3535 of N Lisp objects. */
3538 make_save_memory (Lisp_Object
*a
, ptrdiff_t n
)
3540 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3541 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3542 p
->save_type
= SAVE_TYPE_MEMORY
;
3543 p
->data
[0].pointer
= a
;
3544 p
->data
[1].integer
= n
;
3548 /* Free a Lisp_Save_Value object. Do not use this function
3549 if SAVE contains pointer other than returned by xmalloc. */
3552 free_save_value (Lisp_Object save
)
3554 xfree (XSAVE_POINTER (save
, 0));
3558 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3561 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3563 register Lisp_Object overlay
;
3565 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3566 OVERLAY_START (overlay
) = start
;
3567 OVERLAY_END (overlay
) = end
;
3568 set_overlay_plist (overlay
, plist
);
3569 XOVERLAY (overlay
)->next
= NULL
;
3573 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3574 doc
: /* Return a newly allocated marker which does not point at any place. */)
3577 register Lisp_Object val
;
3578 register struct Lisp_Marker
*p
;
3580 val
= allocate_misc (Lisp_Misc_Marker
);
3586 p
->insertion_type
= 0;
3587 p
->need_adjustment
= 0;
3591 /* Return a newly allocated marker which points into BUF
3592 at character position CHARPOS and byte position BYTEPOS. */
3595 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3598 struct Lisp_Marker
*m
;
3600 /* No dead buffers here. */
3601 eassert (BUFFER_LIVE_P (buf
));
3603 /* Every character is at least one byte. */
3604 eassert (charpos
<= bytepos
);
3606 obj
= allocate_misc (Lisp_Misc_Marker
);
3609 m
->charpos
= charpos
;
3610 m
->bytepos
= bytepos
;
3611 m
->insertion_type
= 0;
3612 m
->need_adjustment
= 0;
3613 m
->next
= BUF_MARKERS (buf
);
3614 BUF_MARKERS (buf
) = m
;
3618 /* Put MARKER back on the free list after using it temporarily. */
3621 free_marker (Lisp_Object marker
)
3623 unchain_marker (XMARKER (marker
));
3628 /* Return a newly created vector or string with specified arguments as
3629 elements. If all the arguments are characters that can fit
3630 in a string of events, make a string; otherwise, make a vector.
3632 Any number of arguments, even zero arguments, are allowed. */
3635 make_event_array (ptrdiff_t nargs
, Lisp_Object
*args
)
3639 for (i
= 0; i
< nargs
; i
++)
3640 /* The things that fit in a string
3641 are characters that are in 0...127,
3642 after discarding the meta bit and all the bits above it. */
3643 if (!INTEGERP (args
[i
])
3644 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3645 return Fvector (nargs
, args
);
3647 /* Since the loop exited, we know that all the things in it are
3648 characters, so we can make a string. */
3652 result
= Fmake_string (make_number (nargs
), make_number (0));
3653 for (i
= 0; i
< nargs
; i
++)
3655 SSET (result
, i
, XINT (args
[i
]));
3656 /* Move the meta bit to the right place for a string char. */
3657 if (XINT (args
[i
]) & CHAR_META
)
3658 SSET (result
, i
, SREF (result
, i
) | 0x80);
3667 /************************************************************************
3668 Memory Full Handling
3669 ************************************************************************/
3672 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3673 there may have been size_t overflow so that malloc was never
3674 called, or perhaps malloc was invoked successfully but the
3675 resulting pointer had problems fitting into a tagged EMACS_INT. In
3676 either case this counts as memory being full even though malloc did
3680 memory_full (size_t nbytes
)
3682 /* Do not go into hysterics merely because a large request failed. */
3683 bool enough_free_memory
= 0;
3684 if (SPARE_MEMORY
< nbytes
)
3688 p
= malloc (SPARE_MEMORY
);
3692 enough_free_memory
= 1;
3696 if (! enough_free_memory
)
3700 /* The first time we get here, free the spare memory. */
3703 free (spare_memory
);
3704 spare_memory
= NULL
;
3708 /* This used to call error, but if we've run out of memory, we could
3709 get infinite recursion trying to build the string. */
3710 xsignal (Qnil
, Vmemory_signal_data
);
3713 /* If we released our reserve (due to running out of memory),
3714 and we have a fair amount free once again,
3715 try to set aside another reserve in case we run out once more.
3717 This is called when a relocatable block is freed in ralloc.c,
3718 and also directly from this file, in case we're not using ralloc.c. */
3721 refill_memory_reserve (void)
3723 #ifndef SYSTEM_MALLOC
3724 if (spare_memory
== NULL
)
3725 spare_memory
= malloc (SPARE_MEMORY
);
3728 Vmemory_full
= Qnil
;
3732 /************************************************************************
3734 ************************************************************************/
3736 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3738 /* Conservative C stack marking requires a method to identify possibly
3739 live Lisp objects given a pointer value. We do this by keeping
3740 track of blocks of Lisp data that are allocated in a red-black tree
3741 (see also the comment of mem_node which is the type of nodes in
3742 that tree). Function lisp_malloc adds information for an allocated
3743 block to the red-black tree with calls to mem_insert, and function
3744 lisp_free removes it with mem_delete. Functions live_string_p etc
3745 call mem_find to lookup information about a given pointer in the
3746 tree, and use that to determine if the pointer points to a Lisp
3749 /* Initialize this part of alloc.c. */
3754 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3755 mem_z
.parent
= NULL
;
3756 mem_z
.color
= MEM_BLACK
;
3757 mem_z
.start
= mem_z
.end
= NULL
;
3762 /* Value is a pointer to the mem_node containing START. Value is
3763 MEM_NIL if there is no node in the tree containing START. */
3765 static struct mem_node
*
3766 mem_find (void *start
)
3770 if (start
< min_heap_address
|| start
> max_heap_address
)
3773 /* Make the search always successful to speed up the loop below. */
3774 mem_z
.start
= start
;
3775 mem_z
.end
= (char *) start
+ 1;
3778 while (start
< p
->start
|| start
>= p
->end
)
3779 p
= start
< p
->start
? p
->left
: p
->right
;
3784 /* Insert a new node into the tree for a block of memory with start
3785 address START, end address END, and type TYPE. Value is a
3786 pointer to the node that was inserted. */
3788 static struct mem_node
*
3789 mem_insert (void *start
, void *end
, enum mem_type type
)
3791 struct mem_node
*c
, *parent
, *x
;
3793 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3794 min_heap_address
= start
;
3795 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3796 max_heap_address
= end
;
3798 /* See where in the tree a node for START belongs. In this
3799 particular application, it shouldn't happen that a node is already
3800 present. For debugging purposes, let's check that. */
3804 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3806 while (c
!= MEM_NIL
)
3808 if (start
>= c
->start
&& start
< c
->end
)
3811 c
= start
< c
->start
? c
->left
: c
->right
;
3814 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3816 while (c
!= MEM_NIL
)
3819 c
= start
< c
->start
? c
->left
: c
->right
;
3822 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3824 /* Create a new node. */
3825 #ifdef GC_MALLOC_CHECK
3826 x
= malloc (sizeof *x
);
3830 x
= xmalloc (sizeof *x
);
3836 x
->left
= x
->right
= MEM_NIL
;
3839 /* Insert it as child of PARENT or install it as root. */
3842 if (start
< parent
->start
)
3850 /* Re-establish red-black tree properties. */
3851 mem_insert_fixup (x
);
3857 /* Re-establish the red-black properties of the tree, and thereby
3858 balance the tree, after node X has been inserted; X is always red. */
3861 mem_insert_fixup (struct mem_node
*x
)
3863 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3865 /* X is red and its parent is red. This is a violation of
3866 red-black tree property #3. */
3868 if (x
->parent
== x
->parent
->parent
->left
)
3870 /* We're on the left side of our grandparent, and Y is our
3872 struct mem_node
*y
= x
->parent
->parent
->right
;
3874 if (y
->color
== MEM_RED
)
3876 /* Uncle and parent are red but should be black because
3877 X is red. Change the colors accordingly and proceed
3878 with the grandparent. */
3879 x
->parent
->color
= MEM_BLACK
;
3880 y
->color
= MEM_BLACK
;
3881 x
->parent
->parent
->color
= MEM_RED
;
3882 x
= x
->parent
->parent
;
3886 /* Parent and uncle have different colors; parent is
3887 red, uncle is black. */
3888 if (x
== x
->parent
->right
)
3891 mem_rotate_left (x
);
3894 x
->parent
->color
= MEM_BLACK
;
3895 x
->parent
->parent
->color
= MEM_RED
;
3896 mem_rotate_right (x
->parent
->parent
);
3901 /* This is the symmetrical case of above. */
3902 struct mem_node
*y
= x
->parent
->parent
->left
;
3904 if (y
->color
== MEM_RED
)
3906 x
->parent
->color
= MEM_BLACK
;
3907 y
->color
= MEM_BLACK
;
3908 x
->parent
->parent
->color
= MEM_RED
;
3909 x
= x
->parent
->parent
;
3913 if (x
== x
->parent
->left
)
3916 mem_rotate_right (x
);
3919 x
->parent
->color
= MEM_BLACK
;
3920 x
->parent
->parent
->color
= MEM_RED
;
3921 mem_rotate_left (x
->parent
->parent
);
3926 /* The root may have been changed to red due to the algorithm. Set
3927 it to black so that property #5 is satisfied. */
3928 mem_root
->color
= MEM_BLACK
;
3939 mem_rotate_left (struct mem_node
*x
)
3943 /* Turn y's left sub-tree into x's right sub-tree. */
3946 if (y
->left
!= MEM_NIL
)
3947 y
->left
->parent
= x
;
3949 /* Y's parent was x's parent. */
3951 y
->parent
= x
->parent
;
3953 /* Get the parent to point to y instead of x. */
3956 if (x
== x
->parent
->left
)
3957 x
->parent
->left
= y
;
3959 x
->parent
->right
= y
;
3964 /* Put x on y's left. */
3978 mem_rotate_right (struct mem_node
*x
)
3980 struct mem_node
*y
= x
->left
;
3983 if (y
->right
!= MEM_NIL
)
3984 y
->right
->parent
= x
;
3987 y
->parent
= x
->parent
;
3990 if (x
== x
->parent
->right
)
3991 x
->parent
->right
= y
;
3993 x
->parent
->left
= y
;
4004 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4007 mem_delete (struct mem_node
*z
)
4009 struct mem_node
*x
, *y
;
4011 if (!z
|| z
== MEM_NIL
)
4014 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4019 while (y
->left
!= MEM_NIL
)
4023 if (y
->left
!= MEM_NIL
)
4028 x
->parent
= y
->parent
;
4031 if (y
== y
->parent
->left
)
4032 y
->parent
->left
= x
;
4034 y
->parent
->right
= x
;
4041 z
->start
= y
->start
;
4046 if (y
->color
== MEM_BLACK
)
4047 mem_delete_fixup (x
);
4049 #ifdef GC_MALLOC_CHECK
4057 /* Re-establish the red-black properties of the tree, after a
4061 mem_delete_fixup (struct mem_node
*x
)
4063 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4065 if (x
== x
->parent
->left
)
4067 struct mem_node
*w
= x
->parent
->right
;
4069 if (w
->color
== MEM_RED
)
4071 w
->color
= MEM_BLACK
;
4072 x
->parent
->color
= MEM_RED
;
4073 mem_rotate_left (x
->parent
);
4074 w
= x
->parent
->right
;
4077 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4084 if (w
->right
->color
== MEM_BLACK
)
4086 w
->left
->color
= MEM_BLACK
;
4088 mem_rotate_right (w
);
4089 w
= x
->parent
->right
;
4091 w
->color
= x
->parent
->color
;
4092 x
->parent
->color
= MEM_BLACK
;
4093 w
->right
->color
= MEM_BLACK
;
4094 mem_rotate_left (x
->parent
);
4100 struct mem_node
*w
= x
->parent
->left
;
4102 if (w
->color
== MEM_RED
)
4104 w
->color
= MEM_BLACK
;
4105 x
->parent
->color
= MEM_RED
;
4106 mem_rotate_right (x
->parent
);
4107 w
= x
->parent
->left
;
4110 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4117 if (w
->left
->color
== MEM_BLACK
)
4119 w
->right
->color
= MEM_BLACK
;
4121 mem_rotate_left (w
);
4122 w
= x
->parent
->left
;
4125 w
->color
= x
->parent
->color
;
4126 x
->parent
->color
= MEM_BLACK
;
4127 w
->left
->color
= MEM_BLACK
;
4128 mem_rotate_right (x
->parent
);
4134 x
->color
= MEM_BLACK
;
4138 /* Value is non-zero if P is a pointer to a live Lisp string on
4139 the heap. M is a pointer to the mem_block for P. */
4142 live_string_p (struct mem_node
*m
, void *p
)
4144 if (m
->type
== MEM_TYPE_STRING
)
4146 struct string_block
*b
= m
->start
;
4147 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4149 /* P must point to the start of a Lisp_String structure, and it
4150 must not be on the free-list. */
4152 && offset
% sizeof b
->strings
[0] == 0
4153 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4154 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4161 /* Value is non-zero if P is a pointer to a live Lisp cons on
4162 the heap. M is a pointer to the mem_block for P. */
4165 live_cons_p (struct mem_node
*m
, void *p
)
4167 if (m
->type
== MEM_TYPE_CONS
)
4169 struct cons_block
*b
= m
->start
;
4170 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4172 /* P must point to the start of a Lisp_Cons, not be
4173 one of the unused cells in the current cons block,
4174 and not be on the free-list. */
4176 && offset
% sizeof b
->conses
[0] == 0
4177 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4179 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4180 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
4187 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4188 the heap. M is a pointer to the mem_block for P. */
4191 live_symbol_p (struct mem_node
*m
, void *p
)
4193 if (m
->type
== MEM_TYPE_SYMBOL
)
4195 struct symbol_block
*b
= m
->start
;
4196 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4198 /* P must point to the start of a Lisp_Symbol, not be
4199 one of the unused cells in the current symbol block,
4200 and not be on the free-list. */
4202 && offset
% sizeof b
->symbols
[0] == 0
4203 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4204 && (b
!= symbol_block
4205 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4206 && !EQ (((struct Lisp_Symbol
*)p
)->function
, Vdead
));
4213 /* Value is non-zero if P is a pointer to a live Lisp float on
4214 the heap. M is a pointer to the mem_block for P. */
4217 live_float_p (struct mem_node
*m
, void *p
)
4219 if (m
->type
== MEM_TYPE_FLOAT
)
4221 struct float_block
*b
= m
->start
;
4222 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4224 /* P must point to the start of a Lisp_Float and not be
4225 one of the unused cells in the current float block. */
4227 && offset
% sizeof b
->floats
[0] == 0
4228 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4229 && (b
!= float_block
4230 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4237 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4238 the heap. M is a pointer to the mem_block for P. */
4241 live_misc_p (struct mem_node
*m
, void *p
)
4243 if (m
->type
== MEM_TYPE_MISC
)
4245 struct marker_block
*b
= m
->start
;
4246 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4248 /* P must point to the start of a Lisp_Misc, not be
4249 one of the unused cells in the current misc block,
4250 and not be on the free-list. */
4252 && offset
% sizeof b
->markers
[0] == 0
4253 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4254 && (b
!= marker_block
4255 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4256 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4263 /* Value is non-zero if P is a pointer to a live vector-like object.
4264 M is a pointer to the mem_block for P. */
4267 live_vector_p (struct mem_node
*m
, void *p
)
4269 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4271 /* This memory node corresponds to a vector block. */
4272 struct vector_block
*block
= m
->start
;
4273 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4275 /* P is in the block's allocation range. Scan the block
4276 up to P and see whether P points to the start of some
4277 vector which is not on a free list. FIXME: check whether
4278 some allocation patterns (probably a lot of short vectors)
4279 may cause a substantial overhead of this loop. */
4280 while (VECTOR_IN_BLOCK (vector
, block
)
4281 && vector
<= (struct Lisp_Vector
*) p
)
4283 if (!PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
) && vector
== p
)
4286 vector
= ADVANCE (vector
, vector_nbytes (vector
));
4289 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== large_vector_vec (m
->start
))
4290 /* This memory node corresponds to a large vector. */
4296 /* Value is non-zero if P is a pointer to a live buffer. M is a
4297 pointer to the mem_block for P. */
4300 live_buffer_p (struct mem_node
*m
, void *p
)
4302 /* P must point to the start of the block, and the buffer
4303 must not have been killed. */
4304 return (m
->type
== MEM_TYPE_BUFFER
4306 && !NILP (((struct buffer
*) p
)->INTERNAL_FIELD (name
)));
4309 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4313 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4315 /* Currently not used, but may be called from gdb. */
4317 void dump_zombies (void) EXTERNALLY_VISIBLE
;
4319 /* Array of objects that are kept alive because the C stack contains
4320 a pattern that looks like a reference to them. */
4322 #define MAX_ZOMBIES 10
4323 static Lisp_Object zombies
[MAX_ZOMBIES
];
4325 /* Number of zombie objects. */
4327 static EMACS_INT nzombies
;
4329 /* Number of garbage collections. */
4331 static EMACS_INT ngcs
;
4333 /* Average percentage of zombies per collection. */
4335 static double avg_zombies
;
4337 /* Max. number of live and zombie objects. */
4339 static EMACS_INT max_live
, max_zombies
;
4341 /* Average number of live objects per GC. */
4343 static double avg_live
;
4345 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4346 doc
: /* Show information about live and zombie objects. */)
4349 Lisp_Object args
[8], zombie_list
= Qnil
;
4351 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); i
++)
4352 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4353 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4354 args
[1] = make_number (ngcs
);
4355 args
[2] = make_float (avg_live
);
4356 args
[3] = make_float (avg_zombies
);
4357 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4358 args
[5] = make_number (max_live
);
4359 args
[6] = make_number (max_zombies
);
4360 args
[7] = zombie_list
;
4361 return Fmessage (8, args
);
4364 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4367 /* Mark OBJ if we can prove it's a Lisp_Object. */
4370 mark_maybe_object (Lisp_Object obj
)
4377 VALGRIND_MAKE_MEM_DEFINED (&obj
, sizeof (obj
));
4383 po
= (void *) XPNTR (obj
);
4390 switch (XTYPE (obj
))
4393 mark_p
= (live_string_p (m
, po
)
4394 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4398 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4402 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4406 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4409 case Lisp_Vectorlike
:
4410 /* Note: can't check BUFFERP before we know it's a
4411 buffer because checking that dereferences the pointer
4412 PO which might point anywhere. */
4413 if (live_vector_p (m
, po
))
4414 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4415 else if (live_buffer_p (m
, po
))
4416 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4420 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4429 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4430 if (nzombies
< MAX_ZOMBIES
)
4431 zombies
[nzombies
] = obj
;
4439 /* Return true if P can point to Lisp data, and false otherwise.
4440 USE_LSB_TAG needs Lisp data to be aligned on multiples of GCALIGNMENT.
4441 Otherwise, assume that Lisp data is aligned on even addresses. */
4444 maybe_lisp_pointer (void *p
)
4446 return !((intptr_t) p
% (USE_LSB_TAG
? GCALIGNMENT
: 2));
4449 /* If P points to Lisp data, mark that as live if it isn't already
4453 mark_maybe_pointer (void *p
)
4459 VALGRIND_MAKE_MEM_DEFINED (&p
, sizeof (p
));
4462 if (!maybe_lisp_pointer (p
))
4468 Lisp_Object obj
= Qnil
;
4472 case MEM_TYPE_NON_LISP
:
4473 case MEM_TYPE_SPARE
:
4474 /* Nothing to do; not a pointer to Lisp memory. */
4477 case MEM_TYPE_BUFFER
:
4478 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4479 XSETVECTOR (obj
, p
);
4483 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4487 case MEM_TYPE_STRING
:
4488 if (live_string_p (m
, p
)
4489 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4490 XSETSTRING (obj
, p
);
4494 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4498 case MEM_TYPE_SYMBOL
:
4499 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4500 XSETSYMBOL (obj
, p
);
4503 case MEM_TYPE_FLOAT
:
4504 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4508 case MEM_TYPE_VECTORLIKE
:
4509 case MEM_TYPE_VECTOR_BLOCK
:
4510 if (live_vector_p (m
, p
))
4513 XSETVECTOR (tem
, p
);
4514 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4529 /* Alignment of pointer values. Use alignof, as it sometimes returns
4530 a smaller alignment than GCC's __alignof__ and mark_memory might
4531 miss objects if __alignof__ were used. */
4532 #define GC_POINTER_ALIGNMENT alignof (void *)
4534 /* Define POINTERS_MIGHT_HIDE_IN_OBJECTS to 1 if marking via C pointers does
4535 not suffice, which is the typical case. A host where a Lisp_Object is
4536 wider than a pointer might allocate a Lisp_Object in non-adjacent halves.
4537 If USE_LSB_TAG, the bottom half is not a valid pointer, but it should
4538 suffice to widen it to to a Lisp_Object and check it that way. */
4539 #if USE_LSB_TAG || VAL_MAX < UINTPTR_MAX
4540 # if !USE_LSB_TAG && VAL_MAX < UINTPTR_MAX >> GCTYPEBITS
4541 /* If tag bits straddle pointer-word boundaries, neither mark_maybe_pointer
4542 nor mark_maybe_object can follow the pointers. This should not occur on
4543 any practical porting target. */
4544 # error "MSB type bits straddle pointer-word boundaries"
4546 /* Marking via C pointers does not suffice, because Lisp_Objects contain
4547 pointer words that hold pointers ORed with type bits. */
4548 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 1
4550 /* Marking via C pointers suffices, because Lisp_Objects contain pointer
4551 words that hold unmodified pointers. */
4552 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 0
4555 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4556 or END+OFFSET..START. */
4558 static void ATTRIBUTE_NO_SANITIZE_ADDRESS
4559 mark_memory (void *start
, void *end
)
4564 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4568 /* Make START the pointer to the start of the memory region,
4569 if it isn't already. */
4577 /* Mark Lisp data pointed to. This is necessary because, in some
4578 situations, the C compiler optimizes Lisp objects away, so that
4579 only a pointer to them remains. Example:
4581 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4584 Lisp_Object obj = build_string ("test");
4585 struct Lisp_String *s = XSTRING (obj);
4586 Fgarbage_collect ();
4587 fprintf (stderr, "test `%s'\n", s->data);
4591 Here, `obj' isn't really used, and the compiler optimizes it
4592 away. The only reference to the life string is through the
4595 for (pp
= start
; (void *) pp
< end
; pp
++)
4596 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4598 void *p
= *(void **) ((char *) pp
+ i
);
4599 mark_maybe_pointer (p
);
4600 if (POINTERS_MIGHT_HIDE_IN_OBJECTS
)
4601 mark_maybe_object (XIL ((intptr_t) p
));
4605 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4607 static bool setjmp_tested_p
;
4608 static int longjmps_done
;
4610 #define SETJMP_WILL_LIKELY_WORK "\
4612 Emacs garbage collector has been changed to use conservative stack\n\
4613 marking. Emacs has determined that the method it uses to do the\n\
4614 marking will likely work on your system, but this isn't sure.\n\
4616 If you are a system-programmer, or can get the help of a local wizard\n\
4617 who is, please take a look at the function mark_stack in alloc.c, and\n\
4618 verify that the methods used are appropriate for your system.\n\
4620 Please mail the result to <emacs-devel@gnu.org>.\n\
4623 #define SETJMP_WILL_NOT_WORK "\
4625 Emacs garbage collector has been changed to use conservative stack\n\
4626 marking. Emacs has determined that the default method it uses to do the\n\
4627 marking will not work on your system. We will need a system-dependent\n\
4628 solution for your system.\n\
4630 Please take a look at the function mark_stack in alloc.c, and\n\
4631 try to find a way to make it work on your system.\n\
4633 Note that you may get false negatives, depending on the compiler.\n\
4634 In particular, you need to use -O with GCC for this test.\n\
4636 Please mail the result to <emacs-devel@gnu.org>.\n\
4640 /* Perform a quick check if it looks like setjmp saves registers in a
4641 jmp_buf. Print a message to stderr saying so. When this test
4642 succeeds, this is _not_ a proof that setjmp is sufficient for
4643 conservative stack marking. Only the sources or a disassembly
4653 /* Arrange for X to be put in a register. */
4659 if (longjmps_done
== 1)
4661 /* Came here after the longjmp at the end of the function.
4663 If x == 1, the longjmp has restored the register to its
4664 value before the setjmp, and we can hope that setjmp
4665 saves all such registers in the jmp_buf, although that
4668 For other values of X, either something really strange is
4669 taking place, or the setjmp just didn't save the register. */
4672 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4675 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4682 if (longjmps_done
== 1)
4683 sys_longjmp (jbuf
, 1);
4686 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4689 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4691 /* Abort if anything GCPRO'd doesn't survive the GC. */
4699 for (p
= gcprolist
; p
; p
= p
->next
)
4700 for (i
= 0; i
< p
->nvars
; ++i
)
4701 if (!survives_gc_p (p
->var
[i
]))
4702 /* FIXME: It's not necessarily a bug. It might just be that the
4703 GCPRO is unnecessary or should release the object sooner. */
4707 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4714 fprintf (stderr
, "\nZombies kept alive = %"pI
"d:\n", nzombies
);
4715 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4717 fprintf (stderr
, " %d = ", i
);
4718 debug_print (zombies
[i
]);
4722 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4725 /* Mark live Lisp objects on the C stack.
4727 There are several system-dependent problems to consider when
4728 porting this to new architectures:
4732 We have to mark Lisp objects in CPU registers that can hold local
4733 variables or are used to pass parameters.
4735 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4736 something that either saves relevant registers on the stack, or
4737 calls mark_maybe_object passing it each register's contents.
4739 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4740 implementation assumes that calling setjmp saves registers we need
4741 to see in a jmp_buf which itself lies on the stack. This doesn't
4742 have to be true! It must be verified for each system, possibly
4743 by taking a look at the source code of setjmp.
4745 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4746 can use it as a machine independent method to store all registers
4747 to the stack. In this case the macros described in the previous
4748 two paragraphs are not used.
4752 Architectures differ in the way their processor stack is organized.
4753 For example, the stack might look like this
4756 | Lisp_Object | size = 4
4758 | something else | size = 2
4760 | Lisp_Object | size = 4
4764 In such a case, not every Lisp_Object will be aligned equally. To
4765 find all Lisp_Object on the stack it won't be sufficient to walk
4766 the stack in steps of 4 bytes. Instead, two passes will be
4767 necessary, one starting at the start of the stack, and a second
4768 pass starting at the start of the stack + 2. Likewise, if the
4769 minimal alignment of Lisp_Objects on the stack is 1, four passes
4770 would be necessary, each one starting with one byte more offset
4771 from the stack start. */
4774 mark_stack (void *end
)
4777 /* This assumes that the stack is a contiguous region in memory. If
4778 that's not the case, something has to be done here to iterate
4779 over the stack segments. */
4780 mark_memory (stack_base
, end
);
4782 /* Allow for marking a secondary stack, like the register stack on the
4784 #ifdef GC_MARK_SECONDARY_STACK
4785 GC_MARK_SECONDARY_STACK ();
4788 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4793 #else /* GC_MARK_STACK == 0 */
4795 #define mark_maybe_object(obj) emacs_abort ()
4797 #endif /* GC_MARK_STACK != 0 */
4800 /* Determine whether it is safe to access memory at address P. */
4802 valid_pointer_p (void *p
)
4805 return w32_valid_pointer_p (p
, 16);
4809 /* Obviously, we cannot just access it (we would SEGV trying), so we
4810 trick the o/s to tell us whether p is a valid pointer.
4811 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4812 not validate p in that case. */
4814 if (emacs_pipe (fd
) == 0)
4816 bool valid
= emacs_write (fd
[1], p
, 16) == 16;
4817 emacs_close (fd
[1]);
4818 emacs_close (fd
[0]);
4826 /* Return 2 if OBJ is a killed or special buffer object, 1 if OBJ is a
4827 valid lisp object, 0 if OBJ is NOT a valid lisp object, or -1 if we
4828 cannot validate OBJ. This function can be quite slow, so its primary
4829 use is the manual debugging. The only exception is print_object, where
4830 we use it to check whether the memory referenced by the pointer of
4831 Lisp_Save_Value object contains valid objects. */
4834 valid_lisp_object_p (Lisp_Object obj
)
4844 p
= (void *) XPNTR (obj
);
4845 if (PURE_POINTER_P (p
))
4848 if (p
== &buffer_defaults
|| p
== &buffer_local_symbols
)
4852 return valid_pointer_p (p
);
4859 int valid
= valid_pointer_p (p
);
4871 case MEM_TYPE_NON_LISP
:
4872 case MEM_TYPE_SPARE
:
4875 case MEM_TYPE_BUFFER
:
4876 return live_buffer_p (m
, p
) ? 1 : 2;
4879 return live_cons_p (m
, p
);
4881 case MEM_TYPE_STRING
:
4882 return live_string_p (m
, p
);
4885 return live_misc_p (m
, p
);
4887 case MEM_TYPE_SYMBOL
:
4888 return live_symbol_p (m
, p
);
4890 case MEM_TYPE_FLOAT
:
4891 return live_float_p (m
, p
);
4893 case MEM_TYPE_VECTORLIKE
:
4894 case MEM_TYPE_VECTOR_BLOCK
:
4895 return live_vector_p (m
, p
);
4905 /* If GC_MARK_STACK, return 1 if STR is a relocatable data of Lisp_String
4906 (i.e. there is a non-pure Lisp_Object X so that SDATA (X) == STR) and 0
4907 if not. Otherwise we can't rely on valid_lisp_object_p and return -1.
4908 This function is slow and should be used for debugging purposes. */
4911 relocatable_string_data_p (const char *str
)
4913 if (PURE_POINTER_P (str
))
4919 = (struct sdata
*) (str
- offsetof (struct sdata
, data
));
4921 if (valid_pointer_p (sdata
)
4922 && valid_pointer_p (sdata
->string
)
4923 && maybe_lisp_pointer (sdata
->string
))
4924 return (valid_lisp_object_p
4925 (make_lisp_ptr (sdata
->string
, Lisp_String
))
4926 && (const char *) sdata
->string
->data
== str
);
4929 #endif /* GC_MARK_STACK */
4933 /***********************************************************************
4934 Pure Storage Management
4935 ***********************************************************************/
4937 /* Allocate room for SIZE bytes from pure Lisp storage and return a
4938 pointer to it. TYPE is the Lisp type for which the memory is
4939 allocated. TYPE < 0 means it's not used for a Lisp object. */
4942 pure_alloc (size_t size
, int type
)
4946 size_t alignment
= GCALIGNMENT
;
4948 size_t alignment
= alignof (EMACS_INT
);
4950 /* Give Lisp_Floats an extra alignment. */
4951 if (type
== Lisp_Float
)
4952 alignment
= alignof (struct Lisp_Float
);
4958 /* Allocate space for a Lisp object from the beginning of the free
4959 space with taking account of alignment. */
4960 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
4961 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
4965 /* Allocate space for a non-Lisp object from the end of the free
4967 pure_bytes_used_non_lisp
+= size
;
4968 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4970 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
4972 if (pure_bytes_used
<= pure_size
)
4975 /* Don't allocate a large amount here,
4976 because it might get mmap'd and then its address
4977 might not be usable. */
4978 purebeg
= xmalloc (10000);
4980 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
4981 pure_bytes_used
= 0;
4982 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
4987 /* Print a warning if PURESIZE is too small. */
4990 check_pure_size (void)
4992 if (pure_bytes_used_before_overflow
)
4993 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
4995 pure_bytes_used
+ pure_bytes_used_before_overflow
);
4999 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
5000 the non-Lisp data pool of the pure storage, and return its start
5001 address. Return NULL if not found. */
5004 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5007 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5008 const unsigned char *p
;
5011 if (pure_bytes_used_non_lisp
<= nbytes
)
5014 /* Set up the Boyer-Moore table. */
5016 for (i
= 0; i
< 256; i
++)
5019 p
= (const unsigned char *) data
;
5021 bm_skip
[*p
++] = skip
;
5023 last_char_skip
= bm_skip
['\0'];
5025 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5026 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5028 /* See the comments in the function `boyer_moore' (search.c) for the
5029 use of `infinity'. */
5030 infinity
= pure_bytes_used_non_lisp
+ 1;
5031 bm_skip
['\0'] = infinity
;
5033 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5037 /* Check the last character (== '\0'). */
5040 start
+= bm_skip
[*(p
+ start
)];
5042 while (start
<= start_max
);
5044 if (start
< infinity
)
5045 /* Couldn't find the last character. */
5048 /* No less than `infinity' means we could find the last
5049 character at `p[start - infinity]'. */
5052 /* Check the remaining characters. */
5053 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5055 return non_lisp_beg
+ start
;
5057 start
+= last_char_skip
;
5059 while (start
<= start_max
);
5065 /* Return a string allocated in pure space. DATA is a buffer holding
5066 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5067 means make the result string multibyte.
5069 Must get an error if pure storage is full, since if it cannot hold
5070 a large string it may be able to hold conses that point to that
5071 string; then the string is not protected from gc. */
5074 make_pure_string (const char *data
,
5075 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
5078 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5079 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5080 if (s
->data
== NULL
)
5082 s
->data
= pure_alloc (nbytes
+ 1, -1);
5083 memcpy (s
->data
, data
, nbytes
);
5084 s
->data
[nbytes
] = '\0';
5087 s
->size_byte
= multibyte
? nbytes
: -1;
5088 s
->intervals
= NULL
;
5089 XSETSTRING (string
, s
);
5093 /* Return a string allocated in pure space. Do not
5094 allocate the string data, just point to DATA. */
5097 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5100 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5103 s
->data
= (unsigned char *) data
;
5104 s
->intervals
= NULL
;
5105 XSETSTRING (string
, s
);
5109 static Lisp_Object
purecopy (Lisp_Object obj
);
5111 /* Return a cons allocated from pure space. Give it pure copies
5112 of CAR as car and CDR as cdr. */
5115 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5118 struct Lisp_Cons
*p
= pure_alloc (sizeof *p
, Lisp_Cons
);
5120 XSETCAR (new, purecopy (car
));
5121 XSETCDR (new, purecopy (cdr
));
5126 /* Value is a float object with value NUM allocated from pure space. */
5129 make_pure_float (double num
)
5132 struct Lisp_Float
*p
= pure_alloc (sizeof *p
, Lisp_Float
);
5134 XFLOAT_INIT (new, num
);
5139 /* Return a vector with room for LEN Lisp_Objects allocated from
5143 make_pure_vector (ptrdiff_t len
)
5146 size_t size
= header_size
+ len
* word_size
;
5147 struct Lisp_Vector
*p
= pure_alloc (size
, Lisp_Vectorlike
);
5148 XSETVECTOR (new, p
);
5149 XVECTOR (new)->header
.size
= len
;
5154 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5155 doc
: /* Make a copy of object OBJ in pure storage.
5156 Recursively copies contents of vectors and cons cells.
5157 Does not copy symbols. Copies strings without text properties. */)
5158 (register Lisp_Object obj
)
5160 if (NILP (Vpurify_flag
))
5162 else if (MARKERP (obj
) || OVERLAYP (obj
)
5163 || HASH_TABLE_P (obj
) || SYMBOLP (obj
))
5164 /* Can't purify those. */
5167 return purecopy (obj
);
5171 purecopy (Lisp_Object obj
)
5173 if (PURE_POINTER_P (XPNTR (obj
)) || INTEGERP (obj
) || SUBRP (obj
))
5174 return obj
; /* Already pure. */
5176 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5178 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5184 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5185 else if (FLOATP (obj
))
5186 obj
= make_pure_float (XFLOAT_DATA (obj
));
5187 else if (STRINGP (obj
))
5188 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5190 STRING_MULTIBYTE (obj
));
5191 else if (COMPILEDP (obj
) || VECTORP (obj
))
5193 register struct Lisp_Vector
*vec
;
5194 register ptrdiff_t i
;
5198 if (size
& PSEUDOVECTOR_FLAG
)
5199 size
&= PSEUDOVECTOR_SIZE_MASK
;
5200 vec
= XVECTOR (make_pure_vector (size
));
5201 for (i
= 0; i
< size
; i
++)
5202 vec
->contents
[i
] = purecopy (AREF (obj
, i
));
5203 if (COMPILEDP (obj
))
5205 XSETPVECTYPE (vec
, PVEC_COMPILED
);
5206 XSETCOMPILED (obj
, vec
);
5209 XSETVECTOR (obj
, vec
);
5211 else if (SYMBOLP (obj
))
5213 if (!XSYMBOL (obj
)->pinned
)
5214 { /* We can't purify them, but they appear in many pure objects.
5215 Mark them as `pinned' so we know to mark them at every GC cycle. */
5216 XSYMBOL (obj
)->pinned
= true;
5217 symbol_block_pinned
= symbol_block
;
5223 Lisp_Object args
[2];
5224 args
[0] = build_pure_c_string ("Don't know how to purify: %S");
5226 Fsignal (Qerror
, (Fcons (Fformat (2, args
), Qnil
)));
5229 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5230 Fputhash (obj
, obj
, Vpurify_flag
);
5237 /***********************************************************************
5239 ***********************************************************************/
5241 /* Put an entry in staticvec, pointing at the variable with address
5245 staticpro (Lisp_Object
*varaddress
)
5247 if (staticidx
>= NSTATICS
)
5248 fatal ("NSTATICS too small; try increasing and recompiling Emacs.");
5249 staticvec
[staticidx
++] = varaddress
;
5253 /***********************************************************************
5255 ***********************************************************************/
5257 /* Temporarily prevent garbage collection. */
5260 inhibit_garbage_collection (void)
5262 ptrdiff_t count
= SPECPDL_INDEX ();
5264 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5268 /* Used to avoid possible overflows when
5269 converting from C to Lisp integers. */
5272 bounded_number (EMACS_INT number
)
5274 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5277 /* Calculate total bytes of live objects. */
5280 total_bytes_of_live_objects (void)
5283 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5284 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5285 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5286 tot
+= total_string_bytes
;
5287 tot
+= total_vector_slots
* word_size
;
5288 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5289 tot
+= total_intervals
* sizeof (struct interval
);
5290 tot
+= total_strings
* sizeof (struct Lisp_String
);
5294 #ifdef HAVE_WINDOW_SYSTEM
5296 /* This code has a few issues on MS-Windows, see Bug#15876 and Bug#16140. */
5298 #if !defined (HAVE_NTGUI)
5300 /* Remove unmarked font-spec and font-entity objects from ENTRY, which is
5301 (DRIVER-TYPE NUM-FRAMES FONT-CACHE-DATA ...), and return changed entry. */
5304 compact_font_cache_entry (Lisp_Object entry
)
5306 Lisp_Object tail
, *prev
= &entry
;
5308 for (tail
= entry
; CONSP (tail
); tail
= XCDR (tail
))
5311 Lisp_Object obj
= XCAR (tail
);
5313 /* Consider OBJ if it is (font-spec . [font-entity font-entity ...]). */
5314 if (CONSP (obj
) && FONT_SPEC_P (XCAR (obj
))
5315 && !VECTOR_MARKED_P (XFONT_SPEC (XCAR (obj
)))
5316 && VECTORP (XCDR (obj
)))
5318 ptrdiff_t i
, size
= ASIZE (XCDR (obj
)) & ~ARRAY_MARK_FLAG
;
5320 /* If font-spec is not marked, most likely all font-entities
5321 are not marked too. But we must be sure that nothing is
5322 marked within OBJ before we really drop it. */
5323 for (i
= 0; i
< size
; i
++)
5324 if (VECTOR_MARKED_P (XFONT_ENTITY (AREF (XCDR (obj
), i
))))
5331 *prev
= XCDR (tail
);
5333 prev
= xcdr_addr (tail
);
5338 #endif /* not HAVE_NTGUI */
5340 /* Compact font caches on all terminals and mark
5341 everything which is still here after compaction. */
5344 compact_font_caches (void)
5348 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5350 Lisp_Object cache
= TERMINAL_FONT_CACHE (t
);
5351 #if !defined (HAVE_NTGUI)
5356 for (entry
= XCDR (cache
); CONSP (entry
); entry
= XCDR (entry
))
5357 XSETCAR (entry
, compact_font_cache_entry (XCAR (entry
)));
5359 #endif /* not HAVE_NTGUI */
5360 mark_object (cache
);
5364 #else /* not HAVE_WINDOW_SYSTEM */
5366 #define compact_font_caches() (void)(0)
5368 #endif /* HAVE_WINDOW_SYSTEM */
5370 /* Remove (MARKER . DATA) entries with unmarked MARKER
5371 from buffer undo LIST and return changed list. */
5374 compact_undo_list (Lisp_Object list
)
5376 Lisp_Object tail
, *prev
= &list
;
5378 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
5380 if (CONSP (XCAR (tail
))
5381 && MARKERP (XCAR (XCAR (tail
)))
5382 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5383 *prev
= XCDR (tail
);
5385 prev
= xcdr_addr (tail
);
5391 mark_pinned_symbols (void)
5393 struct symbol_block
*sblk
;
5394 int lim
= (symbol_block_pinned
== symbol_block
5395 ? symbol_block_index
: SYMBOL_BLOCK_SIZE
);
5397 for (sblk
= symbol_block_pinned
; sblk
; sblk
= sblk
->next
)
5399 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
, *end
= sym
+ lim
;
5400 for (; sym
< end
; ++sym
)
5402 mark_object (make_lisp_ptr (&sym
->s
, Lisp_Symbol
));
5404 lim
= SYMBOL_BLOCK_SIZE
;
5408 /* Subroutine of Fgarbage_collect that does most of the work. It is a
5409 separate function so that we could limit mark_stack in searching
5410 the stack frames below this function, thus avoiding the rare cases
5411 where mark_stack finds values that look like live Lisp objects on
5412 portions of stack that couldn't possibly contain such live objects.
5413 For more details of this, see the discussion at
5414 http://lists.gnu.org/archive/html/emacs-devel/2014-05/msg00270.html. */
5416 garbage_collect_1 (void *end
)
5418 struct buffer
*nextb
;
5419 char stack_top_variable
;
5422 ptrdiff_t count
= SPECPDL_INDEX ();
5423 struct timespec start
;
5424 Lisp_Object retval
= Qnil
;
5425 size_t tot_before
= 0;
5430 /* Can't GC if pure storage overflowed because we can't determine
5431 if something is a pure object or not. */
5432 if (pure_bytes_used_before_overflow
)
5435 /* Record this function, so it appears on the profiler's backtraces. */
5436 record_in_backtrace (Qautomatic_gc
, &Qnil
, 0);
5440 /* Don't keep undo information around forever.
5441 Do this early on, so it is no problem if the user quits. */
5442 FOR_EACH_BUFFER (nextb
)
5443 compact_buffer (nextb
);
5445 if (profiler_memory_running
)
5446 tot_before
= total_bytes_of_live_objects ();
5448 start
= current_timespec ();
5450 /* In case user calls debug_print during GC,
5451 don't let that cause a recursive GC. */
5452 consing_since_gc
= 0;
5454 /* Save what's currently displayed in the echo area. */
5455 message_p
= push_message ();
5456 record_unwind_protect_void (pop_message_unwind
);
5458 /* Save a copy of the contents of the stack, for debugging. */
5459 #if MAX_SAVE_STACK > 0
5460 if (NILP (Vpurify_flag
))
5463 ptrdiff_t stack_size
;
5464 if (&stack_top_variable
< stack_bottom
)
5466 stack
= &stack_top_variable
;
5467 stack_size
= stack_bottom
- &stack_top_variable
;
5471 stack
= stack_bottom
;
5472 stack_size
= &stack_top_variable
- stack_bottom
;
5474 if (stack_size
<= MAX_SAVE_STACK
)
5476 if (stack_copy_size
< stack_size
)
5478 stack_copy
= xrealloc (stack_copy
, stack_size
);
5479 stack_copy_size
= stack_size
;
5481 no_sanitize_memcpy (stack_copy
, stack
, stack_size
);
5484 #endif /* MAX_SAVE_STACK > 0 */
5486 if (garbage_collection_messages
)
5487 message1_nolog ("Garbage collecting...");
5491 shrink_regexp_cache ();
5495 /* Mark all the special slots that serve as the roots of accessibility. */
5497 mark_buffer (&buffer_defaults
);
5498 mark_buffer (&buffer_local_symbols
);
5500 for (i
= 0; i
< staticidx
; i
++)
5501 mark_object (*staticvec
[i
]);
5503 mark_pinned_symbols ();
5512 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5513 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5517 register struct gcpro
*tail
;
5518 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5519 for (i
= 0; i
< tail
->nvars
; i
++)
5520 mark_object (tail
->var
[i
]);
5525 struct handler
*handler
;
5526 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5528 mark_object (handler
->tag_or_ch
);
5529 mark_object (handler
->val
);
5532 #ifdef HAVE_WINDOW_SYSTEM
5533 mark_fringe_data ();
5536 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5540 /* Everything is now marked, except for the data in font caches
5541 and undo lists. They're compacted by removing an items which
5542 aren't reachable otherwise. */
5544 compact_font_caches ();
5546 FOR_EACH_BUFFER (nextb
)
5548 if (!EQ (BVAR (nextb
, undo_list
), Qt
))
5549 bset_undo_list (nextb
, compact_undo_list (BVAR (nextb
, undo_list
)));
5550 /* Now that we have stripped the elements that need not be
5551 in the undo_list any more, we can finally mark the list. */
5552 mark_object (BVAR (nextb
, undo_list
));
5557 /* Clear the mark bits that we set in certain root slots. */
5559 unmark_byte_stack ();
5560 VECTOR_UNMARK (&buffer_defaults
);
5561 VECTOR_UNMARK (&buffer_local_symbols
);
5563 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5573 consing_since_gc
= 0;
5574 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
5575 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
5577 gc_relative_threshold
= 0;
5578 if (FLOATP (Vgc_cons_percentage
))
5579 { /* Set gc_cons_combined_threshold. */
5580 double tot
= total_bytes_of_live_objects ();
5582 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5585 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5586 gc_relative_threshold
= tot
;
5588 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5592 if (garbage_collection_messages
)
5594 if (message_p
|| minibuf_level
> 0)
5597 message1_nolog ("Garbage collecting...done");
5600 unbind_to (count
, Qnil
);
5602 Lisp_Object total
[11];
5603 int total_size
= 10;
5605 total
[0] = list4 (Qconses
, make_number (sizeof (struct Lisp_Cons
)),
5606 bounded_number (total_conses
),
5607 bounded_number (total_free_conses
));
5609 total
[1] = list4 (Qsymbols
, make_number (sizeof (struct Lisp_Symbol
)),
5610 bounded_number (total_symbols
),
5611 bounded_number (total_free_symbols
));
5613 total
[2] = list4 (Qmiscs
, make_number (sizeof (union Lisp_Misc
)),
5614 bounded_number (total_markers
),
5615 bounded_number (total_free_markers
));
5617 total
[3] = list4 (Qstrings
, make_number (sizeof (struct Lisp_String
)),
5618 bounded_number (total_strings
),
5619 bounded_number (total_free_strings
));
5621 total
[4] = list3 (Qstring_bytes
, make_number (1),
5622 bounded_number (total_string_bytes
));
5624 total
[5] = list3 (Qvectors
,
5625 make_number (header_size
+ sizeof (Lisp_Object
)),
5626 bounded_number (total_vectors
));
5628 total
[6] = list4 (Qvector_slots
, make_number (word_size
),
5629 bounded_number (total_vector_slots
),
5630 bounded_number (total_free_vector_slots
));
5632 total
[7] = list4 (Qfloats
, make_number (sizeof (struct Lisp_Float
)),
5633 bounded_number (total_floats
),
5634 bounded_number (total_free_floats
));
5636 total
[8] = list4 (Qintervals
, make_number (sizeof (struct interval
)),
5637 bounded_number (total_intervals
),
5638 bounded_number (total_free_intervals
));
5640 total
[9] = list3 (Qbuffers
, make_number (sizeof (struct buffer
)),
5641 bounded_number (total_buffers
));
5643 #ifdef DOUG_LEA_MALLOC
5645 total
[10] = list4 (Qheap
, make_number (1024),
5646 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
5647 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10));
5649 retval
= Flist (total_size
, total
);
5652 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5654 /* Compute average percentage of zombies. */
5656 = (total_conses
+ total_symbols
+ total_markers
+ total_strings
5657 + total_vectors
+ total_floats
+ total_intervals
+ total_buffers
);
5659 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5660 max_live
= max (nlive
, max_live
);
5661 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5662 max_zombies
= max (nzombies
, max_zombies
);
5667 if (!NILP (Vpost_gc_hook
))
5669 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5670 safe_run_hooks (Qpost_gc_hook
);
5671 unbind_to (gc_count
, Qnil
);
5674 /* Accumulate statistics. */
5675 if (FLOATP (Vgc_elapsed
))
5677 struct timespec since_start
= timespec_sub (current_timespec (), start
);
5678 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5679 + timespectod (since_start
));
5684 /* Collect profiling data. */
5685 if (profiler_memory_running
)
5688 size_t tot_after
= total_bytes_of_live_objects ();
5689 if (tot_before
> tot_after
)
5690 swept
= tot_before
- tot_after
;
5691 malloc_probe (swept
);
5697 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5698 doc
: /* Reclaim storage for Lisp objects no longer needed.
5699 Garbage collection happens automatically if you cons more than
5700 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5701 `garbage-collect' normally returns a list with info on amount of space in use,
5702 where each entry has the form (NAME SIZE USED FREE), where:
5703 - NAME is a symbol describing the kind of objects this entry represents,
5704 - SIZE is the number of bytes used by each one,
5705 - USED is the number of those objects that were found live in the heap,
5706 - FREE is the number of those objects that are not live but that Emacs
5707 keeps around for future allocations (maybe because it does not know how
5708 to return them to the OS).
5709 However, if there was overflow in pure space, `garbage-collect'
5710 returns nil, because real GC can't be done.
5711 See Info node `(elisp)Garbage Collection'. */)
5714 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5715 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS \
5716 || GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES)
5719 #ifdef HAVE___BUILTIN_UNWIND_INIT
5720 /* Force callee-saved registers and register windows onto the stack.
5721 This is the preferred method if available, obviating the need for
5722 machine dependent methods. */
5723 __builtin_unwind_init ();
5725 #else /* not HAVE___BUILTIN_UNWIND_INIT */
5726 #ifndef GC_SAVE_REGISTERS_ON_STACK
5727 /* jmp_buf may not be aligned enough on darwin-ppc64 */
5728 union aligned_jmpbuf
{
5732 volatile bool stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
5734 /* This trick flushes the register windows so that all the state of
5735 the process is contained in the stack. */
5736 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
5737 needed on ia64 too. See mach_dep.c, where it also says inline
5738 assembler doesn't work with relevant proprietary compilers. */
5740 #if defined (__sparc64__) && defined (__FreeBSD__)
5741 /* FreeBSD does not have a ta 3 handler. */
5748 /* Save registers that we need to see on the stack. We need to see
5749 registers used to hold register variables and registers used to
5751 #ifdef GC_SAVE_REGISTERS_ON_STACK
5752 GC_SAVE_REGISTERS_ON_STACK (end
);
5753 #else /* not GC_SAVE_REGISTERS_ON_STACK */
5755 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
5756 setjmp will definitely work, test it
5757 and print a message with the result
5759 if (!setjmp_tested_p
)
5761 setjmp_tested_p
= 1;
5764 #endif /* GC_SETJMP_WORKS */
5767 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
5768 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
5769 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
5770 return garbage_collect_1 (end
);
5771 #elif (GC_MARK_STACK == GC_USE_GCPROS_AS_BEFORE)
5772 /* Old GCPROs-based method without stack marking. */
5773 return garbage_collect_1 (NULL
);
5776 #endif /* GC_MARK_STACK */
5779 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5780 only interesting objects referenced from glyphs are strings. */
5783 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5785 struct glyph_row
*row
= matrix
->rows
;
5786 struct glyph_row
*end
= row
+ matrix
->nrows
;
5788 for (; row
< end
; ++row
)
5792 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5794 struct glyph
*glyph
= row
->glyphs
[area
];
5795 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5797 for (; glyph
< end_glyph
; ++glyph
)
5798 if (STRINGP (glyph
->object
)
5799 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5800 mark_object (glyph
->object
);
5805 /* Mark reference to a Lisp_Object.
5806 If the object referred to has not been seen yet, recursively mark
5807 all the references contained in it. */
5809 #define LAST_MARKED_SIZE 500
5810 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5811 static int last_marked_index
;
5813 /* For debugging--call abort when we cdr down this many
5814 links of a list, in mark_object. In debugging,
5815 the call to abort will hit a breakpoint.
5816 Normally this is zero and the check never goes off. */
5817 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5820 mark_vectorlike (struct Lisp_Vector
*ptr
)
5822 ptrdiff_t size
= ptr
->header
.size
;
5825 eassert (!VECTOR_MARKED_P (ptr
));
5826 VECTOR_MARK (ptr
); /* Else mark it. */
5827 if (size
& PSEUDOVECTOR_FLAG
)
5828 size
&= PSEUDOVECTOR_SIZE_MASK
;
5830 /* Note that this size is not the memory-footprint size, but only
5831 the number of Lisp_Object fields that we should trace.
5832 The distinction is used e.g. by Lisp_Process which places extra
5833 non-Lisp_Object fields at the end of the structure... */
5834 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
5835 mark_object (ptr
->contents
[i
]);
5838 /* Like mark_vectorlike but optimized for char-tables (and
5839 sub-char-tables) assuming that the contents are mostly integers or
5843 mark_char_table (struct Lisp_Vector
*ptr
)
5845 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5848 eassert (!VECTOR_MARKED_P (ptr
));
5850 for (i
= 0; i
< size
; i
++)
5852 Lisp_Object val
= ptr
->contents
[i
];
5854 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5856 if (SUB_CHAR_TABLE_P (val
))
5858 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5859 mark_char_table (XVECTOR (val
));
5866 NO_INLINE
/* To reduce stack depth in mark_object. */
5868 mark_compiled (struct Lisp_Vector
*ptr
)
5870 int i
, size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5873 for (i
= 0; i
< size
; i
++)
5874 if (i
!= COMPILED_CONSTANTS
)
5875 mark_object (ptr
->contents
[i
]);
5876 return size
> COMPILED_CONSTANTS
? ptr
->contents
[COMPILED_CONSTANTS
] : Qnil
;
5879 /* Mark the chain of overlays starting at PTR. */
5882 mark_overlay (struct Lisp_Overlay
*ptr
)
5884 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
5887 mark_object (ptr
->start
);
5888 mark_object (ptr
->end
);
5889 mark_object (ptr
->plist
);
5893 /* Mark Lisp_Objects and special pointers in BUFFER. */
5896 mark_buffer (struct buffer
*buffer
)
5898 /* This is handled much like other pseudovectors... */
5899 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
5901 /* ...but there are some buffer-specific things. */
5903 MARK_INTERVAL_TREE (buffer_intervals (buffer
));
5905 /* For now, we just don't mark the undo_list. It's done later in
5906 a special way just before the sweep phase, and after stripping
5907 some of its elements that are not needed any more. */
5909 mark_overlay (buffer
->overlays_before
);
5910 mark_overlay (buffer
->overlays_after
);
5912 /* If this is an indirect buffer, mark its base buffer. */
5913 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5914 mark_buffer (buffer
->base_buffer
);
5917 /* Mark Lisp faces in the face cache C. */
5919 NO_INLINE
/* To reduce stack depth in mark_object. */
5921 mark_face_cache (struct face_cache
*c
)
5926 for (i
= 0; i
< c
->used
; ++i
)
5928 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5932 if (face
->font
&& !VECTOR_MARKED_P (face
->font
))
5933 mark_vectorlike ((struct Lisp_Vector
*) face
->font
);
5935 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5936 mark_object (face
->lface
[j
]);
5942 NO_INLINE
/* To reduce stack depth in mark_object. */
5944 mark_localized_symbol (struct Lisp_Symbol
*ptr
)
5946 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
5947 Lisp_Object where
= blv
->where
;
5948 /* If the value is set up for a killed buffer or deleted
5949 frame, restore its global binding. If the value is
5950 forwarded to a C variable, either it's not a Lisp_Object
5951 var, or it's staticpro'd already. */
5952 if ((BUFFERP (where
) && !BUFFER_LIVE_P (XBUFFER (where
)))
5953 || (FRAMEP (where
) && !FRAME_LIVE_P (XFRAME (where
))))
5954 swap_in_global_binding (ptr
);
5955 mark_object (blv
->where
);
5956 mark_object (blv
->valcell
);
5957 mark_object (blv
->defcell
);
5960 NO_INLINE
/* To reduce stack depth in mark_object. */
5962 mark_save_value (struct Lisp_Save_Value
*ptr
)
5964 /* If `save_type' is zero, `data[0].pointer' is the address
5965 of a memory area containing `data[1].integer' potential
5967 if (GC_MARK_STACK
&& ptr
->save_type
== SAVE_TYPE_MEMORY
)
5969 Lisp_Object
*p
= ptr
->data
[0].pointer
;
5971 for (nelt
= ptr
->data
[1].integer
; nelt
> 0; nelt
--, p
++)
5972 mark_maybe_object (*p
);
5976 /* Find Lisp_Objects in `data[N]' slots and mark them. */
5978 for (i
= 0; i
< SAVE_VALUE_SLOTS
; i
++)
5979 if (save_type (ptr
, i
) == SAVE_OBJECT
)
5980 mark_object (ptr
->data
[i
].object
);
5984 /* Remove killed buffers or items whose car is a killed buffer from
5985 LIST, and mark other items. Return changed LIST, which is marked. */
5988 mark_discard_killed_buffers (Lisp_Object list
)
5990 Lisp_Object tail
, *prev
= &list
;
5992 for (tail
= list
; CONSP (tail
) && !CONS_MARKED_P (XCONS (tail
));
5995 Lisp_Object tem
= XCAR (tail
);
5998 if (BUFFERP (tem
) && !BUFFER_LIVE_P (XBUFFER (tem
)))
5999 *prev
= XCDR (tail
);
6002 CONS_MARK (XCONS (tail
));
6003 mark_object (XCAR (tail
));
6004 prev
= xcdr_addr (tail
);
6011 /* Determine type of generic Lisp_Object and mark it accordingly.
6013 This function implements a straightforward depth-first marking
6014 algorithm and so the recursion depth may be very high (a few
6015 tens of thousands is not uncommon). To minimize stack usage,
6016 a few cold paths are moved out to NO_INLINE functions above.
6017 In general, inlining them doesn't help you to gain more speed. */
6020 mark_object (Lisp_Object arg
)
6022 register Lisp_Object obj
= arg
;
6023 #ifdef GC_CHECK_MARKED_OBJECTS
6027 ptrdiff_t cdr_count
= 0;
6031 if (PURE_POINTER_P (XPNTR (obj
)))
6034 last_marked
[last_marked_index
++] = obj
;
6035 if (last_marked_index
== LAST_MARKED_SIZE
)
6036 last_marked_index
= 0;
6038 /* Perform some sanity checks on the objects marked here. Abort if
6039 we encounter an object we know is bogus. This increases GC time
6040 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
6041 #ifdef GC_CHECK_MARKED_OBJECTS
6043 po
= (void *) XPNTR (obj
);
6045 /* Check that the object pointed to by PO is known to be a Lisp
6046 structure allocated from the heap. */
6047 #define CHECK_ALLOCATED() \
6049 m = mem_find (po); \
6054 /* Check that the object pointed to by PO is live, using predicate
6056 #define CHECK_LIVE(LIVEP) \
6058 if (!LIVEP (m, po)) \
6062 /* Check both of the above conditions. */
6063 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
6065 CHECK_ALLOCATED (); \
6066 CHECK_LIVE (LIVEP); \
6069 #else /* not GC_CHECK_MARKED_OBJECTS */
6071 #define CHECK_LIVE(LIVEP) (void) 0
6072 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
6074 #endif /* not GC_CHECK_MARKED_OBJECTS */
6076 switch (XTYPE (obj
))
6080 register struct Lisp_String
*ptr
= XSTRING (obj
);
6081 if (STRING_MARKED_P (ptr
))
6083 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
6085 MARK_INTERVAL_TREE (ptr
->intervals
);
6086 #ifdef GC_CHECK_STRING_BYTES
6087 /* Check that the string size recorded in the string is the
6088 same as the one recorded in the sdata structure. */
6090 #endif /* GC_CHECK_STRING_BYTES */
6094 case Lisp_Vectorlike
:
6096 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
6097 register ptrdiff_t pvectype
;
6099 if (VECTOR_MARKED_P (ptr
))
6102 #ifdef GC_CHECK_MARKED_OBJECTS
6104 if (m
== MEM_NIL
&& !SUBRP (obj
))
6106 #endif /* GC_CHECK_MARKED_OBJECTS */
6108 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
6109 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
6110 >> PSEUDOVECTOR_AREA_BITS
);
6112 pvectype
= PVEC_NORMAL_VECTOR
;
6114 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
6115 CHECK_LIVE (live_vector_p
);
6120 #ifdef GC_CHECK_MARKED_OBJECTS
6129 #endif /* GC_CHECK_MARKED_OBJECTS */
6130 mark_buffer ((struct buffer
*) ptr
);
6134 /* Although we could treat this just like a vector, mark_compiled
6135 returns the COMPILED_CONSTANTS element, which is marked at the
6136 next iteration of goto-loop here. This is done to avoid a few
6137 recursive calls to mark_object. */
6138 obj
= mark_compiled (ptr
);
6145 struct frame
*f
= (struct frame
*) ptr
;
6147 mark_vectorlike (ptr
);
6148 mark_face_cache (f
->face_cache
);
6149 #ifdef HAVE_WINDOW_SYSTEM
6150 if (FRAME_WINDOW_P (f
) && FRAME_X_OUTPUT (f
))
6152 struct font
*font
= FRAME_FONT (f
);
6154 if (font
&& !VECTOR_MARKED_P (font
))
6155 mark_vectorlike ((struct Lisp_Vector
*) font
);
6163 struct window
*w
= (struct window
*) ptr
;
6165 mark_vectorlike (ptr
);
6167 /* Mark glyph matrices, if any. Marking window
6168 matrices is sufficient because frame matrices
6169 use the same glyph memory. */
6170 if (w
->current_matrix
)
6172 mark_glyph_matrix (w
->current_matrix
);
6173 mark_glyph_matrix (w
->desired_matrix
);
6176 /* Filter out killed buffers from both buffer lists
6177 in attempt to help GC to reclaim killed buffers faster.
6178 We can do it elsewhere for live windows, but this is the
6179 best place to do it for dead windows. */
6181 (w
, mark_discard_killed_buffers (w
->prev_buffers
));
6183 (w
, mark_discard_killed_buffers (w
->next_buffers
));
6187 case PVEC_HASH_TABLE
:
6189 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6191 mark_vectorlike (ptr
);
6192 mark_object (h
->test
.name
);
6193 mark_object (h
->test
.user_hash_function
);
6194 mark_object (h
->test
.user_cmp_function
);
6195 /* If hash table is not weak, mark all keys and values.
6196 For weak tables, mark only the vector. */
6198 mark_object (h
->key_and_value
);
6200 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6204 case PVEC_CHAR_TABLE
:
6205 mark_char_table (ptr
);
6208 case PVEC_BOOL_VECTOR
:
6209 /* No Lisp_Objects to mark in a bool vector. */
6220 mark_vectorlike (ptr
);
6227 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6231 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
6233 /* Attempt to catch bogus objects. */
6234 eassert (valid_lisp_object_p (ptr
->function
) >= 1);
6235 mark_object (ptr
->function
);
6236 mark_object (ptr
->plist
);
6237 switch (ptr
->redirect
)
6239 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6240 case SYMBOL_VARALIAS
:
6243 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6247 case SYMBOL_LOCALIZED
:
6248 mark_localized_symbol (ptr
);
6250 case SYMBOL_FORWARDED
:
6251 /* If the value is forwarded to a buffer or keyboard field,
6252 these are marked when we see the corresponding object.
6253 And if it's forwarded to a C variable, either it's not
6254 a Lisp_Object var, or it's staticpro'd already. */
6256 default: emacs_abort ();
6258 if (!PURE_POINTER_P (XSTRING (ptr
->name
)))
6259 MARK_STRING (XSTRING (ptr
->name
));
6260 MARK_INTERVAL_TREE (string_intervals (ptr
->name
));
6261 /* Inner loop to mark next symbol in this bucket, if any. */
6269 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6271 if (XMISCANY (obj
)->gcmarkbit
)
6274 switch (XMISCTYPE (obj
))
6276 case Lisp_Misc_Marker
:
6277 /* DO NOT mark thru the marker's chain.
6278 The buffer's markers chain does not preserve markers from gc;
6279 instead, markers are removed from the chain when freed by gc. */
6280 XMISCANY (obj
)->gcmarkbit
= 1;
6283 case Lisp_Misc_Save_Value
:
6284 XMISCANY (obj
)->gcmarkbit
= 1;
6285 mark_save_value (XSAVE_VALUE (obj
));
6288 case Lisp_Misc_Overlay
:
6289 mark_overlay (XOVERLAY (obj
));
6299 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6300 if (CONS_MARKED_P (ptr
))
6302 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6304 /* If the cdr is nil, avoid recursion for the car. */
6305 if (EQ (ptr
->u
.cdr
, Qnil
))
6311 mark_object (ptr
->car
);
6314 if (cdr_count
== mark_object_loop_halt
)
6320 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6321 FLOAT_MARK (XFLOAT (obj
));
6332 #undef CHECK_ALLOCATED
6333 #undef CHECK_ALLOCATED_AND_LIVE
6335 /* Mark the Lisp pointers in the terminal objects.
6336 Called by Fgarbage_collect. */
6339 mark_terminals (void)
6342 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6344 eassert (t
->name
!= NULL
);
6345 #ifdef HAVE_WINDOW_SYSTEM
6346 /* If a terminal object is reachable from a stacpro'ed object,
6347 it might have been marked already. Make sure the image cache
6349 mark_image_cache (t
->image_cache
);
6350 #endif /* HAVE_WINDOW_SYSTEM */
6351 if (!VECTOR_MARKED_P (t
))
6352 mark_vectorlike ((struct Lisp_Vector
*)t
);
6358 /* Value is non-zero if OBJ will survive the current GC because it's
6359 either marked or does not need to be marked to survive. */
6362 survives_gc_p (Lisp_Object obj
)
6366 switch (XTYPE (obj
))
6373 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6377 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6381 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6384 case Lisp_Vectorlike
:
6385 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6389 survives_p
= CONS_MARKED_P (XCONS (obj
));
6393 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6400 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
6406 NO_INLINE
/* For better stack traces */
6410 struct cons_block
*cblk
;
6411 struct cons_block
**cprev
= &cons_block
;
6412 int lim
= cons_block_index
;
6413 EMACS_INT num_free
= 0, num_used
= 0;
6417 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6421 int ilim
= (lim
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
6423 /* Scan the mark bits an int at a time. */
6424 for (i
= 0; i
< ilim
; i
++)
6426 if (cblk
->gcmarkbits
[i
] == BITS_WORD_MAX
)
6428 /* Fast path - all cons cells for this int are marked. */
6429 cblk
->gcmarkbits
[i
] = 0;
6430 num_used
+= BITS_PER_BITS_WORD
;
6434 /* Some cons cells for this int are not marked.
6435 Find which ones, and free them. */
6436 int start
, pos
, stop
;
6438 start
= i
* BITS_PER_BITS_WORD
;
6440 if (stop
> BITS_PER_BITS_WORD
)
6441 stop
= BITS_PER_BITS_WORD
;
6444 for (pos
= start
; pos
< stop
; pos
++)
6446 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6449 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6450 cons_free_list
= &cblk
->conses
[pos
];
6452 cons_free_list
->car
= Vdead
;
6458 CONS_UNMARK (&cblk
->conses
[pos
]);
6464 lim
= CONS_BLOCK_SIZE
;
6465 /* If this block contains only free conses and we have already
6466 seen more than two blocks worth of free conses then deallocate
6468 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6470 *cprev
= cblk
->next
;
6471 /* Unhook from the free list. */
6472 cons_free_list
= cblk
->conses
[0].u
.chain
;
6473 lisp_align_free (cblk
);
6477 num_free
+= this_free
;
6478 cprev
= &cblk
->next
;
6481 total_conses
= num_used
;
6482 total_free_conses
= num_free
;
6485 NO_INLINE
/* For better stack traces */
6489 register struct float_block
*fblk
;
6490 struct float_block
**fprev
= &float_block
;
6491 register int lim
= float_block_index
;
6492 EMACS_INT num_free
= 0, num_used
= 0;
6494 float_free_list
= 0;
6496 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6500 for (i
= 0; i
< lim
; i
++)
6501 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6504 fblk
->floats
[i
].u
.chain
= float_free_list
;
6505 float_free_list
= &fblk
->floats
[i
];
6510 FLOAT_UNMARK (&fblk
->floats
[i
]);
6512 lim
= FLOAT_BLOCK_SIZE
;
6513 /* If this block contains only free floats and we have already
6514 seen more than two blocks worth of free floats then deallocate
6516 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6518 *fprev
= fblk
->next
;
6519 /* Unhook from the free list. */
6520 float_free_list
= fblk
->floats
[0].u
.chain
;
6521 lisp_align_free (fblk
);
6525 num_free
+= this_free
;
6526 fprev
= &fblk
->next
;
6529 total_floats
= num_used
;
6530 total_free_floats
= num_free
;
6533 NO_INLINE
/* For better stack traces */
6535 sweep_intervals (void)
6537 register struct interval_block
*iblk
;
6538 struct interval_block
**iprev
= &interval_block
;
6539 register int lim
= interval_block_index
;
6540 EMACS_INT num_free
= 0, num_used
= 0;
6542 interval_free_list
= 0;
6544 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6549 for (i
= 0; i
< lim
; i
++)
6551 if (!iblk
->intervals
[i
].gcmarkbit
)
6553 set_interval_parent (&iblk
->intervals
[i
], interval_free_list
);
6554 interval_free_list
= &iblk
->intervals
[i
];
6560 iblk
->intervals
[i
].gcmarkbit
= 0;
6563 lim
= INTERVAL_BLOCK_SIZE
;
6564 /* If this block contains only free intervals and we have already
6565 seen more than two blocks worth of free intervals then
6566 deallocate this block. */
6567 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6569 *iprev
= iblk
->next
;
6570 /* Unhook from the free list. */
6571 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6576 num_free
+= this_free
;
6577 iprev
= &iblk
->next
;
6580 total_intervals
= num_used
;
6581 total_free_intervals
= num_free
;
6584 NO_INLINE
/* For better stack traces */
6586 sweep_symbols (void)
6588 register struct symbol_block
*sblk
;
6589 struct symbol_block
**sprev
= &symbol_block
;
6590 register int lim
= symbol_block_index
;
6591 EMACS_INT num_free
= 0, num_used
= 0;
6593 symbol_free_list
= NULL
;
6595 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6598 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6599 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6601 for (; sym
< end
; ++sym
)
6603 if (!sym
->s
.gcmarkbit
)
6605 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6606 xfree (SYMBOL_BLV (&sym
->s
));
6607 sym
->s
.next
= symbol_free_list
;
6608 symbol_free_list
= &sym
->s
;
6610 symbol_free_list
->function
= Vdead
;
6617 sym
->s
.gcmarkbit
= 0;
6618 /* Attempt to catch bogus objects. */
6619 eassert (valid_lisp_object_p (sym
->s
.function
) >= 1);
6623 lim
= SYMBOL_BLOCK_SIZE
;
6624 /* If this block contains only free symbols and we have already
6625 seen more than two blocks worth of free symbols then deallocate
6627 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6629 *sprev
= sblk
->next
;
6630 /* Unhook from the free list. */
6631 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6636 num_free
+= this_free
;
6637 sprev
= &sblk
->next
;
6640 total_symbols
= num_used
;
6641 total_free_symbols
= num_free
;
6644 NO_INLINE
/* For better stack traces */
6648 register struct marker_block
*mblk
;
6649 struct marker_block
**mprev
= &marker_block
;
6650 register int lim
= marker_block_index
;
6651 EMACS_INT num_free
= 0, num_used
= 0;
6653 /* Put all unmarked misc's on free list. For a marker, first
6654 unchain it from the buffer it points into. */
6656 marker_free_list
= 0;
6658 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6663 for (i
= 0; i
< lim
; i
++)
6665 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6667 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6668 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6669 /* Set the type of the freed object to Lisp_Misc_Free.
6670 We could leave the type alone, since nobody checks it,
6671 but this might catch bugs faster. */
6672 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6673 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6674 marker_free_list
= &mblk
->markers
[i
].m
;
6680 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6683 lim
= MARKER_BLOCK_SIZE
;
6684 /* If this block contains only free markers and we have already
6685 seen more than two blocks worth of free markers then deallocate
6687 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6689 *mprev
= mblk
->next
;
6690 /* Unhook from the free list. */
6691 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6696 num_free
+= this_free
;
6697 mprev
= &mblk
->next
;
6701 total_markers
= num_used
;
6702 total_free_markers
= num_free
;
6705 NO_INLINE
/* For better stack traces */
6707 sweep_buffers (void)
6709 register struct buffer
*buffer
, **bprev
= &all_buffers
;
6712 for (buffer
= all_buffers
; buffer
; buffer
= *bprev
)
6713 if (!VECTOR_MARKED_P (buffer
))
6715 *bprev
= buffer
->next
;
6720 VECTOR_UNMARK (buffer
);
6721 /* Do not use buffer_(set|get)_intervals here. */
6722 buffer
->text
->intervals
= balance_intervals (buffer
->text
->intervals
);
6724 bprev
= &buffer
->next
;
6728 /* Sweep: find all structures not marked, and free them. */
6732 /* Remove or mark entries in weak hash tables.
6733 This must be done before any object is unmarked. */
6734 sweep_weak_hash_tables ();
6737 check_string_bytes (!noninteractive
);
6745 check_string_bytes (!noninteractive
);
6749 /* Debugging aids. */
6751 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6752 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6753 This may be helpful in debugging Emacs's memory usage.
6754 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6760 /* Avoid warning. sbrk has no relation to memory allocated anyway. */
6763 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6769 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6770 doc
: /* Return a list of counters that measure how much consing there has been.
6771 Each of these counters increments for a certain kind of object.
6772 The counters wrap around from the largest positive integer to zero.
6773 Garbage collection does not decrease them.
6774 The elements of the value are as follows:
6775 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6776 All are in units of 1 = one object consed
6777 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6779 MISCS include overlays, markers, and some internal types.
6780 Frames, windows, buffers, and subprocesses count as vectors
6781 (but the contents of a buffer's text do not count here). */)
6784 return listn (CONSTYPE_HEAP
, 8,
6785 bounded_number (cons_cells_consed
),
6786 bounded_number (floats_consed
),
6787 bounded_number (vector_cells_consed
),
6788 bounded_number (symbols_consed
),
6789 bounded_number (string_chars_consed
),
6790 bounded_number (misc_objects_consed
),
6791 bounded_number (intervals_consed
),
6792 bounded_number (strings_consed
));
6795 /* Find at most FIND_MAX symbols which have OBJ as their value or
6796 function. This is used in gdbinit's `xwhichsymbols' command. */
6799 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6801 struct symbol_block
*sblk
;
6802 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6803 Lisp_Object found
= Qnil
;
6807 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6809 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
6812 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
6814 struct Lisp_Symbol
*sym
= &aligned_sym
->s
;
6818 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6821 XSETSYMBOL (tem
, sym
);
6822 val
= find_symbol_value (tem
);
6824 || EQ (sym
->function
, obj
)
6825 || (!NILP (sym
->function
)
6826 && COMPILEDP (sym
->function
)
6827 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
6830 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)))
6832 found
= Fcons (tem
, found
);
6833 if (--find_max
== 0)
6841 unbind_to (gc_count
, Qnil
);
6845 #ifdef SUSPICIOUS_OBJECT_CHECKING
6848 find_suspicious_object_in_range (void *begin
, void *end
)
6850 char *begin_a
= begin
;
6854 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
6856 char *suspicious_object
= suspicious_objects
[i
];
6857 if (begin_a
<= suspicious_object
&& suspicious_object
< end_a
)
6858 return suspicious_object
;
6865 note_suspicious_free (void* ptr
)
6867 struct suspicious_free_record
* rec
;
6869 rec
= &suspicious_free_history
[suspicious_free_history_index
++];
6870 if (suspicious_free_history_index
==
6871 ARRAYELTS (suspicious_free_history
))
6873 suspicious_free_history_index
= 0;
6876 memset (rec
, 0, sizeof (*rec
));
6877 rec
->suspicious_object
= ptr
;
6878 backtrace (&rec
->backtrace
[0], ARRAYELTS (rec
->backtrace
));
6882 detect_suspicious_free (void* ptr
)
6886 eassert (ptr
!= NULL
);
6888 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
6889 if (suspicious_objects
[i
] == ptr
)
6891 note_suspicious_free (ptr
);
6892 suspicious_objects
[i
] = NULL
;
6896 #endif /* SUSPICIOUS_OBJECT_CHECKING */
6898 DEFUN ("suspicious-object", Fsuspicious_object
, Ssuspicious_object
, 1, 1, 0,
6899 doc
: /* Return OBJ, maybe marking it for extra scrutiny.
6900 If Emacs is compiled with suspicous object checking, capture
6901 a stack trace when OBJ is freed in order to help track down
6902 garbage collection bugs. Otherwise, do nothing and return OBJ. */)
6905 #ifdef SUSPICIOUS_OBJECT_CHECKING
6906 /* Right now, we care only about vectors. */
6907 if (VECTORLIKEP (obj
))
6909 suspicious_objects
[suspicious_object_index
++] = XVECTOR (obj
);
6910 if (suspicious_object_index
== ARRAYELTS (suspicious_objects
))
6911 suspicious_object_index
= 0;
6917 #ifdef ENABLE_CHECKING
6919 bool suppress_checking
;
6922 die (const char *msg
, const char *file
, int line
)
6924 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: assertion failed: %s\r\n",
6926 terminate_due_to_signal (SIGABRT
, INT_MAX
);
6930 /* Initialization. */
6933 init_alloc_once (void)
6935 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6937 pure_size
= PURESIZE
;
6939 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6941 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6944 #ifdef DOUG_LEA_MALLOC
6945 mallopt (M_TRIM_THRESHOLD
, 128 * 1024); /* Trim threshold. */
6946 mallopt (M_MMAP_THRESHOLD
, 64 * 1024); /* Mmap threshold. */
6947 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* Max. number of mmap'ed areas. */
6952 refill_memory_reserve ();
6953 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
6960 byte_stack_list
= 0;
6962 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6963 setjmp_tested_p
= longjmps_done
= 0;
6966 Vgc_elapsed
= make_float (0.0);
6970 valgrind_p
= RUNNING_ON_VALGRIND
!= 0;
6975 syms_of_alloc (void)
6977 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6978 doc
: /* Number of bytes of consing between garbage collections.
6979 Garbage collection can happen automatically once this many bytes have been
6980 allocated since the last garbage collection. All data types count.
6982 Garbage collection happens automatically only when `eval' is called.
6984 By binding this temporarily to a large number, you can effectively
6985 prevent garbage collection during a part of the program.
6986 See also `gc-cons-percentage'. */);
6988 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6989 doc
: /* Portion of the heap used for allocation.
6990 Garbage collection can happen automatically once this portion of the heap
6991 has been allocated since the last garbage collection.
6992 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6993 Vgc_cons_percentage
= make_float (0.1);
6995 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6996 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
6998 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6999 doc
: /* Number of cons cells that have been consed so far. */);
7001 DEFVAR_INT ("floats-consed", floats_consed
,
7002 doc
: /* Number of floats that have been consed so far. */);
7004 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
7005 doc
: /* Number of vector cells that have been consed so far. */);
7007 DEFVAR_INT ("symbols-consed", symbols_consed
,
7008 doc
: /* Number of symbols that have been consed so far. */);
7010 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
7011 doc
: /* Number of string characters that have been consed so far. */);
7013 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
7014 doc
: /* Number of miscellaneous objects that have been consed so far.
7015 These include markers and overlays, plus certain objects not visible
7018 DEFVAR_INT ("intervals-consed", intervals_consed
,
7019 doc
: /* Number of intervals that have been consed so far. */);
7021 DEFVAR_INT ("strings-consed", strings_consed
,
7022 doc
: /* Number of strings that have been consed so far. */);
7024 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
7025 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
7026 This means that certain objects should be allocated in shared (pure) space.
7027 It can also be set to a hash-table, in which case this table is used to
7028 do hash-consing of the objects allocated to pure space. */);
7030 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
7031 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
7032 garbage_collection_messages
= 0;
7034 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
7035 doc
: /* Hook run after garbage collection has finished. */);
7036 Vpost_gc_hook
= Qnil
;
7037 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
7039 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
7040 doc
: /* Precomputed `signal' argument for memory-full error. */);
7041 /* We build this in advance because if we wait until we need it, we might
7042 not be able to allocate the memory to hold it. */
7044 = listn (CONSTYPE_PURE
, 2, Qerror
,
7045 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
7047 DEFVAR_LISP ("memory-full", Vmemory_full
,
7048 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
7049 Vmemory_full
= Qnil
;
7051 DEFSYM (Qconses
, "conses");
7052 DEFSYM (Qsymbols
, "symbols");
7053 DEFSYM (Qmiscs
, "miscs");
7054 DEFSYM (Qstrings
, "strings");
7055 DEFSYM (Qvectors
, "vectors");
7056 DEFSYM (Qfloats
, "floats");
7057 DEFSYM (Qintervals
, "intervals");
7058 DEFSYM (Qbuffers
, "buffers");
7059 DEFSYM (Qstring_bytes
, "string-bytes");
7060 DEFSYM (Qvector_slots
, "vector-slots");
7061 DEFSYM (Qheap
, "heap");
7062 DEFSYM (Qautomatic_gc
, "Automatic GC");
7064 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
7065 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
7067 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
7068 doc
: /* Accumulated time elapsed in garbage collections.
7069 The time is in seconds as a floating point value. */);
7070 DEFVAR_INT ("gcs-done", gcs_done
,
7071 doc
: /* Accumulated number of garbage collections done. */);
7076 defsubr (&Sbool_vector
);
7077 defsubr (&Smake_byte_code
);
7078 defsubr (&Smake_list
);
7079 defsubr (&Smake_vector
);
7080 defsubr (&Smake_string
);
7081 defsubr (&Smake_bool_vector
);
7082 defsubr (&Smake_symbol
);
7083 defsubr (&Smake_marker
);
7084 defsubr (&Spurecopy
);
7085 defsubr (&Sgarbage_collect
);
7086 defsubr (&Smemory_limit
);
7087 defsubr (&Smemory_use_counts
);
7088 defsubr (&Ssuspicious_object
);
7090 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
7091 defsubr (&Sgc_status
);
7095 /* When compiled with GCC, GDB might say "No enum type named
7096 pvec_type" if we don't have at least one symbol with that type, and
7097 then xbacktrace could fail. Similarly for the other enums and
7098 their values. Some non-GCC compilers don't like these constructs. */
7102 enum CHARTAB_SIZE_BITS CHARTAB_SIZE_BITS
;
7103 enum CHAR_TABLE_STANDARD_SLOTS CHAR_TABLE_STANDARD_SLOTS
;
7104 enum char_bits char_bits
;
7105 enum CHECK_LISP_OBJECT_TYPE CHECK_LISP_OBJECT_TYPE
;
7106 enum DEFAULT_HASH_SIZE DEFAULT_HASH_SIZE
;
7107 enum Lisp_Bits Lisp_Bits
;
7108 enum Lisp_Compiled Lisp_Compiled
;
7109 enum maxargs maxargs
;
7110 enum MAX_ALLOCA MAX_ALLOCA
;
7111 enum More_Lisp_Bits More_Lisp_Bits
;
7112 enum pvec_type pvec_type
;
7113 } const EXTERNALLY_VISIBLE gdb_make_enums_visible
= {0};
7114 #endif /* __GNUC__ */