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 */
51 #ifdef HAVE_EXECINFO_H
52 #include <execinfo.h> /* For backtrace */
55 #if (defined ENABLE_CHECKING \
56 && defined HAVE_VALGRIND_VALGRIND_H \
57 && !defined USE_VALGRIND)
58 # define USE_VALGRIND 1
62 #include <valgrind/valgrind.h>
63 #include <valgrind/memcheck.h>
64 static bool valgrind_p
;
67 /* GC_CHECK_MARKED_OBJECTS means do sanity checks on allocated objects.
68 Doable only if GC_MARK_STACK. */
70 # undef GC_CHECK_MARKED_OBJECTS
73 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
74 memory. Can do this only if using gmalloc.c and if not checking
77 #if (defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC \
78 || defined GC_CHECK_MARKED_OBJECTS)
79 #undef GC_MALLOC_CHECK
90 #include "w32heap.h" /* for sbrk */
93 #ifdef DOUG_LEA_MALLOC
97 /* Specify maximum number of areas to mmap. It would be nice to use a
98 value that explicitly means "no limit". */
100 #define MMAP_MAX_AREAS 100000000
102 #endif /* not DOUG_LEA_MALLOC */
104 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
105 to a struct Lisp_String. */
107 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
108 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
109 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
111 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
112 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
113 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
115 /* Default value of gc_cons_threshold (see below). */
117 #define GC_DEFAULT_THRESHOLD (100000 * word_size)
119 /* Global variables. */
120 struct emacs_globals globals
;
122 /* Number of bytes of consing done since the last gc. */
124 EMACS_INT consing_since_gc
;
126 /* Similar minimum, computed from Vgc_cons_percentage. */
128 EMACS_INT gc_relative_threshold
;
130 /* Minimum number of bytes of consing since GC before next GC,
131 when memory is full. */
133 EMACS_INT memory_full_cons_threshold
;
135 /* True during GC. */
139 /* True means abort if try to GC.
140 This is for code which is written on the assumption that
141 no GC will happen, so as to verify that assumption. */
145 /* Number of live and free conses etc. */
147 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_buffers
;
148 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
149 static EMACS_INT total_free_floats
, total_floats
;
151 /* Points to memory space allocated as "spare", to be freed if we run
152 out of memory. We keep one large block, four cons-blocks, and
153 two string blocks. */
155 static char *spare_memory
[7];
157 /* Amount of spare memory to keep in large reserve block, or to see
158 whether this much is available when malloc fails on a larger request. */
160 #define SPARE_MEMORY (1 << 14)
162 /* Initialize it to a nonzero value to force it into data space
163 (rather than bss space). That way unexec will remap it into text
164 space (pure), on some systems. We have not implemented the
165 remapping on more recent systems because this is less important
166 nowadays than in the days of small memories and timesharing. */
168 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
169 #define PUREBEG (char *) pure
171 /* Pointer to the pure area, and its size. */
173 static char *purebeg
;
174 static ptrdiff_t pure_size
;
176 /* Number of bytes of pure storage used before pure storage overflowed.
177 If this is non-zero, this implies that an overflow occurred. */
179 static ptrdiff_t pure_bytes_used_before_overflow
;
181 /* True if P points into pure space. */
183 #define PURE_POINTER_P(P) \
184 ((uintptr_t) (P) - (uintptr_t) purebeg <= pure_size)
186 /* Index in pure at which next pure Lisp object will be allocated.. */
188 static ptrdiff_t pure_bytes_used_lisp
;
190 /* Number of bytes allocated for non-Lisp objects in pure storage. */
192 static ptrdiff_t pure_bytes_used_non_lisp
;
194 /* If nonzero, this is a warning delivered by malloc and not yet
197 const char *pending_malloc_warning
;
199 #if 0 /* Normally, pointer sanity only on request... */
200 #ifdef ENABLE_CHECKING
201 #define SUSPICIOUS_OBJECT_CHECKING 1
205 /* ... but unconditionally use SUSPICIOUS_OBJECT_CHECKING while the GC
206 bug is unresolved. */
207 #define SUSPICIOUS_OBJECT_CHECKING 1
209 #ifdef SUSPICIOUS_OBJECT_CHECKING
210 struct suspicious_free_record
{
211 void* suspicious_object
;
212 #ifdef HAVE_EXECINFO_H
213 void* backtrace
[128];
216 static void* suspicious_objects
[32];
217 static int suspicious_object_index
;
218 struct suspicious_free_record suspicious_free_history
[64];
219 static int suspicious_free_history_index
;
220 /* Find the first currently-monitored suspicious pointer in range
221 [begin,end) or NULL if no such pointer exists. */
222 static void* find_suspicious_object_in_range (void* begin
, void* end
);
223 static void detect_suspicious_free (void* ptr
);
225 #define find_suspicious_object_in_range(begin, end) NULL
226 #define detect_suspicious_free(ptr) (void)
229 /* Maximum amount of C stack to save when a GC happens. */
231 #ifndef MAX_SAVE_STACK
232 #define MAX_SAVE_STACK 16000
235 /* Buffer in which we save a copy of the C stack at each GC. */
237 #if MAX_SAVE_STACK > 0
238 static char *stack_copy
;
239 static ptrdiff_t stack_copy_size
;
241 /* Copy to DEST a block of memory from SRC of size SIZE bytes,
242 avoiding any address sanitization. */
244 static void * ATTRIBUTE_NO_SANITIZE_ADDRESS
245 no_sanitize_memcpy (void *dest
, void const *src
, size_t size
)
247 if (! ADDRESS_SANITIZER
)
248 return memcpy (dest
, src
, size
);
254 for (i
= 0; i
< size
; i
++)
260 #endif /* MAX_SAVE_STACK > 0 */
262 static Lisp_Object Qconses
;
263 static Lisp_Object Qsymbols
;
264 static Lisp_Object Qmiscs
;
265 static Lisp_Object Qstrings
;
266 static Lisp_Object Qvectors
;
267 static Lisp_Object Qfloats
;
268 static Lisp_Object Qintervals
;
269 static Lisp_Object Qbuffers
;
270 static Lisp_Object Qstring_bytes
, Qvector_slots
, Qheap
;
271 static Lisp_Object Qgc_cons_threshold
;
272 Lisp_Object Qautomatic_gc
;
273 Lisp_Object Qchar_table_extra_slots
;
275 /* Hook run after GC has finished. */
277 static Lisp_Object Qpost_gc_hook
;
279 static void mark_terminals (void);
280 static void gc_sweep (void);
281 static Lisp_Object
make_pure_vector (ptrdiff_t);
282 static void mark_buffer (struct buffer
*);
284 #if !defined REL_ALLOC || defined SYSTEM_MALLOC
285 static void refill_memory_reserve (void);
287 static void compact_small_strings (void);
288 static void free_large_strings (void);
289 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
291 /* When scanning the C stack for live Lisp objects, Emacs keeps track of
292 what memory allocated via lisp_malloc and lisp_align_malloc is intended
293 for what purpose. This enumeration specifies the type of memory. */
304 /* Since all non-bool pseudovectors are small enough to be
305 allocated from vector blocks, this memory type denotes
306 large regular vectors and large bool pseudovectors. */
308 /* Special type to denote vector blocks. */
309 MEM_TYPE_VECTOR_BLOCK
,
310 /* Special type to denote reserved memory. */
314 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
316 /* A unique object in pure space used to make some Lisp objects
317 on free lists recognizable in O(1). */
319 static Lisp_Object Vdead
;
320 #define DEADP(x) EQ (x, Vdead)
322 #ifdef GC_MALLOC_CHECK
324 enum mem_type allocated_mem_type
;
326 #endif /* GC_MALLOC_CHECK */
328 /* A node in the red-black tree describing allocated memory containing
329 Lisp data. Each such block is recorded with its start and end
330 address when it is allocated, and removed from the tree when it
333 A red-black tree is a balanced binary tree with the following
336 1. Every node is either red or black.
337 2. Every leaf is black.
338 3. If a node is red, then both of its children are black.
339 4. Every simple path from a node to a descendant leaf contains
340 the same number of black nodes.
341 5. The root is always black.
343 When nodes are inserted into the tree, or deleted from the tree,
344 the tree is "fixed" so that these properties are always true.
346 A red-black tree with N internal nodes has height at most 2
347 log(N+1). Searches, insertions and deletions are done in O(log N).
348 Please see a text book about data structures for a detailed
349 description of red-black trees. Any book worth its salt should
354 /* Children of this node. These pointers are never NULL. When there
355 is no child, the value is MEM_NIL, which points to a dummy node. */
356 struct mem_node
*left
, *right
;
358 /* The parent of this node. In the root node, this is NULL. */
359 struct mem_node
*parent
;
361 /* Start and end of allocated region. */
365 enum {MEM_BLACK
, MEM_RED
} color
;
371 /* Base address of stack. Set in main. */
373 Lisp_Object
*stack_base
;
375 /* Root of the tree describing allocated Lisp memory. */
377 static struct mem_node
*mem_root
;
379 /* Lowest and highest known address in the heap. */
381 static void *min_heap_address
, *max_heap_address
;
383 /* Sentinel node of the tree. */
385 static struct mem_node mem_z
;
386 #define MEM_NIL &mem_z
388 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
389 static void mem_insert_fixup (struct mem_node
*);
390 static void mem_rotate_left (struct mem_node
*);
391 static void mem_rotate_right (struct mem_node
*);
392 static void mem_delete (struct mem_node
*);
393 static void mem_delete_fixup (struct mem_node
*);
394 static struct mem_node
*mem_find (void *);
396 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
402 /* Recording what needs to be marked for gc. */
404 struct gcpro
*gcprolist
;
406 /* Addresses of staticpro'd variables. Initialize it to a nonzero
407 value; otherwise some compilers put it into BSS. */
409 enum { NSTATICS
= 2048 };
410 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
412 /* Index of next unused slot in staticvec. */
414 static int staticidx
;
416 static void *pure_alloc (size_t, int);
418 /* Return X rounded to the next multiple of Y. Arguments should not
419 have side effects, as they are evaluated more than once. Assume X
420 + Y - 1 does not overflow. Tune for Y being a power of 2. */
422 #define ROUNDUP(x, y) ((y) & ((y) - 1) \
423 ? ((x) + (y) - 1) - ((x) + (y) - 1) % (y) \
424 : ((x) + (y) - 1) & ~ ((y) - 1))
426 /* Return PTR rounded up to the next multiple of ALIGNMENT. */
429 ALIGN (void *ptr
, int alignment
)
431 return (void *) ROUNDUP ((uintptr_t) ptr
, alignment
);
435 XFLOAT_INIT (Lisp_Object f
, double n
)
437 XFLOAT (f
)->u
.data
= n
;
441 pointers_fit_in_lispobj_p (void)
443 return (UINTPTR_MAX
<= VAL_MAX
) || USE_LSB_TAG
;
447 mmap_lisp_allowed_p (void)
449 /* If we can't store all memory addresses in our lisp objects, it's
450 risky to let the heap use mmap and give us addresses from all
451 over our address space. We also can't use mmap for lisp objects
452 if we might dump: unexec doesn't preserve the contents of mmaped
454 return pointers_fit_in_lispobj_p () && !might_dump
;
458 /************************************************************************
460 ************************************************************************/
462 /* Function malloc calls this if it finds we are near exhausting storage. */
465 malloc_warning (const char *str
)
467 pending_malloc_warning
= str
;
471 /* Display an already-pending malloc warning. */
474 display_malloc_warning (void)
476 call3 (intern ("display-warning"),
478 build_string (pending_malloc_warning
),
479 intern ("emergency"));
480 pending_malloc_warning
= 0;
483 /* Called if we can't allocate relocatable space for a buffer. */
486 buffer_memory_full (ptrdiff_t nbytes
)
488 /* If buffers use the relocating allocator, no need to free
489 spare_memory, because we may have plenty of malloc space left
490 that we could get, and if we don't, the malloc that fails will
491 itself cause spare_memory to be freed. If buffers don't use the
492 relocating allocator, treat this like any other failing
496 memory_full (nbytes
);
498 /* This used to call error, but if we've run out of memory, we could
499 get infinite recursion trying to build the string. */
500 xsignal (Qnil
, Vmemory_signal_data
);
504 /* A common multiple of the positive integers A and B. Ideally this
505 would be the least common multiple, but there's no way to do that
506 as a constant expression in C, so do the best that we can easily do. */
507 #define COMMON_MULTIPLE(a, b) \
508 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
510 #ifndef XMALLOC_OVERRUN_CHECK
511 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
514 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
517 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
518 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
519 block size in little-endian order. The trailer consists of
520 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
522 The header is used to detect whether this block has been allocated
523 through these functions, as some low-level libc functions may
524 bypass the malloc hooks. */
526 #define XMALLOC_OVERRUN_CHECK_SIZE 16
527 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
528 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
530 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
531 hold a size_t value and (2) the header size is a multiple of the
532 alignment that Emacs needs for C types and for USE_LSB_TAG. */
533 #define XMALLOC_BASE_ALIGNMENT \
534 alignof (union { long double d; intmax_t i; void *p; })
537 # define XMALLOC_HEADER_ALIGNMENT \
538 COMMON_MULTIPLE (GCALIGNMENT, XMALLOC_BASE_ALIGNMENT)
540 # define XMALLOC_HEADER_ALIGNMENT XMALLOC_BASE_ALIGNMENT
542 #define XMALLOC_OVERRUN_SIZE_SIZE \
543 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
544 + XMALLOC_HEADER_ALIGNMENT - 1) \
545 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
546 - XMALLOC_OVERRUN_CHECK_SIZE)
548 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
549 { '\x9a', '\x9b', '\xae', '\xaf',
550 '\xbf', '\xbe', '\xce', '\xcf',
551 '\xea', '\xeb', '\xec', '\xed',
552 '\xdf', '\xde', '\x9c', '\x9d' };
554 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
555 { '\xaa', '\xab', '\xac', '\xad',
556 '\xba', '\xbb', '\xbc', '\xbd',
557 '\xca', '\xcb', '\xcc', '\xcd',
558 '\xda', '\xdb', '\xdc', '\xdd' };
560 /* Insert and extract the block size in the header. */
563 xmalloc_put_size (unsigned char *ptr
, size_t size
)
566 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
568 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
574 xmalloc_get_size (unsigned char *ptr
)
578 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
579 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
588 /* Like malloc, but wraps allocated block with header and trailer. */
591 overrun_check_malloc (size_t size
)
593 register unsigned char *val
;
594 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
597 val
= malloc (size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
600 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
601 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
602 xmalloc_put_size (val
, size
);
603 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
604 XMALLOC_OVERRUN_CHECK_SIZE
);
610 /* Like realloc, but checks old block for overrun, and wraps new block
611 with header and trailer. */
614 overrun_check_realloc (void *block
, size_t size
)
616 register unsigned char *val
= (unsigned char *) block
;
617 if (SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
< size
)
621 && memcmp (xmalloc_overrun_check_header
,
622 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
623 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
625 size_t osize
= xmalloc_get_size (val
);
626 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
627 XMALLOC_OVERRUN_CHECK_SIZE
))
629 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
630 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
631 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
634 val
= realloc (val
, size
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
638 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
639 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
640 xmalloc_put_size (val
, size
);
641 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
642 XMALLOC_OVERRUN_CHECK_SIZE
);
647 /* Like free, but checks block for overrun. */
650 overrun_check_free (void *block
)
652 unsigned char *val
= (unsigned char *) block
;
655 && memcmp (xmalloc_overrun_check_header
,
656 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
657 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
659 size_t osize
= xmalloc_get_size (val
);
660 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
661 XMALLOC_OVERRUN_CHECK_SIZE
))
663 #ifdef XMALLOC_CLEAR_FREE_MEMORY
664 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
665 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
667 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
668 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
669 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
679 #define malloc overrun_check_malloc
680 #define realloc overrun_check_realloc
681 #define free overrun_check_free
684 /* If compiled with XMALLOC_BLOCK_INPUT_CHECK, define a symbol
685 BLOCK_INPUT_IN_MEMORY_ALLOCATORS that is visible to the debugger.
686 If that variable is set, block input while in one of Emacs's memory
687 allocation functions. There should be no need for this debugging
688 option, since signal handlers do not allocate memory, but Emacs
689 formerly allocated memory in signal handlers and this compile-time
690 option remains as a way to help debug the issue should it rear its
692 #ifdef XMALLOC_BLOCK_INPUT_CHECK
693 bool block_input_in_memory_allocators EXTERNALLY_VISIBLE
;
695 malloc_block_input (void)
697 if (block_input_in_memory_allocators
)
701 malloc_unblock_input (void)
703 if (block_input_in_memory_allocators
)
706 # define MALLOC_BLOCK_INPUT malloc_block_input ()
707 # define MALLOC_UNBLOCK_INPUT malloc_unblock_input ()
709 # define MALLOC_BLOCK_INPUT ((void) 0)
710 # define MALLOC_UNBLOCK_INPUT ((void) 0)
713 #define MALLOC_PROBE(size) \
715 if (profiler_memory_running) \
716 malloc_probe (size); \
720 /* Like malloc but check for no memory and block interrupt input.. */
723 xmalloc (size_t size
)
729 MALLOC_UNBLOCK_INPUT
;
737 /* Like the above, but zeroes out the memory just allocated. */
740 xzalloc (size_t size
)
746 MALLOC_UNBLOCK_INPUT
;
750 memset (val
, 0, size
);
755 /* Like realloc but check for no memory and block interrupt input.. */
758 xrealloc (void *block
, size_t size
)
763 /* We must call malloc explicitly when BLOCK is 0, since some
764 reallocs don't do this. */
768 val
= realloc (block
, size
);
769 MALLOC_UNBLOCK_INPUT
;
778 /* Like free but block interrupt input. */
787 MALLOC_UNBLOCK_INPUT
;
788 /* We don't call refill_memory_reserve here
789 because in practice the call in r_alloc_free seems to suffice. */
793 /* Other parts of Emacs pass large int values to allocator functions
794 expecting ptrdiff_t. This is portable in practice, but check it to
796 verify (INT_MAX
<= PTRDIFF_MAX
);
799 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
800 Signal an error on memory exhaustion, and block interrupt input. */
803 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
805 eassert (0 <= nitems
&& 0 < item_size
);
806 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
807 memory_full (SIZE_MAX
);
808 return xmalloc (nitems
* item_size
);
812 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
813 Signal an error on memory exhaustion, and block interrupt input. */
816 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
818 eassert (0 <= nitems
&& 0 < item_size
);
819 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
820 memory_full (SIZE_MAX
);
821 return xrealloc (pa
, nitems
* item_size
);
825 /* Grow PA, which points to an array of *NITEMS items, and return the
826 location of the reallocated array, updating *NITEMS to reflect its
827 new size. The new array will contain at least NITEMS_INCR_MIN more
828 items, but will not contain more than NITEMS_MAX items total.
829 ITEM_SIZE is the size of each item, in bytes.
831 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
832 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
835 If PA is null, then allocate a new array instead of reallocating
838 Block interrupt input as needed. If memory exhaustion occurs, set
839 *NITEMS to zero if PA is null, and signal an error (i.e., do not
842 Thus, to grow an array A without saving its old contents, do
843 { xfree (A); A = NULL; A = xpalloc (NULL, &AITEMS, ...); }.
844 The A = NULL avoids a dangling pointer if xpalloc exhausts memory
845 and signals an error, and later this code is reexecuted and
846 attempts to free A. */
849 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
850 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
852 /* The approximate size to use for initial small allocation
853 requests. This is the largest "small" request for the GNU C
855 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
857 /* If the array is tiny, grow it to about (but no greater than)
858 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
859 ptrdiff_t n
= *nitems
;
860 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
861 ptrdiff_t half_again
= n
>> 1;
862 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
864 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
865 NITEMS_MAX, and what the C language can represent safely. */
866 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
867 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
868 ? nitems_max
: C_language_max
);
869 ptrdiff_t nitems_incr_max
= n_max
- n
;
870 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
872 eassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
875 if (nitems_incr_max
< incr
)
876 memory_full (SIZE_MAX
);
878 pa
= xrealloc (pa
, n
* item_size
);
884 /* Like strdup, but uses xmalloc. */
887 xstrdup (const char *s
)
891 size
= strlen (s
) + 1;
892 return memcpy (xmalloc (size
), s
, size
);
895 /* Like above, but duplicates Lisp string to C string. */
898 xlispstrdup (Lisp_Object string
)
900 ptrdiff_t size
= SBYTES (string
) + 1;
901 return memcpy (xmalloc (size
), SSDATA (string
), size
);
904 /* Assign to *PTR a copy of STRING, freeing any storage *PTR formerly
905 pointed to. If STRING is null, assign it without copying anything.
906 Allocate before freeing, to avoid a dangling pointer if allocation
910 dupstring (char **ptr
, char const *string
)
913 *ptr
= string
? xstrdup (string
) : 0;
918 /* Like putenv, but (1) use the equivalent of xmalloc and (2) the
919 argument is a const pointer. */
922 xputenv (char const *string
)
924 if (putenv ((char *) string
) != 0)
928 /* Return a newly allocated memory block of SIZE bytes, remembering
929 to free it when unwinding. */
931 record_xmalloc (size_t size
)
933 void *p
= xmalloc (size
);
934 record_unwind_protect_ptr (xfree
, p
);
939 /* Like malloc but used for allocating Lisp data. NBYTES is the
940 number of bytes to allocate, TYPE describes the intended use of the
941 allocated memory block (for strings, for conses, ...). */
944 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
948 lisp_malloc (size_t nbytes
, enum mem_type type
)
954 #ifdef GC_MALLOC_CHECK
955 allocated_mem_type
= type
;
958 val
= malloc (nbytes
);
961 /* If the memory just allocated cannot be addressed thru a Lisp
962 object's pointer, and it needs to be,
963 that's equivalent to running out of memory. */
964 if (val
&& type
!= MEM_TYPE_NON_LISP
)
967 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
968 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
970 lisp_malloc_loser
= val
;
977 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
978 if (val
&& type
!= MEM_TYPE_NON_LISP
)
979 mem_insert (val
, (char *) val
+ nbytes
, type
);
982 MALLOC_UNBLOCK_INPUT
;
984 memory_full (nbytes
);
985 MALLOC_PROBE (nbytes
);
989 /* Free BLOCK. This must be called to free memory allocated with a
990 call to lisp_malloc. */
993 lisp_free (void *block
)
997 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
998 mem_delete (mem_find (block
));
1000 MALLOC_UNBLOCK_INPUT
;
1003 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
1005 /* The entry point is lisp_align_malloc which returns blocks of at most
1006 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
1008 /* Use aligned_alloc if it or a simple substitute is available.
1009 Address sanitization breaks aligned allocation, as of gcc 4.8.2 and
1010 clang 3.3 anyway. */
1012 #if ! ADDRESS_SANITIZER
1013 # if !defined SYSTEM_MALLOC && !defined DOUG_LEA_MALLOC
1014 # define USE_ALIGNED_ALLOC 1
1015 /* Defined in gmalloc.c. */
1016 void *aligned_alloc (size_t, size_t);
1017 # elif defined HAVE_ALIGNED_ALLOC
1018 # define USE_ALIGNED_ALLOC 1
1019 # elif defined HAVE_POSIX_MEMALIGN
1020 # define USE_ALIGNED_ALLOC 1
1022 aligned_alloc (size_t alignment
, size_t size
)
1025 return posix_memalign (&p
, alignment
, size
) == 0 ? p
: 0;
1030 /* BLOCK_ALIGN has to be a power of 2. */
1031 #define BLOCK_ALIGN (1 << 10)
1033 /* Padding to leave at the end of a malloc'd block. This is to give
1034 malloc a chance to minimize the amount of memory wasted to alignment.
1035 It should be tuned to the particular malloc library used.
1036 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
1037 aligned_alloc on the other hand would ideally prefer a value of 4
1038 because otherwise, there's 1020 bytes wasted between each ablocks.
1039 In Emacs, testing shows that those 1020 can most of the time be
1040 efficiently used by malloc to place other objects, so a value of 0 can
1041 still preferable unless you have a lot of aligned blocks and virtually
1043 #define BLOCK_PADDING 0
1044 #define BLOCK_BYTES \
1045 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
1047 /* Internal data structures and constants. */
1049 #define ABLOCKS_SIZE 16
1051 /* An aligned block of memory. */
1056 char payload
[BLOCK_BYTES
];
1057 struct ablock
*next_free
;
1059 /* `abase' is the aligned base of the ablocks. */
1060 /* It is overloaded to hold the virtual `busy' field that counts
1061 the number of used ablock in the parent ablocks.
1062 The first ablock has the `busy' field, the others have the `abase'
1063 field. To tell the difference, we assume that pointers will have
1064 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1065 is used to tell whether the real base of the parent ablocks is `abase'
1066 (if not, the word before the first ablock holds a pointer to the
1068 struct ablocks
*abase
;
1069 /* The padding of all but the last ablock is unused. The padding of
1070 the last ablock in an ablocks is not allocated. */
1072 char padding
[BLOCK_PADDING
];
1076 /* A bunch of consecutive aligned blocks. */
1079 struct ablock blocks
[ABLOCKS_SIZE
];
1082 /* Size of the block requested from malloc or aligned_alloc. */
1083 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1085 #define ABLOCK_ABASE(block) \
1086 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1087 ? (struct ablocks *)(block) \
1090 /* Virtual `busy' field. */
1091 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1093 /* Pointer to the (not necessarily aligned) malloc block. */
1094 #ifdef USE_ALIGNED_ALLOC
1095 #define ABLOCKS_BASE(abase) (abase)
1097 #define ABLOCKS_BASE(abase) \
1098 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void **)abase)[-1])
1101 /* The list of free ablock. */
1102 static struct ablock
*free_ablock
;
1104 /* Allocate an aligned block of nbytes.
1105 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1106 smaller or equal to BLOCK_BYTES. */
1108 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1111 struct ablocks
*abase
;
1113 eassert (nbytes
<= BLOCK_BYTES
);
1117 #ifdef GC_MALLOC_CHECK
1118 allocated_mem_type
= type
;
1124 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1126 #ifdef DOUG_LEA_MALLOC
1127 if (!mmap_lisp_allowed_p ())
1128 mallopt (M_MMAP_MAX
, 0);
1131 #ifdef USE_ALIGNED_ALLOC
1132 abase
= base
= aligned_alloc (BLOCK_ALIGN
, ABLOCKS_BYTES
);
1134 base
= malloc (ABLOCKS_BYTES
);
1135 abase
= ALIGN (base
, BLOCK_ALIGN
);
1140 MALLOC_UNBLOCK_INPUT
;
1141 memory_full (ABLOCKS_BYTES
);
1144 aligned
= (base
== abase
);
1146 ((void **) abase
)[-1] = base
;
1148 #ifdef DOUG_LEA_MALLOC
1149 if (!mmap_lisp_allowed_p ())
1150 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1154 /* If the memory just allocated cannot be addressed thru a Lisp
1155 object's pointer, and it needs to be, that's equivalent to
1156 running out of memory. */
1157 if (type
!= MEM_TYPE_NON_LISP
)
1160 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1161 XSETCONS (tem
, end
);
1162 if ((char *) XCONS (tem
) != end
)
1164 lisp_malloc_loser
= base
;
1166 MALLOC_UNBLOCK_INPUT
;
1167 memory_full (SIZE_MAX
);
1172 /* Initialize the blocks and put them on the free list.
1173 If `base' was not properly aligned, we can't use the last block. */
1174 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1176 abase
->blocks
[i
].abase
= abase
;
1177 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1178 free_ablock
= &abase
->blocks
[i
];
1180 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1182 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1183 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1184 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1185 eassert (ABLOCKS_BASE (abase
) == base
);
1186 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1189 abase
= ABLOCK_ABASE (free_ablock
);
1190 ABLOCKS_BUSY (abase
)
1191 = (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1193 free_ablock
= free_ablock
->x
.next_free
;
1195 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1196 if (type
!= MEM_TYPE_NON_LISP
)
1197 mem_insert (val
, (char *) val
+ nbytes
, type
);
1200 MALLOC_UNBLOCK_INPUT
;
1202 MALLOC_PROBE (nbytes
);
1204 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1209 lisp_align_free (void *block
)
1211 struct ablock
*ablock
= block
;
1212 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1215 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1216 mem_delete (mem_find (block
));
1218 /* Put on free list. */
1219 ablock
->x
.next_free
= free_ablock
;
1220 free_ablock
= ablock
;
1221 /* Update busy count. */
1222 ABLOCKS_BUSY (abase
)
1223 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1225 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1226 { /* All the blocks are free. */
1227 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1228 struct ablock
**tem
= &free_ablock
;
1229 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1233 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1236 *tem
= (*tem
)->x
.next_free
;
1239 tem
= &(*tem
)->x
.next_free
;
1241 eassert ((aligned
& 1) == aligned
);
1242 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1243 #ifdef USE_POSIX_MEMALIGN
1244 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1246 free (ABLOCKS_BASE (abase
));
1248 MALLOC_UNBLOCK_INPUT
;
1252 /***********************************************************************
1254 ***********************************************************************/
1256 /* Number of intervals allocated in an interval_block structure.
1257 The 1020 is 1024 minus malloc overhead. */
1259 #define INTERVAL_BLOCK_SIZE \
1260 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1262 /* Intervals are allocated in chunks in the form of an interval_block
1265 struct interval_block
1267 /* Place `intervals' first, to preserve alignment. */
1268 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1269 struct interval_block
*next
;
1272 /* Current interval block. Its `next' pointer points to older
1275 static struct interval_block
*interval_block
;
1277 /* Index in interval_block above of the next unused interval
1280 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1282 /* Number of free and live intervals. */
1284 static EMACS_INT total_free_intervals
, total_intervals
;
1286 /* List of free intervals. */
1288 static INTERVAL interval_free_list
;
1290 /* Return a new interval. */
1293 make_interval (void)
1299 if (interval_free_list
)
1301 val
= interval_free_list
;
1302 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1306 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1308 struct interval_block
*newi
1309 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1311 newi
->next
= interval_block
;
1312 interval_block
= newi
;
1313 interval_block_index
= 0;
1314 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1316 val
= &interval_block
->intervals
[interval_block_index
++];
1319 MALLOC_UNBLOCK_INPUT
;
1321 consing_since_gc
+= sizeof (struct interval
);
1323 total_free_intervals
--;
1324 RESET_INTERVAL (val
);
1330 /* Mark Lisp objects in interval I. */
1333 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1335 /* Intervals should never be shared. So, if extra internal checking is
1336 enabled, GC aborts if it seems to have visited an interval twice. */
1337 eassert (!i
->gcmarkbit
);
1339 mark_object (i
->plist
);
1342 /* Mark the interval tree rooted in I. */
1344 #define MARK_INTERVAL_TREE(i) \
1346 if (i && !i->gcmarkbit) \
1347 traverse_intervals_noorder (i, mark_interval, Qnil); \
1350 /***********************************************************************
1352 ***********************************************************************/
1354 /* Lisp_Strings are allocated in string_block structures. When a new
1355 string_block is allocated, all the Lisp_Strings it contains are
1356 added to a free-list string_free_list. When a new Lisp_String is
1357 needed, it is taken from that list. During the sweep phase of GC,
1358 string_blocks that are entirely free are freed, except two which
1361 String data is allocated from sblock structures. Strings larger
1362 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1363 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1365 Sblocks consist internally of sdata structures, one for each
1366 Lisp_String. The sdata structure points to the Lisp_String it
1367 belongs to. The Lisp_String points back to the `u.data' member of
1368 its sdata structure.
1370 When a Lisp_String is freed during GC, it is put back on
1371 string_free_list, and its `data' member and its sdata's `string'
1372 pointer is set to null. The size of the string is recorded in the
1373 `n.nbytes' member of the sdata. So, sdata structures that are no
1374 longer used, can be easily recognized, and it's easy to compact the
1375 sblocks of small strings which we do in compact_small_strings. */
1377 /* Size in bytes of an sblock structure used for small strings. This
1378 is 8192 minus malloc overhead. */
1380 #define SBLOCK_SIZE 8188
1382 /* Strings larger than this are considered large strings. String data
1383 for large strings is allocated from individual sblocks. */
1385 #define LARGE_STRING_BYTES 1024
1387 /* The SDATA typedef is a struct or union describing string memory
1388 sub-allocated from an sblock. This is where the contents of Lisp
1389 strings are stored. */
1393 /* Back-pointer to the string this sdata belongs to. If null, this
1394 structure is free, and NBYTES (in this structure or in the union below)
1395 contains the string's byte size (the same value that STRING_BYTES
1396 would return if STRING were non-null). If non-null, STRING_BYTES
1397 (STRING) is the size of the data, and DATA contains the string's
1399 struct Lisp_String
*string
;
1401 #ifdef GC_CHECK_STRING_BYTES
1405 unsigned char data
[FLEXIBLE_ARRAY_MEMBER
];
1408 #ifdef GC_CHECK_STRING_BYTES
1410 typedef struct sdata sdata
;
1411 #define SDATA_NBYTES(S) (S)->nbytes
1412 #define SDATA_DATA(S) (S)->data
1418 struct Lisp_String
*string
;
1420 /* When STRING is nonnull, this union is actually of type 'struct sdata',
1421 which has a flexible array member. However, if implemented by
1422 giving this union a member of type 'struct sdata', the union
1423 could not be the last (flexible) member of 'struct sblock',
1424 because C99 prohibits a flexible array member from having a type
1425 that is itself a flexible array. So, comment this member out here,
1426 but remember that the option's there when using this union. */
1431 /* When STRING is null. */
1434 struct Lisp_String
*string
;
1439 #define SDATA_NBYTES(S) (S)->n.nbytes
1440 #define SDATA_DATA(S) ((struct sdata *) (S))->data
1442 #endif /* not GC_CHECK_STRING_BYTES */
1444 enum { SDATA_DATA_OFFSET
= offsetof (struct sdata
, data
) };
1446 /* Structure describing a block of memory which is sub-allocated to
1447 obtain string data memory for strings. Blocks for small strings
1448 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1449 as large as needed. */
1454 struct sblock
*next
;
1456 /* Pointer to the next free sdata block. This points past the end
1457 of the sblock if there isn't any space left in this block. */
1461 sdata data
[FLEXIBLE_ARRAY_MEMBER
];
1464 /* Number of Lisp strings in a string_block structure. The 1020 is
1465 1024 minus malloc overhead. */
1467 #define STRING_BLOCK_SIZE \
1468 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1470 /* Structure describing a block from which Lisp_String structures
1475 /* Place `strings' first, to preserve alignment. */
1476 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1477 struct string_block
*next
;
1480 /* Head and tail of the list of sblock structures holding Lisp string
1481 data. We always allocate from current_sblock. The NEXT pointers
1482 in the sblock structures go from oldest_sblock to current_sblock. */
1484 static struct sblock
*oldest_sblock
, *current_sblock
;
1486 /* List of sblocks for large strings. */
1488 static struct sblock
*large_sblocks
;
1490 /* List of string_block structures. */
1492 static struct string_block
*string_blocks
;
1494 /* Free-list of Lisp_Strings. */
1496 static struct Lisp_String
*string_free_list
;
1498 /* Number of live and free Lisp_Strings. */
1500 static EMACS_INT total_strings
, total_free_strings
;
1502 /* Number of bytes used by live strings. */
1504 static EMACS_INT total_string_bytes
;
1506 /* Given a pointer to a Lisp_String S which is on the free-list
1507 string_free_list, return a pointer to its successor in the
1510 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1512 /* Return a pointer to the sdata structure belonging to Lisp string S.
1513 S must be live, i.e. S->data must not be null. S->data is actually
1514 a pointer to the `u.data' member of its sdata structure; the
1515 structure starts at a constant offset in front of that. */
1517 #define SDATA_OF_STRING(S) ((sdata *) ((S)->data - SDATA_DATA_OFFSET))
1520 #ifdef GC_CHECK_STRING_OVERRUN
1522 /* We check for overrun in string data blocks by appending a small
1523 "cookie" after each allocated string data block, and check for the
1524 presence of this cookie during GC. */
1526 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1527 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1528 { '\xde', '\xad', '\xbe', '\xef' };
1531 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1534 /* Value is the size of an sdata structure large enough to hold NBYTES
1535 bytes of string data. The value returned includes a terminating
1536 NUL byte, the size of the sdata structure, and padding. */
1538 #ifdef GC_CHECK_STRING_BYTES
1540 #define SDATA_SIZE(NBYTES) \
1541 ((SDATA_DATA_OFFSET \
1543 + sizeof (ptrdiff_t) - 1) \
1544 & ~(sizeof (ptrdiff_t) - 1))
1546 #else /* not GC_CHECK_STRING_BYTES */
1548 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1549 less than the size of that member. The 'max' is not needed when
1550 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1551 alignment code reserves enough space. */
1553 #define SDATA_SIZE(NBYTES) \
1554 ((SDATA_DATA_OFFSET \
1555 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1557 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1559 + sizeof (ptrdiff_t) - 1) \
1560 & ~(sizeof (ptrdiff_t) - 1))
1562 #endif /* not GC_CHECK_STRING_BYTES */
1564 /* Extra bytes to allocate for each string. */
1566 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1568 /* Exact bound on the number of bytes in a string, not counting the
1569 terminating null. A string cannot contain more bytes than
1570 STRING_BYTES_BOUND, nor can it be so long that the size_t
1571 arithmetic in allocate_string_data would overflow while it is
1572 calculating a value to be passed to malloc. */
1573 static ptrdiff_t const STRING_BYTES_MAX
=
1574 min (STRING_BYTES_BOUND
,
1575 ((SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
1577 - offsetof (struct sblock
, data
)
1578 - SDATA_DATA_OFFSET
)
1579 & ~(sizeof (EMACS_INT
) - 1)));
1581 /* Initialize string allocation. Called from init_alloc_once. */
1586 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1587 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1591 #ifdef GC_CHECK_STRING_BYTES
1593 static int check_string_bytes_count
;
1595 /* Like STRING_BYTES, but with debugging check. Can be
1596 called during GC, so pay attention to the mark bit. */
1599 string_bytes (struct Lisp_String
*s
)
1602 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1604 if (!PURE_POINTER_P (s
)
1606 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1611 /* Check validity of Lisp strings' string_bytes member in B. */
1614 check_sblock (struct sblock
*b
)
1616 sdata
*from
, *end
, *from_end
;
1620 for (from
= b
->data
; from
< end
; from
= from_end
)
1622 /* Compute the next FROM here because copying below may
1623 overwrite data we need to compute it. */
1626 /* Check that the string size recorded in the string is the
1627 same as the one recorded in the sdata structure. */
1628 nbytes
= SDATA_SIZE (from
->string
? string_bytes (from
->string
)
1629 : SDATA_NBYTES (from
));
1630 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1635 /* Check validity of Lisp strings' string_bytes member. ALL_P
1636 means check all strings, otherwise check only most
1637 recently allocated strings. Used for hunting a bug. */
1640 check_string_bytes (bool all_p
)
1646 for (b
= large_sblocks
; b
; b
= b
->next
)
1648 struct Lisp_String
*s
= b
->data
[0].string
;
1653 for (b
= oldest_sblock
; b
; b
= b
->next
)
1656 else if (current_sblock
)
1657 check_sblock (current_sblock
);
1660 #else /* not GC_CHECK_STRING_BYTES */
1662 #define check_string_bytes(all) ((void) 0)
1664 #endif /* GC_CHECK_STRING_BYTES */
1666 #ifdef GC_CHECK_STRING_FREE_LIST
1668 /* Walk through the string free list looking for bogus next pointers.
1669 This may catch buffer overrun from a previous string. */
1672 check_string_free_list (void)
1674 struct Lisp_String
*s
;
1676 /* Pop a Lisp_String off the free-list. */
1677 s
= string_free_list
;
1680 if ((uintptr_t) s
< 1024)
1682 s
= NEXT_FREE_LISP_STRING (s
);
1686 #define check_string_free_list()
1689 /* Return a new Lisp_String. */
1691 static struct Lisp_String
*
1692 allocate_string (void)
1694 struct Lisp_String
*s
;
1698 /* If the free-list is empty, allocate a new string_block, and
1699 add all the Lisp_Strings in it to the free-list. */
1700 if (string_free_list
== NULL
)
1702 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1705 b
->next
= string_blocks
;
1708 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1711 /* Every string on a free list should have NULL data pointer. */
1713 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1714 string_free_list
= s
;
1717 total_free_strings
+= STRING_BLOCK_SIZE
;
1720 check_string_free_list ();
1722 /* Pop a Lisp_String off the free-list. */
1723 s
= string_free_list
;
1724 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1726 MALLOC_UNBLOCK_INPUT
;
1728 --total_free_strings
;
1731 consing_since_gc
+= sizeof *s
;
1733 #ifdef GC_CHECK_STRING_BYTES
1734 if (!noninteractive
)
1736 if (++check_string_bytes_count
== 200)
1738 check_string_bytes_count
= 0;
1739 check_string_bytes (1);
1742 check_string_bytes (0);
1744 #endif /* GC_CHECK_STRING_BYTES */
1750 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1751 plus a NUL byte at the end. Allocate an sdata structure for S, and
1752 set S->data to its `u.data' member. Store a NUL byte at the end of
1753 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1754 S->data if it was initially non-null. */
1757 allocate_string_data (struct Lisp_String
*s
,
1758 EMACS_INT nchars
, EMACS_INT nbytes
)
1760 sdata
*data
, *old_data
;
1762 ptrdiff_t needed
, old_nbytes
;
1764 if (STRING_BYTES_MAX
< nbytes
)
1767 /* Determine the number of bytes needed to store NBYTES bytes
1769 needed
= SDATA_SIZE (nbytes
);
1772 old_data
= SDATA_OF_STRING (s
);
1773 old_nbytes
= STRING_BYTES (s
);
1780 if (nbytes
> LARGE_STRING_BYTES
)
1782 size_t size
= offsetof (struct sblock
, data
) + needed
;
1784 #ifdef DOUG_LEA_MALLOC
1785 if (!mmap_lisp_allowed_p ())
1786 mallopt (M_MMAP_MAX
, 0);
1789 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
1791 #ifdef DOUG_LEA_MALLOC
1792 if (!mmap_lisp_allowed_p ())
1793 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1796 b
->next_free
= b
->data
;
1797 b
->data
[0].string
= NULL
;
1798 b
->next
= large_sblocks
;
1801 else if (current_sblock
== NULL
1802 || (((char *) current_sblock
+ SBLOCK_SIZE
1803 - (char *) current_sblock
->next_free
)
1804 < (needed
+ GC_STRING_EXTRA
)))
1806 /* Not enough room in the current sblock. */
1807 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
1808 b
->next_free
= b
->data
;
1809 b
->data
[0].string
= NULL
;
1813 current_sblock
->next
= b
;
1821 data
= b
->next_free
;
1822 b
->next_free
= (sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
1824 MALLOC_UNBLOCK_INPUT
;
1827 s
->data
= SDATA_DATA (data
);
1828 #ifdef GC_CHECK_STRING_BYTES
1829 SDATA_NBYTES (data
) = nbytes
;
1832 s
->size_byte
= nbytes
;
1833 s
->data
[nbytes
] = '\0';
1834 #ifdef GC_CHECK_STRING_OVERRUN
1835 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
1836 GC_STRING_OVERRUN_COOKIE_SIZE
);
1839 /* Note that Faset may call to this function when S has already data
1840 assigned. In this case, mark data as free by setting it's string
1841 back-pointer to null, and record the size of the data in it. */
1844 SDATA_NBYTES (old_data
) = old_nbytes
;
1845 old_data
->string
= NULL
;
1848 consing_since_gc
+= needed
;
1852 /* Sweep and compact strings. */
1854 NO_INLINE
/* For better stack traces */
1856 sweep_strings (void)
1858 struct string_block
*b
, *next
;
1859 struct string_block
*live_blocks
= NULL
;
1861 string_free_list
= NULL
;
1862 total_strings
= total_free_strings
= 0;
1863 total_string_bytes
= 0;
1865 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
1866 for (b
= string_blocks
; b
; b
= next
)
1869 struct Lisp_String
*free_list_before
= string_free_list
;
1873 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
1875 struct Lisp_String
*s
= b
->strings
+ i
;
1879 /* String was not on free-list before. */
1880 if (STRING_MARKED_P (s
))
1882 /* String is live; unmark it and its intervals. */
1885 /* Do not use string_(set|get)_intervals here. */
1886 s
->intervals
= balance_intervals (s
->intervals
);
1889 total_string_bytes
+= STRING_BYTES (s
);
1893 /* String is dead. Put it on the free-list. */
1894 sdata
*data
= SDATA_OF_STRING (s
);
1896 /* Save the size of S in its sdata so that we know
1897 how large that is. Reset the sdata's string
1898 back-pointer so that we know it's free. */
1899 #ifdef GC_CHECK_STRING_BYTES
1900 if (string_bytes (s
) != SDATA_NBYTES (data
))
1903 data
->n
.nbytes
= STRING_BYTES (s
);
1905 data
->string
= NULL
;
1907 /* Reset the strings's `data' member so that we
1911 /* Put the string on the free-list. */
1912 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1913 string_free_list
= s
;
1919 /* S was on the free-list before. Put it there again. */
1920 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1921 string_free_list
= s
;
1926 /* Free blocks that contain free Lisp_Strings only, except
1927 the first two of them. */
1928 if (nfree
== STRING_BLOCK_SIZE
1929 && total_free_strings
> STRING_BLOCK_SIZE
)
1932 string_free_list
= free_list_before
;
1936 total_free_strings
+= nfree
;
1937 b
->next
= live_blocks
;
1942 check_string_free_list ();
1944 string_blocks
= live_blocks
;
1945 free_large_strings ();
1946 compact_small_strings ();
1948 check_string_free_list ();
1952 /* Free dead large strings. */
1955 free_large_strings (void)
1957 struct sblock
*b
, *next
;
1958 struct sblock
*live_blocks
= NULL
;
1960 for (b
= large_sblocks
; b
; b
= next
)
1964 if (b
->data
[0].string
== NULL
)
1968 b
->next
= live_blocks
;
1973 large_sblocks
= live_blocks
;
1977 /* Compact data of small strings. Free sblocks that don't contain
1978 data of live strings after compaction. */
1981 compact_small_strings (void)
1983 struct sblock
*b
, *tb
, *next
;
1984 sdata
*from
, *to
, *end
, *tb_end
;
1985 sdata
*to_end
, *from_end
;
1987 /* TB is the sblock we copy to, TO is the sdata within TB we copy
1988 to, and TB_END is the end of TB. */
1990 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
1993 /* Step through the blocks from the oldest to the youngest. We
1994 expect that old blocks will stabilize over time, so that less
1995 copying will happen this way. */
1996 for (b
= oldest_sblock
; b
; b
= b
->next
)
1999 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2001 for (from
= b
->data
; from
< end
; from
= from_end
)
2003 /* Compute the next FROM here because copying below may
2004 overwrite data we need to compute it. */
2006 struct Lisp_String
*s
= from
->string
;
2008 #ifdef GC_CHECK_STRING_BYTES
2009 /* Check that the string size recorded in the string is the
2010 same as the one recorded in the sdata structure. */
2011 if (s
&& string_bytes (s
) != SDATA_NBYTES (from
))
2013 #endif /* GC_CHECK_STRING_BYTES */
2015 nbytes
= s
? STRING_BYTES (s
) : SDATA_NBYTES (from
);
2016 eassert (nbytes
<= LARGE_STRING_BYTES
);
2018 nbytes
= SDATA_SIZE (nbytes
);
2019 from_end
= (sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2021 #ifdef GC_CHECK_STRING_OVERRUN
2022 if (memcmp (string_overrun_cookie
,
2023 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2024 GC_STRING_OVERRUN_COOKIE_SIZE
))
2028 /* Non-NULL S means it's alive. Copy its data. */
2031 /* If TB is full, proceed with the next sblock. */
2032 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2033 if (to_end
> tb_end
)
2037 tb_end
= (sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2039 to_end
= (sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2042 /* Copy, and update the string's `data' pointer. */
2045 eassert (tb
!= b
|| to
< from
);
2046 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2047 to
->string
->data
= SDATA_DATA (to
);
2050 /* Advance past the sdata we copied to. */
2056 /* The rest of the sblocks following TB don't contain live data, so
2057 we can free them. */
2058 for (b
= tb
->next
; b
; b
= next
)
2066 current_sblock
= tb
;
2070 string_overflow (void)
2072 error ("Maximum string size exceeded");
2075 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2076 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2077 LENGTH must be an integer.
2078 INIT must be an integer that represents a character. */)
2079 (Lisp_Object length
, Lisp_Object init
)
2081 register Lisp_Object val
;
2085 CHECK_NATNUM (length
);
2086 CHECK_CHARACTER (init
);
2088 c
= XFASTINT (init
);
2089 if (ASCII_CHAR_P (c
))
2091 nbytes
= XINT (length
);
2092 val
= make_uninit_string (nbytes
);
2093 memset (SDATA (val
), c
, nbytes
);
2094 SDATA (val
)[nbytes
] = 0;
2098 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2099 ptrdiff_t len
= CHAR_STRING (c
, str
);
2100 EMACS_INT string_len
= XINT (length
);
2101 unsigned char *p
, *beg
, *end
;
2103 if (string_len
> STRING_BYTES_MAX
/ len
)
2105 nbytes
= len
* string_len
;
2106 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2107 for (beg
= SDATA (val
), p
= beg
, end
= beg
+ nbytes
; p
< end
; p
+= len
)
2109 /* First time we just copy `str' to the data of `val'. */
2111 memcpy (p
, str
, len
);
2114 /* Next time we copy largest possible chunk from
2115 initialized to uninitialized part of `val'. */
2116 len
= min (p
- beg
, end
- p
);
2117 memcpy (p
, beg
, len
);
2126 /* Fill A with 1 bits if INIT is non-nil, and with 0 bits otherwise.
2130 bool_vector_fill (Lisp_Object a
, Lisp_Object init
)
2132 EMACS_INT nbits
= bool_vector_size (a
);
2135 unsigned char *data
= bool_vector_uchar_data (a
);
2136 int pattern
= NILP (init
) ? 0 : (1 << BOOL_VECTOR_BITS_PER_CHAR
) - 1;
2137 ptrdiff_t nbytes
= bool_vector_bytes (nbits
);
2138 int last_mask
= ~ (~0 << ((nbits
- 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1));
2139 memset (data
, pattern
, nbytes
- 1);
2140 data
[nbytes
- 1] = pattern
& last_mask
;
2145 /* Return a newly allocated, uninitialized bool vector of size NBITS. */
2148 make_uninit_bool_vector (EMACS_INT nbits
)
2151 EMACS_INT words
= bool_vector_words (nbits
);
2152 EMACS_INT word_bytes
= words
* sizeof (bits_word
);
2153 EMACS_INT needed_elements
= ((bool_header_size
- header_size
+ word_bytes
2156 struct Lisp_Bool_Vector
*p
2157 = (struct Lisp_Bool_Vector
*) allocate_vector (needed_elements
);
2158 XSETVECTOR (val
, p
);
2159 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0, 0);
2162 /* Clear padding at the end. */
2164 p
->data
[words
- 1] = 0;
2169 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2170 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2171 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2172 (Lisp_Object length
, Lisp_Object init
)
2176 CHECK_NATNUM (length
);
2177 val
= make_uninit_bool_vector (XFASTINT (length
));
2178 return bool_vector_fill (val
, init
);
2182 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2183 of characters from the contents. This string may be unibyte or
2184 multibyte, depending on the contents. */
2187 make_string (const char *contents
, ptrdiff_t nbytes
)
2189 register Lisp_Object val
;
2190 ptrdiff_t nchars
, multibyte_nbytes
;
2192 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2193 &nchars
, &multibyte_nbytes
);
2194 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2195 /* CONTENTS contains no multibyte sequences or contains an invalid
2196 multibyte sequence. We must make unibyte string. */
2197 val
= make_unibyte_string (contents
, nbytes
);
2199 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2204 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2207 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2209 register Lisp_Object val
;
2210 val
= make_uninit_string (length
);
2211 memcpy (SDATA (val
), contents
, length
);
2216 /* Make a multibyte string from NCHARS characters occupying NBYTES
2217 bytes at CONTENTS. */
2220 make_multibyte_string (const char *contents
,
2221 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2223 register Lisp_Object val
;
2224 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2225 memcpy (SDATA (val
), contents
, nbytes
);
2230 /* Make a string from NCHARS characters occupying NBYTES bytes at
2231 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2234 make_string_from_bytes (const char *contents
,
2235 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2237 register Lisp_Object val
;
2238 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2239 memcpy (SDATA (val
), contents
, nbytes
);
2240 if (SBYTES (val
) == SCHARS (val
))
2241 STRING_SET_UNIBYTE (val
);
2246 /* Make a string from NCHARS characters occupying NBYTES bytes at
2247 CONTENTS. The argument MULTIBYTE controls whether to label the
2248 string as multibyte. If NCHARS is negative, it counts the number of
2249 characters by itself. */
2252 make_specified_string (const char *contents
,
2253 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
2260 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2265 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2266 memcpy (SDATA (val
), contents
, nbytes
);
2268 STRING_SET_UNIBYTE (val
);
2273 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2274 occupying LENGTH bytes. */
2277 make_uninit_string (EMACS_INT length
)
2282 return empty_unibyte_string
;
2283 val
= make_uninit_multibyte_string (length
, length
);
2284 STRING_SET_UNIBYTE (val
);
2289 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2290 which occupy NBYTES bytes. */
2293 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2296 struct Lisp_String
*s
;
2301 return empty_multibyte_string
;
2303 s
= allocate_string ();
2304 s
->intervals
= NULL
;
2305 allocate_string_data (s
, nchars
, nbytes
);
2306 XSETSTRING (string
, s
);
2307 string_chars_consed
+= nbytes
;
2311 /* Print arguments to BUF according to a FORMAT, then return
2312 a Lisp_String initialized with the data from BUF. */
2315 make_formatted_string (char *buf
, const char *format
, ...)
2320 va_start (ap
, format
);
2321 length
= vsprintf (buf
, format
, ap
);
2323 return make_string (buf
, length
);
2327 /***********************************************************************
2329 ***********************************************************************/
2331 /* We store float cells inside of float_blocks, allocating a new
2332 float_block with malloc whenever necessary. Float cells reclaimed
2333 by GC are put on a free list to be reallocated before allocating
2334 any new float cells from the latest float_block. */
2336 #define FLOAT_BLOCK_SIZE \
2337 (((BLOCK_BYTES - sizeof (struct float_block *) \
2338 /* The compiler might add padding at the end. */ \
2339 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2340 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2342 #define GETMARKBIT(block,n) \
2343 (((block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2344 >> ((n) % (sizeof (int) * CHAR_BIT))) \
2347 #define SETMARKBIT(block,n) \
2348 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2349 |= 1 << ((n) % (sizeof (int) * CHAR_BIT))
2351 #define UNSETMARKBIT(block,n) \
2352 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2353 &= ~(1 << ((n) % (sizeof (int) * CHAR_BIT)))
2355 #define FLOAT_BLOCK(fptr) \
2356 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2358 #define FLOAT_INDEX(fptr) \
2359 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2363 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2364 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2365 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2366 struct float_block
*next
;
2369 #define FLOAT_MARKED_P(fptr) \
2370 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2372 #define FLOAT_MARK(fptr) \
2373 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2375 #define FLOAT_UNMARK(fptr) \
2376 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2378 /* Current float_block. */
2380 static struct float_block
*float_block
;
2382 /* Index of first unused Lisp_Float in the current float_block. */
2384 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2386 /* Free-list of Lisp_Floats. */
2388 static struct Lisp_Float
*float_free_list
;
2390 /* Return a new float object with value FLOAT_VALUE. */
2393 make_float (double float_value
)
2395 register Lisp_Object val
;
2399 if (float_free_list
)
2401 /* We use the data field for chaining the free list
2402 so that we won't use the same field that has the mark bit. */
2403 XSETFLOAT (val
, float_free_list
);
2404 float_free_list
= float_free_list
->u
.chain
;
2408 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2410 struct float_block
*new
2411 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2412 new->next
= float_block
;
2413 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2415 float_block_index
= 0;
2416 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2418 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2419 float_block_index
++;
2422 MALLOC_UNBLOCK_INPUT
;
2424 XFLOAT_INIT (val
, float_value
);
2425 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2426 consing_since_gc
+= sizeof (struct Lisp_Float
);
2428 total_free_floats
--;
2434 /***********************************************************************
2436 ***********************************************************************/
2438 /* We store cons cells inside of cons_blocks, allocating a new
2439 cons_block with malloc whenever necessary. Cons cells reclaimed by
2440 GC are put on a free list to be reallocated before allocating
2441 any new cons cells from the latest cons_block. */
2443 #define CONS_BLOCK_SIZE \
2444 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2445 /* The compiler might add padding at the end. */ \
2446 - (sizeof (struct Lisp_Cons) - sizeof (int))) * CHAR_BIT) \
2447 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2449 #define CONS_BLOCK(fptr) \
2450 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2452 #define CONS_INDEX(fptr) \
2453 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2457 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2458 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2459 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2460 struct cons_block
*next
;
2463 #define CONS_MARKED_P(fptr) \
2464 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2466 #define CONS_MARK(fptr) \
2467 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2469 #define CONS_UNMARK(fptr) \
2470 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2472 /* Current cons_block. */
2474 static struct cons_block
*cons_block
;
2476 /* Index of first unused Lisp_Cons in the current block. */
2478 static int cons_block_index
= CONS_BLOCK_SIZE
;
2480 /* Free-list of Lisp_Cons structures. */
2482 static struct Lisp_Cons
*cons_free_list
;
2484 /* Explicitly free a cons cell by putting it on the free-list. */
2487 free_cons (struct Lisp_Cons
*ptr
)
2489 ptr
->u
.chain
= cons_free_list
;
2493 cons_free_list
= ptr
;
2494 consing_since_gc
-= sizeof *ptr
;
2495 total_free_conses
++;
2498 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2499 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2500 (Lisp_Object car
, Lisp_Object cdr
)
2502 register Lisp_Object val
;
2508 /* We use the cdr for chaining the free list
2509 so that we won't use the same field that has the mark bit. */
2510 XSETCONS (val
, cons_free_list
);
2511 cons_free_list
= cons_free_list
->u
.chain
;
2515 if (cons_block_index
== CONS_BLOCK_SIZE
)
2517 struct cons_block
*new
2518 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2519 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2520 new->next
= cons_block
;
2522 cons_block_index
= 0;
2523 total_free_conses
+= CONS_BLOCK_SIZE
;
2525 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2529 MALLOC_UNBLOCK_INPUT
;
2533 eassert (!CONS_MARKED_P (XCONS (val
)));
2534 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2535 total_free_conses
--;
2536 cons_cells_consed
++;
2540 #ifdef GC_CHECK_CONS_LIST
2541 /* Get an error now if there's any junk in the cons free list. */
2543 check_cons_list (void)
2545 struct Lisp_Cons
*tail
= cons_free_list
;
2548 tail
= tail
->u
.chain
;
2552 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2555 list1 (Lisp_Object arg1
)
2557 return Fcons (arg1
, Qnil
);
2561 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2563 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2568 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2570 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2575 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2577 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2582 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2584 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2585 Fcons (arg5
, Qnil
)))));
2588 /* Make a list of COUNT Lisp_Objects, where ARG is the
2589 first one. Allocate conses from pure space if TYPE
2590 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2593 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2597 Lisp_Object val
, *objp
;
2599 /* Change to SAFE_ALLOCA if you hit this eassert. */
2600 eassert (count
<= MAX_ALLOCA
/ word_size
);
2602 objp
= alloca (count
* word_size
);
2605 for (i
= 1; i
< count
; i
++)
2606 objp
[i
] = va_arg (ap
, Lisp_Object
);
2609 for (val
= Qnil
, i
= count
- 1; i
>= 0; i
--)
2611 if (type
== CONSTYPE_PURE
)
2612 val
= pure_cons (objp
[i
], val
);
2613 else if (type
== CONSTYPE_HEAP
)
2614 val
= Fcons (objp
[i
], val
);
2621 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2622 doc
: /* Return a newly created list with specified arguments as elements.
2623 Any number of arguments, even zero arguments, are allowed.
2624 usage: (list &rest OBJECTS) */)
2625 (ptrdiff_t nargs
, Lisp_Object
*args
)
2627 register Lisp_Object val
;
2633 val
= Fcons (args
[nargs
], val
);
2639 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2640 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2641 (register Lisp_Object length
, Lisp_Object init
)
2643 register Lisp_Object val
;
2644 register EMACS_INT size
;
2646 CHECK_NATNUM (length
);
2647 size
= XFASTINT (length
);
2652 val
= Fcons (init
, val
);
2657 val
= Fcons (init
, val
);
2662 val
= Fcons (init
, val
);
2667 val
= Fcons (init
, val
);
2672 val
= Fcons (init
, val
);
2687 /***********************************************************************
2689 ***********************************************************************/
2691 /* Sometimes a vector's contents are merely a pointer internally used
2692 in vector allocation code. Usually you don't want to touch this. */
2694 static struct Lisp_Vector
*
2695 next_vector (struct Lisp_Vector
*v
)
2697 return XUNTAG (v
->contents
[0], 0);
2701 set_next_vector (struct Lisp_Vector
*v
, struct Lisp_Vector
*p
)
2703 v
->contents
[0] = make_lisp_ptr (p
, 0);
2706 /* This value is balanced well enough to avoid too much internal overhead
2707 for the most common cases; it's not required to be a power of two, but
2708 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2710 #define VECTOR_BLOCK_SIZE 4096
2714 /* Alignment of struct Lisp_Vector objects. */
2715 vector_alignment
= COMMON_MULTIPLE (ALIGNOF_STRUCT_LISP_VECTOR
,
2716 USE_LSB_TAG
? GCALIGNMENT
: 1),
2718 /* Vector size requests are a multiple of this. */
2719 roundup_size
= COMMON_MULTIPLE (vector_alignment
, word_size
)
2722 /* Verify assumptions described above. */
2723 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2724 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2726 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at compile time. */
2727 #define vroundup_ct(x) ROUNDUP (x, roundup_size)
2728 /* Round up X to nearest mult-of-ROUNDUP_SIZE --- use at runtime. */
2729 #define vroundup(x) (eassume ((x) >= 0), vroundup_ct (x))
2731 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2733 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup_ct (sizeof (void *)))
2735 /* Size of the minimal vector allocated from block. */
2737 #define VBLOCK_BYTES_MIN vroundup_ct (header_size + sizeof (Lisp_Object))
2739 /* Size of the largest vector allocated from block. */
2741 #define VBLOCK_BYTES_MAX \
2742 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2744 /* We maintain one free list for each possible block-allocated
2745 vector size, and this is the number of free lists we have. */
2747 #define VECTOR_MAX_FREE_LIST_INDEX \
2748 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2750 /* Common shortcut to advance vector pointer over a block data. */
2752 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2754 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2756 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2758 /* Common shortcut to setup vector on a free list. */
2760 #define SETUP_ON_FREE_LIST(v, nbytes, tmp) \
2762 (tmp) = ((nbytes - header_size) / word_size); \
2763 XSETPVECTYPESIZE (v, PVEC_FREE, 0, (tmp)); \
2764 eassert ((nbytes) % roundup_size == 0); \
2765 (tmp) = VINDEX (nbytes); \
2766 eassert ((tmp) < VECTOR_MAX_FREE_LIST_INDEX); \
2767 set_next_vector (v, vector_free_lists[tmp]); \
2768 vector_free_lists[tmp] = (v); \
2769 total_free_vector_slots += (nbytes) / word_size; \
2772 /* This internal type is used to maintain the list of large vectors
2773 which are allocated at their own, e.g. outside of vector blocks.
2775 struct large_vector itself cannot contain a struct Lisp_Vector, as
2776 the latter contains a flexible array member and C99 does not allow
2777 such structs to be nested. Instead, each struct large_vector
2778 object LV is followed by a struct Lisp_Vector, which is at offset
2779 large_vector_offset from LV, and whose address is therefore
2780 large_vector_vec (&LV). */
2784 struct large_vector
*next
;
2789 large_vector_offset
= ROUNDUP (sizeof (struct large_vector
), vector_alignment
)
2792 static struct Lisp_Vector
*
2793 large_vector_vec (struct large_vector
*p
)
2795 return (struct Lisp_Vector
*) ((char *) p
+ large_vector_offset
);
2798 /* This internal type is used to maintain an underlying storage
2799 for small vectors. */
2803 char data
[VECTOR_BLOCK_BYTES
];
2804 struct vector_block
*next
;
2807 /* Chain of vector blocks. */
2809 static struct vector_block
*vector_blocks
;
2811 /* Vector free lists, where NTH item points to a chain of free
2812 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2814 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2816 /* Singly-linked list of large vectors. */
2818 static struct large_vector
*large_vectors
;
2820 /* The only vector with 0 slots, allocated from pure space. */
2822 Lisp_Object zero_vector
;
2824 /* Number of live vectors. */
2826 static EMACS_INT total_vectors
;
2828 /* Total size of live and free vectors, in Lisp_Object units. */
2830 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
2832 /* Get a new vector block. */
2834 static struct vector_block
*
2835 allocate_vector_block (void)
2837 struct vector_block
*block
= xmalloc (sizeof *block
);
2839 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
2840 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
2841 MEM_TYPE_VECTOR_BLOCK
);
2844 block
->next
= vector_blocks
;
2845 vector_blocks
= block
;
2849 /* Called once to initialize vector allocation. */
2854 zero_vector
= make_pure_vector (0);
2857 /* Allocate vector from a vector block. */
2859 static struct Lisp_Vector
*
2860 allocate_vector_from_block (size_t nbytes
)
2862 struct Lisp_Vector
*vector
;
2863 struct vector_block
*block
;
2864 size_t index
, restbytes
;
2866 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
2867 eassert (nbytes
% roundup_size
== 0);
2869 /* First, try to allocate from a free list
2870 containing vectors of the requested size. */
2871 index
= VINDEX (nbytes
);
2872 if (vector_free_lists
[index
])
2874 vector
= vector_free_lists
[index
];
2875 vector_free_lists
[index
] = next_vector (vector
);
2876 total_free_vector_slots
-= nbytes
/ word_size
;
2880 /* Next, check free lists containing larger vectors. Since
2881 we will split the result, we should have remaining space
2882 large enough to use for one-slot vector at least. */
2883 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
2884 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
2885 if (vector_free_lists
[index
])
2887 /* This vector is larger than requested. */
2888 vector
= vector_free_lists
[index
];
2889 vector_free_lists
[index
] = next_vector (vector
);
2890 total_free_vector_slots
-= nbytes
/ word_size
;
2892 /* Excess bytes are used for the smaller vector,
2893 which should be set on an appropriate free list. */
2894 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
2895 eassert (restbytes
% roundup_size
== 0);
2896 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
2900 /* Finally, need a new vector block. */
2901 block
= allocate_vector_block ();
2903 /* New vector will be at the beginning of this block. */
2904 vector
= (struct Lisp_Vector
*) block
->data
;
2906 /* If the rest of space from this block is large enough
2907 for one-slot vector at least, set up it on a free list. */
2908 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
2909 if (restbytes
>= VBLOCK_BYTES_MIN
)
2911 eassert (restbytes
% roundup_size
== 0);
2912 SETUP_ON_FREE_LIST (ADVANCE (vector
, nbytes
), restbytes
, index
);
2917 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
2919 #define VECTOR_IN_BLOCK(vector, block) \
2920 ((char *) (vector) <= (block)->data \
2921 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
2923 /* Return the memory footprint of V in bytes. */
2926 vector_nbytes (struct Lisp_Vector
*v
)
2928 ptrdiff_t size
= v
->header
.size
& ~ARRAY_MARK_FLAG
;
2931 if (size
& PSEUDOVECTOR_FLAG
)
2933 if (PSEUDOVECTOR_TYPEP (&v
->header
, PVEC_BOOL_VECTOR
))
2935 struct Lisp_Bool_Vector
*bv
= (struct Lisp_Bool_Vector
*) v
;
2936 ptrdiff_t word_bytes
= (bool_vector_words (bv
->size
)
2937 * sizeof (bits_word
));
2938 ptrdiff_t boolvec_bytes
= bool_header_size
+ word_bytes
;
2939 verify (header_size
<= bool_header_size
);
2940 nwords
= (boolvec_bytes
- header_size
+ word_size
- 1) / word_size
;
2943 nwords
= ((size
& PSEUDOVECTOR_SIZE_MASK
)
2944 + ((size
& PSEUDOVECTOR_REST_MASK
)
2945 >> PSEUDOVECTOR_SIZE_BITS
));
2949 return vroundup (header_size
+ word_size
* nwords
);
2952 /* Release extra resources still in use by VECTOR, which may be any
2953 vector-like object. For now, this is used just to free data in
2957 cleanup_vector (struct Lisp_Vector
*vector
)
2959 detect_suspicious_free (vector
);
2960 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FONT
)
2961 && ((vector
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
2962 == FONT_OBJECT_MAX
))
2964 /* Attempt to catch subtle bugs like Bug#16140. */
2965 eassert (valid_font_driver (((struct font
*) vector
)->driver
));
2966 ((struct font
*) vector
)->driver
->close ((struct font
*) vector
);
2970 /* Reclaim space used by unmarked vectors. */
2972 NO_INLINE
/* For better stack traces */
2974 sweep_vectors (void)
2976 struct vector_block
*block
, **bprev
= &vector_blocks
;
2977 struct large_vector
*lv
, **lvprev
= &large_vectors
;
2978 struct Lisp_Vector
*vector
, *next
;
2980 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
2981 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
2983 /* Looking through vector blocks. */
2985 for (block
= vector_blocks
; block
; block
= *bprev
)
2987 bool free_this_block
= 0;
2990 for (vector
= (struct Lisp_Vector
*) block
->data
;
2991 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
2993 if (VECTOR_MARKED_P (vector
))
2995 VECTOR_UNMARK (vector
);
2997 nbytes
= vector_nbytes (vector
);
2998 total_vector_slots
+= nbytes
/ word_size
;
2999 next
= ADVANCE (vector
, nbytes
);
3003 ptrdiff_t total_bytes
;
3005 cleanup_vector (vector
);
3006 nbytes
= vector_nbytes (vector
);
3007 total_bytes
= nbytes
;
3008 next
= ADVANCE (vector
, nbytes
);
3010 /* While NEXT is not marked, try to coalesce with VECTOR,
3011 thus making VECTOR of the largest possible size. */
3013 while (VECTOR_IN_BLOCK (next
, block
))
3015 if (VECTOR_MARKED_P (next
))
3017 cleanup_vector (next
);
3018 nbytes
= vector_nbytes (next
);
3019 total_bytes
+= nbytes
;
3020 next
= ADVANCE (next
, nbytes
);
3023 eassert (total_bytes
% roundup_size
== 0);
3025 if (vector
== (struct Lisp_Vector
*) block
->data
3026 && !VECTOR_IN_BLOCK (next
, block
))
3027 /* This block should be freed because all of its
3028 space was coalesced into the only free vector. */
3029 free_this_block
= 1;
3033 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
3038 if (free_this_block
)
3040 *bprev
= block
->next
;
3041 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
3042 mem_delete (mem_find (block
->data
));
3047 bprev
= &block
->next
;
3050 /* Sweep large vectors. */
3052 for (lv
= large_vectors
; lv
; lv
= *lvprev
)
3054 vector
= large_vector_vec (lv
);
3055 if (VECTOR_MARKED_P (vector
))
3057 VECTOR_UNMARK (vector
);
3059 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
3061 /* All non-bool pseudovectors are small enough to be allocated
3062 from vector blocks. This code should be redesigned if some
3063 pseudovector type grows beyond VBLOCK_BYTES_MAX. */
3064 eassert (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_BOOL_VECTOR
));
3065 total_vector_slots
+= vector_nbytes (vector
) / word_size
;
3069 += header_size
/ word_size
+ vector
->header
.size
;
3080 /* Value is a pointer to a newly allocated Lisp_Vector structure
3081 with room for LEN Lisp_Objects. */
3083 static struct Lisp_Vector
*
3084 allocate_vectorlike (ptrdiff_t len
)
3086 struct Lisp_Vector
*p
;
3091 p
= XVECTOR (zero_vector
);
3094 size_t nbytes
= header_size
+ len
* word_size
;
3096 #ifdef DOUG_LEA_MALLOC
3097 if (!mmap_lisp_allowed_p ())
3098 mallopt (M_MMAP_MAX
, 0);
3101 if (nbytes
<= VBLOCK_BYTES_MAX
)
3102 p
= allocate_vector_from_block (vroundup (nbytes
));
3105 struct large_vector
*lv
3106 = lisp_malloc ((large_vector_offset
+ header_size
3108 MEM_TYPE_VECTORLIKE
);
3109 lv
->next
= large_vectors
;
3111 p
= large_vector_vec (lv
);
3114 #ifdef DOUG_LEA_MALLOC
3115 if (!mmap_lisp_allowed_p ())
3116 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3119 if (find_suspicious_object_in_range (p
, (char*)p
+ nbytes
))
3122 consing_since_gc
+= nbytes
;
3123 vector_cells_consed
+= len
;
3126 MALLOC_UNBLOCK_INPUT
;
3132 /* Allocate a vector with LEN slots. */
3134 struct Lisp_Vector
*
3135 allocate_vector (EMACS_INT len
)
3137 struct Lisp_Vector
*v
;
3138 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3140 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3141 memory_full (SIZE_MAX
);
3142 v
= allocate_vectorlike (len
);
3143 v
->header
.size
= len
;
3148 /* Allocate other vector-like structures. */
3150 struct Lisp_Vector
*
3151 allocate_pseudovector (int memlen
, int lisplen
, enum pvec_type tag
)
3153 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3156 /* Catch bogus values. */
3157 eassert (tag
<= PVEC_FONT
);
3158 eassert (memlen
- lisplen
<= (1 << PSEUDOVECTOR_REST_BITS
) - 1);
3159 eassert (lisplen
<= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1);
3161 /* Only the first lisplen slots will be traced normally by the GC. */
3162 for (i
= 0; i
< lisplen
; ++i
)
3163 v
->contents
[i
] = Qnil
;
3165 XSETPVECTYPESIZE (v
, tag
, lisplen
, memlen
- lisplen
);
3170 allocate_buffer (void)
3172 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3174 BUFFER_PVEC_INIT (b
);
3175 /* Put B on the chain of all buffers including killed ones. */
3176 b
->next
= all_buffers
;
3178 /* Note that the rest fields of B are not initialized. */
3182 struct Lisp_Hash_Table
*
3183 allocate_hash_table (void)
3185 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
3189 allocate_window (void)
3193 w
= ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
3194 /* Users assumes that non-Lisp data is zeroed. */
3195 memset (&w
->current_matrix
, 0,
3196 sizeof (*w
) - offsetof (struct window
, current_matrix
));
3201 allocate_terminal (void)
3205 t
= ALLOCATE_PSEUDOVECTOR (struct terminal
, next_terminal
, PVEC_TERMINAL
);
3206 /* Users assumes that non-Lisp data is zeroed. */
3207 memset (&t
->next_terminal
, 0,
3208 sizeof (*t
) - offsetof (struct terminal
, next_terminal
));
3213 allocate_frame (void)
3217 f
= ALLOCATE_PSEUDOVECTOR (struct frame
, face_cache
, PVEC_FRAME
);
3218 /* Users assumes that non-Lisp data is zeroed. */
3219 memset (&f
->face_cache
, 0,
3220 sizeof (*f
) - offsetof (struct frame
, face_cache
));
3224 struct Lisp_Process
*
3225 allocate_process (void)
3227 struct Lisp_Process
*p
;
3229 p
= ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3230 /* Users assumes that non-Lisp data is zeroed. */
3232 sizeof (*p
) - offsetof (struct Lisp_Process
, pid
));
3236 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3237 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3238 See also the function `vector'. */)
3239 (register Lisp_Object length
, Lisp_Object init
)
3242 register ptrdiff_t sizei
;
3243 register ptrdiff_t i
;
3244 register struct Lisp_Vector
*p
;
3246 CHECK_NATNUM (length
);
3248 p
= allocate_vector (XFASTINT (length
));
3249 sizei
= XFASTINT (length
);
3250 for (i
= 0; i
< sizei
; i
++)
3251 p
->contents
[i
] = init
;
3253 XSETVECTOR (vector
, p
);
3258 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3259 doc
: /* Return a newly created vector with specified arguments as elements.
3260 Any number of arguments, even zero arguments, are allowed.
3261 usage: (vector &rest OBJECTS) */)
3262 (ptrdiff_t nargs
, Lisp_Object
*args
)
3265 register Lisp_Object val
= make_uninit_vector (nargs
);
3266 register struct Lisp_Vector
*p
= XVECTOR (val
);
3268 for (i
= 0; i
< nargs
; i
++)
3269 p
->contents
[i
] = args
[i
];
3274 make_byte_code (struct Lisp_Vector
*v
)
3276 /* Don't allow the global zero_vector to become a byte code object. */
3277 eassert (0 < v
->header
.size
);
3279 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3280 && STRING_MULTIBYTE (v
->contents
[1]))
3281 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3282 earlier because they produced a raw 8-bit string for byte-code
3283 and now such a byte-code string is loaded as multibyte while
3284 raw 8-bit characters converted to multibyte form. Thus, now we
3285 must convert them back to the original unibyte form. */
3286 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3287 XSETPVECTYPE (v
, PVEC_COMPILED
);
3290 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3291 doc
: /* Create a byte-code object with specified arguments as elements.
3292 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3293 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3294 and (optional) INTERACTIVE-SPEC.
3295 The first four arguments are required; at most six have any
3297 The ARGLIST can be either like the one of `lambda', in which case the arguments
3298 will be dynamically bound before executing the byte code, or it can be an
3299 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3300 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3301 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3302 argument to catch the left-over arguments. If such an integer is used, the
3303 arguments will not be dynamically bound but will be instead pushed on the
3304 stack before executing the byte-code.
3305 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3306 (ptrdiff_t nargs
, Lisp_Object
*args
)
3309 register Lisp_Object val
= make_uninit_vector (nargs
);
3310 register struct Lisp_Vector
*p
= XVECTOR (val
);
3312 /* We used to purecopy everything here, if purify-flag was set. This worked
3313 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3314 dangerous, since make-byte-code is used during execution to build
3315 closures, so any closure built during the preload phase would end up
3316 copied into pure space, including its free variables, which is sometimes
3317 just wasteful and other times plainly wrong (e.g. those free vars may want
3320 for (i
= 0; i
< nargs
; i
++)
3321 p
->contents
[i
] = args
[i
];
3323 XSETCOMPILED (val
, p
);
3329 /***********************************************************************
3331 ***********************************************************************/
3333 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3334 of the required alignment if LSB tags are used. */
3336 union aligned_Lisp_Symbol
3338 struct Lisp_Symbol s
;
3340 unsigned char c
[(sizeof (struct Lisp_Symbol
) + GCALIGNMENT
- 1)
3345 /* Each symbol_block is just under 1020 bytes long, since malloc
3346 really allocates in units of powers of two and uses 4 bytes for its
3349 #define SYMBOL_BLOCK_SIZE \
3350 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3354 /* Place `symbols' first, to preserve alignment. */
3355 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3356 struct symbol_block
*next
;
3359 /* Current symbol block and index of first unused Lisp_Symbol
3362 static struct symbol_block
*symbol_block
;
3363 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3365 /* List of free symbols. */
3367 static struct Lisp_Symbol
*symbol_free_list
;
3370 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
3372 XSYMBOL (sym
)->name
= name
;
3375 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3376 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3377 Its value is void, and its function definition and property list are nil. */)
3380 register Lisp_Object val
;
3381 register struct Lisp_Symbol
*p
;
3383 CHECK_STRING (name
);
3387 if (symbol_free_list
)
3389 XSETSYMBOL (val
, symbol_free_list
);
3390 symbol_free_list
= symbol_free_list
->next
;
3394 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3396 struct symbol_block
*new
3397 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3398 new->next
= symbol_block
;
3400 symbol_block_index
= 0;
3401 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3403 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3404 symbol_block_index
++;
3407 MALLOC_UNBLOCK_INPUT
;
3410 set_symbol_name (val
, name
);
3411 set_symbol_plist (val
, Qnil
);
3412 p
->redirect
= SYMBOL_PLAINVAL
;
3413 SET_SYMBOL_VAL (p
, Qunbound
);
3414 set_symbol_function (val
, Qnil
);
3415 set_symbol_next (val
, NULL
);
3417 p
->interned
= SYMBOL_UNINTERNED
;
3419 p
->declared_special
= 0;
3420 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3422 total_free_symbols
--;
3428 /***********************************************************************
3429 Marker (Misc) Allocation
3430 ***********************************************************************/
3432 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3433 the required alignment when LSB tags are used. */
3435 union aligned_Lisp_Misc
3439 unsigned char c
[(sizeof (union Lisp_Misc
) + GCALIGNMENT
- 1)
3444 /* Allocation of markers and other objects that share that structure.
3445 Works like allocation of conses. */
3447 #define MARKER_BLOCK_SIZE \
3448 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3452 /* Place `markers' first, to preserve alignment. */
3453 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3454 struct marker_block
*next
;
3457 static struct marker_block
*marker_block
;
3458 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3460 static union Lisp_Misc
*marker_free_list
;
3462 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3465 allocate_misc (enum Lisp_Misc_Type type
)
3471 if (marker_free_list
)
3473 XSETMISC (val
, marker_free_list
);
3474 marker_free_list
= marker_free_list
->u_free
.chain
;
3478 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3480 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3481 new->next
= marker_block
;
3483 marker_block_index
= 0;
3484 total_free_markers
+= MARKER_BLOCK_SIZE
;
3486 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3487 marker_block_index
++;
3490 MALLOC_UNBLOCK_INPUT
;
3492 --total_free_markers
;
3493 consing_since_gc
+= sizeof (union Lisp_Misc
);
3494 misc_objects_consed
++;
3495 XMISCANY (val
)->type
= type
;
3496 XMISCANY (val
)->gcmarkbit
= 0;
3500 /* Free a Lisp_Misc object. */
3503 free_misc (Lisp_Object misc
)
3505 XMISCANY (misc
)->type
= Lisp_Misc_Free
;
3506 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3507 marker_free_list
= XMISC (misc
);
3508 consing_since_gc
-= sizeof (union Lisp_Misc
);
3509 total_free_markers
++;
3512 /* Verify properties of Lisp_Save_Value's representation
3513 that are assumed here and elsewhere. */
3515 verify (SAVE_UNUSED
== 0);
3516 verify (((SAVE_INTEGER
| SAVE_POINTER
| SAVE_FUNCPOINTER
| SAVE_OBJECT
)
3520 /* Return Lisp_Save_Value objects for the various combinations
3521 that callers need. */
3524 make_save_int_int_int (ptrdiff_t a
, ptrdiff_t b
, ptrdiff_t c
)
3526 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3527 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3528 p
->save_type
= SAVE_TYPE_INT_INT_INT
;
3529 p
->data
[0].integer
= a
;
3530 p
->data
[1].integer
= b
;
3531 p
->data
[2].integer
= c
;
3536 make_save_obj_obj_obj_obj (Lisp_Object a
, Lisp_Object b
, Lisp_Object c
,
3539 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3540 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3541 p
->save_type
= SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
;
3542 p
->data
[0].object
= a
;
3543 p
->data
[1].object
= b
;
3544 p
->data
[2].object
= c
;
3545 p
->data
[3].object
= d
;
3550 make_save_ptr (void *a
)
3552 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3553 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3554 p
->save_type
= SAVE_POINTER
;
3555 p
->data
[0].pointer
= a
;
3560 make_save_ptr_int (void *a
, ptrdiff_t b
)
3562 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3563 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3564 p
->save_type
= SAVE_TYPE_PTR_INT
;
3565 p
->data
[0].pointer
= a
;
3566 p
->data
[1].integer
= b
;
3570 #if ! (defined USE_X_TOOLKIT || defined USE_GTK)
3572 make_save_ptr_ptr (void *a
, void *b
)
3574 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3575 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3576 p
->save_type
= SAVE_TYPE_PTR_PTR
;
3577 p
->data
[0].pointer
= a
;
3578 p
->data
[1].pointer
= b
;
3584 make_save_funcptr_ptr_obj (void (*a
) (void), void *b
, Lisp_Object c
)
3586 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3587 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3588 p
->save_type
= SAVE_TYPE_FUNCPTR_PTR_OBJ
;
3589 p
->data
[0].funcpointer
= a
;
3590 p
->data
[1].pointer
= b
;
3591 p
->data
[2].object
= c
;
3595 /* Return a Lisp_Save_Value object that represents an array A
3596 of N Lisp objects. */
3599 make_save_memory (Lisp_Object
*a
, ptrdiff_t n
)
3601 Lisp_Object val
= allocate_misc (Lisp_Misc_Save_Value
);
3602 struct Lisp_Save_Value
*p
= XSAVE_VALUE (val
);
3603 p
->save_type
= SAVE_TYPE_MEMORY
;
3604 p
->data
[0].pointer
= a
;
3605 p
->data
[1].integer
= n
;
3609 /* Free a Lisp_Save_Value object. Do not use this function
3610 if SAVE contains pointer other than returned by xmalloc. */
3613 free_save_value (Lisp_Object save
)
3615 xfree (XSAVE_POINTER (save
, 0));
3619 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3622 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3624 register Lisp_Object overlay
;
3626 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3627 OVERLAY_START (overlay
) = start
;
3628 OVERLAY_END (overlay
) = end
;
3629 set_overlay_plist (overlay
, plist
);
3630 XOVERLAY (overlay
)->next
= NULL
;
3634 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3635 doc
: /* Return a newly allocated marker which does not point at any place. */)
3638 register Lisp_Object val
;
3639 register struct Lisp_Marker
*p
;
3641 val
= allocate_misc (Lisp_Misc_Marker
);
3647 p
->insertion_type
= 0;
3648 p
->need_adjustment
= 0;
3652 /* Return a newly allocated marker which points into BUF
3653 at character position CHARPOS and byte position BYTEPOS. */
3656 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3659 struct Lisp_Marker
*m
;
3661 /* No dead buffers here. */
3662 eassert (BUFFER_LIVE_P (buf
));
3664 /* Every character is at least one byte. */
3665 eassert (charpos
<= bytepos
);
3667 obj
= allocate_misc (Lisp_Misc_Marker
);
3670 m
->charpos
= charpos
;
3671 m
->bytepos
= bytepos
;
3672 m
->insertion_type
= 0;
3673 m
->need_adjustment
= 0;
3674 m
->next
= BUF_MARKERS (buf
);
3675 BUF_MARKERS (buf
) = m
;
3679 /* Put MARKER back on the free list after using it temporarily. */
3682 free_marker (Lisp_Object marker
)
3684 unchain_marker (XMARKER (marker
));
3689 /* Return a newly created vector or string with specified arguments as
3690 elements. If all the arguments are characters that can fit
3691 in a string of events, make a string; otherwise, make a vector.
3693 Any number of arguments, even zero arguments, are allowed. */
3696 make_event_array (ptrdiff_t nargs
, Lisp_Object
*args
)
3700 for (i
= 0; i
< nargs
; i
++)
3701 /* The things that fit in a string
3702 are characters that are in 0...127,
3703 after discarding the meta bit and all the bits above it. */
3704 if (!INTEGERP (args
[i
])
3705 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3706 return Fvector (nargs
, args
);
3708 /* Since the loop exited, we know that all the things in it are
3709 characters, so we can make a string. */
3713 result
= Fmake_string (make_number (nargs
), make_number (0));
3714 for (i
= 0; i
< nargs
; i
++)
3716 SSET (result
, i
, XINT (args
[i
]));
3717 /* Move the meta bit to the right place for a string char. */
3718 if (XINT (args
[i
]) & CHAR_META
)
3719 SSET (result
, i
, SREF (result
, i
) | 0x80);
3728 /************************************************************************
3729 Memory Full Handling
3730 ************************************************************************/
3733 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3734 there may have been size_t overflow so that malloc was never
3735 called, or perhaps malloc was invoked successfully but the
3736 resulting pointer had problems fitting into a tagged EMACS_INT. In
3737 either case this counts as memory being full even though malloc did
3741 memory_full (size_t nbytes
)
3743 /* Do not go into hysterics merely because a large request failed. */
3744 bool enough_free_memory
= 0;
3745 if (SPARE_MEMORY
< nbytes
)
3750 p
= malloc (SPARE_MEMORY
);
3754 enough_free_memory
= 1;
3756 MALLOC_UNBLOCK_INPUT
;
3759 if (! enough_free_memory
)
3765 memory_full_cons_threshold
= sizeof (struct cons_block
);
3767 /* The first time we get here, free the spare memory. */
3768 for (i
= 0; i
< sizeof (spare_memory
) / sizeof (char *); i
++)
3769 if (spare_memory
[i
])
3772 free (spare_memory
[i
]);
3773 else if (i
>= 1 && i
<= 4)
3774 lisp_align_free (spare_memory
[i
]);
3776 lisp_free (spare_memory
[i
]);
3777 spare_memory
[i
] = 0;
3781 /* This used to call error, but if we've run out of memory, we could
3782 get infinite recursion trying to build the string. */
3783 xsignal (Qnil
, Vmemory_signal_data
);
3786 /* If we released our reserve (due to running out of memory),
3787 and we have a fair amount free once again,
3788 try to set aside another reserve in case we run out once more.
3790 This is called when a relocatable block is freed in ralloc.c,
3791 and also directly from this file, in case we're not using ralloc.c. */
3794 refill_memory_reserve (void)
3796 #ifndef SYSTEM_MALLOC
3797 if (spare_memory
[0] == 0)
3798 spare_memory
[0] = malloc (SPARE_MEMORY
);
3799 if (spare_memory
[1] == 0)
3800 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
3802 if (spare_memory
[2] == 0)
3803 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
3805 if (spare_memory
[3] == 0)
3806 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
3808 if (spare_memory
[4] == 0)
3809 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
3811 if (spare_memory
[5] == 0)
3812 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
3814 if (spare_memory
[6] == 0)
3815 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
3817 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3818 Vmemory_full
= Qnil
;
3823 /************************************************************************
3825 ************************************************************************/
3827 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3829 /* Conservative C stack marking requires a method to identify possibly
3830 live Lisp objects given a pointer value. We do this by keeping
3831 track of blocks of Lisp data that are allocated in a red-black tree
3832 (see also the comment of mem_node which is the type of nodes in
3833 that tree). Function lisp_malloc adds information for an allocated
3834 block to the red-black tree with calls to mem_insert, and function
3835 lisp_free removes it with mem_delete. Functions live_string_p etc
3836 call mem_find to lookup information about a given pointer in the
3837 tree, and use that to determine if the pointer points to a Lisp
3840 /* Initialize this part of alloc.c. */
3845 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3846 mem_z
.parent
= NULL
;
3847 mem_z
.color
= MEM_BLACK
;
3848 mem_z
.start
= mem_z
.end
= NULL
;
3853 /* Value is a pointer to the mem_node containing START. Value is
3854 MEM_NIL if there is no node in the tree containing START. */
3856 static struct mem_node
*
3857 mem_find (void *start
)
3861 if (start
< min_heap_address
|| start
> max_heap_address
)
3864 /* Make the search always successful to speed up the loop below. */
3865 mem_z
.start
= start
;
3866 mem_z
.end
= (char *) start
+ 1;
3869 while (start
< p
->start
|| start
>= p
->end
)
3870 p
= start
< p
->start
? p
->left
: p
->right
;
3875 /* Insert a new node into the tree for a block of memory with start
3876 address START, end address END, and type TYPE. Value is a
3877 pointer to the node that was inserted. */
3879 static struct mem_node
*
3880 mem_insert (void *start
, void *end
, enum mem_type type
)
3882 struct mem_node
*c
, *parent
, *x
;
3884 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3885 min_heap_address
= start
;
3886 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3887 max_heap_address
= end
;
3889 /* See where in the tree a node for START belongs. In this
3890 particular application, it shouldn't happen that a node is already
3891 present. For debugging purposes, let's check that. */
3895 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3897 while (c
!= MEM_NIL
)
3899 if (start
>= c
->start
&& start
< c
->end
)
3902 c
= start
< c
->start
? c
->left
: c
->right
;
3905 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3907 while (c
!= MEM_NIL
)
3910 c
= start
< c
->start
? c
->left
: c
->right
;
3913 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3915 /* Create a new node. */
3916 #ifdef GC_MALLOC_CHECK
3917 x
= malloc (sizeof *x
);
3921 x
= xmalloc (sizeof *x
);
3927 x
->left
= x
->right
= MEM_NIL
;
3930 /* Insert it as child of PARENT or install it as root. */
3933 if (start
< parent
->start
)
3941 /* Re-establish red-black tree properties. */
3942 mem_insert_fixup (x
);
3948 /* Re-establish the red-black properties of the tree, and thereby
3949 balance the tree, after node X has been inserted; X is always red. */
3952 mem_insert_fixup (struct mem_node
*x
)
3954 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3956 /* X is red and its parent is red. This is a violation of
3957 red-black tree property #3. */
3959 if (x
->parent
== x
->parent
->parent
->left
)
3961 /* We're on the left side of our grandparent, and Y is our
3963 struct mem_node
*y
= x
->parent
->parent
->right
;
3965 if (y
->color
== MEM_RED
)
3967 /* Uncle and parent are red but should be black because
3968 X is red. Change the colors accordingly and proceed
3969 with the grandparent. */
3970 x
->parent
->color
= MEM_BLACK
;
3971 y
->color
= MEM_BLACK
;
3972 x
->parent
->parent
->color
= MEM_RED
;
3973 x
= x
->parent
->parent
;
3977 /* Parent and uncle have different colors; parent is
3978 red, uncle is black. */
3979 if (x
== x
->parent
->right
)
3982 mem_rotate_left (x
);
3985 x
->parent
->color
= MEM_BLACK
;
3986 x
->parent
->parent
->color
= MEM_RED
;
3987 mem_rotate_right (x
->parent
->parent
);
3992 /* This is the symmetrical case of above. */
3993 struct mem_node
*y
= x
->parent
->parent
->left
;
3995 if (y
->color
== MEM_RED
)
3997 x
->parent
->color
= MEM_BLACK
;
3998 y
->color
= MEM_BLACK
;
3999 x
->parent
->parent
->color
= MEM_RED
;
4000 x
= x
->parent
->parent
;
4004 if (x
== x
->parent
->left
)
4007 mem_rotate_right (x
);
4010 x
->parent
->color
= MEM_BLACK
;
4011 x
->parent
->parent
->color
= MEM_RED
;
4012 mem_rotate_left (x
->parent
->parent
);
4017 /* The root may have been changed to red due to the algorithm. Set
4018 it to black so that property #5 is satisfied. */
4019 mem_root
->color
= MEM_BLACK
;
4030 mem_rotate_left (struct mem_node
*x
)
4034 /* Turn y's left sub-tree into x's right sub-tree. */
4037 if (y
->left
!= MEM_NIL
)
4038 y
->left
->parent
= x
;
4040 /* Y's parent was x's parent. */
4042 y
->parent
= x
->parent
;
4044 /* Get the parent to point to y instead of x. */
4047 if (x
== x
->parent
->left
)
4048 x
->parent
->left
= y
;
4050 x
->parent
->right
= y
;
4055 /* Put x on y's left. */
4069 mem_rotate_right (struct mem_node
*x
)
4071 struct mem_node
*y
= x
->left
;
4074 if (y
->right
!= MEM_NIL
)
4075 y
->right
->parent
= x
;
4078 y
->parent
= x
->parent
;
4081 if (x
== x
->parent
->right
)
4082 x
->parent
->right
= y
;
4084 x
->parent
->left
= y
;
4095 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4098 mem_delete (struct mem_node
*z
)
4100 struct mem_node
*x
, *y
;
4102 if (!z
|| z
== MEM_NIL
)
4105 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4110 while (y
->left
!= MEM_NIL
)
4114 if (y
->left
!= MEM_NIL
)
4119 x
->parent
= y
->parent
;
4122 if (y
== y
->parent
->left
)
4123 y
->parent
->left
= x
;
4125 y
->parent
->right
= x
;
4132 z
->start
= y
->start
;
4137 if (y
->color
== MEM_BLACK
)
4138 mem_delete_fixup (x
);
4140 #ifdef GC_MALLOC_CHECK
4148 /* Re-establish the red-black properties of the tree, after a
4152 mem_delete_fixup (struct mem_node
*x
)
4154 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4156 if (x
== x
->parent
->left
)
4158 struct mem_node
*w
= x
->parent
->right
;
4160 if (w
->color
== MEM_RED
)
4162 w
->color
= MEM_BLACK
;
4163 x
->parent
->color
= MEM_RED
;
4164 mem_rotate_left (x
->parent
);
4165 w
= x
->parent
->right
;
4168 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4175 if (w
->right
->color
== MEM_BLACK
)
4177 w
->left
->color
= MEM_BLACK
;
4179 mem_rotate_right (w
);
4180 w
= x
->parent
->right
;
4182 w
->color
= x
->parent
->color
;
4183 x
->parent
->color
= MEM_BLACK
;
4184 w
->right
->color
= MEM_BLACK
;
4185 mem_rotate_left (x
->parent
);
4191 struct mem_node
*w
= x
->parent
->left
;
4193 if (w
->color
== MEM_RED
)
4195 w
->color
= MEM_BLACK
;
4196 x
->parent
->color
= MEM_RED
;
4197 mem_rotate_right (x
->parent
);
4198 w
= x
->parent
->left
;
4201 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4208 if (w
->left
->color
== MEM_BLACK
)
4210 w
->right
->color
= MEM_BLACK
;
4212 mem_rotate_left (w
);
4213 w
= x
->parent
->left
;
4216 w
->color
= x
->parent
->color
;
4217 x
->parent
->color
= MEM_BLACK
;
4218 w
->left
->color
= MEM_BLACK
;
4219 mem_rotate_right (x
->parent
);
4225 x
->color
= MEM_BLACK
;
4229 /* Value is non-zero if P is a pointer to a live Lisp string on
4230 the heap. M is a pointer to the mem_block for P. */
4233 live_string_p (struct mem_node
*m
, void *p
)
4235 if (m
->type
== MEM_TYPE_STRING
)
4237 struct string_block
*b
= m
->start
;
4238 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4240 /* P must point to the start of a Lisp_String structure, and it
4241 must not be on the free-list. */
4243 && offset
% sizeof b
->strings
[0] == 0
4244 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4245 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4252 /* Value is non-zero if P is a pointer to a live Lisp cons on
4253 the heap. M is a pointer to the mem_block for P. */
4256 live_cons_p (struct mem_node
*m
, void *p
)
4258 if (m
->type
== MEM_TYPE_CONS
)
4260 struct cons_block
*b
= m
->start
;
4261 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4263 /* P must point to the start of a Lisp_Cons, not be
4264 one of the unused cells in the current cons block,
4265 and not be on the free-list. */
4267 && offset
% sizeof b
->conses
[0] == 0
4268 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4270 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4271 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
4278 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4279 the heap. M is a pointer to the mem_block for P. */
4282 live_symbol_p (struct mem_node
*m
, void *p
)
4284 if (m
->type
== MEM_TYPE_SYMBOL
)
4286 struct symbol_block
*b
= m
->start
;
4287 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4289 /* P must point to the start of a Lisp_Symbol, not be
4290 one of the unused cells in the current symbol block,
4291 and not be on the free-list. */
4293 && offset
% sizeof b
->symbols
[0] == 0
4294 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4295 && (b
!= symbol_block
4296 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4297 && !EQ (((struct Lisp_Symbol
*)p
)->function
, Vdead
));
4304 /* Value is non-zero if P is a pointer to a live Lisp float on
4305 the heap. M is a pointer to the mem_block for P. */
4308 live_float_p (struct mem_node
*m
, void *p
)
4310 if (m
->type
== MEM_TYPE_FLOAT
)
4312 struct float_block
*b
= m
->start
;
4313 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4315 /* P must point to the start of a Lisp_Float and not be
4316 one of the unused cells in the current float block. */
4318 && offset
% sizeof b
->floats
[0] == 0
4319 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4320 && (b
!= float_block
4321 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4328 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4329 the heap. M is a pointer to the mem_block for P. */
4332 live_misc_p (struct mem_node
*m
, void *p
)
4334 if (m
->type
== MEM_TYPE_MISC
)
4336 struct marker_block
*b
= m
->start
;
4337 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4339 /* P must point to the start of a Lisp_Misc, not be
4340 one of the unused cells in the current misc block,
4341 and not be on the free-list. */
4343 && offset
% sizeof b
->markers
[0] == 0
4344 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4345 && (b
!= marker_block
4346 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4347 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4354 /* Value is non-zero if P is a pointer to a live vector-like object.
4355 M is a pointer to the mem_block for P. */
4358 live_vector_p (struct mem_node
*m
, void *p
)
4360 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4362 /* This memory node corresponds to a vector block. */
4363 struct vector_block
*block
= m
->start
;
4364 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4366 /* P is in the block's allocation range. Scan the block
4367 up to P and see whether P points to the start of some
4368 vector which is not on a free list. FIXME: check whether
4369 some allocation patterns (probably a lot of short vectors)
4370 may cause a substantial overhead of this loop. */
4371 while (VECTOR_IN_BLOCK (vector
, block
)
4372 && vector
<= (struct Lisp_Vector
*) p
)
4374 if (!PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
) && vector
== p
)
4377 vector
= ADVANCE (vector
, vector_nbytes (vector
));
4380 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== large_vector_vec (m
->start
))
4381 /* This memory node corresponds to a large vector. */
4387 /* Value is non-zero if P is a pointer to a live buffer. M is a
4388 pointer to the mem_block for P. */
4391 live_buffer_p (struct mem_node
*m
, void *p
)
4393 /* P must point to the start of the block, and the buffer
4394 must not have been killed. */
4395 return (m
->type
== MEM_TYPE_BUFFER
4397 && !NILP (((struct buffer
*) p
)->INTERNAL_FIELD (name
)));
4400 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4404 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4406 /* Currently not used, but may be called from gdb. */
4408 void dump_zombies (void) EXTERNALLY_VISIBLE
;
4410 /* Array of objects that are kept alive because the C stack contains
4411 a pattern that looks like a reference to them. */
4413 #define MAX_ZOMBIES 10
4414 static Lisp_Object zombies
[MAX_ZOMBIES
];
4416 /* Number of zombie objects. */
4418 static EMACS_INT nzombies
;
4420 /* Number of garbage collections. */
4422 static EMACS_INT ngcs
;
4424 /* Average percentage of zombies per collection. */
4426 static double avg_zombies
;
4428 /* Max. number of live and zombie objects. */
4430 static EMACS_INT max_live
, max_zombies
;
4432 /* Average number of live objects per GC. */
4434 static double avg_live
;
4436 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4437 doc
: /* Show information about live and zombie objects. */)
4440 Lisp_Object args
[8], zombie_list
= Qnil
;
4442 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); i
++)
4443 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4444 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4445 args
[1] = make_number (ngcs
);
4446 args
[2] = make_float (avg_live
);
4447 args
[3] = make_float (avg_zombies
);
4448 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4449 args
[5] = make_number (max_live
);
4450 args
[6] = make_number (max_zombies
);
4451 args
[7] = zombie_list
;
4452 return Fmessage (8, args
);
4455 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4458 /* Mark OBJ if we can prove it's a Lisp_Object. */
4461 mark_maybe_object (Lisp_Object obj
)
4468 VALGRIND_MAKE_MEM_DEFINED (&obj
, sizeof (obj
));
4474 po
= (void *) XPNTR (obj
);
4481 switch (XTYPE (obj
))
4484 mark_p
= (live_string_p (m
, po
)
4485 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4489 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4493 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4497 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4500 case Lisp_Vectorlike
:
4501 /* Note: can't check BUFFERP before we know it's a
4502 buffer because checking that dereferences the pointer
4503 PO which might point anywhere. */
4504 if (live_vector_p (m
, po
))
4505 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4506 else if (live_buffer_p (m
, po
))
4507 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4511 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4520 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4521 if (nzombies
< MAX_ZOMBIES
)
4522 zombies
[nzombies
] = obj
;
4531 /* If P points to Lisp data, mark that as live if it isn't already
4535 mark_maybe_pointer (void *p
)
4541 VALGRIND_MAKE_MEM_DEFINED (&p
, sizeof (p
));
4544 /* Quickly rule out some values which can't point to Lisp data.
4545 USE_LSB_TAG needs Lisp data to be aligned on multiples of GCALIGNMENT.
4546 Otherwise, assume that Lisp data is aligned on even addresses. */
4547 if ((intptr_t) p
% (USE_LSB_TAG
? GCALIGNMENT
: 2))
4553 Lisp_Object obj
= Qnil
;
4557 case MEM_TYPE_NON_LISP
:
4558 case MEM_TYPE_SPARE
:
4559 /* Nothing to do; not a pointer to Lisp memory. */
4562 case MEM_TYPE_BUFFER
:
4563 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4564 XSETVECTOR (obj
, p
);
4568 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4572 case MEM_TYPE_STRING
:
4573 if (live_string_p (m
, p
)
4574 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4575 XSETSTRING (obj
, p
);
4579 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4583 case MEM_TYPE_SYMBOL
:
4584 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4585 XSETSYMBOL (obj
, p
);
4588 case MEM_TYPE_FLOAT
:
4589 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4593 case MEM_TYPE_VECTORLIKE
:
4594 case MEM_TYPE_VECTOR_BLOCK
:
4595 if (live_vector_p (m
, p
))
4598 XSETVECTOR (tem
, p
);
4599 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4614 /* Alignment of pointer values. Use alignof, as it sometimes returns
4615 a smaller alignment than GCC's __alignof__ and mark_memory might
4616 miss objects if __alignof__ were used. */
4617 #define GC_POINTER_ALIGNMENT alignof (void *)
4619 /* Define POINTERS_MIGHT_HIDE_IN_OBJECTS to 1 if marking via C pointers does
4620 not suffice, which is the typical case. A host where a Lisp_Object is
4621 wider than a pointer might allocate a Lisp_Object in non-adjacent halves.
4622 If USE_LSB_TAG, the bottom half is not a valid pointer, but it should
4623 suffice to widen it to to a Lisp_Object and check it that way. */
4624 #if USE_LSB_TAG || VAL_MAX < UINTPTR_MAX
4625 # if !USE_LSB_TAG && VAL_MAX < UINTPTR_MAX >> GCTYPEBITS
4626 /* If tag bits straddle pointer-word boundaries, neither mark_maybe_pointer
4627 nor mark_maybe_object can follow the pointers. This should not occur on
4628 any practical porting target. */
4629 # error "MSB type bits straddle pointer-word boundaries"
4631 /* Marking via C pointers does not suffice, because Lisp_Objects contain
4632 pointer words that hold pointers ORed with type bits. */
4633 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 1
4635 /* Marking via C pointers suffices, because Lisp_Objects contain pointer
4636 words that hold unmodified pointers. */
4637 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 0
4640 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4641 or END+OFFSET..START. */
4643 static void ATTRIBUTE_NO_SANITIZE_ADDRESS
4644 mark_memory (void *start
, void *end
)
4649 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4653 /* Make START the pointer to the start of the memory region,
4654 if it isn't already. */
4662 /* Mark Lisp data pointed to. This is necessary because, in some
4663 situations, the C compiler optimizes Lisp objects away, so that
4664 only a pointer to them remains. Example:
4666 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4669 Lisp_Object obj = build_string ("test");
4670 struct Lisp_String *s = XSTRING (obj);
4671 Fgarbage_collect ();
4672 fprintf (stderr, "test `%s'\n", s->data);
4676 Here, `obj' isn't really used, and the compiler optimizes it
4677 away. The only reference to the life string is through the
4680 for (pp
= start
; (void *) pp
< end
; pp
++)
4681 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4683 void *p
= *(void **) ((char *) pp
+ i
);
4684 mark_maybe_pointer (p
);
4685 if (POINTERS_MIGHT_HIDE_IN_OBJECTS
)
4686 mark_maybe_object (XIL ((intptr_t) p
));
4690 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4692 static bool setjmp_tested_p
;
4693 static int longjmps_done
;
4695 #define SETJMP_WILL_LIKELY_WORK "\
4697 Emacs garbage collector has been changed to use conservative stack\n\
4698 marking. Emacs has determined that the method it uses to do the\n\
4699 marking will likely work on your system, but this isn't sure.\n\
4701 If you are a system-programmer, or can get the help of a local wizard\n\
4702 who is, please take a look at the function mark_stack in alloc.c, and\n\
4703 verify that the methods used are appropriate for your system.\n\
4705 Please mail the result to <emacs-devel@gnu.org>.\n\
4708 #define SETJMP_WILL_NOT_WORK "\
4710 Emacs garbage collector has been changed to use conservative stack\n\
4711 marking. Emacs has determined that the default method it uses to do the\n\
4712 marking will not work on your system. We will need a system-dependent\n\
4713 solution for your system.\n\
4715 Please take a look at the function mark_stack in alloc.c, and\n\
4716 try to find a way to make it work on your system.\n\
4718 Note that you may get false negatives, depending on the compiler.\n\
4719 In particular, you need to use -O with GCC for this test.\n\
4721 Please mail the result to <emacs-devel@gnu.org>.\n\
4725 /* Perform a quick check if it looks like setjmp saves registers in a
4726 jmp_buf. Print a message to stderr saying so. When this test
4727 succeeds, this is _not_ a proof that setjmp is sufficient for
4728 conservative stack marking. Only the sources or a disassembly
4738 /* Arrange for X to be put in a register. */
4744 if (longjmps_done
== 1)
4746 /* Came here after the longjmp at the end of the function.
4748 If x == 1, the longjmp has restored the register to its
4749 value before the setjmp, and we can hope that setjmp
4750 saves all such registers in the jmp_buf, although that
4753 For other values of X, either something really strange is
4754 taking place, or the setjmp just didn't save the register. */
4757 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4760 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4767 if (longjmps_done
== 1)
4768 sys_longjmp (jbuf
, 1);
4771 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4774 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4776 /* Abort if anything GCPRO'd doesn't survive the GC. */
4784 for (p
= gcprolist
; p
; p
= p
->next
)
4785 for (i
= 0; i
< p
->nvars
; ++i
)
4786 if (!survives_gc_p (p
->var
[i
]))
4787 /* FIXME: It's not necessarily a bug. It might just be that the
4788 GCPRO is unnecessary or should release the object sooner. */
4792 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4799 fprintf (stderr
, "\nZombies kept alive = %"pI
"d:\n", nzombies
);
4800 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4802 fprintf (stderr
, " %d = ", i
);
4803 debug_print (zombies
[i
]);
4807 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4810 /* Mark live Lisp objects on the C stack.
4812 There are several system-dependent problems to consider when
4813 porting this to new architectures:
4817 We have to mark Lisp objects in CPU registers that can hold local
4818 variables or are used to pass parameters.
4820 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4821 something that either saves relevant registers on the stack, or
4822 calls mark_maybe_object passing it each register's contents.
4824 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4825 implementation assumes that calling setjmp saves registers we need
4826 to see in a jmp_buf which itself lies on the stack. This doesn't
4827 have to be true! It must be verified for each system, possibly
4828 by taking a look at the source code of setjmp.
4830 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4831 can use it as a machine independent method to store all registers
4832 to the stack. In this case the macros described in the previous
4833 two paragraphs are not used.
4837 Architectures differ in the way their processor stack is organized.
4838 For example, the stack might look like this
4841 | Lisp_Object | size = 4
4843 | something else | size = 2
4845 | Lisp_Object | size = 4
4849 In such a case, not every Lisp_Object will be aligned equally. To
4850 find all Lisp_Object on the stack it won't be sufficient to walk
4851 the stack in steps of 4 bytes. Instead, two passes will be
4852 necessary, one starting at the start of the stack, and a second
4853 pass starting at the start of the stack + 2. Likewise, if the
4854 minimal alignment of Lisp_Objects on the stack is 1, four passes
4855 would be necessary, each one starting with one byte more offset
4856 from the stack start. */
4863 #ifdef HAVE___BUILTIN_UNWIND_INIT
4864 /* Force callee-saved registers and register windows onto the stack.
4865 This is the preferred method if available, obviating the need for
4866 machine dependent methods. */
4867 __builtin_unwind_init ();
4869 #else /* not HAVE___BUILTIN_UNWIND_INIT */
4870 #ifndef GC_SAVE_REGISTERS_ON_STACK
4871 /* jmp_buf may not be aligned enough on darwin-ppc64 */
4872 union aligned_jmpbuf
{
4876 volatile bool stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4878 /* This trick flushes the register windows so that all the state of
4879 the process is contained in the stack. */
4880 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4881 needed on ia64 too. See mach_dep.c, where it also says inline
4882 assembler doesn't work with relevant proprietary compilers. */
4884 #if defined (__sparc64__) && defined (__FreeBSD__)
4885 /* FreeBSD does not have a ta 3 handler. */
4892 /* Save registers that we need to see on the stack. We need to see
4893 registers used to hold register variables and registers used to
4895 #ifdef GC_SAVE_REGISTERS_ON_STACK
4896 GC_SAVE_REGISTERS_ON_STACK (end
);
4897 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4899 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4900 setjmp will definitely work, test it
4901 and print a message with the result
4903 if (!setjmp_tested_p
)
4905 setjmp_tested_p
= 1;
4908 #endif /* GC_SETJMP_WORKS */
4911 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4912 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4913 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
4915 /* This assumes that the stack is a contiguous region in memory. If
4916 that's not the case, something has to be done here to iterate
4917 over the stack segments. */
4918 mark_memory (stack_base
, end
);
4920 /* Allow for marking a secondary stack, like the register stack on the
4922 #ifdef GC_MARK_SECONDARY_STACK
4923 GC_MARK_SECONDARY_STACK ();
4926 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4931 #else /* GC_MARK_STACK == 0 */
4933 #define mark_maybe_object(obj) emacs_abort ()
4935 #endif /* GC_MARK_STACK != 0 */
4938 /* Determine whether it is safe to access memory at address P. */
4940 valid_pointer_p (void *p
)
4943 return w32_valid_pointer_p (p
, 16);
4947 /* Obviously, we cannot just access it (we would SEGV trying), so we
4948 trick the o/s to tell us whether p is a valid pointer.
4949 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4950 not validate p in that case. */
4952 if (emacs_pipe (fd
) == 0)
4954 bool valid
= emacs_write (fd
[1], p
, 16) == 16;
4955 emacs_close (fd
[1]);
4956 emacs_close (fd
[0]);
4964 /* Return 2 if OBJ is a killed or special buffer object, 1 if OBJ is a
4965 valid lisp object, 0 if OBJ is NOT a valid lisp object, or -1 if we
4966 cannot validate OBJ. This function can be quite slow, so its primary
4967 use is the manual debugging. The only exception is print_object, where
4968 we use it to check whether the memory referenced by the pointer of
4969 Lisp_Save_Value object contains valid objects. */
4972 valid_lisp_object_p (Lisp_Object obj
)
4982 p
= (void *) XPNTR (obj
);
4983 if (PURE_POINTER_P (p
))
4986 if (p
== &buffer_defaults
|| p
== &buffer_local_symbols
)
4990 return valid_pointer_p (p
);
4997 int valid
= valid_pointer_p (p
);
5009 case MEM_TYPE_NON_LISP
:
5010 case MEM_TYPE_SPARE
:
5013 case MEM_TYPE_BUFFER
:
5014 return live_buffer_p (m
, p
) ? 1 : 2;
5017 return live_cons_p (m
, p
);
5019 case MEM_TYPE_STRING
:
5020 return live_string_p (m
, p
);
5023 return live_misc_p (m
, p
);
5025 case MEM_TYPE_SYMBOL
:
5026 return live_symbol_p (m
, p
);
5028 case MEM_TYPE_FLOAT
:
5029 return live_float_p (m
, p
);
5031 case MEM_TYPE_VECTORLIKE
:
5032 case MEM_TYPE_VECTOR_BLOCK
:
5033 return live_vector_p (m
, p
);
5046 /***********************************************************************
5047 Pure Storage Management
5048 ***********************************************************************/
5050 /* Allocate room for SIZE bytes from pure Lisp storage and return a
5051 pointer to it. TYPE is the Lisp type for which the memory is
5052 allocated. TYPE < 0 means it's not used for a Lisp object. */
5055 pure_alloc (size_t size
, int type
)
5059 size_t alignment
= GCALIGNMENT
;
5061 size_t alignment
= alignof (EMACS_INT
);
5063 /* Give Lisp_Floats an extra alignment. */
5064 if (type
== Lisp_Float
)
5065 alignment
= alignof (struct Lisp_Float
);
5071 /* Allocate space for a Lisp object from the beginning of the free
5072 space with taking account of alignment. */
5073 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
5074 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
5078 /* Allocate space for a non-Lisp object from the end of the free
5080 pure_bytes_used_non_lisp
+= size
;
5081 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5083 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
5085 if (pure_bytes_used
<= pure_size
)
5088 /* Don't allocate a large amount here,
5089 because it might get mmap'd and then its address
5090 might not be usable. */
5091 purebeg
= xmalloc (10000);
5093 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
5094 pure_bytes_used
= 0;
5095 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
5100 /* Print a warning if PURESIZE is too small. */
5103 check_pure_size (void)
5105 if (pure_bytes_used_before_overflow
)
5106 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
5108 pure_bytes_used
+ pure_bytes_used_before_overflow
);
5112 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
5113 the non-Lisp data pool of the pure storage, and return its start
5114 address. Return NULL if not found. */
5117 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5120 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5121 const unsigned char *p
;
5124 if (pure_bytes_used_non_lisp
<= nbytes
)
5127 /* Set up the Boyer-Moore table. */
5129 for (i
= 0; i
< 256; i
++)
5132 p
= (const unsigned char *) data
;
5134 bm_skip
[*p
++] = skip
;
5136 last_char_skip
= bm_skip
['\0'];
5138 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5139 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5141 /* See the comments in the function `boyer_moore' (search.c) for the
5142 use of `infinity'. */
5143 infinity
= pure_bytes_used_non_lisp
+ 1;
5144 bm_skip
['\0'] = infinity
;
5146 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5150 /* Check the last character (== '\0'). */
5153 start
+= bm_skip
[*(p
+ start
)];
5155 while (start
<= start_max
);
5157 if (start
< infinity
)
5158 /* Couldn't find the last character. */
5161 /* No less than `infinity' means we could find the last
5162 character at `p[start - infinity]'. */
5165 /* Check the remaining characters. */
5166 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5168 return non_lisp_beg
+ start
;
5170 start
+= last_char_skip
;
5172 while (start
<= start_max
);
5178 /* Return a string allocated in pure space. DATA is a buffer holding
5179 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5180 means make the result string multibyte.
5182 Must get an error if pure storage is full, since if it cannot hold
5183 a large string it may be able to hold conses that point to that
5184 string; then the string is not protected from gc. */
5187 make_pure_string (const char *data
,
5188 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
5191 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5192 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5193 if (s
->data
== NULL
)
5195 s
->data
= pure_alloc (nbytes
+ 1, -1);
5196 memcpy (s
->data
, data
, nbytes
);
5197 s
->data
[nbytes
] = '\0';
5200 s
->size_byte
= multibyte
? nbytes
: -1;
5201 s
->intervals
= NULL
;
5202 XSETSTRING (string
, s
);
5206 /* Return a string allocated in pure space. Do not
5207 allocate the string data, just point to DATA. */
5210 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5213 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5216 s
->data
= (unsigned char *) data
;
5217 s
->intervals
= NULL
;
5218 XSETSTRING (string
, s
);
5222 /* Return a cons allocated from pure space. Give it pure copies
5223 of CAR as car and CDR as cdr. */
5226 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5229 struct Lisp_Cons
*p
= pure_alloc (sizeof *p
, Lisp_Cons
);
5231 XSETCAR (new, Fpurecopy (car
));
5232 XSETCDR (new, Fpurecopy (cdr
));
5237 /* Value is a float object with value NUM allocated from pure space. */
5240 make_pure_float (double num
)
5243 struct Lisp_Float
*p
= pure_alloc (sizeof *p
, Lisp_Float
);
5245 XFLOAT_INIT (new, num
);
5250 /* Return a vector with room for LEN Lisp_Objects allocated from
5254 make_pure_vector (ptrdiff_t len
)
5257 size_t size
= header_size
+ len
* word_size
;
5258 struct Lisp_Vector
*p
= pure_alloc (size
, Lisp_Vectorlike
);
5259 XSETVECTOR (new, p
);
5260 XVECTOR (new)->header
.size
= len
;
5265 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5266 doc
: /* Make a copy of object OBJ in pure storage.
5267 Recursively copies contents of vectors and cons cells.
5268 Does not copy symbols. Copies strings without text properties. */)
5269 (register Lisp_Object obj
)
5271 if (NILP (Vpurify_flag
))
5274 if (PURE_POINTER_P (XPNTR (obj
)))
5277 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5279 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5285 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5286 else if (FLOATP (obj
))
5287 obj
= make_pure_float (XFLOAT_DATA (obj
));
5288 else if (STRINGP (obj
))
5289 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5291 STRING_MULTIBYTE (obj
));
5292 else if (COMPILEDP (obj
) || VECTORP (obj
))
5294 register struct Lisp_Vector
*vec
;
5295 register ptrdiff_t i
;
5299 if (size
& PSEUDOVECTOR_FLAG
)
5300 size
&= PSEUDOVECTOR_SIZE_MASK
;
5301 vec
= XVECTOR (make_pure_vector (size
));
5302 for (i
= 0; i
< size
; i
++)
5303 vec
->contents
[i
] = Fpurecopy (AREF (obj
, i
));
5304 if (COMPILEDP (obj
))
5306 XSETPVECTYPE (vec
, PVEC_COMPILED
);
5307 XSETCOMPILED (obj
, vec
);
5310 XSETVECTOR (obj
, vec
);
5312 else if (MARKERP (obj
))
5313 error ("Attempt to copy a marker to pure storage");
5315 /* Not purified, don't hash-cons. */
5318 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5319 Fputhash (obj
, obj
, Vpurify_flag
);
5326 /***********************************************************************
5328 ***********************************************************************/
5330 /* Put an entry in staticvec, pointing at the variable with address
5334 staticpro (Lisp_Object
*varaddress
)
5336 if (staticidx
>= NSTATICS
)
5337 fatal ("NSTATICS too small; try increasing and recompiling Emacs.");
5338 staticvec
[staticidx
++] = varaddress
;
5342 /***********************************************************************
5344 ***********************************************************************/
5346 /* Temporarily prevent garbage collection. */
5349 inhibit_garbage_collection (void)
5351 ptrdiff_t count
= SPECPDL_INDEX ();
5353 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5357 /* Used to avoid possible overflows when
5358 converting from C to Lisp integers. */
5361 bounded_number (EMACS_INT number
)
5363 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5366 /* Calculate total bytes of live objects. */
5369 total_bytes_of_live_objects (void)
5372 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5373 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5374 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5375 tot
+= total_string_bytes
;
5376 tot
+= total_vector_slots
* word_size
;
5377 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5378 tot
+= total_intervals
* sizeof (struct interval
);
5379 tot
+= total_strings
* sizeof (struct Lisp_String
);
5383 #ifdef HAVE_WINDOW_SYSTEM
5385 /* This code has a few issues on MS-Windows, see Bug#15876 and Bug#16140. */
5387 #if !defined (HAVE_NTGUI)
5389 /* Remove unmarked font-spec and font-entity objects from ENTRY, which is
5390 (DRIVER-TYPE NUM-FRAMES FONT-CACHE-DATA ...), and return changed entry. */
5393 compact_font_cache_entry (Lisp_Object entry
)
5395 Lisp_Object tail
, *prev
= &entry
;
5397 for (tail
= entry
; CONSP (tail
); tail
= XCDR (tail
))
5400 Lisp_Object obj
= XCAR (tail
);
5402 /* Consider OBJ if it is (font-spec . [font-entity font-entity ...]). */
5403 if (CONSP (obj
) && FONT_SPEC_P (XCAR (obj
))
5404 && !VECTOR_MARKED_P (XFONT_SPEC (XCAR (obj
)))
5405 && VECTORP (XCDR (obj
)))
5407 ptrdiff_t i
, size
= ASIZE (XCDR (obj
)) & ~ARRAY_MARK_FLAG
;
5409 /* If font-spec is not marked, most likely all font-entities
5410 are not marked too. But we must be sure that nothing is
5411 marked within OBJ before we really drop it. */
5412 for (i
= 0; i
< size
; i
++)
5413 if (VECTOR_MARKED_P (XFONT_ENTITY (AREF (XCDR (obj
), i
))))
5420 *prev
= XCDR (tail
);
5422 prev
= xcdr_addr (tail
);
5427 #endif /* not HAVE_NTGUI */
5429 /* Compact font caches on all terminals and mark
5430 everything which is still here after compaction. */
5433 compact_font_caches (void)
5437 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5439 Lisp_Object cache
= TERMINAL_FONT_CACHE (t
);
5440 #if !defined (HAVE_NTGUI)
5445 for (entry
= XCDR (cache
); CONSP (entry
); entry
= XCDR (entry
))
5446 XSETCAR (entry
, compact_font_cache_entry (XCAR (entry
)));
5448 #endif /* not HAVE_NTGUI */
5449 mark_object (cache
);
5453 #else /* not HAVE_WINDOW_SYSTEM */
5455 #define compact_font_caches() (void)(0)
5457 #endif /* HAVE_WINDOW_SYSTEM */
5459 /* Remove (MARKER . DATA) entries with unmarked MARKER
5460 from buffer undo LIST and return changed list. */
5463 compact_undo_list (Lisp_Object list
)
5465 Lisp_Object tail
, *prev
= &list
;
5467 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
5469 if (CONSP (XCAR (tail
))
5470 && MARKERP (XCAR (XCAR (tail
)))
5471 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5472 *prev
= XCDR (tail
);
5474 prev
= xcdr_addr (tail
);
5479 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5480 doc
: /* Reclaim storage for Lisp objects no longer needed.
5481 Garbage collection happens automatically if you cons more than
5482 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5483 `garbage-collect' normally returns a list with info on amount of space in use,
5484 where each entry has the form (NAME SIZE USED FREE), where:
5485 - NAME is a symbol describing the kind of objects this entry represents,
5486 - SIZE is the number of bytes used by each one,
5487 - USED is the number of those objects that were found live in the heap,
5488 - FREE is the number of those objects that are not live but that Emacs
5489 keeps around for future allocations (maybe because it does not know how
5490 to return them to the OS).
5491 However, if there was overflow in pure space, `garbage-collect'
5492 returns nil, because real GC can't be done.
5493 See Info node `(elisp)Garbage Collection'. */)
5496 struct buffer
*nextb
;
5497 char stack_top_variable
;
5500 ptrdiff_t count
= SPECPDL_INDEX ();
5501 struct timespec start
;
5502 Lisp_Object retval
= Qnil
;
5503 size_t tot_before
= 0;
5508 /* Can't GC if pure storage overflowed because we can't determine
5509 if something is a pure object or not. */
5510 if (pure_bytes_used_before_overflow
)
5513 /* Record this function, so it appears on the profiler's backtraces. */
5514 record_in_backtrace (Qautomatic_gc
, &Qnil
, 0);
5518 /* Don't keep undo information around forever.
5519 Do this early on, so it is no problem if the user quits. */
5520 FOR_EACH_BUFFER (nextb
)
5521 compact_buffer (nextb
);
5523 if (profiler_memory_running
)
5524 tot_before
= total_bytes_of_live_objects ();
5526 start
= current_timespec ();
5528 /* In case user calls debug_print during GC,
5529 don't let that cause a recursive GC. */
5530 consing_since_gc
= 0;
5532 /* Save what's currently displayed in the echo area. */
5533 message_p
= push_message ();
5534 record_unwind_protect_void (pop_message_unwind
);
5536 /* Save a copy of the contents of the stack, for debugging. */
5537 #if MAX_SAVE_STACK > 0
5538 if (NILP (Vpurify_flag
))
5541 ptrdiff_t stack_size
;
5542 if (&stack_top_variable
< stack_bottom
)
5544 stack
= &stack_top_variable
;
5545 stack_size
= stack_bottom
- &stack_top_variable
;
5549 stack
= stack_bottom
;
5550 stack_size
= &stack_top_variable
- stack_bottom
;
5552 if (stack_size
<= MAX_SAVE_STACK
)
5554 if (stack_copy_size
< stack_size
)
5556 stack_copy
= xrealloc (stack_copy
, stack_size
);
5557 stack_copy_size
= stack_size
;
5559 no_sanitize_memcpy (stack_copy
, stack
, stack_size
);
5562 #endif /* MAX_SAVE_STACK > 0 */
5564 if (garbage_collection_messages
)
5565 message1_nolog ("Garbage collecting...");
5569 shrink_regexp_cache ();
5573 /* Mark all the special slots that serve as the roots of accessibility. */
5575 mark_buffer (&buffer_defaults
);
5576 mark_buffer (&buffer_local_symbols
);
5578 for (i
= 0; i
< staticidx
; i
++)
5579 mark_object (*staticvec
[i
]);
5589 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5590 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5594 register struct gcpro
*tail
;
5595 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5596 for (i
= 0; i
< tail
->nvars
; i
++)
5597 mark_object (tail
->var
[i
]);
5602 struct handler
*handler
;
5603 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5605 mark_object (handler
->tag_or_ch
);
5606 mark_object (handler
->val
);
5609 #ifdef HAVE_WINDOW_SYSTEM
5610 mark_fringe_data ();
5613 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5617 /* Everything is now marked, except for the data in font caches
5618 and undo lists. They're compacted by removing an items which
5619 aren't reachable otherwise. */
5621 compact_font_caches ();
5623 FOR_EACH_BUFFER (nextb
)
5625 if (!EQ (BVAR (nextb
, undo_list
), Qt
))
5626 bset_undo_list (nextb
, compact_undo_list (BVAR (nextb
, undo_list
)));
5627 /* Now that we have stripped the elements that need not be
5628 in the undo_list any more, we can finally mark the list. */
5629 mark_object (BVAR (nextb
, undo_list
));
5634 /* Clear the mark bits that we set in certain root slots. */
5636 unmark_byte_stack ();
5637 VECTOR_UNMARK (&buffer_defaults
);
5638 VECTOR_UNMARK (&buffer_local_symbols
);
5640 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5650 consing_since_gc
= 0;
5651 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
5652 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
5654 gc_relative_threshold
= 0;
5655 if (FLOATP (Vgc_cons_percentage
))
5656 { /* Set gc_cons_combined_threshold. */
5657 double tot
= total_bytes_of_live_objects ();
5659 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5662 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5663 gc_relative_threshold
= tot
;
5665 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5669 if (garbage_collection_messages
)
5671 if (message_p
|| minibuf_level
> 0)
5674 message1_nolog ("Garbage collecting...done");
5677 unbind_to (count
, Qnil
);
5679 Lisp_Object total
[11];
5680 int total_size
= 10;
5682 total
[0] = list4 (Qconses
, make_number (sizeof (struct Lisp_Cons
)),
5683 bounded_number (total_conses
),
5684 bounded_number (total_free_conses
));
5686 total
[1] = list4 (Qsymbols
, make_number (sizeof (struct Lisp_Symbol
)),
5687 bounded_number (total_symbols
),
5688 bounded_number (total_free_symbols
));
5690 total
[2] = list4 (Qmiscs
, make_number (sizeof (union Lisp_Misc
)),
5691 bounded_number (total_markers
),
5692 bounded_number (total_free_markers
));
5694 total
[3] = list4 (Qstrings
, make_number (sizeof (struct Lisp_String
)),
5695 bounded_number (total_strings
),
5696 bounded_number (total_free_strings
));
5698 total
[4] = list3 (Qstring_bytes
, make_number (1),
5699 bounded_number (total_string_bytes
));
5701 total
[5] = list3 (Qvectors
,
5702 make_number (header_size
+ sizeof (Lisp_Object
)),
5703 bounded_number (total_vectors
));
5705 total
[6] = list4 (Qvector_slots
, make_number (word_size
),
5706 bounded_number (total_vector_slots
),
5707 bounded_number (total_free_vector_slots
));
5709 total
[7] = list4 (Qfloats
, make_number (sizeof (struct Lisp_Float
)),
5710 bounded_number (total_floats
),
5711 bounded_number (total_free_floats
));
5713 total
[8] = list4 (Qintervals
, make_number (sizeof (struct interval
)),
5714 bounded_number (total_intervals
),
5715 bounded_number (total_free_intervals
));
5717 total
[9] = list3 (Qbuffers
, make_number (sizeof (struct buffer
)),
5718 bounded_number (total_buffers
));
5720 #ifdef DOUG_LEA_MALLOC
5722 total
[10] = list4 (Qheap
, make_number (1024),
5723 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
5724 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10));
5726 retval
= Flist (total_size
, total
);
5729 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5731 /* Compute average percentage of zombies. */
5733 = (total_conses
+ total_symbols
+ total_markers
+ total_strings
5734 + total_vectors
+ total_floats
+ total_intervals
+ total_buffers
);
5736 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5737 max_live
= max (nlive
, max_live
);
5738 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5739 max_zombies
= max (nzombies
, max_zombies
);
5744 if (!NILP (Vpost_gc_hook
))
5746 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5747 safe_run_hooks (Qpost_gc_hook
);
5748 unbind_to (gc_count
, Qnil
);
5751 /* Accumulate statistics. */
5752 if (FLOATP (Vgc_elapsed
))
5754 struct timespec since_start
= timespec_sub (current_timespec (), start
);
5755 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5756 + timespectod (since_start
));
5761 /* Collect profiling data. */
5762 if (profiler_memory_running
)
5765 size_t tot_after
= total_bytes_of_live_objects ();
5766 if (tot_before
> tot_after
)
5767 swept
= tot_before
- tot_after
;
5768 malloc_probe (swept
);
5775 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5776 only interesting objects referenced from glyphs are strings. */
5779 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5781 struct glyph_row
*row
= matrix
->rows
;
5782 struct glyph_row
*end
= row
+ matrix
->nrows
;
5784 for (; row
< end
; ++row
)
5788 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5790 struct glyph
*glyph
= row
->glyphs
[area
];
5791 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5793 for (; glyph
< end_glyph
; ++glyph
)
5794 if (STRINGP (glyph
->object
)
5795 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5796 mark_object (glyph
->object
);
5801 /* Mark reference to a Lisp_Object.
5802 If the object referred to has not been seen yet, recursively mark
5803 all the references contained in it. */
5805 #define LAST_MARKED_SIZE 500
5806 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5807 static int last_marked_index
;
5809 /* For debugging--call abort when we cdr down this many
5810 links of a list, in mark_object. In debugging,
5811 the call to abort will hit a breakpoint.
5812 Normally this is zero and the check never goes off. */
5813 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5816 mark_vectorlike (struct Lisp_Vector
*ptr
)
5818 ptrdiff_t size
= ptr
->header
.size
;
5821 eassert (!VECTOR_MARKED_P (ptr
));
5822 VECTOR_MARK (ptr
); /* Else mark it. */
5823 if (size
& PSEUDOVECTOR_FLAG
)
5824 size
&= PSEUDOVECTOR_SIZE_MASK
;
5826 /* Note that this size is not the memory-footprint size, but only
5827 the number of Lisp_Object fields that we should trace.
5828 The distinction is used e.g. by Lisp_Process which places extra
5829 non-Lisp_Object fields at the end of the structure... */
5830 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
5831 mark_object (ptr
->contents
[i
]);
5834 /* Like mark_vectorlike but optimized for char-tables (and
5835 sub-char-tables) assuming that the contents are mostly integers or
5839 mark_char_table (struct Lisp_Vector
*ptr
)
5841 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5844 eassert (!VECTOR_MARKED_P (ptr
));
5846 for (i
= 0; i
< size
; i
++)
5848 Lisp_Object val
= ptr
->contents
[i
];
5850 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5852 if (SUB_CHAR_TABLE_P (val
))
5854 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5855 mark_char_table (XVECTOR (val
));
5862 /* Mark the chain of overlays starting at PTR. */
5865 mark_overlay (struct Lisp_Overlay
*ptr
)
5867 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
5870 mark_object (ptr
->start
);
5871 mark_object (ptr
->end
);
5872 mark_object (ptr
->plist
);
5876 /* Mark Lisp_Objects and special pointers in BUFFER. */
5879 mark_buffer (struct buffer
*buffer
)
5881 /* This is handled much like other pseudovectors... */
5882 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
5884 /* ...but there are some buffer-specific things. */
5886 MARK_INTERVAL_TREE (buffer_intervals (buffer
));
5888 /* For now, we just don't mark the undo_list. It's done later in
5889 a special way just before the sweep phase, and after stripping
5890 some of its elements that are not needed any more. */
5892 mark_overlay (buffer
->overlays_before
);
5893 mark_overlay (buffer
->overlays_after
);
5895 /* If this is an indirect buffer, mark its base buffer. */
5896 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5897 mark_buffer (buffer
->base_buffer
);
5900 /* Mark Lisp faces in the face cache C. */
5903 mark_face_cache (struct face_cache
*c
)
5908 for (i
= 0; i
< c
->used
; ++i
)
5910 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5914 if (face
->font
&& !VECTOR_MARKED_P (face
->font
))
5915 mark_vectorlike ((struct Lisp_Vector
*) face
->font
);
5917 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5918 mark_object (face
->lface
[j
]);
5924 /* Remove killed buffers or items whose car is a killed buffer from
5925 LIST, and mark other items. Return changed LIST, which is marked. */
5928 mark_discard_killed_buffers (Lisp_Object list
)
5930 Lisp_Object tail
, *prev
= &list
;
5932 for (tail
= list
; CONSP (tail
) && !CONS_MARKED_P (XCONS (tail
));
5935 Lisp_Object tem
= XCAR (tail
);
5938 if (BUFFERP (tem
) && !BUFFER_LIVE_P (XBUFFER (tem
)))
5939 *prev
= XCDR (tail
);
5942 CONS_MARK (XCONS (tail
));
5943 mark_object (XCAR (tail
));
5944 prev
= xcdr_addr (tail
);
5951 /* Determine type of generic Lisp_Object and mark it accordingly. */
5954 mark_object (Lisp_Object arg
)
5956 register Lisp_Object obj
= arg
;
5957 #ifdef GC_CHECK_MARKED_OBJECTS
5961 ptrdiff_t cdr_count
= 0;
5965 if (PURE_POINTER_P (XPNTR (obj
)))
5968 last_marked
[last_marked_index
++] = obj
;
5969 if (last_marked_index
== LAST_MARKED_SIZE
)
5970 last_marked_index
= 0;
5972 /* Perform some sanity checks on the objects marked here. Abort if
5973 we encounter an object we know is bogus. This increases GC time
5974 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5975 #ifdef GC_CHECK_MARKED_OBJECTS
5977 po
= (void *) XPNTR (obj
);
5979 /* Check that the object pointed to by PO is known to be a Lisp
5980 structure allocated from the heap. */
5981 #define CHECK_ALLOCATED() \
5983 m = mem_find (po); \
5988 /* Check that the object pointed to by PO is live, using predicate
5990 #define CHECK_LIVE(LIVEP) \
5992 if (!LIVEP (m, po)) \
5996 /* Check both of the above conditions. */
5997 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5999 CHECK_ALLOCATED (); \
6000 CHECK_LIVE (LIVEP); \
6003 #else /* not GC_CHECK_MARKED_OBJECTS */
6005 #define CHECK_LIVE(LIVEP) (void) 0
6006 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
6008 #endif /* not GC_CHECK_MARKED_OBJECTS */
6010 switch (XTYPE (obj
))
6014 register struct Lisp_String
*ptr
= XSTRING (obj
);
6015 if (STRING_MARKED_P (ptr
))
6017 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
6019 MARK_INTERVAL_TREE (ptr
->intervals
);
6020 #ifdef GC_CHECK_STRING_BYTES
6021 /* Check that the string size recorded in the string is the
6022 same as the one recorded in the sdata structure. */
6024 #endif /* GC_CHECK_STRING_BYTES */
6028 case Lisp_Vectorlike
:
6030 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
6031 register ptrdiff_t pvectype
;
6033 if (VECTOR_MARKED_P (ptr
))
6036 #ifdef GC_CHECK_MARKED_OBJECTS
6038 if (m
== MEM_NIL
&& !SUBRP (obj
))
6040 #endif /* GC_CHECK_MARKED_OBJECTS */
6042 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
6043 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
6044 >> PSEUDOVECTOR_AREA_BITS
);
6046 pvectype
= PVEC_NORMAL_VECTOR
;
6048 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
6049 CHECK_LIVE (live_vector_p
);
6054 #ifdef GC_CHECK_MARKED_OBJECTS
6063 #endif /* GC_CHECK_MARKED_OBJECTS */
6064 mark_buffer ((struct buffer
*) ptr
);
6068 { /* We could treat this just like a vector, but it is better
6069 to save the COMPILED_CONSTANTS element for last and avoid
6071 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
6075 for (i
= 0; i
< size
; i
++)
6076 if (i
!= COMPILED_CONSTANTS
)
6077 mark_object (ptr
->contents
[i
]);
6078 if (size
> COMPILED_CONSTANTS
)
6080 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
6088 struct frame
*f
= (struct frame
*) ptr
;
6090 mark_vectorlike (ptr
);
6091 mark_face_cache (f
->face_cache
);
6092 #ifdef HAVE_WINDOW_SYSTEM
6093 if (FRAME_WINDOW_P (f
) && FRAME_X_OUTPUT (f
))
6095 struct font
*font
= FRAME_FONT (f
);
6097 if (font
&& !VECTOR_MARKED_P (font
))
6098 mark_vectorlike ((struct Lisp_Vector
*) font
);
6106 struct window
*w
= (struct window
*) ptr
;
6108 mark_vectorlike (ptr
);
6110 /* Mark glyph matrices, if any. Marking window
6111 matrices is sufficient because frame matrices
6112 use the same glyph memory. */
6113 if (w
->current_matrix
)
6115 mark_glyph_matrix (w
->current_matrix
);
6116 mark_glyph_matrix (w
->desired_matrix
);
6119 /* Filter out killed buffers from both buffer lists
6120 in attempt to help GC to reclaim killed buffers faster.
6121 We can do it elsewhere for live windows, but this is the
6122 best place to do it for dead windows. */
6124 (w
, mark_discard_killed_buffers (w
->prev_buffers
));
6126 (w
, mark_discard_killed_buffers (w
->next_buffers
));
6130 case PVEC_HASH_TABLE
:
6132 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6134 mark_vectorlike (ptr
);
6135 mark_object (h
->test
.name
);
6136 mark_object (h
->test
.user_hash_function
);
6137 mark_object (h
->test
.user_cmp_function
);
6138 /* If hash table is not weak, mark all keys and values.
6139 For weak tables, mark only the vector. */
6141 mark_object (h
->key_and_value
);
6143 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6147 case PVEC_CHAR_TABLE
:
6148 mark_char_table (ptr
);
6151 case PVEC_BOOL_VECTOR
:
6152 /* No Lisp_Objects to mark in a bool vector. */
6163 mark_vectorlike (ptr
);
6170 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6171 struct Lisp_Symbol
*ptrx
;
6175 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
6177 mark_object (ptr
->function
);
6178 mark_object (ptr
->plist
);
6179 switch (ptr
->redirect
)
6181 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6182 case SYMBOL_VARALIAS
:
6185 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6189 case SYMBOL_LOCALIZED
:
6191 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
6192 Lisp_Object where
= blv
->where
;
6193 /* If the value is set up for a killed buffer or deleted
6194 frame, restore it's global binding. If the value is
6195 forwarded to a C variable, either it's not a Lisp_Object
6196 var, or it's staticpro'd already. */
6197 if ((BUFFERP (where
) && !BUFFER_LIVE_P (XBUFFER (where
)))
6198 || (FRAMEP (where
) && !FRAME_LIVE_P (XFRAME (where
))))
6199 swap_in_global_binding (ptr
);
6200 mark_object (blv
->where
);
6201 mark_object (blv
->valcell
);
6202 mark_object (blv
->defcell
);
6205 case SYMBOL_FORWARDED
:
6206 /* If the value is forwarded to a buffer or keyboard field,
6207 these are marked when we see the corresponding object.
6208 And if it's forwarded to a C variable, either it's not
6209 a Lisp_Object var, or it's staticpro'd already. */
6211 default: emacs_abort ();
6213 if (!PURE_POINTER_P (XSTRING (ptr
->name
)))
6214 MARK_STRING (XSTRING (ptr
->name
));
6215 MARK_INTERVAL_TREE (string_intervals (ptr
->name
));
6220 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun. */
6221 XSETSYMBOL (obj
, ptrx
);
6228 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6230 if (XMISCANY (obj
)->gcmarkbit
)
6233 switch (XMISCTYPE (obj
))
6235 case Lisp_Misc_Marker
:
6236 /* DO NOT mark thru the marker's chain.
6237 The buffer's markers chain does not preserve markers from gc;
6238 instead, markers are removed from the chain when freed by gc. */
6239 XMISCANY (obj
)->gcmarkbit
= 1;
6242 case Lisp_Misc_Save_Value
:
6243 XMISCANY (obj
)->gcmarkbit
= 1;
6245 struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
6246 /* If `save_type' is zero, `data[0].pointer' is the address
6247 of a memory area containing `data[1].integer' potential
6249 if (GC_MARK_STACK
&& ptr
->save_type
== SAVE_TYPE_MEMORY
)
6251 Lisp_Object
*p
= ptr
->data
[0].pointer
;
6253 for (nelt
= ptr
->data
[1].integer
; nelt
> 0; nelt
--, p
++)
6254 mark_maybe_object (*p
);
6258 /* Find Lisp_Objects in `data[N]' slots and mark them. */
6260 for (i
= 0; i
< SAVE_VALUE_SLOTS
; i
++)
6261 if (save_type (ptr
, i
) == SAVE_OBJECT
)
6262 mark_object (ptr
->data
[i
].object
);
6267 case Lisp_Misc_Overlay
:
6268 mark_overlay (XOVERLAY (obj
));
6278 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6279 if (CONS_MARKED_P (ptr
))
6281 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6283 /* If the cdr is nil, avoid recursion for the car. */
6284 if (EQ (ptr
->u
.cdr
, Qnil
))
6290 mark_object (ptr
->car
);
6293 if (cdr_count
== mark_object_loop_halt
)
6299 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6300 FLOAT_MARK (XFLOAT (obj
));
6311 #undef CHECK_ALLOCATED
6312 #undef CHECK_ALLOCATED_AND_LIVE
6314 /* Mark the Lisp pointers in the terminal objects.
6315 Called by Fgarbage_collect. */
6318 mark_terminals (void)
6321 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6323 eassert (t
->name
!= NULL
);
6324 #ifdef HAVE_WINDOW_SYSTEM
6325 /* If a terminal object is reachable from a stacpro'ed object,
6326 it might have been marked already. Make sure the image cache
6328 mark_image_cache (t
->image_cache
);
6329 #endif /* HAVE_WINDOW_SYSTEM */
6330 if (!VECTOR_MARKED_P (t
))
6331 mark_vectorlike ((struct Lisp_Vector
*)t
);
6337 /* Value is non-zero if OBJ will survive the current GC because it's
6338 either marked or does not need to be marked to survive. */
6341 survives_gc_p (Lisp_Object obj
)
6345 switch (XTYPE (obj
))
6352 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6356 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6360 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6363 case Lisp_Vectorlike
:
6364 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6368 survives_p
= CONS_MARKED_P (XCONS (obj
));
6372 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6379 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
6385 NO_INLINE
/* For better stack traces */
6389 register struct cons_block
*cblk
;
6390 struct cons_block
**cprev
= &cons_block
;
6391 register int lim
= cons_block_index
;
6392 EMACS_INT num_free
= 0, num_used
= 0;
6396 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6400 int ilim
= (lim
+ BITS_PER_INT
- 1) / BITS_PER_INT
;
6402 /* Scan the mark bits an int at a time. */
6403 for (i
= 0; i
< ilim
; i
++)
6405 if (cblk
->gcmarkbits
[i
] == -1)
6407 /* Fast path - all cons cells for this int are marked. */
6408 cblk
->gcmarkbits
[i
] = 0;
6409 num_used
+= BITS_PER_INT
;
6413 /* Some cons cells for this int are not marked.
6414 Find which ones, and free them. */
6415 int start
, pos
, stop
;
6417 start
= i
* BITS_PER_INT
;
6419 if (stop
> BITS_PER_INT
)
6420 stop
= BITS_PER_INT
;
6423 for (pos
= start
; pos
< stop
; pos
++)
6425 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6428 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6429 cons_free_list
= &cblk
->conses
[pos
];
6431 cons_free_list
->car
= Vdead
;
6437 CONS_UNMARK (&cblk
->conses
[pos
]);
6443 lim
= CONS_BLOCK_SIZE
;
6444 /* If this block contains only free conses and we have already
6445 seen more than two blocks worth of free conses then deallocate
6447 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6449 *cprev
= cblk
->next
;
6450 /* Unhook from the free list. */
6451 cons_free_list
= cblk
->conses
[0].u
.chain
;
6452 lisp_align_free (cblk
);
6456 num_free
+= this_free
;
6457 cprev
= &cblk
->next
;
6460 total_conses
= num_used
;
6461 total_free_conses
= num_free
;
6464 NO_INLINE
/* For better stack traces */
6468 register struct float_block
*fblk
;
6469 struct float_block
**fprev
= &float_block
;
6470 register int lim
= float_block_index
;
6471 EMACS_INT num_free
= 0, num_used
= 0;
6473 float_free_list
= 0;
6475 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6479 for (i
= 0; i
< lim
; i
++)
6480 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6483 fblk
->floats
[i
].u
.chain
= float_free_list
;
6484 float_free_list
= &fblk
->floats
[i
];
6489 FLOAT_UNMARK (&fblk
->floats
[i
]);
6491 lim
= FLOAT_BLOCK_SIZE
;
6492 /* If this block contains only free floats and we have already
6493 seen more than two blocks worth of free floats then deallocate
6495 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6497 *fprev
= fblk
->next
;
6498 /* Unhook from the free list. */
6499 float_free_list
= fblk
->floats
[0].u
.chain
;
6500 lisp_align_free (fblk
);
6504 num_free
+= this_free
;
6505 fprev
= &fblk
->next
;
6508 total_floats
= num_used
;
6509 total_free_floats
= num_free
;
6512 NO_INLINE
/* For better stack traces */
6514 sweep_intervals (void)
6516 register struct interval_block
*iblk
;
6517 struct interval_block
**iprev
= &interval_block
;
6518 register int lim
= interval_block_index
;
6519 EMACS_INT num_free
= 0, num_used
= 0;
6521 interval_free_list
= 0;
6523 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6528 for (i
= 0; i
< lim
; i
++)
6530 if (!iblk
->intervals
[i
].gcmarkbit
)
6532 set_interval_parent (&iblk
->intervals
[i
], interval_free_list
);
6533 interval_free_list
= &iblk
->intervals
[i
];
6539 iblk
->intervals
[i
].gcmarkbit
= 0;
6542 lim
= INTERVAL_BLOCK_SIZE
;
6543 /* If this block contains only free intervals and we have already
6544 seen more than two blocks worth of free intervals then
6545 deallocate this block. */
6546 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6548 *iprev
= iblk
->next
;
6549 /* Unhook from the free list. */
6550 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6555 num_free
+= this_free
;
6556 iprev
= &iblk
->next
;
6559 total_intervals
= num_used
;
6560 total_free_intervals
= num_free
;
6563 NO_INLINE
/* For better stack traces */
6565 sweep_symbols (void)
6567 register struct symbol_block
*sblk
;
6568 struct symbol_block
**sprev
= &symbol_block
;
6569 register int lim
= symbol_block_index
;
6570 EMACS_INT num_free
= 0, num_used
= 0;
6572 symbol_free_list
= NULL
;
6574 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6577 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6578 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6580 for (; sym
< end
; ++sym
)
6582 /* Check if the symbol was created during loadup. In such a case
6583 it might be pointed to by pure bytecode which we don't trace,
6584 so we conservatively assume that it is live. */
6585 bool pure_p
= PURE_POINTER_P (XSTRING (sym
->s
.name
));
6587 if (!sym
->s
.gcmarkbit
&& !pure_p
)
6589 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6590 xfree (SYMBOL_BLV (&sym
->s
));
6591 sym
->s
.next
= symbol_free_list
;
6592 symbol_free_list
= &sym
->s
;
6594 symbol_free_list
->function
= Vdead
;
6602 eassert (!STRING_MARKED_P (XSTRING (sym
->s
.name
)));
6603 sym
->s
.gcmarkbit
= 0;
6607 lim
= SYMBOL_BLOCK_SIZE
;
6608 /* If this block contains only free symbols and we have already
6609 seen more than two blocks worth of free symbols then deallocate
6611 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6613 *sprev
= sblk
->next
;
6614 /* Unhook from the free list. */
6615 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6620 num_free
+= this_free
;
6621 sprev
= &sblk
->next
;
6624 total_symbols
= num_used
;
6625 total_free_symbols
= num_free
;
6628 NO_INLINE
/* For better stack traces */
6632 register struct marker_block
*mblk
;
6633 struct marker_block
**mprev
= &marker_block
;
6634 register int lim
= marker_block_index
;
6635 EMACS_INT num_free
= 0, num_used
= 0;
6637 /* Put all unmarked misc's on free list. For a marker, first
6638 unchain it from the buffer it points into. */
6640 marker_free_list
= 0;
6642 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6647 for (i
= 0; i
< lim
; i
++)
6649 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6651 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6652 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6653 /* Set the type of the freed object to Lisp_Misc_Free.
6654 We could leave the type alone, since nobody checks it,
6655 but this might catch bugs faster. */
6656 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6657 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6658 marker_free_list
= &mblk
->markers
[i
].m
;
6664 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6667 lim
= MARKER_BLOCK_SIZE
;
6668 /* If this block contains only free markers and we have already
6669 seen more than two blocks worth of free markers then deallocate
6671 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6673 *mprev
= mblk
->next
;
6674 /* Unhook from the free list. */
6675 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6680 num_free
+= this_free
;
6681 mprev
= &mblk
->next
;
6685 total_markers
= num_used
;
6686 total_free_markers
= num_free
;
6689 NO_INLINE
/* For better stack traces */
6691 sweep_buffers (void)
6693 register struct buffer
*buffer
, **bprev
= &all_buffers
;
6696 for (buffer
= all_buffers
; buffer
; buffer
= *bprev
)
6697 if (!VECTOR_MARKED_P (buffer
))
6699 *bprev
= buffer
->next
;
6704 VECTOR_UNMARK (buffer
);
6705 /* Do not use buffer_(set|get)_intervals here. */
6706 buffer
->text
->intervals
= balance_intervals (buffer
->text
->intervals
);
6708 bprev
= &buffer
->next
;
6712 /* Sweep: find all structures not marked, and free them. */
6716 /* Remove or mark entries in weak hash tables.
6717 This must be done before any object is unmarked. */
6718 sweep_weak_hash_tables ();
6721 check_string_bytes (!noninteractive
);
6729 check_string_bytes (!noninteractive
);
6733 /* Debugging aids. */
6735 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6736 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6737 This may be helpful in debugging Emacs's memory usage.
6738 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6744 /* Avoid warning. sbrk has no relation to memory allocated anyway. */
6747 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6753 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6754 doc
: /* Return a list of counters that measure how much consing there has been.
6755 Each of these counters increments for a certain kind of object.
6756 The counters wrap around from the largest positive integer to zero.
6757 Garbage collection does not decrease them.
6758 The elements of the value are as follows:
6759 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6760 All are in units of 1 = one object consed
6761 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6763 MISCS include overlays, markers, and some internal types.
6764 Frames, windows, buffers, and subprocesses count as vectors
6765 (but the contents of a buffer's text do not count here). */)
6768 return listn (CONSTYPE_HEAP
, 8,
6769 bounded_number (cons_cells_consed
),
6770 bounded_number (floats_consed
),
6771 bounded_number (vector_cells_consed
),
6772 bounded_number (symbols_consed
),
6773 bounded_number (string_chars_consed
),
6774 bounded_number (misc_objects_consed
),
6775 bounded_number (intervals_consed
),
6776 bounded_number (strings_consed
));
6779 /* Find at most FIND_MAX symbols which have OBJ as their value or
6780 function. This is used in gdbinit's `xwhichsymbols' command. */
6783 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6785 struct symbol_block
*sblk
;
6786 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6787 Lisp_Object found
= Qnil
;
6791 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6793 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
6796 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
6798 struct Lisp_Symbol
*sym
= &aligned_sym
->s
;
6802 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6805 XSETSYMBOL (tem
, sym
);
6806 val
= find_symbol_value (tem
);
6808 || EQ (sym
->function
, obj
)
6809 || (!NILP (sym
->function
)
6810 && COMPILEDP (sym
->function
)
6811 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
6814 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)))
6816 found
= Fcons (tem
, found
);
6817 if (--find_max
== 0)
6825 unbind_to (gc_count
, Qnil
);
6829 #ifdef SUSPICIOUS_OBJECT_CHECKING
6832 find_suspicious_object_in_range (void* begin
, void* end
)
6834 char* begin_a
= begin
;
6838 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
) {
6839 char* suspicious_object
= suspicious_objects
[i
];
6840 if (begin_a
<= suspicious_object
&& suspicious_object
< end_a
)
6841 return suspicious_object
;
6848 detect_suspicious_free (void* ptr
)
6851 struct suspicious_free_record
* rec
;
6853 eassert (ptr
!= NULL
);
6855 for (i
= 0; i
< ARRAYELTS (suspicious_objects
); ++i
)
6856 if (suspicious_objects
[i
] == ptr
)
6858 rec
= &suspicious_free_history
[suspicious_free_history_index
++];
6859 if (suspicious_free_history_index
==
6860 ARRAYELTS (suspicious_free_history
))
6862 suspicious_free_history_index
= 0;
6865 memset (rec
, 0, sizeof (*rec
));
6866 rec
->suspicious_object
= ptr
;
6867 #ifdef HAVE_EXECINFO_H
6868 backtrace (&rec
->backtrace
[0], ARRAYELTS (rec
->backtrace
));
6870 suspicious_objects
[i
] = NULL
;
6874 #endif /* SUSPICIOUS_OBJECT_CHECKING */
6876 DEFUN ("suspicious-object", Fsuspicious_object
, Ssuspicious_object
, 1, 1, 0,
6877 doc
: /* Return OBJ, maybe marking it for extra scrutiny.
6878 If Emacs is compiled with suspicous object checking, capture
6879 a stack trace when OBJ is freed in order to help track down
6880 garbage collection bugs. Otherwise, do nothing and return OBJ. */)
6883 #ifdef SUSPICIOUS_OBJECT_CHECKING
6884 /* Right now, we care only about vectors. */
6885 if (VECTORLIKEP (obj
)) {
6886 suspicious_objects
[suspicious_object_index
++] = XVECTOR (obj
);
6887 if (suspicious_object_index
== ARRAYELTS (suspicious_objects
))
6888 suspicious_object_index
= 0;
6894 #ifdef ENABLE_CHECKING
6896 bool suppress_checking
;
6899 die (const char *msg
, const char *file
, int line
)
6901 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: assertion failed: %s\r\n",
6903 terminate_due_to_signal (SIGABRT
, INT_MAX
);
6907 /* Initialization. */
6910 init_alloc_once (void)
6912 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6914 pure_size
= PURESIZE
;
6916 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6918 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6921 #ifdef DOUG_LEA_MALLOC
6922 mallopt (M_TRIM_THRESHOLD
, 128 * 1024); /* Trim threshold. */
6923 mallopt (M_MMAP_THRESHOLD
, 64 * 1024); /* Mmap threshold. */
6924 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* Max. number of mmap'ed areas. */
6929 refill_memory_reserve ();
6930 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
6937 byte_stack_list
= 0;
6939 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6940 setjmp_tested_p
= longjmps_done
= 0;
6943 Vgc_elapsed
= make_float (0.0);
6947 valgrind_p
= RUNNING_ON_VALGRIND
!= 0;
6952 syms_of_alloc (void)
6954 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6955 doc
: /* Number of bytes of consing between garbage collections.
6956 Garbage collection can happen automatically once this many bytes have been
6957 allocated since the last garbage collection. All data types count.
6959 Garbage collection happens automatically only when `eval' is called.
6961 By binding this temporarily to a large number, you can effectively
6962 prevent garbage collection during a part of the program.
6963 See also `gc-cons-percentage'. */);
6965 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6966 doc
: /* Portion of the heap used for allocation.
6967 Garbage collection can happen automatically once this portion of the heap
6968 has been allocated since the last garbage collection.
6969 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6970 Vgc_cons_percentage
= make_float (0.1);
6972 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6973 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
6975 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6976 doc
: /* Number of cons cells that have been consed so far. */);
6978 DEFVAR_INT ("floats-consed", floats_consed
,
6979 doc
: /* Number of floats that have been consed so far. */);
6981 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
6982 doc
: /* Number of vector cells that have been consed so far. */);
6984 DEFVAR_INT ("symbols-consed", symbols_consed
,
6985 doc
: /* Number of symbols that have been consed so far. */);
6987 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
6988 doc
: /* Number of string characters that have been consed so far. */);
6990 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
6991 doc
: /* Number of miscellaneous objects that have been consed so far.
6992 These include markers and overlays, plus certain objects not visible
6995 DEFVAR_INT ("intervals-consed", intervals_consed
,
6996 doc
: /* Number of intervals that have been consed so far. */);
6998 DEFVAR_INT ("strings-consed", strings_consed
,
6999 doc
: /* Number of strings that have been consed so far. */);
7001 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
7002 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
7003 This means that certain objects should be allocated in shared (pure) space.
7004 It can also be set to a hash-table, in which case this table is used to
7005 do hash-consing of the objects allocated to pure space. */);
7007 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
7008 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
7009 garbage_collection_messages
= 0;
7011 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
7012 doc
: /* Hook run after garbage collection has finished. */);
7013 Vpost_gc_hook
= Qnil
;
7014 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
7016 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
7017 doc
: /* Precomputed `signal' argument for memory-full error. */);
7018 /* We build this in advance because if we wait until we need it, we might
7019 not be able to allocate the memory to hold it. */
7021 = listn (CONSTYPE_PURE
, 2, Qerror
,
7022 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
7024 DEFVAR_LISP ("memory-full", Vmemory_full
,
7025 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
7026 Vmemory_full
= Qnil
;
7028 DEFSYM (Qconses
, "conses");
7029 DEFSYM (Qsymbols
, "symbols");
7030 DEFSYM (Qmiscs
, "miscs");
7031 DEFSYM (Qstrings
, "strings");
7032 DEFSYM (Qvectors
, "vectors");
7033 DEFSYM (Qfloats
, "floats");
7034 DEFSYM (Qintervals
, "intervals");
7035 DEFSYM (Qbuffers
, "buffers");
7036 DEFSYM (Qstring_bytes
, "string-bytes");
7037 DEFSYM (Qvector_slots
, "vector-slots");
7038 DEFSYM (Qheap
, "heap");
7039 DEFSYM (Qautomatic_gc
, "Automatic GC");
7041 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
7042 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
7044 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
7045 doc
: /* Accumulated time elapsed in garbage collections.
7046 The time is in seconds as a floating point value. */);
7047 DEFVAR_INT ("gcs-done", gcs_done
,
7048 doc
: /* Accumulated number of garbage collections done. */);
7053 defsubr (&Smake_byte_code
);
7054 defsubr (&Smake_list
);
7055 defsubr (&Smake_vector
);
7056 defsubr (&Smake_string
);
7057 defsubr (&Smake_bool_vector
);
7058 defsubr (&Smake_symbol
);
7059 defsubr (&Smake_marker
);
7060 defsubr (&Spurecopy
);
7061 defsubr (&Sgarbage_collect
);
7062 defsubr (&Smemory_limit
);
7063 defsubr (&Smemory_use_counts
);
7064 defsubr (&Ssuspicious_object
);
7066 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
7067 defsubr (&Sgc_status
);
7071 /* When compiled with GCC, GDB might say "No enum type named
7072 pvec_type" if we don't have at least one symbol with that type, and
7073 then xbacktrace could fail. Similarly for the other enums and
7074 their values. Some non-GCC compilers don't like these constructs. */
7078 enum CHARTAB_SIZE_BITS CHARTAB_SIZE_BITS
;
7079 enum CHAR_TABLE_STANDARD_SLOTS CHAR_TABLE_STANDARD_SLOTS
;
7080 enum char_bits char_bits
;
7081 enum CHECK_LISP_OBJECT_TYPE CHECK_LISP_OBJECT_TYPE
;
7082 enum DEFAULT_HASH_SIZE DEFAULT_HASH_SIZE
;
7083 enum enum_USE_LSB_TAG enum_USE_LSB_TAG
;
7084 enum FLOAT_TO_STRING_BUFSIZE FLOAT_TO_STRING_BUFSIZE
;
7085 enum Lisp_Bits Lisp_Bits
;
7086 enum Lisp_Compiled Lisp_Compiled
;
7087 enum maxargs maxargs
;
7088 enum MAX_ALLOCA MAX_ALLOCA
;
7089 enum More_Lisp_Bits More_Lisp_Bits
;
7090 enum pvec_type pvec_type
;
7091 } const EXTERNALLY_VISIBLE gdb_make_enums_visible
= {0};
7092 #endif /* __GNUC__ */