1 /* Storage allocation and gc for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2012
4 Free Software Foundation, Inc.
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/>. */
23 #define LISP_INLINE EXTERN_INLINE
26 #include <limits.h> /* For CHAR_BIT. */
37 #include "intervals.h"
39 #include "character.h"
44 #include "blockinput.h"
45 #include "syssignal.h"
46 #include "termhooks.h" /* For struct terminal. */
50 /* GC_CHECK_MARKED_OBJECTS means do sanity checks on allocated objects.
51 Doable only if GC_MARK_STACK. */
53 # undef GC_CHECK_MARKED_OBJECTS
56 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
57 memory. Can do this only if using gmalloc.c and if not checking
60 #if (defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC \
61 || defined GC_CHECK_MARKED_OBJECTS)
62 #undef GC_MALLOC_CHECK
76 #ifdef DOUG_LEA_MALLOC
80 /* Specify maximum number of areas to mmap. It would be nice to use a
81 value that explicitly means "no limit". */
83 #define MMAP_MAX_AREAS 100000000
85 #else /* not DOUG_LEA_MALLOC */
87 /* The following come from gmalloc.c. */
89 extern size_t _bytes_used
;
90 extern size_t __malloc_extra_blocks
;
91 extern void *_malloc_internal (size_t);
92 extern void _free_internal (void *);
94 #endif /* not DOUG_LEA_MALLOC */
96 #if ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT
99 /* When GTK uses the file chooser dialog, different backends can be loaded
100 dynamically. One such a backend is the Gnome VFS backend that gets loaded
101 if you run Gnome. That backend creates several threads and also allocates
104 Also, gconf and gsettings may create several threads.
106 If Emacs sets malloc hooks (! SYSTEM_MALLOC) and the emacs_blocked_*
107 functions below are called from malloc, there is a chance that one
108 of these threads preempts the Emacs main thread and the hook variables
109 end up in an inconsistent state. So we have a mutex to prevent that (note
110 that the backend handles concurrent access to malloc within its own threads
111 but Emacs code running in the main thread is not included in that control).
113 When UNBLOCK_INPUT is called, reinvoke_input_signal may be called. If this
114 happens in one of the backend threads we will have two threads that tries
115 to run Emacs code at once, and the code is not prepared for that.
116 To prevent that, we only call BLOCK/UNBLOCK from the main thread. */
118 static pthread_mutex_t alloc_mutex
;
120 #define BLOCK_INPUT_ALLOC \
123 if (pthread_equal (pthread_self (), main_thread)) \
125 pthread_mutex_lock (&alloc_mutex); \
128 #define UNBLOCK_INPUT_ALLOC \
131 pthread_mutex_unlock (&alloc_mutex); \
132 if (pthread_equal (pthread_self (), main_thread)) \
137 #else /* ! defined HAVE_PTHREAD */
139 #define BLOCK_INPUT_ALLOC BLOCK_INPUT
140 #define UNBLOCK_INPUT_ALLOC UNBLOCK_INPUT
142 #endif /* ! defined HAVE_PTHREAD */
143 #endif /* ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT */
145 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
146 to a struct Lisp_String. */
148 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
149 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
150 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
152 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
153 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
154 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
156 /* Default value of gc_cons_threshold (see below). */
158 #define GC_DEFAULT_THRESHOLD (100000 * word_size)
160 /* Global variables. */
161 struct emacs_globals globals
;
163 /* Number of bytes of consing done since the last gc. */
165 EMACS_INT consing_since_gc
;
167 /* Similar minimum, computed from Vgc_cons_percentage. */
169 EMACS_INT gc_relative_threshold
;
171 /* Minimum number of bytes of consing since GC before next GC,
172 when memory is full. */
174 EMACS_INT memory_full_cons_threshold
;
176 /* Nonzero during GC. */
180 /* Nonzero means abort if try to GC.
181 This is for code which is written on the assumption that
182 no GC will happen, so as to verify that assumption. */
186 /* Number of live and free conses etc. */
188 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_buffers
;
189 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
190 static EMACS_INT total_free_floats
, total_floats
;
192 /* Points to memory space allocated as "spare", to be freed if we run
193 out of memory. We keep one large block, four cons-blocks, and
194 two string blocks. */
196 static char *spare_memory
[7];
198 /* Amount of spare memory to keep in large reserve block, or to see
199 whether this much is available when malloc fails on a larger request. */
201 #define SPARE_MEMORY (1 << 14)
203 /* Number of extra blocks malloc should get when it needs more core. */
205 static int malloc_hysteresis
;
207 /* Initialize it to a nonzero value to force it into data space
208 (rather than bss space). That way unexec will remap it into text
209 space (pure), on some systems. We have not implemented the
210 remapping on more recent systems because this is less important
211 nowadays than in the days of small memories and timesharing. */
213 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
214 #define PUREBEG (char *) pure
216 /* Pointer to the pure area, and its size. */
218 static char *purebeg
;
219 static ptrdiff_t pure_size
;
221 /* Number of bytes of pure storage used before pure storage overflowed.
222 If this is non-zero, this implies that an overflow occurred. */
224 static ptrdiff_t pure_bytes_used_before_overflow
;
226 /* Value is non-zero if P points into pure space. */
228 #define PURE_POINTER_P(P) \
229 ((uintptr_t) (P) - (uintptr_t) purebeg <= pure_size)
231 /* Index in pure at which next pure Lisp object will be allocated.. */
233 static ptrdiff_t pure_bytes_used_lisp
;
235 /* Number of bytes allocated for non-Lisp objects in pure storage. */
237 static ptrdiff_t pure_bytes_used_non_lisp
;
239 /* If nonzero, this is a warning delivered by malloc and not yet
242 const char *pending_malloc_warning
;
244 /* Maximum amount of C stack to save when a GC happens. */
246 #ifndef MAX_SAVE_STACK
247 #define MAX_SAVE_STACK 16000
250 /* Buffer in which we save a copy of the C stack at each GC. */
252 #if MAX_SAVE_STACK > 0
253 static char *stack_copy
;
254 static ptrdiff_t stack_copy_size
;
257 static Lisp_Object Qstring_bytes
, Qvector_slots
, Qheap
;
258 static Lisp_Object Qgc_cons_threshold
;
259 Lisp_Object Qchar_table_extra_slots
;
261 /* Hook run after GC has finished. */
263 static Lisp_Object Qpost_gc_hook
;
265 static void mark_terminals (void);
266 static void gc_sweep (void);
267 static Lisp_Object
make_pure_vector (ptrdiff_t);
268 static void mark_glyph_matrix (struct glyph_matrix
*);
269 static void mark_face_cache (struct face_cache
*);
271 #if !defined REL_ALLOC || defined SYSTEM_MALLOC
272 static void refill_memory_reserve (void);
274 static struct Lisp_String
*allocate_string (void);
275 static void compact_small_strings (void);
276 static void free_large_strings (void);
277 static void sweep_strings (void);
278 static void free_misc (Lisp_Object
);
279 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
281 /* When scanning the C stack for live Lisp objects, Emacs keeps track
282 of what memory allocated via lisp_malloc is intended for what
283 purpose. This enumeration specifies the type of memory. */
294 /* We used to keep separate mem_types for subtypes of vectors such as
295 process, hash_table, frame, terminal, and window, but we never made
296 use of the distinction, so it only caused source-code complexity
297 and runtime slowdown. Minor but pointless. */
299 /* Special type to denote vector blocks. */
300 MEM_TYPE_VECTOR_BLOCK
303 static void *lisp_malloc (size_t, enum mem_type
);
306 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
308 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
309 #include <stdio.h> /* For fprintf. */
312 /* A unique object in pure space used to make some Lisp objects
313 on free lists recognizable in O(1). */
315 static Lisp_Object Vdead
;
316 #define DEADP(x) EQ (x, Vdead)
318 #ifdef GC_MALLOC_CHECK
320 enum mem_type allocated_mem_type
;
322 #endif /* GC_MALLOC_CHECK */
324 /* A node in the red-black tree describing allocated memory containing
325 Lisp data. Each such block is recorded with its start and end
326 address when it is allocated, and removed from the tree when it
329 A red-black tree is a balanced binary tree with the following
332 1. Every node is either red or black.
333 2. Every leaf is black.
334 3. If a node is red, then both of its children are black.
335 4. Every simple path from a node to a descendant leaf contains
336 the same number of black nodes.
337 5. The root is always black.
339 When nodes are inserted into the tree, or deleted from the tree,
340 the tree is "fixed" so that these properties are always true.
342 A red-black tree with N internal nodes has height at most 2
343 log(N+1). Searches, insertions and deletions are done in O(log N).
344 Please see a text book about data structures for a detailed
345 description of red-black trees. Any book worth its salt should
350 /* Children of this node. These pointers are never NULL. When there
351 is no child, the value is MEM_NIL, which points to a dummy node. */
352 struct mem_node
*left
, *right
;
354 /* The parent of this node. In the root node, this is NULL. */
355 struct mem_node
*parent
;
357 /* Start and end of allocated region. */
361 enum {MEM_BLACK
, MEM_RED
} color
;
367 /* Base address of stack. Set in main. */
369 Lisp_Object
*stack_base
;
371 /* Root of the tree describing allocated Lisp memory. */
373 static struct mem_node
*mem_root
;
375 /* Lowest and highest known address in the heap. */
377 static void *min_heap_address
, *max_heap_address
;
379 /* Sentinel node of the tree. */
381 static struct mem_node mem_z
;
382 #define MEM_NIL &mem_z
384 static struct Lisp_Vector
*allocate_vectorlike (ptrdiff_t);
385 static void lisp_free (void *);
386 static void mark_stack (void);
387 static int live_vector_p (struct mem_node
*, void *);
388 static int live_buffer_p (struct mem_node
*, void *);
389 static int live_string_p (struct mem_node
*, void *);
390 static int live_cons_p (struct mem_node
*, void *);
391 static int live_symbol_p (struct mem_node
*, void *);
392 static int live_float_p (struct mem_node
*, void *);
393 static int live_misc_p (struct mem_node
*, void *);
394 static void mark_maybe_object (Lisp_Object
);
395 static void mark_memory (void *, void *);
396 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
397 static void mem_init (void);
398 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
399 static void mem_insert_fixup (struct mem_node
*);
401 static void mem_rotate_left (struct mem_node
*);
402 static void mem_rotate_right (struct mem_node
*);
403 static void mem_delete (struct mem_node
*);
404 static void mem_delete_fixup (struct mem_node
*);
405 static inline struct mem_node
*mem_find (void *);
408 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
409 static void check_gcpros (void);
412 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
418 /* Recording what needs to be marked for gc. */
420 struct gcpro
*gcprolist
;
422 /* Addresses of staticpro'd variables. Initialize it to a nonzero
423 value; otherwise some compilers put it into BSS. */
425 #define NSTATICS 0x650
426 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
428 /* Index of next unused slot in staticvec. */
430 static int staticidx
;
432 static void *pure_alloc (size_t, int);
435 /* Value is SZ rounded up to the next multiple of ALIGNMENT.
436 ALIGNMENT must be a power of 2. */
438 #define ALIGN(ptr, ALIGNMENT) \
439 ((void *) (((uintptr_t) (ptr) + (ALIGNMENT) - 1) \
440 & ~ ((ALIGNMENT) - 1)))
444 /************************************************************************
446 ************************************************************************/
448 /* Function malloc calls this if it finds we are near exhausting storage. */
451 malloc_warning (const char *str
)
453 pending_malloc_warning
= str
;
457 /* Display an already-pending malloc warning. */
460 display_malloc_warning (void)
462 call3 (intern ("display-warning"),
464 build_string (pending_malloc_warning
),
465 intern ("emergency"));
466 pending_malloc_warning
= 0;
469 /* Called if we can't allocate relocatable space for a buffer. */
472 buffer_memory_full (ptrdiff_t nbytes
)
474 /* If buffers use the relocating allocator, no need to free
475 spare_memory, because we may have plenty of malloc space left
476 that we could get, and if we don't, the malloc that fails will
477 itself cause spare_memory to be freed. If buffers don't use the
478 relocating allocator, treat this like any other failing
482 memory_full (nbytes
);
485 /* This used to call error, but if we've run out of memory, we could
486 get infinite recursion trying to build the string. */
487 xsignal (Qnil
, Vmemory_signal_data
);
490 /* A common multiple of the positive integers A and B. Ideally this
491 would be the least common multiple, but there's no way to do that
492 as a constant expression in C, so do the best that we can easily do. */
493 #define COMMON_MULTIPLE(a, b) \
494 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
496 #ifndef XMALLOC_OVERRUN_CHECK
497 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
500 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
503 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
504 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
505 block size in little-endian order. The trailer consists of
506 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
508 The header is used to detect whether this block has been allocated
509 through these functions, as some low-level libc functions may
510 bypass the malloc hooks. */
512 #define XMALLOC_OVERRUN_CHECK_SIZE 16
513 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
514 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
516 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
517 hold a size_t value and (2) the header size is a multiple of the
518 alignment that Emacs needs for C types and for USE_LSB_TAG. */
519 #define XMALLOC_BASE_ALIGNMENT \
520 alignof (union { long double d; intmax_t i; void *p; })
523 # define XMALLOC_HEADER_ALIGNMENT \
524 COMMON_MULTIPLE (1 << GCTYPEBITS, XMALLOC_BASE_ALIGNMENT)
526 # define XMALLOC_HEADER_ALIGNMENT XMALLOC_BASE_ALIGNMENT
528 #define XMALLOC_OVERRUN_SIZE_SIZE \
529 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
530 + XMALLOC_HEADER_ALIGNMENT - 1) \
531 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
532 - XMALLOC_OVERRUN_CHECK_SIZE)
534 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
535 { '\x9a', '\x9b', '\xae', '\xaf',
536 '\xbf', '\xbe', '\xce', '\xcf',
537 '\xea', '\xeb', '\xec', '\xed',
538 '\xdf', '\xde', '\x9c', '\x9d' };
540 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
541 { '\xaa', '\xab', '\xac', '\xad',
542 '\xba', '\xbb', '\xbc', '\xbd',
543 '\xca', '\xcb', '\xcc', '\xcd',
544 '\xda', '\xdb', '\xdc', '\xdd' };
546 /* Insert and extract the block size in the header. */
549 xmalloc_put_size (unsigned char *ptr
, size_t size
)
552 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
554 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
560 xmalloc_get_size (unsigned char *ptr
)
564 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
565 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
574 /* The call depth in overrun_check functions. For example, this might happen:
576 overrun_check_malloc()
577 -> malloc -> (via hook)_-> emacs_blocked_malloc
578 -> overrun_check_malloc
579 call malloc (hooks are NULL, so real malloc is called).
580 malloc returns 10000.
581 add overhead, return 10016.
582 <- (back in overrun_check_malloc)
583 add overhead again, return 10032
584 xmalloc returns 10032.
589 overrun_check_free(10032)
591 free(10016) <- crash, because 10000 is the original pointer. */
593 static ptrdiff_t check_depth
;
595 /* Like malloc, but wraps allocated block with header and trailer. */
598 overrun_check_malloc (size_t size
)
600 register unsigned char *val
;
601 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
602 if (SIZE_MAX
- overhead
< size
)
605 val
= malloc (size
+ overhead
);
606 if (val
&& check_depth
== 1)
608 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
609 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
610 xmalloc_put_size (val
, size
);
611 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
612 XMALLOC_OVERRUN_CHECK_SIZE
);
619 /* Like realloc, but checks old block for overrun, and wraps new block
620 with header and trailer. */
623 overrun_check_realloc (void *block
, size_t size
)
625 register unsigned char *val
= (unsigned char *) block
;
626 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
627 if (SIZE_MAX
- overhead
< size
)
632 && memcmp (xmalloc_overrun_check_header
,
633 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
634 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
636 size_t osize
= xmalloc_get_size (val
);
637 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
638 XMALLOC_OVERRUN_CHECK_SIZE
))
640 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
641 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
642 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
645 val
= realloc (val
, size
+ overhead
);
647 if (val
&& check_depth
== 1)
649 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
650 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
651 xmalloc_put_size (val
, size
);
652 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
653 XMALLOC_OVERRUN_CHECK_SIZE
);
659 /* Like free, but checks block for overrun. */
662 overrun_check_free (void *block
)
664 unsigned char *val
= (unsigned char *) block
;
669 && memcmp (xmalloc_overrun_check_header
,
670 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
671 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
673 size_t osize
= xmalloc_get_size (val
);
674 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
675 XMALLOC_OVERRUN_CHECK_SIZE
))
677 #ifdef XMALLOC_CLEAR_FREE_MEMORY
678 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
679 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
681 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
682 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
683 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
694 #define malloc overrun_check_malloc
695 #define realloc overrun_check_realloc
696 #define free overrun_check_free
700 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
701 there's no need to block input around malloc. */
702 #define MALLOC_BLOCK_INPUT ((void)0)
703 #define MALLOC_UNBLOCK_INPUT ((void)0)
705 #define MALLOC_BLOCK_INPUT BLOCK_INPUT
706 #define MALLOC_UNBLOCK_INPUT UNBLOCK_INPUT
709 /* Like malloc but check for no memory and block interrupt input.. */
712 xmalloc (size_t size
)
718 MALLOC_UNBLOCK_INPUT
;
725 /* Like the above, but zeroes out the memory just allocated. */
728 xzalloc (size_t size
)
734 MALLOC_UNBLOCK_INPUT
;
738 memset (val
, 0, size
);
742 /* Like realloc but check for no memory and block interrupt input.. */
745 xrealloc (void *block
, size_t size
)
750 /* We must call malloc explicitly when BLOCK is 0, since some
751 reallocs don't do this. */
755 val
= realloc (block
, size
);
756 MALLOC_UNBLOCK_INPUT
;
764 /* Like free but block interrupt input. */
773 MALLOC_UNBLOCK_INPUT
;
774 /* We don't call refill_memory_reserve here
775 because that duplicates doing so in emacs_blocked_free
776 and the criterion should go there. */
780 /* Other parts of Emacs pass large int values to allocator functions
781 expecting ptrdiff_t. This is portable in practice, but check it to
783 verify (INT_MAX
<= PTRDIFF_MAX
);
786 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
787 Signal an error on memory exhaustion, and block interrupt input. */
790 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
792 eassert (0 <= nitems
&& 0 < item_size
);
793 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
794 memory_full (SIZE_MAX
);
795 return xmalloc (nitems
* item_size
);
799 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
800 Signal an error on memory exhaustion, and block interrupt input. */
803 xnrealloc (void *pa
, 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 xrealloc (pa
, nitems
* item_size
);
812 /* Grow PA, which points to an array of *NITEMS items, and return the
813 location of the reallocated array, updating *NITEMS to reflect its
814 new size. The new array will contain at least NITEMS_INCR_MIN more
815 items, but will not contain more than NITEMS_MAX items total.
816 ITEM_SIZE is the size of each item, in bytes.
818 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
819 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
822 If PA is null, then allocate a new array instead of reallocating
823 the old one. Thus, to grow an array A without saving its old
824 contents, invoke xfree (A) immediately followed by xgrowalloc (0,
827 Block interrupt input as needed. If memory exhaustion occurs, set
828 *NITEMS to zero if PA is null, and signal an error (i.e., do not
832 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
833 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
835 /* The approximate size to use for initial small allocation
836 requests. This is the largest "small" request for the GNU C
838 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
840 /* If the array is tiny, grow it to about (but no greater than)
841 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
842 ptrdiff_t n
= *nitems
;
843 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
844 ptrdiff_t half_again
= n
>> 1;
845 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
847 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
848 NITEMS_MAX, and what the C language can represent safely. */
849 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
850 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
851 ? nitems_max
: C_language_max
);
852 ptrdiff_t nitems_incr_max
= n_max
- n
;
853 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
855 eassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
858 if (nitems_incr_max
< incr
)
859 memory_full (SIZE_MAX
);
861 pa
= xrealloc (pa
, n
* item_size
);
867 /* Like strdup, but uses xmalloc. */
870 xstrdup (const char *s
)
872 size_t len
= strlen (s
) + 1;
873 char *p
= xmalloc (len
);
879 /* Unwind for SAFE_ALLOCA */
882 safe_alloca_unwind (Lisp_Object arg
)
884 register struct Lisp_Save_Value
*p
= XSAVE_VALUE (arg
);
893 /* Return a newly allocated memory block of SIZE bytes, remembering
894 to free it when unwinding. */
896 record_xmalloc (size_t size
)
898 void *p
= xmalloc (size
);
899 record_unwind_protect (safe_alloca_unwind
, make_save_value (p
, 0));
904 /* Like malloc but used for allocating Lisp data. NBYTES is the
905 number of bytes to allocate, TYPE describes the intended use of the
906 allocated memory block (for strings, for conses, ...). */
909 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
913 lisp_malloc (size_t nbytes
, enum mem_type type
)
919 #ifdef GC_MALLOC_CHECK
920 allocated_mem_type
= type
;
923 val
= malloc (nbytes
);
926 /* If the memory just allocated cannot be addressed thru a Lisp
927 object's pointer, and it needs to be,
928 that's equivalent to running out of memory. */
929 if (val
&& type
!= MEM_TYPE_NON_LISP
)
932 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
933 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
935 lisp_malloc_loser
= val
;
942 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
943 if (val
&& type
!= MEM_TYPE_NON_LISP
)
944 mem_insert (val
, (char *) val
+ nbytes
, type
);
947 MALLOC_UNBLOCK_INPUT
;
949 memory_full (nbytes
);
953 /* Free BLOCK. This must be called to free memory allocated with a
954 call to lisp_malloc. */
957 lisp_free (void *block
)
961 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
962 mem_delete (mem_find (block
));
964 MALLOC_UNBLOCK_INPUT
;
967 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
969 /* The entry point is lisp_align_malloc which returns blocks of at most
970 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
972 #if defined (HAVE_POSIX_MEMALIGN) && defined (SYSTEM_MALLOC)
973 #define USE_POSIX_MEMALIGN 1
976 /* BLOCK_ALIGN has to be a power of 2. */
977 #define BLOCK_ALIGN (1 << 10)
979 /* Padding to leave at the end of a malloc'd block. This is to give
980 malloc a chance to minimize the amount of memory wasted to alignment.
981 It should be tuned to the particular malloc library used.
982 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
983 posix_memalign on the other hand would ideally prefer a value of 4
984 because otherwise, there's 1020 bytes wasted between each ablocks.
985 In Emacs, testing shows that those 1020 can most of the time be
986 efficiently used by malloc to place other objects, so a value of 0 can
987 still preferable unless you have a lot of aligned blocks and virtually
989 #define BLOCK_PADDING 0
990 #define BLOCK_BYTES \
991 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
993 /* Internal data structures and constants. */
995 #define ABLOCKS_SIZE 16
997 /* An aligned block of memory. */
1002 char payload
[BLOCK_BYTES
];
1003 struct ablock
*next_free
;
1005 /* `abase' is the aligned base of the ablocks. */
1006 /* It is overloaded to hold the virtual `busy' field that counts
1007 the number of used ablock in the parent ablocks.
1008 The first ablock has the `busy' field, the others have the `abase'
1009 field. To tell the difference, we assume that pointers will have
1010 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1011 is used to tell whether the real base of the parent ablocks is `abase'
1012 (if not, the word before the first ablock holds a pointer to the
1014 struct ablocks
*abase
;
1015 /* The padding of all but the last ablock is unused. The padding of
1016 the last ablock in an ablocks is not allocated. */
1018 char padding
[BLOCK_PADDING
];
1022 /* A bunch of consecutive aligned blocks. */
1025 struct ablock blocks
[ABLOCKS_SIZE
];
1028 /* Size of the block requested from malloc or posix_memalign. */
1029 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1031 #define ABLOCK_ABASE(block) \
1032 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1033 ? (struct ablocks *)(block) \
1036 /* Virtual `busy' field. */
1037 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1039 /* Pointer to the (not necessarily aligned) malloc block. */
1040 #ifdef USE_POSIX_MEMALIGN
1041 #define ABLOCKS_BASE(abase) (abase)
1043 #define ABLOCKS_BASE(abase) \
1044 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void**)abase)[-1])
1047 /* The list of free ablock. */
1048 static struct ablock
*free_ablock
;
1050 /* Allocate an aligned block of nbytes.
1051 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1052 smaller or equal to BLOCK_BYTES. */
1054 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1057 struct ablocks
*abase
;
1059 eassert (nbytes
<= BLOCK_BYTES
);
1063 #ifdef GC_MALLOC_CHECK
1064 allocated_mem_type
= type
;
1070 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1072 #ifdef DOUG_LEA_MALLOC
1073 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1074 because mapped region contents are not preserved in
1076 mallopt (M_MMAP_MAX
, 0);
1079 #ifdef USE_POSIX_MEMALIGN
1081 int err
= posix_memalign (&base
, BLOCK_ALIGN
, ABLOCKS_BYTES
);
1087 base
= malloc (ABLOCKS_BYTES
);
1088 abase
= ALIGN (base
, BLOCK_ALIGN
);
1093 MALLOC_UNBLOCK_INPUT
;
1094 memory_full (ABLOCKS_BYTES
);
1097 aligned
= (base
== abase
);
1099 ((void**)abase
)[-1] = base
;
1101 #ifdef DOUG_LEA_MALLOC
1102 /* Back to a reasonable maximum of mmap'ed areas. */
1103 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1107 /* If the memory just allocated cannot be addressed thru a Lisp
1108 object's pointer, and it needs to be, that's equivalent to
1109 running out of memory. */
1110 if (type
!= MEM_TYPE_NON_LISP
)
1113 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1114 XSETCONS (tem
, end
);
1115 if ((char *) XCONS (tem
) != end
)
1117 lisp_malloc_loser
= base
;
1119 MALLOC_UNBLOCK_INPUT
;
1120 memory_full (SIZE_MAX
);
1125 /* Initialize the blocks and put them on the free list.
1126 If `base' was not properly aligned, we can't use the last block. */
1127 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1129 abase
->blocks
[i
].abase
= abase
;
1130 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1131 free_ablock
= &abase
->blocks
[i
];
1133 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1135 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1136 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1137 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1138 eassert (ABLOCKS_BASE (abase
) == base
);
1139 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1142 abase
= ABLOCK_ABASE (free_ablock
);
1143 ABLOCKS_BUSY (abase
) =
1144 (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1146 free_ablock
= free_ablock
->x
.next_free
;
1148 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1149 if (type
!= MEM_TYPE_NON_LISP
)
1150 mem_insert (val
, (char *) val
+ nbytes
, type
);
1153 MALLOC_UNBLOCK_INPUT
;
1155 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1160 lisp_align_free (void *block
)
1162 struct ablock
*ablock
= block
;
1163 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1166 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1167 mem_delete (mem_find (block
));
1169 /* Put on free list. */
1170 ablock
->x
.next_free
= free_ablock
;
1171 free_ablock
= ablock
;
1172 /* Update busy count. */
1173 ABLOCKS_BUSY (abase
)
1174 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1176 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1177 { /* All the blocks are free. */
1178 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1179 struct ablock
**tem
= &free_ablock
;
1180 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1184 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1187 *tem
= (*tem
)->x
.next_free
;
1190 tem
= &(*tem
)->x
.next_free
;
1192 eassert ((aligned
& 1) == aligned
);
1193 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1194 #ifdef USE_POSIX_MEMALIGN
1195 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1197 free (ABLOCKS_BASE (abase
));
1199 MALLOC_UNBLOCK_INPUT
;
1203 #ifndef SYSTEM_MALLOC
1205 /* Arranging to disable input signals while we're in malloc.
1207 This only works with GNU malloc. To help out systems which can't
1208 use GNU malloc, all the calls to malloc, realloc, and free
1209 elsewhere in the code should be inside a BLOCK_INPUT/UNBLOCK_INPUT
1210 pair; unfortunately, we have no idea what C library functions
1211 might call malloc, so we can't really protect them unless you're
1212 using GNU malloc. Fortunately, most of the major operating systems
1213 can use GNU malloc. */
1216 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
1217 there's no need to block input around malloc. */
1219 #ifndef DOUG_LEA_MALLOC
1220 extern void * (*__malloc_hook
) (size_t, const void *);
1221 extern void * (*__realloc_hook
) (void *, size_t, const void *);
1222 extern void (*__free_hook
) (void *, const void *);
1223 /* Else declared in malloc.h, perhaps with an extra arg. */
1224 #endif /* DOUG_LEA_MALLOC */
1225 static void * (*old_malloc_hook
) (size_t, const void *);
1226 static void * (*old_realloc_hook
) (void *, size_t, const void*);
1227 static void (*old_free_hook
) (void*, const void*);
1229 #ifdef DOUG_LEA_MALLOC
1230 # define BYTES_USED (mallinfo ().uordblks)
1232 # define BYTES_USED _bytes_used
1235 #ifdef GC_MALLOC_CHECK
1236 static int dont_register_blocks
;
1239 static size_t bytes_used_when_reconsidered
;
1241 /* Value of _bytes_used, when spare_memory was freed. */
1243 static size_t bytes_used_when_full
;
1245 /* This function is used as the hook for free to call. */
1248 emacs_blocked_free (void *ptr
, const void *ptr2
)
1252 #ifdef GC_MALLOC_CHECK
1258 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1261 "Freeing `%p' which wasn't allocated with malloc\n", ptr
);
1266 /* fprintf (stderr, "free %p...%p (%p)\n", m->start, m->end, ptr); */
1270 #endif /* GC_MALLOC_CHECK */
1272 __free_hook
= old_free_hook
;
1275 /* If we released our reserve (due to running out of memory),
1276 and we have a fair amount free once again,
1277 try to set aside another reserve in case we run out once more. */
1278 if (! NILP (Vmemory_full
)
1279 /* Verify there is enough space that even with the malloc
1280 hysteresis this call won't run out again.
1281 The code here is correct as long as SPARE_MEMORY
1282 is substantially larger than the block size malloc uses. */
1283 && (bytes_used_when_full
1284 > ((bytes_used_when_reconsidered
= BYTES_USED
)
1285 + max (malloc_hysteresis
, 4) * SPARE_MEMORY
)))
1286 refill_memory_reserve ();
1288 __free_hook
= emacs_blocked_free
;
1289 UNBLOCK_INPUT_ALLOC
;
1293 /* This function is the malloc hook that Emacs uses. */
1296 emacs_blocked_malloc (size_t size
, const void *ptr
)
1301 __malloc_hook
= old_malloc_hook
;
1302 #ifdef DOUG_LEA_MALLOC
1303 /* Segfaults on my system. --lorentey */
1304 /* mallopt (M_TOP_PAD, malloc_hysteresis * 4096); */
1306 __malloc_extra_blocks
= malloc_hysteresis
;
1309 value
= malloc (size
);
1311 #ifdef GC_MALLOC_CHECK
1313 struct mem_node
*m
= mem_find (value
);
1316 fprintf (stderr
, "Malloc returned %p which is already in use\n",
1318 fprintf (stderr
, "Region in use is %p...%p, %td bytes, type %d\n",
1319 m
->start
, m
->end
, (char *) m
->end
- (char *) m
->start
,
1324 if (!dont_register_blocks
)
1326 mem_insert (value
, (char *) value
+ max (1, size
), allocated_mem_type
);
1327 allocated_mem_type
= MEM_TYPE_NON_LISP
;
1330 #endif /* GC_MALLOC_CHECK */
1332 __malloc_hook
= emacs_blocked_malloc
;
1333 UNBLOCK_INPUT_ALLOC
;
1335 /* fprintf (stderr, "%p malloc\n", value); */
1340 /* This function is the realloc hook that Emacs uses. */
1343 emacs_blocked_realloc (void *ptr
, size_t size
, const void *ptr2
)
1348 __realloc_hook
= old_realloc_hook
;
1350 #ifdef GC_MALLOC_CHECK
1353 struct mem_node
*m
= mem_find (ptr
);
1354 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1357 "Realloc of %p which wasn't allocated with malloc\n",
1365 /* fprintf (stderr, "%p -> realloc\n", ptr); */
1367 /* Prevent malloc from registering blocks. */
1368 dont_register_blocks
= 1;
1369 #endif /* GC_MALLOC_CHECK */
1371 value
= realloc (ptr
, size
);
1373 #ifdef GC_MALLOC_CHECK
1374 dont_register_blocks
= 0;
1377 struct mem_node
*m
= mem_find (value
);
1380 fprintf (stderr
, "Realloc returns memory that is already in use\n");
1384 /* Can't handle zero size regions in the red-black tree. */
1385 mem_insert (value
, (char *) value
+ max (size
, 1), MEM_TYPE_NON_LISP
);
1388 /* fprintf (stderr, "%p <- realloc\n", value); */
1389 #endif /* GC_MALLOC_CHECK */
1391 __realloc_hook
= emacs_blocked_realloc
;
1392 UNBLOCK_INPUT_ALLOC
;
1399 /* Called from Fdump_emacs so that when the dumped Emacs starts, it has a
1400 normal malloc. Some thread implementations need this as they call
1401 malloc before main. The pthread_self call in BLOCK_INPUT_ALLOC then
1402 calls malloc because it is the first call, and we have an endless loop. */
1405 reset_malloc_hooks (void)
1407 __free_hook
= old_free_hook
;
1408 __malloc_hook
= old_malloc_hook
;
1409 __realloc_hook
= old_realloc_hook
;
1411 #endif /* HAVE_PTHREAD */
1414 /* Called from main to set up malloc to use our hooks. */
1417 uninterrupt_malloc (void)
1420 #ifdef DOUG_LEA_MALLOC
1421 pthread_mutexattr_t attr
;
1423 /* GLIBC has a faster way to do this, but let's keep it portable.
1424 This is according to the Single UNIX Specification. */
1425 pthread_mutexattr_init (&attr
);
1426 pthread_mutexattr_settype (&attr
, PTHREAD_MUTEX_RECURSIVE
);
1427 pthread_mutex_init (&alloc_mutex
, &attr
);
1428 #else /* !DOUG_LEA_MALLOC */
1429 /* Some systems such as Solaris 2.6 don't have a recursive mutex,
1430 and the bundled gmalloc.c doesn't require it. */
1431 pthread_mutex_init (&alloc_mutex
, NULL
);
1432 #endif /* !DOUG_LEA_MALLOC */
1433 #endif /* HAVE_PTHREAD */
1435 if (__free_hook
!= emacs_blocked_free
)
1436 old_free_hook
= __free_hook
;
1437 __free_hook
= emacs_blocked_free
;
1439 if (__malloc_hook
!= emacs_blocked_malloc
)
1440 old_malloc_hook
= __malloc_hook
;
1441 __malloc_hook
= emacs_blocked_malloc
;
1443 if (__realloc_hook
!= emacs_blocked_realloc
)
1444 old_realloc_hook
= __realloc_hook
;
1445 __realloc_hook
= emacs_blocked_realloc
;
1448 #endif /* not SYNC_INPUT */
1449 #endif /* not SYSTEM_MALLOC */
1453 /***********************************************************************
1455 ***********************************************************************/
1457 /* Number of intervals allocated in an interval_block structure.
1458 The 1020 is 1024 minus malloc overhead. */
1460 #define INTERVAL_BLOCK_SIZE \
1461 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1463 /* Intervals are allocated in chunks in form of an interval_block
1466 struct interval_block
1468 /* Place `intervals' first, to preserve alignment. */
1469 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1470 struct interval_block
*next
;
1473 /* Current interval block. Its `next' pointer points to older
1476 static struct interval_block
*interval_block
;
1478 /* Index in interval_block above of the next unused interval
1481 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1483 /* Number of free and live intervals. */
1485 static EMACS_INT total_free_intervals
, total_intervals
;
1487 /* List of free intervals. */
1489 static INTERVAL interval_free_list
;
1491 /* Return a new interval. */
1494 make_interval (void)
1498 /* eassert (!handling_signal); */
1502 if (interval_free_list
)
1504 val
= interval_free_list
;
1505 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1509 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1511 struct interval_block
*newi
1512 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1514 newi
->next
= interval_block
;
1515 interval_block
= newi
;
1516 interval_block_index
= 0;
1517 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1519 val
= &interval_block
->intervals
[interval_block_index
++];
1522 MALLOC_UNBLOCK_INPUT
;
1524 consing_since_gc
+= sizeof (struct interval
);
1526 total_free_intervals
--;
1527 RESET_INTERVAL (val
);
1533 /* Mark Lisp objects in interval I. */
1536 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1538 /* Intervals should never be shared. So, if extra internal checking is
1539 enabled, GC aborts if it seems to have visited an interval twice. */
1540 eassert (!i
->gcmarkbit
);
1542 mark_object (i
->plist
);
1546 /* Mark the interval tree rooted in TREE. Don't call this directly;
1547 use the macro MARK_INTERVAL_TREE instead. */
1550 mark_interval_tree (register INTERVAL tree
)
1552 /* No need to test if this tree has been marked already; this
1553 function is always called through the MARK_INTERVAL_TREE macro,
1554 which takes care of that. */
1556 traverse_intervals_noorder (tree
, mark_interval
, Qnil
);
1560 /* Mark the interval tree rooted in I. */
1562 #define MARK_INTERVAL_TREE(i) \
1564 if (!NULL_INTERVAL_P (i) && !i->gcmarkbit) \
1565 mark_interval_tree (i); \
1569 #define UNMARK_BALANCE_INTERVALS(i) \
1571 if (! NULL_INTERVAL_P (i)) \
1572 (i) = balance_intervals (i); \
1575 /***********************************************************************
1577 ***********************************************************************/
1579 /* Lisp_Strings are allocated in string_block structures. When a new
1580 string_block is allocated, all the Lisp_Strings it contains are
1581 added to a free-list string_free_list. When a new Lisp_String is
1582 needed, it is taken from that list. During the sweep phase of GC,
1583 string_blocks that are entirely free are freed, except two which
1586 String data is allocated from sblock structures. Strings larger
1587 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1588 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1590 Sblocks consist internally of sdata structures, one for each
1591 Lisp_String. The sdata structure points to the Lisp_String it
1592 belongs to. The Lisp_String points back to the `u.data' member of
1593 its sdata structure.
1595 When a Lisp_String is freed during GC, it is put back on
1596 string_free_list, and its `data' member and its sdata's `string'
1597 pointer is set to null. The size of the string is recorded in the
1598 `u.nbytes' member of the sdata. So, sdata structures that are no
1599 longer used, can be easily recognized, and it's easy to compact the
1600 sblocks of small strings which we do in compact_small_strings. */
1602 /* Size in bytes of an sblock structure used for small strings. This
1603 is 8192 minus malloc overhead. */
1605 #define SBLOCK_SIZE 8188
1607 /* Strings larger than this are considered large strings. String data
1608 for large strings is allocated from individual sblocks. */
1610 #define LARGE_STRING_BYTES 1024
1612 /* Structure describing string memory sub-allocated from an sblock.
1613 This is where the contents of Lisp strings are stored. */
1617 /* Back-pointer to the string this sdata belongs to. If null, this
1618 structure is free, and the NBYTES member of the union below
1619 contains the string's byte size (the same value that STRING_BYTES
1620 would return if STRING were non-null). If non-null, STRING_BYTES
1621 (STRING) is the size of the data, and DATA contains the string's
1623 struct Lisp_String
*string
;
1625 #ifdef GC_CHECK_STRING_BYTES
1628 unsigned char data
[1];
1630 #define SDATA_NBYTES(S) (S)->nbytes
1631 #define SDATA_DATA(S) (S)->data
1632 #define SDATA_SELECTOR(member) member
1634 #else /* not GC_CHECK_STRING_BYTES */
1638 /* When STRING is non-null. */
1639 unsigned char data
[1];
1641 /* When STRING is null. */
1645 #define SDATA_NBYTES(S) (S)->u.nbytes
1646 #define SDATA_DATA(S) (S)->u.data
1647 #define SDATA_SELECTOR(member) u.member
1649 #endif /* not GC_CHECK_STRING_BYTES */
1651 #define SDATA_DATA_OFFSET offsetof (struct sdata, SDATA_SELECTOR (data))
1655 /* Structure describing a block of memory which is sub-allocated to
1656 obtain string data memory for strings. Blocks for small strings
1657 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1658 as large as needed. */
1663 struct sblock
*next
;
1665 /* Pointer to the next free sdata block. This points past the end
1666 of the sblock if there isn't any space left in this block. */
1667 struct sdata
*next_free
;
1669 /* Start of data. */
1670 struct sdata first_data
;
1673 /* Number of Lisp strings in a string_block structure. The 1020 is
1674 1024 minus malloc overhead. */
1676 #define STRING_BLOCK_SIZE \
1677 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1679 /* Structure describing a block from which Lisp_String structures
1684 /* Place `strings' first, to preserve alignment. */
1685 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1686 struct string_block
*next
;
1689 /* Head and tail of the list of sblock structures holding Lisp string
1690 data. We always allocate from current_sblock. The NEXT pointers
1691 in the sblock structures go from oldest_sblock to current_sblock. */
1693 static struct sblock
*oldest_sblock
, *current_sblock
;
1695 /* List of sblocks for large strings. */
1697 static struct sblock
*large_sblocks
;
1699 /* List of string_block structures. */
1701 static struct string_block
*string_blocks
;
1703 /* Free-list of Lisp_Strings. */
1705 static struct Lisp_String
*string_free_list
;
1707 /* Number of live and free Lisp_Strings. */
1709 static EMACS_INT total_strings
, total_free_strings
;
1711 /* Number of bytes used by live strings. */
1713 static EMACS_INT total_string_bytes
;
1715 /* Given a pointer to a Lisp_String S which is on the free-list
1716 string_free_list, return a pointer to its successor in the
1719 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1721 /* Return a pointer to the sdata structure belonging to Lisp string S.
1722 S must be live, i.e. S->data must not be null. S->data is actually
1723 a pointer to the `u.data' member of its sdata structure; the
1724 structure starts at a constant offset in front of that. */
1726 #define SDATA_OF_STRING(S) ((struct sdata *) ((S)->data - SDATA_DATA_OFFSET))
1729 #ifdef GC_CHECK_STRING_OVERRUN
1731 /* We check for overrun in string data blocks by appending a small
1732 "cookie" after each allocated string data block, and check for the
1733 presence of this cookie during GC. */
1735 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1736 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1737 { '\xde', '\xad', '\xbe', '\xef' };
1740 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1743 /* Value is the size of an sdata structure large enough to hold NBYTES
1744 bytes of string data. The value returned includes a terminating
1745 NUL byte, the size of the sdata structure, and padding. */
1747 #ifdef GC_CHECK_STRING_BYTES
1749 #define SDATA_SIZE(NBYTES) \
1750 ((SDATA_DATA_OFFSET \
1752 + sizeof (ptrdiff_t) - 1) \
1753 & ~(sizeof (ptrdiff_t) - 1))
1755 #else /* not GC_CHECK_STRING_BYTES */
1757 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1758 less than the size of that member. The 'max' is not needed when
1759 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1760 alignment code reserves enough space. */
1762 #define SDATA_SIZE(NBYTES) \
1763 ((SDATA_DATA_OFFSET \
1764 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1766 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1768 + sizeof (ptrdiff_t) - 1) \
1769 & ~(sizeof (ptrdiff_t) - 1))
1771 #endif /* not GC_CHECK_STRING_BYTES */
1773 /* Extra bytes to allocate for each string. */
1775 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1777 /* Exact bound on the number of bytes in a string, not counting the
1778 terminating null. A string cannot contain more bytes than
1779 STRING_BYTES_BOUND, nor can it be so long that the size_t
1780 arithmetic in allocate_string_data would overflow while it is
1781 calculating a value to be passed to malloc. */
1782 static ptrdiff_t const STRING_BYTES_MAX
=
1783 min (STRING_BYTES_BOUND
,
1784 ((SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
1786 - offsetof (struct sblock
, first_data
)
1787 - SDATA_DATA_OFFSET
)
1788 & ~(sizeof (EMACS_INT
) - 1)));
1790 /* Initialize string allocation. Called from init_alloc_once. */
1795 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1796 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1800 #ifdef GC_CHECK_STRING_BYTES
1802 static int check_string_bytes_count
;
1804 /* Like STRING_BYTES, but with debugging check. Can be
1805 called during GC, so pay attention to the mark bit. */
1808 string_bytes (struct Lisp_String
*s
)
1811 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1813 if (!PURE_POINTER_P (s
)
1815 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1820 /* Check validity of Lisp strings' string_bytes member in B. */
1823 check_sblock (struct sblock
*b
)
1825 struct sdata
*from
, *end
, *from_end
;
1829 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1831 /* Compute the next FROM here because copying below may
1832 overwrite data we need to compute it. */
1835 /* Check that the string size recorded in the string is the
1836 same as the one recorded in the sdata structure. */
1837 nbytes
= SDATA_SIZE (from
->string
? string_bytes (from
->string
)
1838 : SDATA_NBYTES (from
));
1839 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1844 /* Check validity of Lisp strings' string_bytes member. ALL_P
1845 non-zero means check all strings, otherwise check only most
1846 recently allocated strings. Used for hunting a bug. */
1849 check_string_bytes (int all_p
)
1855 for (b
= large_sblocks
; b
; b
= b
->next
)
1857 struct Lisp_String
*s
= b
->first_data
.string
;
1862 for (b
= oldest_sblock
; b
; b
= b
->next
)
1865 else if (current_sblock
)
1866 check_sblock (current_sblock
);
1869 #else /* not GC_CHECK_STRING_BYTES */
1871 #define check_string_bytes(all) ((void) 0)
1873 #endif /* GC_CHECK_STRING_BYTES */
1875 #ifdef GC_CHECK_STRING_FREE_LIST
1877 /* Walk through the string free list looking for bogus next pointers.
1878 This may catch buffer overrun from a previous string. */
1881 check_string_free_list (void)
1883 struct Lisp_String
*s
;
1885 /* Pop a Lisp_String off the free-list. */
1886 s
= string_free_list
;
1889 if ((uintptr_t) s
< 1024)
1891 s
= NEXT_FREE_LISP_STRING (s
);
1895 #define check_string_free_list()
1898 /* Return a new Lisp_String. */
1900 static struct Lisp_String
*
1901 allocate_string (void)
1903 struct Lisp_String
*s
;
1905 /* eassert (!handling_signal); */
1909 /* If the free-list is empty, allocate a new string_block, and
1910 add all the Lisp_Strings in it to the free-list. */
1911 if (string_free_list
== NULL
)
1913 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1916 b
->next
= string_blocks
;
1919 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1922 /* Every string on a free list should have NULL data pointer. */
1924 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1925 string_free_list
= s
;
1928 total_free_strings
+= STRING_BLOCK_SIZE
;
1931 check_string_free_list ();
1933 /* Pop a Lisp_String off the free-list. */
1934 s
= string_free_list
;
1935 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1937 MALLOC_UNBLOCK_INPUT
;
1939 --total_free_strings
;
1942 consing_since_gc
+= sizeof *s
;
1944 #ifdef GC_CHECK_STRING_BYTES
1945 if (!noninteractive
)
1947 if (++check_string_bytes_count
== 200)
1949 check_string_bytes_count
= 0;
1950 check_string_bytes (1);
1953 check_string_bytes (0);
1955 #endif /* GC_CHECK_STRING_BYTES */
1961 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1962 plus a NUL byte at the end. Allocate an sdata structure for S, and
1963 set S->data to its `u.data' member. Store a NUL byte at the end of
1964 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1965 S->data if it was initially non-null. */
1968 allocate_string_data (struct Lisp_String
*s
,
1969 EMACS_INT nchars
, EMACS_INT nbytes
)
1971 struct sdata
*data
, *old_data
;
1973 ptrdiff_t needed
, old_nbytes
;
1975 if (STRING_BYTES_MAX
< nbytes
)
1978 /* Determine the number of bytes needed to store NBYTES bytes
1980 needed
= SDATA_SIZE (nbytes
);
1983 old_data
= SDATA_OF_STRING (s
);
1984 old_nbytes
= STRING_BYTES (s
);
1991 if (nbytes
> LARGE_STRING_BYTES
)
1993 size_t size
= offsetof (struct sblock
, first_data
) + needed
;
1995 #ifdef DOUG_LEA_MALLOC
1996 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1997 because mapped region contents are not preserved in
2000 In case you think of allowing it in a dumped Emacs at the
2001 cost of not being able to re-dump, there's another reason:
2002 mmap'ed data typically have an address towards the top of the
2003 address space, which won't fit into an EMACS_INT (at least on
2004 32-bit systems with the current tagging scheme). --fx */
2005 mallopt (M_MMAP_MAX
, 0);
2008 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
2010 #ifdef DOUG_LEA_MALLOC
2011 /* Back to a reasonable maximum of mmap'ed areas. */
2012 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2015 b
->next_free
= &b
->first_data
;
2016 b
->first_data
.string
= NULL
;
2017 b
->next
= large_sblocks
;
2020 else if (current_sblock
== NULL
2021 || (((char *) current_sblock
+ SBLOCK_SIZE
2022 - (char *) current_sblock
->next_free
)
2023 < (needed
+ GC_STRING_EXTRA
)))
2025 /* Not enough room in the current sblock. */
2026 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
2027 b
->next_free
= &b
->first_data
;
2028 b
->first_data
.string
= NULL
;
2032 current_sblock
->next
= b
;
2040 data
= b
->next_free
;
2041 b
->next_free
= (struct sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
2043 MALLOC_UNBLOCK_INPUT
;
2046 s
->data
= SDATA_DATA (data
);
2047 #ifdef GC_CHECK_STRING_BYTES
2048 SDATA_NBYTES (data
) = nbytes
;
2051 s
->size_byte
= nbytes
;
2052 s
->data
[nbytes
] = '\0';
2053 #ifdef GC_CHECK_STRING_OVERRUN
2054 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
2055 GC_STRING_OVERRUN_COOKIE_SIZE
);
2058 /* Note that Faset may call to this function when S has already data
2059 assigned. In this case, mark data as free by setting it's string
2060 back-pointer to null, and record the size of the data in it. */
2063 SDATA_NBYTES (old_data
) = old_nbytes
;
2064 old_data
->string
= NULL
;
2067 consing_since_gc
+= needed
;
2071 /* Sweep and compact strings. */
2074 sweep_strings (void)
2076 struct string_block
*b
, *next
;
2077 struct string_block
*live_blocks
= NULL
;
2079 string_free_list
= NULL
;
2080 total_strings
= total_free_strings
= 0;
2081 total_string_bytes
= 0;
2083 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
2084 for (b
= string_blocks
; b
; b
= next
)
2087 struct Lisp_String
*free_list_before
= string_free_list
;
2091 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
2093 struct Lisp_String
*s
= b
->strings
+ i
;
2097 /* String was not on free-list before. */
2098 if (STRING_MARKED_P (s
))
2100 /* String is live; unmark it and its intervals. */
2103 if (!NULL_INTERVAL_P (s
->intervals
))
2104 UNMARK_BALANCE_INTERVALS (s
->intervals
);
2107 total_string_bytes
+= STRING_BYTES (s
);
2111 /* String is dead. Put it on the free-list. */
2112 struct sdata
*data
= SDATA_OF_STRING (s
);
2114 /* Save the size of S in its sdata so that we know
2115 how large that is. Reset the sdata's string
2116 back-pointer so that we know it's free. */
2117 #ifdef GC_CHECK_STRING_BYTES
2118 if (string_bytes (s
) != SDATA_NBYTES (data
))
2121 data
->u
.nbytes
= STRING_BYTES (s
);
2123 data
->string
= NULL
;
2125 /* Reset the strings's `data' member so that we
2129 /* Put the string on the free-list. */
2130 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2131 string_free_list
= s
;
2137 /* S was on the free-list before. Put it there again. */
2138 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2139 string_free_list
= s
;
2144 /* Free blocks that contain free Lisp_Strings only, except
2145 the first two of them. */
2146 if (nfree
== STRING_BLOCK_SIZE
2147 && total_free_strings
> STRING_BLOCK_SIZE
)
2150 string_free_list
= free_list_before
;
2154 total_free_strings
+= nfree
;
2155 b
->next
= live_blocks
;
2160 check_string_free_list ();
2162 string_blocks
= live_blocks
;
2163 free_large_strings ();
2164 compact_small_strings ();
2166 check_string_free_list ();
2170 /* Free dead large strings. */
2173 free_large_strings (void)
2175 struct sblock
*b
, *next
;
2176 struct sblock
*live_blocks
= NULL
;
2178 for (b
= large_sblocks
; b
; b
= next
)
2182 if (b
->first_data
.string
== NULL
)
2186 b
->next
= live_blocks
;
2191 large_sblocks
= live_blocks
;
2195 /* Compact data of small strings. Free sblocks that don't contain
2196 data of live strings after compaction. */
2199 compact_small_strings (void)
2201 struct sblock
*b
, *tb
, *next
;
2202 struct sdata
*from
, *to
, *end
, *tb_end
;
2203 struct sdata
*to_end
, *from_end
;
2205 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2206 to, and TB_END is the end of TB. */
2208 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2209 to
= &tb
->first_data
;
2211 /* Step through the blocks from the oldest to the youngest. We
2212 expect that old blocks will stabilize over time, so that less
2213 copying will happen this way. */
2214 for (b
= oldest_sblock
; b
; b
= b
->next
)
2217 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2219 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
2221 /* Compute the next FROM here because copying below may
2222 overwrite data we need to compute it. */
2224 struct Lisp_String
*s
= from
->string
;
2226 #ifdef GC_CHECK_STRING_BYTES
2227 /* Check that the string size recorded in the string is the
2228 same as the one recorded in the sdata structure. */
2229 if (s
&& string_bytes (s
) != SDATA_NBYTES (from
))
2231 #endif /* GC_CHECK_STRING_BYTES */
2233 nbytes
= s
? STRING_BYTES (s
) : SDATA_NBYTES (from
);
2234 eassert (nbytes
<= LARGE_STRING_BYTES
);
2236 nbytes
= SDATA_SIZE (nbytes
);
2237 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2239 #ifdef GC_CHECK_STRING_OVERRUN
2240 if (memcmp (string_overrun_cookie
,
2241 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2242 GC_STRING_OVERRUN_COOKIE_SIZE
))
2246 /* Non-NULL S means it's alive. Copy its data. */
2249 /* If TB is full, proceed with the next sblock. */
2250 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2251 if (to_end
> tb_end
)
2255 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2256 to
= &tb
->first_data
;
2257 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2260 /* Copy, and update the string's `data' pointer. */
2263 eassert (tb
!= b
|| to
< from
);
2264 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2265 to
->string
->data
= SDATA_DATA (to
);
2268 /* Advance past the sdata we copied to. */
2274 /* The rest of the sblocks following TB don't contain live data, so
2275 we can free them. */
2276 for (b
= tb
->next
; b
; b
= next
)
2284 current_sblock
= tb
;
2288 string_overflow (void)
2290 error ("Maximum string size exceeded");
2293 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2294 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2295 LENGTH must be an integer.
2296 INIT must be an integer that represents a character. */)
2297 (Lisp_Object length
, Lisp_Object init
)
2299 register Lisp_Object val
;
2300 register unsigned char *p
, *end
;
2304 CHECK_NATNUM (length
);
2305 CHECK_CHARACTER (init
);
2307 c
= XFASTINT (init
);
2308 if (ASCII_CHAR_P (c
))
2310 nbytes
= XINT (length
);
2311 val
= make_uninit_string (nbytes
);
2313 end
= p
+ SCHARS (val
);
2319 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2320 int len
= CHAR_STRING (c
, str
);
2321 EMACS_INT string_len
= XINT (length
);
2323 if (string_len
> STRING_BYTES_MAX
/ len
)
2325 nbytes
= len
* string_len
;
2326 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2331 memcpy (p
, str
, len
);
2341 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2342 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2343 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2344 (Lisp_Object length
, Lisp_Object init
)
2346 register Lisp_Object val
;
2347 struct Lisp_Bool_Vector
*p
;
2348 ptrdiff_t length_in_chars
;
2349 EMACS_INT length_in_elts
;
2351 int extra_bool_elts
= ((bool_header_size
- header_size
+ word_size
- 1)
2354 CHECK_NATNUM (length
);
2356 bits_per_value
= sizeof (EMACS_INT
) * BOOL_VECTOR_BITS_PER_CHAR
;
2358 length_in_elts
= (XFASTINT (length
) + bits_per_value
- 1) / bits_per_value
;
2360 val
= Fmake_vector (make_number (length_in_elts
+ extra_bool_elts
), Qnil
);
2362 /* No Lisp_Object to trace in there. */
2363 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0);
2365 p
= XBOOL_VECTOR (val
);
2366 p
->size
= XFASTINT (length
);
2368 length_in_chars
= ((XFASTINT (length
) + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2369 / BOOL_VECTOR_BITS_PER_CHAR
);
2370 if (length_in_chars
)
2372 memset (p
->data
, ! NILP (init
) ? -1 : 0, length_in_chars
);
2374 /* Clear any extraneous bits in the last byte. */
2375 p
->data
[length_in_chars
- 1]
2376 &= (1 << ((XFASTINT (length
) - 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1)) - 1;
2383 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2384 of characters from the contents. This string may be unibyte or
2385 multibyte, depending on the contents. */
2388 make_string (const char *contents
, ptrdiff_t nbytes
)
2390 register Lisp_Object val
;
2391 ptrdiff_t nchars
, multibyte_nbytes
;
2393 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2394 &nchars
, &multibyte_nbytes
);
2395 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2396 /* CONTENTS contains no multibyte sequences or contains an invalid
2397 multibyte sequence. We must make unibyte string. */
2398 val
= make_unibyte_string (contents
, nbytes
);
2400 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2405 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2408 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2410 register Lisp_Object val
;
2411 val
= make_uninit_string (length
);
2412 memcpy (SDATA (val
), contents
, length
);
2417 /* Make a multibyte string from NCHARS characters occupying NBYTES
2418 bytes at CONTENTS. */
2421 make_multibyte_string (const char *contents
,
2422 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2424 register Lisp_Object val
;
2425 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2426 memcpy (SDATA (val
), contents
, nbytes
);
2431 /* Make a string from NCHARS characters occupying NBYTES bytes at
2432 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2435 make_string_from_bytes (const char *contents
,
2436 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2438 register Lisp_Object val
;
2439 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2440 memcpy (SDATA (val
), contents
, nbytes
);
2441 if (SBYTES (val
) == SCHARS (val
))
2442 STRING_SET_UNIBYTE (val
);
2447 /* Make a string from NCHARS characters occupying NBYTES bytes at
2448 CONTENTS. The argument MULTIBYTE controls whether to label the
2449 string as multibyte. If NCHARS is negative, it counts the number of
2450 characters by itself. */
2453 make_specified_string (const char *contents
,
2454 ptrdiff_t nchars
, ptrdiff_t nbytes
, int multibyte
)
2456 register Lisp_Object val
;
2461 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2466 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2467 memcpy (SDATA (val
), contents
, nbytes
);
2469 STRING_SET_UNIBYTE (val
);
2474 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2475 occupying LENGTH bytes. */
2478 make_uninit_string (EMACS_INT length
)
2483 return empty_unibyte_string
;
2484 val
= make_uninit_multibyte_string (length
, length
);
2485 STRING_SET_UNIBYTE (val
);
2490 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2491 which occupy NBYTES bytes. */
2494 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2497 struct Lisp_String
*s
;
2502 return empty_multibyte_string
;
2504 s
= allocate_string ();
2505 s
->intervals
= NULL_INTERVAL
;
2506 allocate_string_data (s
, nchars
, nbytes
);
2507 XSETSTRING (string
, s
);
2508 string_chars_consed
+= nbytes
;
2512 /* Print arguments to BUF according to a FORMAT, then return
2513 a Lisp_String initialized with the data from BUF. */
2516 make_formatted_string (char *buf
, const char *format
, ...)
2521 va_start (ap
, format
);
2522 length
= vsprintf (buf
, format
, ap
);
2524 return make_string (buf
, length
);
2528 /***********************************************************************
2530 ***********************************************************************/
2532 /* We store float cells inside of float_blocks, allocating a new
2533 float_block with malloc whenever necessary. Float cells reclaimed
2534 by GC are put on a free list to be reallocated before allocating
2535 any new float cells from the latest float_block. */
2537 #define FLOAT_BLOCK_SIZE \
2538 (((BLOCK_BYTES - sizeof (struct float_block *) \
2539 /* The compiler might add padding at the end. */ \
2540 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2541 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2543 #define GETMARKBIT(block,n) \
2544 (((block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2545 >> ((n) % (sizeof (int) * CHAR_BIT))) \
2548 #define SETMARKBIT(block,n) \
2549 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2550 |= 1 << ((n) % (sizeof (int) * CHAR_BIT))
2552 #define UNSETMARKBIT(block,n) \
2553 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2554 &= ~(1 << ((n) % (sizeof (int) * CHAR_BIT)))
2556 #define FLOAT_BLOCK(fptr) \
2557 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2559 #define FLOAT_INDEX(fptr) \
2560 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2564 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2565 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2566 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2567 struct float_block
*next
;
2570 #define FLOAT_MARKED_P(fptr) \
2571 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2573 #define FLOAT_MARK(fptr) \
2574 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2576 #define FLOAT_UNMARK(fptr) \
2577 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2579 /* Current float_block. */
2581 static struct float_block
*float_block
;
2583 /* Index of first unused Lisp_Float in the current float_block. */
2585 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2587 /* Free-list of Lisp_Floats. */
2589 static struct Lisp_Float
*float_free_list
;
2591 /* Return a new float object with value FLOAT_VALUE. */
2594 make_float (double float_value
)
2596 register Lisp_Object val
;
2598 /* eassert (!handling_signal); */
2602 if (float_free_list
)
2604 /* We use the data field for chaining the free list
2605 so that we won't use the same field that has the mark bit. */
2606 XSETFLOAT (val
, float_free_list
);
2607 float_free_list
= float_free_list
->u
.chain
;
2611 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2613 struct float_block
*new
2614 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2615 new->next
= float_block
;
2616 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2618 float_block_index
= 0;
2619 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2621 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2622 float_block_index
++;
2625 MALLOC_UNBLOCK_INPUT
;
2627 XFLOAT_INIT (val
, float_value
);
2628 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2629 consing_since_gc
+= sizeof (struct Lisp_Float
);
2631 total_free_floats
--;
2637 /***********************************************************************
2639 ***********************************************************************/
2641 /* We store cons cells inside of cons_blocks, allocating a new
2642 cons_block with malloc whenever necessary. Cons cells reclaimed by
2643 GC are put on a free list to be reallocated before allocating
2644 any new cons cells from the latest cons_block. */
2646 #define CONS_BLOCK_SIZE \
2647 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2648 /* The compiler might add padding at the end. */ \
2649 - (sizeof (struct Lisp_Cons) - sizeof (int))) * CHAR_BIT) \
2650 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2652 #define CONS_BLOCK(fptr) \
2653 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2655 #define CONS_INDEX(fptr) \
2656 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2660 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2661 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2662 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2663 struct cons_block
*next
;
2666 #define CONS_MARKED_P(fptr) \
2667 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2669 #define CONS_MARK(fptr) \
2670 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2672 #define CONS_UNMARK(fptr) \
2673 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2675 /* Current cons_block. */
2677 static struct cons_block
*cons_block
;
2679 /* Index of first unused Lisp_Cons in the current block. */
2681 static int cons_block_index
= CONS_BLOCK_SIZE
;
2683 /* Free-list of Lisp_Cons structures. */
2685 static struct Lisp_Cons
*cons_free_list
;
2687 /* Explicitly free a cons cell by putting it on the free-list. */
2690 free_cons (struct Lisp_Cons
*ptr
)
2692 ptr
->u
.chain
= cons_free_list
;
2694 CVAR (ptr
, car
) = Vdead
;
2696 cons_free_list
= ptr
;
2697 consing_since_gc
-= sizeof *ptr
;
2698 total_free_conses
++;
2701 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2702 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2703 (Lisp_Object car
, Lisp_Object cdr
)
2705 register Lisp_Object val
;
2707 /* eassert (!handling_signal); */
2713 /* We use the cdr for chaining the free list
2714 so that we won't use the same field that has the mark bit. */
2715 XSETCONS (val
, cons_free_list
);
2716 cons_free_list
= cons_free_list
->u
.chain
;
2720 if (cons_block_index
== CONS_BLOCK_SIZE
)
2722 struct cons_block
*new
2723 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2724 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2725 new->next
= cons_block
;
2727 cons_block_index
= 0;
2728 total_free_conses
+= CONS_BLOCK_SIZE
;
2730 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2734 MALLOC_UNBLOCK_INPUT
;
2738 eassert (!CONS_MARKED_P (XCONS (val
)));
2739 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2740 total_free_conses
--;
2741 cons_cells_consed
++;
2745 #ifdef GC_CHECK_CONS_LIST
2746 /* Get an error now if there's any junk in the cons free list. */
2748 check_cons_list (void)
2750 struct Lisp_Cons
*tail
= cons_free_list
;
2753 tail
= tail
->u
.chain
;
2757 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2760 list1 (Lisp_Object arg1
)
2762 return Fcons (arg1
, Qnil
);
2766 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2768 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2773 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2775 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2780 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2782 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2787 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2789 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2790 Fcons (arg5
, Qnil
)))));
2793 /* Make a list of COUNT Lisp_Objects, where ARG is the
2794 first one. Allocate conses from pure space if TYPE
2795 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2798 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2802 Lisp_Object val
, *objp
;
2804 /* Change to SAFE_ALLOCA if you hit this eassert. */
2805 eassert (count
<= MAX_ALLOCA
/ word_size
);
2807 objp
= alloca (count
* word_size
);
2810 for (i
= 1; i
< count
; i
++)
2811 objp
[i
] = va_arg (ap
, Lisp_Object
);
2814 for (val
= Qnil
, i
= count
- 1; i
>= 0; i
--)
2816 if (type
== CONSTYPE_PURE
)
2817 val
= pure_cons (objp
[i
], val
);
2818 else if (type
== CONSTYPE_HEAP
)
2819 val
= Fcons (objp
[i
], val
);
2826 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2827 doc
: /* Return a newly created list with specified arguments as elements.
2828 Any number of arguments, even zero arguments, are allowed.
2829 usage: (list &rest OBJECTS) */)
2830 (ptrdiff_t nargs
, Lisp_Object
*args
)
2832 register Lisp_Object val
;
2838 val
= Fcons (args
[nargs
], val
);
2844 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2845 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2846 (register Lisp_Object length
, Lisp_Object init
)
2848 register Lisp_Object val
;
2849 register EMACS_INT size
;
2851 CHECK_NATNUM (length
);
2852 size
= XFASTINT (length
);
2857 val
= Fcons (init
, val
);
2862 val
= Fcons (init
, val
);
2867 val
= Fcons (init
, val
);
2872 val
= Fcons (init
, val
);
2877 val
= Fcons (init
, val
);
2892 /***********************************************************************
2894 ***********************************************************************/
2896 /* This value is balanced well enough to avoid too much internal overhead
2897 for the most common cases; it's not required to be a power of two, but
2898 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2900 #define VECTOR_BLOCK_SIZE 4096
2902 /* Align allocation request sizes to be a multiple of ROUNDUP_SIZE. */
2905 roundup_size
= COMMON_MULTIPLE (word_size
,
2906 USE_LSB_TAG
? 1 << GCTYPEBITS
: 1)
2909 /* ROUNDUP_SIZE must be a power of 2. */
2910 verify ((roundup_size
& (roundup_size
- 1)) == 0);
2912 /* Verify assumptions described above. */
2913 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2914 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2916 /* Round up X to nearest mult-of-ROUNDUP_SIZE. */
2918 #define vroundup(x) (((x) + (roundup_size - 1)) & ~(roundup_size - 1))
2920 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2922 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup (sizeof (void *)))
2924 /* Size of the minimal vector allocated from block. */
2926 #define VBLOCK_BYTES_MIN vroundup (sizeof (struct Lisp_Vector))
2928 /* Size of the largest vector allocated from block. */
2930 #define VBLOCK_BYTES_MAX \
2931 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2933 /* We maintain one free list for each possible block-allocated
2934 vector size, and this is the number of free lists we have. */
2936 #define VECTOR_MAX_FREE_LIST_INDEX \
2937 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2939 /* Common shortcut to advance vector pointer over a block data. */
2941 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2943 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2945 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2947 /* Common shortcut to setup vector on a free list. */
2949 #define SETUP_ON_FREE_LIST(v, nbytes, index) \
2951 XSETPVECTYPESIZE (v, PVEC_FREE, nbytes); \
2952 eassert ((nbytes) % roundup_size == 0); \
2953 (index) = VINDEX (nbytes); \
2954 eassert ((index) < VECTOR_MAX_FREE_LIST_INDEX); \
2955 (v)->header.next.vector = vector_free_lists[index]; \
2956 vector_free_lists[index] = (v); \
2957 total_free_vector_slots += (nbytes) / word_size; \
2962 char data
[VECTOR_BLOCK_BYTES
];
2963 struct vector_block
*next
;
2966 /* Chain of vector blocks. */
2968 static struct vector_block
*vector_blocks
;
2970 /* Vector free lists, where NTH item points to a chain of free
2971 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2973 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2975 /* Singly-linked list of large vectors. */
2977 static struct Lisp_Vector
*large_vectors
;
2979 /* The only vector with 0 slots, allocated from pure space. */
2981 Lisp_Object zero_vector
;
2983 /* Number of live vectors. */
2985 static EMACS_INT total_vectors
;
2987 /* Total size of live and free vectors, in Lisp_Object units. */
2989 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
2991 /* Get a new vector block. */
2993 static struct vector_block
*
2994 allocate_vector_block (void)
2996 struct vector_block
*block
= xmalloc (sizeof *block
);
2998 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
2999 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
3000 MEM_TYPE_VECTOR_BLOCK
);
3003 block
->next
= vector_blocks
;
3004 vector_blocks
= block
;
3008 /* Called once to initialize vector allocation. */
3013 zero_vector
= make_pure_vector (0);
3016 /* Allocate vector from a vector block. */
3018 static struct Lisp_Vector
*
3019 allocate_vector_from_block (size_t nbytes
)
3021 struct Lisp_Vector
*vector
, *rest
;
3022 struct vector_block
*block
;
3023 size_t index
, restbytes
;
3025 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
3026 eassert (nbytes
% roundup_size
== 0);
3028 /* First, try to allocate from a free list
3029 containing vectors of the requested size. */
3030 index
= VINDEX (nbytes
);
3031 if (vector_free_lists
[index
])
3033 vector
= vector_free_lists
[index
];
3034 vector_free_lists
[index
] = vector
->header
.next
.vector
;
3035 vector
->header
.next
.nbytes
= nbytes
;
3036 total_free_vector_slots
-= nbytes
/ word_size
;
3040 /* Next, check free lists containing larger vectors. Since
3041 we will split the result, we should have remaining space
3042 large enough to use for one-slot vector at least. */
3043 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
3044 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
3045 if (vector_free_lists
[index
])
3047 /* This vector is larger than requested. */
3048 vector
= vector_free_lists
[index
];
3049 vector_free_lists
[index
] = vector
->header
.next
.vector
;
3050 vector
->header
.next
.nbytes
= nbytes
;
3051 total_free_vector_slots
-= nbytes
/ word_size
;
3053 /* Excess bytes are used for the smaller vector,
3054 which should be set on an appropriate free list. */
3055 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
3056 eassert (restbytes
% roundup_size
== 0);
3057 rest
= ADVANCE (vector
, nbytes
);
3058 SETUP_ON_FREE_LIST (rest
, restbytes
, index
);
3062 /* Finally, need a new vector block. */
3063 block
= allocate_vector_block ();
3065 /* New vector will be at the beginning of this block. */
3066 vector
= (struct Lisp_Vector
*) block
->data
;
3067 vector
->header
.next
.nbytes
= nbytes
;
3069 /* If the rest of space from this block is large enough
3070 for one-slot vector at least, set up it on a free list. */
3071 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
3072 if (restbytes
>= VBLOCK_BYTES_MIN
)
3074 eassert (restbytes
% roundup_size
== 0);
3075 rest
= ADVANCE (vector
, nbytes
);
3076 SETUP_ON_FREE_LIST (rest
, restbytes
, index
);
3081 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
3083 #define VECTOR_IN_BLOCK(vector, block) \
3084 ((char *) (vector) <= (block)->data \
3085 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
3087 /* Number of bytes used by vector-block-allocated object. This is the only
3088 place where we actually use the `nbytes' field of the vector-header.
3089 I.e. we could get rid of the `nbytes' field by computing it based on the
3092 #define PSEUDOVECTOR_NBYTES(vector) \
3093 (PSEUDOVECTOR_TYPEP (&vector->header, PVEC_FREE) \
3094 ? vector->header.size & PSEUDOVECTOR_SIZE_MASK \
3095 : vector->header.next.nbytes)
3097 /* Reclaim space used by unmarked vectors. */
3100 sweep_vectors (void)
3102 struct vector_block
*block
= vector_blocks
, **bprev
= &vector_blocks
;
3103 struct Lisp_Vector
*vector
, *next
, **vprev
= &large_vectors
;
3105 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
3106 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
3108 /* Looking through vector blocks. */
3110 for (block
= vector_blocks
; block
; block
= *bprev
)
3112 int free_this_block
= 0;
3114 for (vector
= (struct Lisp_Vector
*) block
->data
;
3115 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
3117 if (VECTOR_MARKED_P (vector
))
3119 VECTOR_UNMARK (vector
);
3121 total_vector_slots
+= vector
->header
.next
.nbytes
/ word_size
;
3122 next
= ADVANCE (vector
, vector
->header
.next
.nbytes
);
3126 ptrdiff_t nbytes
= PSEUDOVECTOR_NBYTES (vector
);
3127 ptrdiff_t total_bytes
= nbytes
;
3129 next
= ADVANCE (vector
, nbytes
);
3131 /* While NEXT is not marked, try to coalesce with VECTOR,
3132 thus making VECTOR of the largest possible size. */
3134 while (VECTOR_IN_BLOCK (next
, block
))
3136 if (VECTOR_MARKED_P (next
))
3138 nbytes
= PSEUDOVECTOR_NBYTES (next
);
3139 total_bytes
+= nbytes
;
3140 next
= ADVANCE (next
, nbytes
);
3143 eassert (total_bytes
% roundup_size
== 0);
3145 if (vector
== (struct Lisp_Vector
*) block
->data
3146 && !VECTOR_IN_BLOCK (next
, block
))
3147 /* This block should be freed because all of it's
3148 space was coalesced into the only free vector. */
3149 free_this_block
= 1;
3153 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
3158 if (free_this_block
)
3160 *bprev
= block
->next
;
3161 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
3162 mem_delete (mem_find (block
->data
));
3167 bprev
= &block
->next
;
3170 /* Sweep large vectors. */
3172 for (vector
= large_vectors
; vector
; vector
= *vprev
)
3174 if (VECTOR_MARKED_P (vector
))
3176 VECTOR_UNMARK (vector
);
3178 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
3180 struct Lisp_Bool_Vector
*b
= (struct Lisp_Bool_Vector
*) vector
;
3182 /* All non-bool pseudovectors are small enough to be allocated
3183 from vector blocks. This code should be redesigned if some
3184 pseudovector type grows beyond VBLOCK_BYTES_MAX. */
3185 eassert (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_BOOL_VECTOR
));
3188 += (bool_header_size
3189 + ((b
->size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1)
3190 / BOOL_VECTOR_BITS_PER_CHAR
)) / word_size
;
3194 += header_size
/ word_size
+ vector
->header
.size
;
3195 vprev
= &vector
->header
.next
.vector
;
3199 *vprev
= vector
->header
.next
.vector
;
3205 /* Value is a pointer to a newly allocated Lisp_Vector structure
3206 with room for LEN Lisp_Objects. */
3208 static struct Lisp_Vector
*
3209 allocate_vectorlike (ptrdiff_t len
)
3211 struct Lisp_Vector
*p
;
3215 /* This gets triggered by code which I haven't bothered to fix. --Stef */
3216 /* eassert (!handling_signal); */
3219 p
= XVECTOR (zero_vector
);
3222 size_t nbytes
= header_size
+ len
* word_size
;
3224 #ifdef DOUG_LEA_MALLOC
3225 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
3226 because mapped region contents are not preserved in
3228 mallopt (M_MMAP_MAX
, 0);
3231 if (nbytes
<= VBLOCK_BYTES_MAX
)
3232 p
= allocate_vector_from_block (vroundup (nbytes
));
3235 p
= lisp_malloc (nbytes
, MEM_TYPE_VECTORLIKE
);
3236 p
->header
.next
.vector
= large_vectors
;
3240 #ifdef DOUG_LEA_MALLOC
3241 /* Back to a reasonable maximum of mmap'ed areas. */
3242 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3245 consing_since_gc
+= nbytes
;
3246 vector_cells_consed
+= len
;
3249 MALLOC_UNBLOCK_INPUT
;
3255 /* Allocate a vector with LEN slots. */
3257 struct Lisp_Vector
*
3258 allocate_vector (EMACS_INT len
)
3260 struct Lisp_Vector
*v
;
3261 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3263 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3264 memory_full (SIZE_MAX
);
3265 v
= allocate_vectorlike (len
);
3266 v
->header
.size
= len
;
3271 /* Allocate other vector-like structures. */
3273 struct Lisp_Vector
*
3274 allocate_pseudovector (int memlen
, int lisplen
, int tag
)
3276 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3279 /* Only the first lisplen slots will be traced normally by the GC. */
3280 for (i
= 0; i
< lisplen
; ++i
)
3281 v
->contents
[i
] = Qnil
;
3283 XSETPVECTYPESIZE (v
, tag
, lisplen
);
3288 allocate_buffer (void)
3290 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3292 XSETPVECTYPESIZE (b
, PVEC_BUFFER
, (offsetof (struct buffer
, own_text
)
3293 - header_size
) / word_size
);
3294 /* Note that the fields of B are not initialized. */
3298 struct Lisp_Hash_Table
*
3299 allocate_hash_table (void)
3301 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
3305 allocate_window (void)
3309 w
= ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
3310 /* Users assumes that non-Lisp data is zeroed. */
3311 memset (&w
->current_matrix
, 0,
3312 sizeof (*w
) - offsetof (struct window
, current_matrix
));
3317 allocate_terminal (void)
3321 t
= ALLOCATE_PSEUDOVECTOR (struct terminal
, next_terminal
, PVEC_TERMINAL
);
3322 /* Users assumes that non-Lisp data is zeroed. */
3323 memset (&t
->next_terminal
, 0,
3324 sizeof (*t
) - offsetof (struct terminal
, next_terminal
));
3329 allocate_frame (void)
3333 f
= ALLOCATE_PSEUDOVECTOR (struct frame
, face_cache
, PVEC_FRAME
);
3334 /* Users assumes that non-Lisp data is zeroed. */
3335 memset (&f
->face_cache
, 0,
3336 sizeof (*f
) - offsetof (struct frame
, face_cache
));
3340 struct Lisp_Process
*
3341 allocate_process (void)
3343 struct Lisp_Process
*p
;
3345 p
= ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3346 /* Users assumes that non-Lisp data is zeroed. */
3348 sizeof (*p
) - offsetof (struct Lisp_Process
, pid
));
3352 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3353 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3354 See also the function `vector'. */)
3355 (register Lisp_Object length
, Lisp_Object init
)
3358 register ptrdiff_t sizei
;
3359 register ptrdiff_t i
;
3360 register struct Lisp_Vector
*p
;
3362 CHECK_NATNUM (length
);
3364 p
= allocate_vector (XFASTINT (length
));
3365 sizei
= XFASTINT (length
);
3366 for (i
= 0; i
< sizei
; i
++)
3367 p
->contents
[i
] = init
;
3369 XSETVECTOR (vector
, p
);
3374 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3375 doc
: /* Return a newly created vector with specified arguments as elements.
3376 Any number of arguments, even zero arguments, are allowed.
3377 usage: (vector &rest OBJECTS) */)
3378 (ptrdiff_t nargs
, Lisp_Object
*args
)
3380 register Lisp_Object len
, val
;
3382 register struct Lisp_Vector
*p
;
3384 XSETFASTINT (len
, nargs
);
3385 val
= Fmake_vector (len
, Qnil
);
3387 for (i
= 0; i
< nargs
; i
++)
3388 p
->contents
[i
] = args
[i
];
3393 make_byte_code (struct Lisp_Vector
*v
)
3395 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3396 && STRING_MULTIBYTE (v
->contents
[1]))
3397 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3398 earlier because they produced a raw 8-bit string for byte-code
3399 and now such a byte-code string is loaded as multibyte while
3400 raw 8-bit characters converted to multibyte form. Thus, now we
3401 must convert them back to the original unibyte form. */
3402 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3403 XSETPVECTYPE (v
, PVEC_COMPILED
);
3406 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3407 doc
: /* Create a byte-code object with specified arguments as elements.
3408 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3409 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3410 and (optional) INTERACTIVE-SPEC.
3411 The first four arguments are required; at most six have any
3413 The ARGLIST can be either like the one of `lambda', in which case the arguments
3414 will be dynamically bound before executing the byte code, or it can be an
3415 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3416 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3417 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3418 argument to catch the left-over arguments. If such an integer is used, the
3419 arguments will not be dynamically bound but will be instead pushed on the
3420 stack before executing the byte-code.
3421 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3422 (ptrdiff_t nargs
, Lisp_Object
*args
)
3424 register Lisp_Object len
, val
;
3426 register struct Lisp_Vector
*p
;
3428 /* We used to purecopy everything here, if purify-flga was set. This worked
3429 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3430 dangerous, since make-byte-code is used during execution to build
3431 closures, so any closure built during the preload phase would end up
3432 copied into pure space, including its free variables, which is sometimes
3433 just wasteful and other times plainly wrong (e.g. those free vars may want
3436 XSETFASTINT (len
, nargs
);
3437 val
= Fmake_vector (len
, Qnil
);
3440 for (i
= 0; i
< nargs
; i
++)
3441 p
->contents
[i
] = args
[i
];
3443 XSETCOMPILED (val
, p
);
3449 /***********************************************************************
3451 ***********************************************************************/
3453 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3454 of the required alignment if LSB tags are used. */
3456 union aligned_Lisp_Symbol
3458 struct Lisp_Symbol s
;
3460 unsigned char c
[(sizeof (struct Lisp_Symbol
) + (1 << GCTYPEBITS
) - 1)
3461 & -(1 << GCTYPEBITS
)];
3465 /* Each symbol_block is just under 1020 bytes long, since malloc
3466 really allocates in units of powers of two and uses 4 bytes for its
3469 #define SYMBOL_BLOCK_SIZE \
3470 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3474 /* Place `symbols' first, to preserve alignment. */
3475 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3476 struct symbol_block
*next
;
3479 /* Current symbol block and index of first unused Lisp_Symbol
3482 static struct symbol_block
*symbol_block
;
3483 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3485 /* List of free symbols. */
3487 static struct Lisp_Symbol
*symbol_free_list
;
3489 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3490 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3491 Its value and function definition are void, and its property list is nil. */)
3494 register Lisp_Object val
;
3495 register struct Lisp_Symbol
*p
;
3497 CHECK_STRING (name
);
3499 /* eassert (!handling_signal); */
3503 if (symbol_free_list
)
3505 XSETSYMBOL (val
, symbol_free_list
);
3506 symbol_free_list
= symbol_free_list
->next
;
3510 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3512 struct symbol_block
*new
3513 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3514 new->next
= symbol_block
;
3516 symbol_block_index
= 0;
3517 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3519 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3520 symbol_block_index
++;
3523 MALLOC_UNBLOCK_INPUT
;
3526 SVAR (p
, xname
) = name
;
3527 SVAR (p
, plist
) = Qnil
;
3528 p
->redirect
= SYMBOL_PLAINVAL
;
3529 SET_SYMBOL_VAL (p
, Qunbound
);
3530 SVAR (p
, function
) = Qunbound
;
3533 p
->interned
= SYMBOL_UNINTERNED
;
3535 p
->declared_special
= 0;
3536 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3538 total_free_symbols
--;
3544 /***********************************************************************
3545 Marker (Misc) Allocation
3546 ***********************************************************************/
3548 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3549 the required alignment when LSB tags are used. */
3551 union aligned_Lisp_Misc
3555 unsigned char c
[(sizeof (union Lisp_Misc
) + (1 << GCTYPEBITS
) - 1)
3556 & -(1 << GCTYPEBITS
)];
3560 /* Allocation of markers and other objects that share that structure.
3561 Works like allocation of conses. */
3563 #define MARKER_BLOCK_SIZE \
3564 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3568 /* Place `markers' first, to preserve alignment. */
3569 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3570 struct marker_block
*next
;
3573 static struct marker_block
*marker_block
;
3574 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3576 static union Lisp_Misc
*marker_free_list
;
3578 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3581 allocate_misc (enum Lisp_Misc_Type type
)
3585 /* eassert (!handling_signal); */
3589 if (marker_free_list
)
3591 XSETMISC (val
, marker_free_list
);
3592 marker_free_list
= marker_free_list
->u_free
.chain
;
3596 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3598 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3599 new->next
= marker_block
;
3601 marker_block_index
= 0;
3602 total_free_markers
+= MARKER_BLOCK_SIZE
;
3604 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3605 marker_block_index
++;
3608 MALLOC_UNBLOCK_INPUT
;
3610 --total_free_markers
;
3611 consing_since_gc
+= sizeof (union Lisp_Misc
);
3612 misc_objects_consed
++;
3613 XMISCTYPE (val
) = type
;
3614 XMISCANY (val
)->gcmarkbit
= 0;
3618 /* Free a Lisp_Misc object */
3621 free_misc (Lisp_Object misc
)
3623 XMISCTYPE (misc
) = Lisp_Misc_Free
;
3624 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3625 marker_free_list
= XMISC (misc
);
3626 consing_since_gc
-= sizeof (union Lisp_Misc
);
3627 total_free_markers
++;
3630 /* Return a Lisp_Misc_Save_Value object containing POINTER and
3631 INTEGER. This is used to package C values to call record_unwind_protect.
3632 The unwind function can get the C values back using XSAVE_VALUE. */
3635 make_save_value (void *pointer
, ptrdiff_t integer
)
3637 register Lisp_Object val
;
3638 register struct Lisp_Save_Value
*p
;
3640 val
= allocate_misc (Lisp_Misc_Save_Value
);
3641 p
= XSAVE_VALUE (val
);
3642 p
->pointer
= pointer
;
3643 p
->integer
= integer
;
3648 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3651 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3653 register Lisp_Object overlay
;
3655 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3656 OVERLAY_START (overlay
) = start
;
3657 OVERLAY_END (overlay
) = end
;
3658 OVERLAY_PLIST (overlay
) = plist
;
3659 XOVERLAY (overlay
)->next
= NULL
;
3663 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3664 doc
: /* Return a newly allocated marker which does not point at any place. */)
3667 register Lisp_Object val
;
3668 register struct Lisp_Marker
*p
;
3670 val
= allocate_misc (Lisp_Misc_Marker
);
3676 p
->insertion_type
= 0;
3680 /* Return a newly allocated marker which points into BUF
3681 at character position CHARPOS and byte position BYTEPOS. */
3684 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3687 struct Lisp_Marker
*m
;
3689 /* No dead buffers here. */
3690 eassert (!NILP (BVAR (buf
, name
)));
3692 /* Every character is at least one byte. */
3693 eassert (charpos
<= bytepos
);
3695 obj
= allocate_misc (Lisp_Misc_Marker
);
3698 m
->charpos
= charpos
;
3699 m
->bytepos
= bytepos
;
3700 m
->insertion_type
= 0;
3701 m
->next
= BUF_MARKERS (buf
);
3702 BUF_MARKERS (buf
) = m
;
3706 /* Put MARKER back on the free list after using it temporarily. */
3709 free_marker (Lisp_Object marker
)
3711 unchain_marker (XMARKER (marker
));
3716 /* Return a newly created vector or string with specified arguments as
3717 elements. If all the arguments are characters that can fit
3718 in a string of events, make a string; otherwise, make a vector.
3720 Any number of arguments, even zero arguments, are allowed. */
3723 make_event_array (register int nargs
, Lisp_Object
*args
)
3727 for (i
= 0; i
< nargs
; i
++)
3728 /* The things that fit in a string
3729 are characters that are in 0...127,
3730 after discarding the meta bit and all the bits above it. */
3731 if (!INTEGERP (args
[i
])
3732 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3733 return Fvector (nargs
, args
);
3735 /* Since the loop exited, we know that all the things in it are
3736 characters, so we can make a string. */
3740 result
= Fmake_string (make_number (nargs
), make_number (0));
3741 for (i
= 0; i
< nargs
; i
++)
3743 SSET (result
, i
, XINT (args
[i
]));
3744 /* Move the meta bit to the right place for a string char. */
3745 if (XINT (args
[i
]) & CHAR_META
)
3746 SSET (result
, i
, SREF (result
, i
) | 0x80);
3755 /************************************************************************
3756 Memory Full Handling
3757 ************************************************************************/
3760 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3761 there may have been size_t overflow so that malloc was never
3762 called, or perhaps malloc was invoked successfully but the
3763 resulting pointer had problems fitting into a tagged EMACS_INT. In
3764 either case this counts as memory being full even though malloc did
3768 memory_full (size_t nbytes
)
3770 /* Do not go into hysterics merely because a large request failed. */
3771 int enough_free_memory
= 0;
3772 if (SPARE_MEMORY
< nbytes
)
3777 p
= malloc (SPARE_MEMORY
);
3781 enough_free_memory
= 1;
3783 MALLOC_UNBLOCK_INPUT
;
3786 if (! enough_free_memory
)
3792 memory_full_cons_threshold
= sizeof (struct cons_block
);
3794 /* The first time we get here, free the spare memory. */
3795 for (i
= 0; i
< sizeof (spare_memory
) / sizeof (char *); i
++)
3796 if (spare_memory
[i
])
3799 free (spare_memory
[i
]);
3800 else if (i
>= 1 && i
<= 4)
3801 lisp_align_free (spare_memory
[i
]);
3803 lisp_free (spare_memory
[i
]);
3804 spare_memory
[i
] = 0;
3807 /* Record the space now used. When it decreases substantially,
3808 we can refill the memory reserve. */
3809 #if !defined SYSTEM_MALLOC && !defined SYNC_INPUT
3810 bytes_used_when_full
= BYTES_USED
;
3814 /* This used to call error, but if we've run out of memory, we could
3815 get infinite recursion trying to build the string. */
3816 xsignal (Qnil
, Vmemory_signal_data
);
3819 /* If we released our reserve (due to running out of memory),
3820 and we have a fair amount free once again,
3821 try to set aside another reserve in case we run out once more.
3823 This is called when a relocatable block is freed in ralloc.c,
3824 and also directly from this file, in case we're not using ralloc.c. */
3827 refill_memory_reserve (void)
3829 #ifndef SYSTEM_MALLOC
3830 if (spare_memory
[0] == 0)
3831 spare_memory
[0] = malloc (SPARE_MEMORY
);
3832 if (spare_memory
[1] == 0)
3833 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
3835 if (spare_memory
[2] == 0)
3836 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
3838 if (spare_memory
[3] == 0)
3839 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
3841 if (spare_memory
[4] == 0)
3842 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
3844 if (spare_memory
[5] == 0)
3845 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
3847 if (spare_memory
[6] == 0)
3848 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
3850 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3851 Vmemory_full
= Qnil
;
3855 /************************************************************************
3857 ************************************************************************/
3859 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3861 /* Conservative C stack marking requires a method to identify possibly
3862 live Lisp objects given a pointer value. We do this by keeping
3863 track of blocks of Lisp data that are allocated in a red-black tree
3864 (see also the comment of mem_node which is the type of nodes in
3865 that tree). Function lisp_malloc adds information for an allocated
3866 block to the red-black tree with calls to mem_insert, and function
3867 lisp_free removes it with mem_delete. Functions live_string_p etc
3868 call mem_find to lookup information about a given pointer in the
3869 tree, and use that to determine if the pointer points to a Lisp
3872 /* Initialize this part of alloc.c. */
3877 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3878 mem_z
.parent
= NULL
;
3879 mem_z
.color
= MEM_BLACK
;
3880 mem_z
.start
= mem_z
.end
= NULL
;
3885 /* Value is a pointer to the mem_node containing START. Value is
3886 MEM_NIL if there is no node in the tree containing START. */
3888 static inline struct mem_node
*
3889 mem_find (void *start
)
3893 if (start
< min_heap_address
|| start
> max_heap_address
)
3896 /* Make the search always successful to speed up the loop below. */
3897 mem_z
.start
= start
;
3898 mem_z
.end
= (char *) start
+ 1;
3901 while (start
< p
->start
|| start
>= p
->end
)
3902 p
= start
< p
->start
? p
->left
: p
->right
;
3907 /* Insert a new node into the tree for a block of memory with start
3908 address START, end address END, and type TYPE. Value is a
3909 pointer to the node that was inserted. */
3911 static struct mem_node
*
3912 mem_insert (void *start
, void *end
, enum mem_type type
)
3914 struct mem_node
*c
, *parent
, *x
;
3916 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3917 min_heap_address
= start
;
3918 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3919 max_heap_address
= end
;
3921 /* See where in the tree a node for START belongs. In this
3922 particular application, it shouldn't happen that a node is already
3923 present. For debugging purposes, let's check that. */
3927 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3929 while (c
!= MEM_NIL
)
3931 if (start
>= c
->start
&& start
< c
->end
)
3934 c
= start
< c
->start
? c
->left
: c
->right
;
3937 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3939 while (c
!= MEM_NIL
)
3942 c
= start
< c
->start
? c
->left
: c
->right
;
3945 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3947 /* Create a new node. */
3948 #ifdef GC_MALLOC_CHECK
3949 x
= _malloc_internal (sizeof *x
);
3953 x
= xmalloc (sizeof *x
);
3959 x
->left
= x
->right
= MEM_NIL
;
3962 /* Insert it as child of PARENT or install it as root. */
3965 if (start
< parent
->start
)
3973 /* Re-establish red-black tree properties. */
3974 mem_insert_fixup (x
);
3980 /* Re-establish the red-black properties of the tree, and thereby
3981 balance the tree, after node X has been inserted; X is always red. */
3984 mem_insert_fixup (struct mem_node
*x
)
3986 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3988 /* X is red and its parent is red. This is a violation of
3989 red-black tree property #3. */
3991 if (x
->parent
== x
->parent
->parent
->left
)
3993 /* We're on the left side of our grandparent, and Y is our
3995 struct mem_node
*y
= x
->parent
->parent
->right
;
3997 if (y
->color
== MEM_RED
)
3999 /* Uncle and parent are red but should be black because
4000 X is red. Change the colors accordingly and proceed
4001 with the grandparent. */
4002 x
->parent
->color
= MEM_BLACK
;
4003 y
->color
= MEM_BLACK
;
4004 x
->parent
->parent
->color
= MEM_RED
;
4005 x
= x
->parent
->parent
;
4009 /* Parent and uncle have different colors; parent is
4010 red, uncle is black. */
4011 if (x
== x
->parent
->right
)
4014 mem_rotate_left (x
);
4017 x
->parent
->color
= MEM_BLACK
;
4018 x
->parent
->parent
->color
= MEM_RED
;
4019 mem_rotate_right (x
->parent
->parent
);
4024 /* This is the symmetrical case of above. */
4025 struct mem_node
*y
= x
->parent
->parent
->left
;
4027 if (y
->color
== MEM_RED
)
4029 x
->parent
->color
= MEM_BLACK
;
4030 y
->color
= MEM_BLACK
;
4031 x
->parent
->parent
->color
= MEM_RED
;
4032 x
= x
->parent
->parent
;
4036 if (x
== x
->parent
->left
)
4039 mem_rotate_right (x
);
4042 x
->parent
->color
= MEM_BLACK
;
4043 x
->parent
->parent
->color
= MEM_RED
;
4044 mem_rotate_left (x
->parent
->parent
);
4049 /* The root may have been changed to red due to the algorithm. Set
4050 it to black so that property #5 is satisfied. */
4051 mem_root
->color
= MEM_BLACK
;
4062 mem_rotate_left (struct mem_node
*x
)
4066 /* Turn y's left sub-tree into x's right sub-tree. */
4069 if (y
->left
!= MEM_NIL
)
4070 y
->left
->parent
= x
;
4072 /* Y's parent was x's parent. */
4074 y
->parent
= x
->parent
;
4076 /* Get the parent to point to y instead of x. */
4079 if (x
== x
->parent
->left
)
4080 x
->parent
->left
= y
;
4082 x
->parent
->right
= y
;
4087 /* Put x on y's left. */
4101 mem_rotate_right (struct mem_node
*x
)
4103 struct mem_node
*y
= x
->left
;
4106 if (y
->right
!= MEM_NIL
)
4107 y
->right
->parent
= x
;
4110 y
->parent
= x
->parent
;
4113 if (x
== x
->parent
->right
)
4114 x
->parent
->right
= y
;
4116 x
->parent
->left
= y
;
4127 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4130 mem_delete (struct mem_node
*z
)
4132 struct mem_node
*x
, *y
;
4134 if (!z
|| z
== MEM_NIL
)
4137 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4142 while (y
->left
!= MEM_NIL
)
4146 if (y
->left
!= MEM_NIL
)
4151 x
->parent
= y
->parent
;
4154 if (y
== y
->parent
->left
)
4155 y
->parent
->left
= x
;
4157 y
->parent
->right
= x
;
4164 z
->start
= y
->start
;
4169 if (y
->color
== MEM_BLACK
)
4170 mem_delete_fixup (x
);
4172 #ifdef GC_MALLOC_CHECK
4180 /* Re-establish the red-black properties of the tree, after a
4184 mem_delete_fixup (struct mem_node
*x
)
4186 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4188 if (x
== x
->parent
->left
)
4190 struct mem_node
*w
= x
->parent
->right
;
4192 if (w
->color
== MEM_RED
)
4194 w
->color
= MEM_BLACK
;
4195 x
->parent
->color
= MEM_RED
;
4196 mem_rotate_left (x
->parent
);
4197 w
= x
->parent
->right
;
4200 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4207 if (w
->right
->color
== MEM_BLACK
)
4209 w
->left
->color
= MEM_BLACK
;
4211 mem_rotate_right (w
);
4212 w
= x
->parent
->right
;
4214 w
->color
= x
->parent
->color
;
4215 x
->parent
->color
= MEM_BLACK
;
4216 w
->right
->color
= MEM_BLACK
;
4217 mem_rotate_left (x
->parent
);
4223 struct mem_node
*w
= x
->parent
->left
;
4225 if (w
->color
== MEM_RED
)
4227 w
->color
= MEM_BLACK
;
4228 x
->parent
->color
= MEM_RED
;
4229 mem_rotate_right (x
->parent
);
4230 w
= x
->parent
->left
;
4233 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4240 if (w
->left
->color
== MEM_BLACK
)
4242 w
->right
->color
= MEM_BLACK
;
4244 mem_rotate_left (w
);
4245 w
= x
->parent
->left
;
4248 w
->color
= x
->parent
->color
;
4249 x
->parent
->color
= MEM_BLACK
;
4250 w
->left
->color
= MEM_BLACK
;
4251 mem_rotate_right (x
->parent
);
4257 x
->color
= MEM_BLACK
;
4261 /* Value is non-zero if P is a pointer to a live Lisp string on
4262 the heap. M is a pointer to the mem_block for P. */
4265 live_string_p (struct mem_node
*m
, void *p
)
4267 if (m
->type
== MEM_TYPE_STRING
)
4269 struct string_block
*b
= (struct string_block
*) m
->start
;
4270 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4272 /* P must point to the start of a Lisp_String structure, and it
4273 must not be on the free-list. */
4275 && offset
% sizeof b
->strings
[0] == 0
4276 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4277 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4284 /* Value is non-zero if P is a pointer to a live Lisp cons on
4285 the heap. M is a pointer to the mem_block for P. */
4288 live_cons_p (struct mem_node
*m
, void *p
)
4290 if (m
->type
== MEM_TYPE_CONS
)
4292 struct cons_block
*b
= (struct cons_block
*) m
->start
;
4293 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4295 /* P must point to the start of a Lisp_Cons, not be
4296 one of the unused cells in the current cons block,
4297 and not be on the free-list. */
4299 && offset
% sizeof b
->conses
[0] == 0
4300 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4302 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4303 && !EQ (CVAR ((struct Lisp_Cons
*) p
, car
), Vdead
));
4310 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4311 the heap. M is a pointer to the mem_block for P. */
4314 live_symbol_p (struct mem_node
*m
, void *p
)
4316 if (m
->type
== MEM_TYPE_SYMBOL
)
4318 struct symbol_block
*b
= (struct symbol_block
*) m
->start
;
4319 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4321 /* P must point to the start of a Lisp_Symbol, not be
4322 one of the unused cells in the current symbol block,
4323 and not be on the free-list. */
4325 && offset
% sizeof b
->symbols
[0] == 0
4326 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4327 && (b
!= symbol_block
4328 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4329 && !EQ (SVAR (((struct Lisp_Symbol
*)p
), function
), Vdead
));
4336 /* Value is non-zero if P is a pointer to a live Lisp float on
4337 the heap. M is a pointer to the mem_block for P. */
4340 live_float_p (struct mem_node
*m
, void *p
)
4342 if (m
->type
== MEM_TYPE_FLOAT
)
4344 struct float_block
*b
= (struct float_block
*) m
->start
;
4345 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4347 /* P must point to the start of a Lisp_Float and not be
4348 one of the unused cells in the current float block. */
4350 && offset
% sizeof b
->floats
[0] == 0
4351 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4352 && (b
!= float_block
4353 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4360 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4361 the heap. M is a pointer to the mem_block for P. */
4364 live_misc_p (struct mem_node
*m
, void *p
)
4366 if (m
->type
== MEM_TYPE_MISC
)
4368 struct marker_block
*b
= (struct marker_block
*) m
->start
;
4369 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4371 /* P must point to the start of a Lisp_Misc, not be
4372 one of the unused cells in the current misc block,
4373 and not be on the free-list. */
4375 && offset
% sizeof b
->markers
[0] == 0
4376 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4377 && (b
!= marker_block
4378 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4379 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4386 /* Value is non-zero if P is a pointer to a live vector-like object.
4387 M is a pointer to the mem_block for P. */
4390 live_vector_p (struct mem_node
*m
, void *p
)
4392 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4394 /* This memory node corresponds to a vector block. */
4395 struct vector_block
*block
= (struct vector_block
*) m
->start
;
4396 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4398 /* P is in the block's allocation range. Scan the block
4399 up to P and see whether P points to the start of some
4400 vector which is not on a free list. FIXME: check whether
4401 some allocation patterns (probably a lot of short vectors)
4402 may cause a substantial overhead of this loop. */
4403 while (VECTOR_IN_BLOCK (vector
, block
)
4404 && vector
<= (struct Lisp_Vector
*) p
)
4406 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
))
4407 vector
= ADVANCE (vector
, (vector
->header
.size
4408 & PSEUDOVECTOR_SIZE_MASK
));
4409 else if (vector
== p
)
4412 vector
= ADVANCE (vector
, vector
->header
.next
.nbytes
);
4415 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== m
->start
)
4416 /* This memory node corresponds to a large vector. */
4422 /* Value is non-zero if P is a pointer to a live buffer. M is a
4423 pointer to the mem_block for P. */
4426 live_buffer_p (struct mem_node
*m
, void *p
)
4428 /* P must point to the start of the block, and the buffer
4429 must not have been killed. */
4430 return (m
->type
== MEM_TYPE_BUFFER
4432 && !NILP (((struct buffer
*) p
)->INTERNAL_FIELD (name
)));
4435 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4439 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4441 /* Array of objects that are kept alive because the C stack contains
4442 a pattern that looks like a reference to them . */
4444 #define MAX_ZOMBIES 10
4445 static Lisp_Object zombies
[MAX_ZOMBIES
];
4447 /* Number of zombie objects. */
4449 static EMACS_INT nzombies
;
4451 /* Number of garbage collections. */
4453 static EMACS_INT ngcs
;
4455 /* Average percentage of zombies per collection. */
4457 static double avg_zombies
;
4459 /* Max. number of live and zombie objects. */
4461 static EMACS_INT max_live
, max_zombies
;
4463 /* Average number of live objects per GC. */
4465 static double avg_live
;
4467 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4468 doc
: /* Show information about live and zombie objects. */)
4471 Lisp_Object args
[8], zombie_list
= Qnil
;
4473 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); i
++)
4474 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4475 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4476 args
[1] = make_number (ngcs
);
4477 args
[2] = make_float (avg_live
);
4478 args
[3] = make_float (avg_zombies
);
4479 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4480 args
[5] = make_number (max_live
);
4481 args
[6] = make_number (max_zombies
);
4482 args
[7] = zombie_list
;
4483 return Fmessage (8, args
);
4486 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4489 /* Mark OBJ if we can prove it's a Lisp_Object. */
4492 mark_maybe_object (Lisp_Object obj
)
4500 po
= (void *) XPNTR (obj
);
4507 switch (XTYPE (obj
))
4510 mark_p
= (live_string_p (m
, po
)
4511 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4515 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4519 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4523 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4526 case Lisp_Vectorlike
:
4527 /* Note: can't check BUFFERP before we know it's a
4528 buffer because checking that dereferences the pointer
4529 PO which might point anywhere. */
4530 if (live_vector_p (m
, po
))
4531 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4532 else if (live_buffer_p (m
, po
))
4533 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4537 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4546 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4547 if (nzombies
< MAX_ZOMBIES
)
4548 zombies
[nzombies
] = obj
;
4557 /* If P points to Lisp data, mark that as live if it isn't already
4561 mark_maybe_pointer (void *p
)
4565 /* Quickly rule out some values which can't point to Lisp data.
4566 USE_LSB_TAG needs Lisp data to be aligned on multiples of 1 << GCTYPEBITS.
4567 Otherwise, assume that Lisp data is aligned on even addresses. */
4568 if ((intptr_t) p
% (USE_LSB_TAG
? 1 << GCTYPEBITS
: 2))
4574 Lisp_Object obj
= Qnil
;
4578 case MEM_TYPE_NON_LISP
:
4579 /* Nothing to do; not a pointer to Lisp memory. */
4582 case MEM_TYPE_BUFFER
:
4583 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4584 XSETVECTOR (obj
, p
);
4588 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4592 case MEM_TYPE_STRING
:
4593 if (live_string_p (m
, p
)
4594 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4595 XSETSTRING (obj
, p
);
4599 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4603 case MEM_TYPE_SYMBOL
:
4604 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4605 XSETSYMBOL (obj
, p
);
4608 case MEM_TYPE_FLOAT
:
4609 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4613 case MEM_TYPE_VECTORLIKE
:
4614 case MEM_TYPE_VECTOR_BLOCK
:
4615 if (live_vector_p (m
, p
))
4618 XSETVECTOR (tem
, p
);
4619 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4634 /* Alignment of pointer values. Use alignof, as it sometimes returns
4635 a smaller alignment than GCC's __alignof__ and mark_memory might
4636 miss objects if __alignof__ were used. */
4637 #define GC_POINTER_ALIGNMENT alignof (void *)
4639 /* Define POINTERS_MIGHT_HIDE_IN_OBJECTS to 1 if marking via C pointers does
4640 not suffice, which is the typical case. A host where a Lisp_Object is
4641 wider than a pointer might allocate a Lisp_Object in non-adjacent halves.
4642 If USE_LSB_TAG, the bottom half is not a valid pointer, but it should
4643 suffice to widen it to to a Lisp_Object and check it that way. */
4644 #if USE_LSB_TAG || VAL_MAX < UINTPTR_MAX
4645 # if !USE_LSB_TAG && VAL_MAX < UINTPTR_MAX >> GCTYPEBITS
4646 /* If tag bits straddle pointer-word boundaries, neither mark_maybe_pointer
4647 nor mark_maybe_object can follow the pointers. This should not occur on
4648 any practical porting target. */
4649 # error "MSB type bits straddle pointer-word boundaries"
4651 /* Marking via C pointers does not suffice, because Lisp_Objects contain
4652 pointer words that hold pointers ORed with type bits. */
4653 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 1
4655 /* Marking via C pointers suffices, because Lisp_Objects contain pointer
4656 words that hold unmodified pointers. */
4657 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 0
4660 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4661 or END+OFFSET..START. */
4664 mark_memory (void *start
, void *end
)
4665 #if defined (__clang__) && defined (__has_feature)
4666 #if __has_feature(address_sanitizer)
4667 /* Do not allow -faddress-sanitizer to check this function, since it
4668 crosses the function stack boundary, and thus would yield many
4670 __attribute__((no_address_safety_analysis
))
4677 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4681 /* Make START the pointer to the start of the memory region,
4682 if it isn't already. */
4690 /* Mark Lisp data pointed to. This is necessary because, in some
4691 situations, the C compiler optimizes Lisp objects away, so that
4692 only a pointer to them remains. Example:
4694 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4697 Lisp_Object obj = build_string ("test");
4698 struct Lisp_String *s = XSTRING (obj);
4699 Fgarbage_collect ();
4700 fprintf (stderr, "test `%s'\n", s->data);
4704 Here, `obj' isn't really used, and the compiler optimizes it
4705 away. The only reference to the life string is through the
4708 for (pp
= start
; (void *) pp
< end
; pp
++)
4709 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4711 void *p
= *(void **) ((char *) pp
+ i
);
4712 mark_maybe_pointer (p
);
4713 if (POINTERS_MIGHT_HIDE_IN_OBJECTS
)
4714 mark_maybe_object (XIL ((intptr_t) p
));
4718 /* setjmp will work with GCC unless NON_SAVING_SETJMP is defined in
4719 the GCC system configuration. In gcc 3.2, the only systems for
4720 which this is so are i386-sco5 non-ELF, i386-sysv3 (maybe included
4721 by others?) and ns32k-pc532-min. */
4723 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4725 static int setjmp_tested_p
, longjmps_done
;
4727 #define SETJMP_WILL_LIKELY_WORK "\
4729 Emacs garbage collector has been changed to use conservative stack\n\
4730 marking. Emacs has determined that the method it uses to do the\n\
4731 marking will likely work on your system, but this isn't sure.\n\
4733 If you are a system-programmer, or can get the help of a local wizard\n\
4734 who is, please take a look at the function mark_stack in alloc.c, and\n\
4735 verify that the methods used are appropriate for your system.\n\
4737 Please mail the result to <emacs-devel@gnu.org>.\n\
4740 #define SETJMP_WILL_NOT_WORK "\
4742 Emacs garbage collector has been changed to use conservative stack\n\
4743 marking. Emacs has determined that the default method it uses to do the\n\
4744 marking will not work on your system. We will need a system-dependent\n\
4745 solution for your system.\n\
4747 Please take a look at the function mark_stack in alloc.c, and\n\
4748 try to find a way to make it work on your system.\n\
4750 Note that you may get false negatives, depending on the compiler.\n\
4751 In particular, you need to use -O with GCC for this test.\n\
4753 Please mail the result to <emacs-devel@gnu.org>.\n\
4757 /* Perform a quick check if it looks like setjmp saves registers in a
4758 jmp_buf. Print a message to stderr saying so. When this test
4759 succeeds, this is _not_ a proof that setjmp is sufficient for
4760 conservative stack marking. Only the sources or a disassembly
4771 /* Arrange for X to be put in a register. */
4777 if (longjmps_done
== 1)
4779 /* Came here after the longjmp at the end of the function.
4781 If x == 1, the longjmp has restored the register to its
4782 value before the setjmp, and we can hope that setjmp
4783 saves all such registers in the jmp_buf, although that
4786 For other values of X, either something really strange is
4787 taking place, or the setjmp just didn't save the register. */
4790 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4793 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4800 if (longjmps_done
== 1)
4804 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4807 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4809 /* Abort if anything GCPRO'd doesn't survive the GC. */
4817 for (p
= gcprolist
; p
; p
= p
->next
)
4818 for (i
= 0; i
< p
->nvars
; ++i
)
4819 if (!survives_gc_p (p
->var
[i
]))
4820 /* FIXME: It's not necessarily a bug. It might just be that the
4821 GCPRO is unnecessary or should release the object sooner. */
4825 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4832 fprintf (stderr
, "\nZombies kept alive = %"pI
"d:\n", nzombies
);
4833 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4835 fprintf (stderr
, " %d = ", i
);
4836 debug_print (zombies
[i
]);
4840 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4843 /* Mark live Lisp objects on the C stack.
4845 There are several system-dependent problems to consider when
4846 porting this to new architectures:
4850 We have to mark Lisp objects in CPU registers that can hold local
4851 variables or are used to pass parameters.
4853 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4854 something that either saves relevant registers on the stack, or
4855 calls mark_maybe_object passing it each register's contents.
4857 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4858 implementation assumes that calling setjmp saves registers we need
4859 to see in a jmp_buf which itself lies on the stack. This doesn't
4860 have to be true! It must be verified for each system, possibly
4861 by taking a look at the source code of setjmp.
4863 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4864 can use it as a machine independent method to store all registers
4865 to the stack. In this case the macros described in the previous
4866 two paragraphs are not used.
4870 Architectures differ in the way their processor stack is organized.
4871 For example, the stack might look like this
4874 | Lisp_Object | size = 4
4876 | something else | size = 2
4878 | Lisp_Object | size = 4
4882 In such a case, not every Lisp_Object will be aligned equally. To
4883 find all Lisp_Object on the stack it won't be sufficient to walk
4884 the stack in steps of 4 bytes. Instead, two passes will be
4885 necessary, one starting at the start of the stack, and a second
4886 pass starting at the start of the stack + 2. Likewise, if the
4887 minimal alignment of Lisp_Objects on the stack is 1, four passes
4888 would be necessary, each one starting with one byte more offset
4889 from the stack start. */
4896 #ifdef HAVE___BUILTIN_UNWIND_INIT
4897 /* Force callee-saved registers and register windows onto the stack.
4898 This is the preferred method if available, obviating the need for
4899 machine dependent methods. */
4900 __builtin_unwind_init ();
4902 #else /* not HAVE___BUILTIN_UNWIND_INIT */
4903 #ifndef GC_SAVE_REGISTERS_ON_STACK
4904 /* jmp_buf may not be aligned enough on darwin-ppc64 */
4905 union aligned_jmpbuf
{
4909 volatile int stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4911 /* This trick flushes the register windows so that all the state of
4912 the process is contained in the stack. */
4913 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4914 needed on ia64 too. See mach_dep.c, where it also says inline
4915 assembler doesn't work with relevant proprietary compilers. */
4917 #if defined (__sparc64__) && defined (__FreeBSD__)
4918 /* FreeBSD does not have a ta 3 handler. */
4925 /* Save registers that we need to see on the stack. We need to see
4926 registers used to hold register variables and registers used to
4928 #ifdef GC_SAVE_REGISTERS_ON_STACK
4929 GC_SAVE_REGISTERS_ON_STACK (end
);
4930 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4932 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4933 setjmp will definitely work, test it
4934 and print a message with the result
4936 if (!setjmp_tested_p
)
4938 setjmp_tested_p
= 1;
4941 #endif /* GC_SETJMP_WORKS */
4944 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4945 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4946 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
4948 /* This assumes that the stack is a contiguous region in memory. If
4949 that's not the case, something has to be done here to iterate
4950 over the stack segments. */
4951 mark_memory (stack_base
, end
);
4953 /* Allow for marking a secondary stack, like the register stack on the
4955 #ifdef GC_MARK_SECONDARY_STACK
4956 GC_MARK_SECONDARY_STACK ();
4959 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4964 #endif /* GC_MARK_STACK != 0 */
4967 /* Determine whether it is safe to access memory at address P. */
4969 valid_pointer_p (void *p
)
4972 return w32_valid_pointer_p (p
, 16);
4976 /* Obviously, we cannot just access it (we would SEGV trying), so we
4977 trick the o/s to tell us whether p is a valid pointer.
4978 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4979 not validate p in that case. */
4983 int valid
= (emacs_write (fd
[1], (char *) p
, 16) == 16);
4984 emacs_close (fd
[1]);
4985 emacs_close (fd
[0]);
4993 /* Return 1 if OBJ is a valid lisp object.
4994 Return 0 if OBJ is NOT a valid lisp object.
4995 Return -1 if we cannot validate OBJ.
4996 This function can be quite slow,
4997 so it should only be used in code for manual debugging. */
5000 valid_lisp_object_p (Lisp_Object obj
)
5010 p
= (void *) XPNTR (obj
);
5011 if (PURE_POINTER_P (p
))
5015 return valid_pointer_p (p
);
5022 int valid
= valid_pointer_p (p
);
5034 case MEM_TYPE_NON_LISP
:
5037 case MEM_TYPE_BUFFER
:
5038 return live_buffer_p (m
, p
);
5041 return live_cons_p (m
, p
);
5043 case MEM_TYPE_STRING
:
5044 return live_string_p (m
, p
);
5047 return live_misc_p (m
, p
);
5049 case MEM_TYPE_SYMBOL
:
5050 return live_symbol_p (m
, p
);
5052 case MEM_TYPE_FLOAT
:
5053 return live_float_p (m
, p
);
5055 case MEM_TYPE_VECTORLIKE
:
5056 case MEM_TYPE_VECTOR_BLOCK
:
5057 return live_vector_p (m
, p
);
5070 /***********************************************************************
5071 Pure Storage Management
5072 ***********************************************************************/
5074 /* Allocate room for SIZE bytes from pure Lisp storage and return a
5075 pointer to it. TYPE is the Lisp type for which the memory is
5076 allocated. TYPE < 0 means it's not used for a Lisp object. */
5079 pure_alloc (size_t size
, int type
)
5083 size_t alignment
= (1 << GCTYPEBITS
);
5085 size_t alignment
= alignof (EMACS_INT
);
5087 /* Give Lisp_Floats an extra alignment. */
5088 if (type
== Lisp_Float
)
5089 alignment
= alignof (struct Lisp_Float
);
5095 /* Allocate space for a Lisp object from the beginning of the free
5096 space with taking account of alignment. */
5097 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
5098 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
5102 /* Allocate space for a non-Lisp object from the end of the free
5104 pure_bytes_used_non_lisp
+= size
;
5105 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5107 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
5109 if (pure_bytes_used
<= pure_size
)
5112 /* Don't allocate a large amount here,
5113 because it might get mmap'd and then its address
5114 might not be usable. */
5115 purebeg
= xmalloc (10000);
5117 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
5118 pure_bytes_used
= 0;
5119 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
5124 /* Print a warning if PURESIZE is too small. */
5127 check_pure_size (void)
5129 if (pure_bytes_used_before_overflow
)
5130 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
5132 pure_bytes_used
+ pure_bytes_used_before_overflow
);
5136 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
5137 the non-Lisp data pool of the pure storage, and return its start
5138 address. Return NULL if not found. */
5141 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5144 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5145 const unsigned char *p
;
5148 if (pure_bytes_used_non_lisp
<= nbytes
)
5151 /* Set up the Boyer-Moore table. */
5153 for (i
= 0; i
< 256; i
++)
5156 p
= (const unsigned char *) data
;
5158 bm_skip
[*p
++] = skip
;
5160 last_char_skip
= bm_skip
['\0'];
5162 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5163 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5165 /* See the comments in the function `boyer_moore' (search.c) for the
5166 use of `infinity'. */
5167 infinity
= pure_bytes_used_non_lisp
+ 1;
5168 bm_skip
['\0'] = infinity
;
5170 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5174 /* Check the last character (== '\0'). */
5177 start
+= bm_skip
[*(p
+ start
)];
5179 while (start
<= start_max
);
5181 if (start
< infinity
)
5182 /* Couldn't find the last character. */
5185 /* No less than `infinity' means we could find the last
5186 character at `p[start - infinity]'. */
5189 /* Check the remaining characters. */
5190 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5192 return non_lisp_beg
+ start
;
5194 start
+= last_char_skip
;
5196 while (start
<= start_max
);
5202 /* Return a string allocated in pure space. DATA is a buffer holding
5203 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5204 non-zero means make the result string multibyte.
5206 Must get an error if pure storage is full, since if it cannot hold
5207 a large string it may be able to hold conses that point to that
5208 string; then the string is not protected from gc. */
5211 make_pure_string (const char *data
,
5212 ptrdiff_t nchars
, ptrdiff_t nbytes
, int multibyte
)
5215 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5216 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5217 if (s
->data
== NULL
)
5219 s
->data
= pure_alloc (nbytes
+ 1, -1);
5220 memcpy (s
->data
, data
, nbytes
);
5221 s
->data
[nbytes
] = '\0';
5224 s
->size_byte
= multibyte
? nbytes
: -1;
5225 s
->intervals
= NULL_INTERVAL
;
5226 XSETSTRING (string
, s
);
5230 /* Return a string allocated in pure space. Do not
5231 allocate the string data, just point to DATA. */
5234 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5237 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5240 s
->data
= (unsigned char *) data
;
5241 s
->intervals
= NULL_INTERVAL
;
5242 XSETSTRING (string
, s
);
5246 /* Return a cons allocated from pure space. Give it pure copies
5247 of CAR as car and CDR as cdr. */
5250 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5253 struct Lisp_Cons
*p
= pure_alloc (sizeof *p
, Lisp_Cons
);
5255 XSETCAR (new, Fpurecopy (car
));
5256 XSETCDR (new, Fpurecopy (cdr
));
5261 /* Value is a float object with value NUM allocated from pure space. */
5264 make_pure_float (double num
)
5267 struct Lisp_Float
*p
= pure_alloc (sizeof *p
, Lisp_Float
);
5269 XFLOAT_INIT (new, num
);
5274 /* Return a vector with room for LEN Lisp_Objects allocated from
5278 make_pure_vector (ptrdiff_t len
)
5281 size_t size
= header_size
+ len
* word_size
;
5282 struct Lisp_Vector
*p
= pure_alloc (size
, Lisp_Vectorlike
);
5283 XSETVECTOR (new, p
);
5284 XVECTOR (new)->header
.size
= len
;
5289 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5290 doc
: /* Make a copy of object OBJ in pure storage.
5291 Recursively copies contents of vectors and cons cells.
5292 Does not copy symbols. Copies strings without text properties. */)
5293 (register Lisp_Object obj
)
5295 if (NILP (Vpurify_flag
))
5298 if (PURE_POINTER_P (XPNTR (obj
)))
5301 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5303 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5309 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5310 else if (FLOATP (obj
))
5311 obj
= make_pure_float (XFLOAT_DATA (obj
));
5312 else if (STRINGP (obj
))
5313 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5315 STRING_MULTIBYTE (obj
));
5316 else if (COMPILEDP (obj
) || VECTORP (obj
))
5318 register struct Lisp_Vector
*vec
;
5319 register ptrdiff_t i
;
5323 if (size
& PSEUDOVECTOR_FLAG
)
5324 size
&= PSEUDOVECTOR_SIZE_MASK
;
5325 vec
= XVECTOR (make_pure_vector (size
));
5326 for (i
= 0; i
< size
; i
++)
5327 vec
->contents
[i
] = Fpurecopy (AREF (obj
, i
));
5328 if (COMPILEDP (obj
))
5330 XSETPVECTYPE (vec
, PVEC_COMPILED
);
5331 XSETCOMPILED (obj
, vec
);
5334 XSETVECTOR (obj
, vec
);
5336 else if (MARKERP (obj
))
5337 error ("Attempt to copy a marker to pure storage");
5339 /* Not purified, don't hash-cons. */
5342 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5343 Fputhash (obj
, obj
, Vpurify_flag
);
5350 /***********************************************************************
5352 ***********************************************************************/
5354 /* Put an entry in staticvec, pointing at the variable with address
5358 staticpro (Lisp_Object
*varaddress
)
5360 staticvec
[staticidx
++] = varaddress
;
5361 if (staticidx
>= NSTATICS
)
5366 /***********************************************************************
5368 ***********************************************************************/
5370 /* Temporarily prevent garbage collection. */
5373 inhibit_garbage_collection (void)
5375 ptrdiff_t count
= SPECPDL_INDEX ();
5377 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5381 /* Used to avoid possible overflows when
5382 converting from C to Lisp integers. */
5384 static inline Lisp_Object
5385 bounded_number (EMACS_INT number
)
5387 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5390 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5391 doc
: /* Reclaim storage for Lisp objects no longer needed.
5392 Garbage collection happens automatically if you cons more than
5393 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5394 `garbage-collect' normally returns a list with info on amount of space in use,
5395 where each entry has the form (NAME SIZE USED FREE), where:
5396 - NAME is a symbol describing the kind of objects this entry represents,
5397 - SIZE is the number of bytes used by each one,
5398 - USED is the number of those objects that were found live in the heap,
5399 - FREE is the number of those objects that are not live but that Emacs
5400 keeps around for future allocations (maybe because it does not know how
5401 to return them to the OS).
5402 However, if there was overflow in pure space, `garbage-collect'
5403 returns nil, because real GC can't be done.
5404 See Info node `(elisp)Garbage Collection'. */)
5407 register struct specbinding
*bind
;
5408 register struct buffer
*nextb
;
5409 char stack_top_variable
;
5412 Lisp_Object total
[11];
5413 ptrdiff_t count
= SPECPDL_INDEX ();
5419 /* Can't GC if pure storage overflowed because we can't determine
5420 if something is a pure object or not. */
5421 if (pure_bytes_used_before_overflow
)
5426 /* Don't keep undo information around forever.
5427 Do this early on, so it is no problem if the user quits. */
5428 FOR_EACH_BUFFER (nextb
)
5429 compact_buffer (nextb
);
5431 start
= current_emacs_time ();
5433 /* In case user calls debug_print during GC,
5434 don't let that cause a recursive GC. */
5435 consing_since_gc
= 0;
5437 /* Save what's currently displayed in the echo area. */
5438 message_p
= push_message ();
5439 record_unwind_protect (pop_message_unwind
, Qnil
);
5441 /* Save a copy of the contents of the stack, for debugging. */
5442 #if MAX_SAVE_STACK > 0
5443 if (NILP (Vpurify_flag
))
5446 ptrdiff_t stack_size
;
5447 if (&stack_top_variable
< stack_bottom
)
5449 stack
= &stack_top_variable
;
5450 stack_size
= stack_bottom
- &stack_top_variable
;
5454 stack
= stack_bottom
;
5455 stack_size
= &stack_top_variable
- stack_bottom
;
5457 if (stack_size
<= MAX_SAVE_STACK
)
5459 if (stack_copy_size
< stack_size
)
5461 stack_copy
= xrealloc (stack_copy
, stack_size
);
5462 stack_copy_size
= stack_size
;
5464 memcpy (stack_copy
, stack
, stack_size
);
5467 #endif /* MAX_SAVE_STACK > 0 */
5469 if (garbage_collection_messages
)
5470 message1_nolog ("Garbage collecting...");
5474 shrink_regexp_cache ();
5478 /* Mark all the special slots that serve as the roots of accessibility. */
5480 for (i
= 0; i
< staticidx
; i
++)
5481 mark_object (*staticvec
[i
]);
5483 for (bind
= specpdl
; bind
!= specpdl_ptr
; bind
++)
5485 mark_object (bind
->symbol
);
5486 mark_object (bind
->old_value
);
5494 extern void xg_mark_data (void);
5499 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5500 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5504 register struct gcpro
*tail
;
5505 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5506 for (i
= 0; i
< tail
->nvars
; i
++)
5507 mark_object (tail
->var
[i
]);
5511 struct catchtag
*catch;
5512 struct handler
*handler
;
5514 for (catch = catchlist
; catch; catch = catch->next
)
5516 mark_object (catch->tag
);
5517 mark_object (catch->val
);
5519 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5521 mark_object (handler
->handler
);
5522 mark_object (handler
->var
);
5528 #ifdef HAVE_WINDOW_SYSTEM
5529 mark_fringe_data ();
5532 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5536 /* Everything is now marked, except for the things that require special
5537 finalization, i.e. the undo_list.
5538 Look thru every buffer's undo list
5539 for elements that update markers that were not marked,
5541 FOR_EACH_BUFFER (nextb
)
5543 /* If a buffer's undo list is Qt, that means that undo is
5544 turned off in that buffer. Calling truncate_undo_list on
5545 Qt tends to return NULL, which effectively turns undo back on.
5546 So don't call truncate_undo_list if undo_list is Qt. */
5547 if (! EQ (nextb
->INTERNAL_FIELD (undo_list
), Qt
))
5549 Lisp_Object tail
, prev
;
5550 tail
= nextb
->INTERNAL_FIELD (undo_list
);
5552 while (CONSP (tail
))
5554 if (CONSP (XCAR (tail
))
5555 && MARKERP (XCAR (XCAR (tail
)))
5556 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5559 nextb
->INTERNAL_FIELD (undo_list
) = tail
= XCDR (tail
);
5563 XSETCDR (prev
, tail
);
5573 /* Now that we have stripped the elements that need not be in the
5574 undo_list any more, we can finally mark the list. */
5575 mark_object (nextb
->INTERNAL_FIELD (undo_list
));
5580 /* Clear the mark bits that we set in certain root slots. */
5582 unmark_byte_stack ();
5583 VECTOR_UNMARK (&buffer_defaults
);
5584 VECTOR_UNMARK (&buffer_local_symbols
);
5586 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5596 consing_since_gc
= 0;
5597 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
5598 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
5600 gc_relative_threshold
= 0;
5601 if (FLOATP (Vgc_cons_percentage
))
5602 { /* Set gc_cons_combined_threshold. */
5605 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5606 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5607 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5608 tot
+= total_string_bytes
;
5609 tot
+= total_vector_slots
* word_size
;
5610 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5611 tot
+= total_intervals
* sizeof (struct interval
);
5612 tot
+= total_strings
* sizeof (struct Lisp_String
);
5614 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5617 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5618 gc_relative_threshold
= tot
;
5620 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5624 if (garbage_collection_messages
)
5626 if (message_p
|| minibuf_level
> 0)
5629 message1_nolog ("Garbage collecting...done");
5632 unbind_to (count
, Qnil
);
5634 total
[0] = list4 (Qcons
, make_number (sizeof (struct Lisp_Cons
)),
5635 bounded_number (total_conses
),
5636 bounded_number (total_free_conses
));
5638 total
[1] = list4 (Qsymbol
, make_number (sizeof (struct Lisp_Symbol
)),
5639 bounded_number (total_symbols
),
5640 bounded_number (total_free_symbols
));
5642 total
[2] = list4 (Qmisc
, make_number (sizeof (union Lisp_Misc
)),
5643 bounded_number (total_markers
),
5644 bounded_number (total_free_markers
));
5646 total
[3] = list4 (Qstring
, make_number (sizeof (struct Lisp_String
)),
5647 bounded_number (total_strings
),
5648 bounded_number (total_free_strings
));
5650 total
[4] = list3 (Qstring_bytes
, make_number (1),
5651 bounded_number (total_string_bytes
));
5653 total
[5] = list3 (Qvector
, make_number (sizeof (struct Lisp_Vector
)),
5654 bounded_number (total_vectors
));
5656 total
[6] = list4 (Qvector_slots
, make_number (word_size
),
5657 bounded_number (total_vector_slots
),
5658 bounded_number (total_free_vector_slots
));
5660 total
[7] = list4 (Qfloat
, make_number (sizeof (struct Lisp_Float
)),
5661 bounded_number (total_floats
),
5662 bounded_number (total_free_floats
));
5664 total
[8] = list4 (Qinterval
, make_number (sizeof (struct interval
)),
5665 bounded_number (total_intervals
),
5666 bounded_number (total_free_intervals
));
5668 total
[9] = list3 (Qbuffer
, make_number (sizeof (struct buffer
)),
5669 bounded_number (total_buffers
));
5671 total
[10] = list4 (Qheap
, make_number (1024),
5672 #ifdef DOUG_LEA_MALLOC
5673 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
5674 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10)
5680 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5682 /* Compute average percentage of zombies. */
5684 (total_conses
+ total_symbols
+ total_markers
+ total_strings
5685 + total_vectors
+ total_floats
+ total_intervals
+ total_buffers
);
5687 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5688 max_live
= max (nlive
, max_live
);
5689 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5690 max_zombies
= max (nzombies
, max_zombies
);
5695 if (!NILP (Vpost_gc_hook
))
5697 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5698 safe_run_hooks (Qpost_gc_hook
);
5699 unbind_to (gc_count
, Qnil
);
5702 /* Accumulate statistics. */
5703 if (FLOATP (Vgc_elapsed
))
5705 EMACS_TIME since_start
= sub_emacs_time (current_emacs_time (), start
);
5706 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5707 + EMACS_TIME_TO_DOUBLE (since_start
));
5712 return Flist (sizeof total
/ sizeof *total
, total
);
5716 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5717 only interesting objects referenced from glyphs are strings. */
5720 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5722 struct glyph_row
*row
= matrix
->rows
;
5723 struct glyph_row
*end
= row
+ matrix
->nrows
;
5725 for (; row
< end
; ++row
)
5729 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5731 struct glyph
*glyph
= row
->glyphs
[area
];
5732 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5734 for (; glyph
< end_glyph
; ++glyph
)
5735 if (STRINGP (glyph
->object
)
5736 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5737 mark_object (glyph
->object
);
5743 /* Mark Lisp faces in the face cache C. */
5746 mark_face_cache (struct face_cache
*c
)
5751 for (i
= 0; i
< c
->used
; ++i
)
5753 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5757 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5758 mark_object (face
->lface
[j
]);
5766 /* Mark reference to a Lisp_Object.
5767 If the object referred to has not been seen yet, recursively mark
5768 all the references contained in it. */
5770 #define LAST_MARKED_SIZE 500
5771 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5772 static int last_marked_index
;
5774 /* For debugging--call abort when we cdr down this many
5775 links of a list, in mark_object. In debugging,
5776 the call to abort will hit a breakpoint.
5777 Normally this is zero and the check never goes off. */
5778 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5781 mark_vectorlike (struct Lisp_Vector
*ptr
)
5783 ptrdiff_t size
= ptr
->header
.size
;
5786 eassert (!VECTOR_MARKED_P (ptr
));
5787 VECTOR_MARK (ptr
); /* Else mark it. */
5788 if (size
& PSEUDOVECTOR_FLAG
)
5789 size
&= PSEUDOVECTOR_SIZE_MASK
;
5791 /* Note that this size is not the memory-footprint size, but only
5792 the number of Lisp_Object fields that we should trace.
5793 The distinction is used e.g. by Lisp_Process which places extra
5794 non-Lisp_Object fields at the end of the structure... */
5795 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
5796 mark_object (ptr
->contents
[i
]);
5799 /* Like mark_vectorlike but optimized for char-tables (and
5800 sub-char-tables) assuming that the contents are mostly integers or
5804 mark_char_table (struct Lisp_Vector
*ptr
)
5806 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5809 eassert (!VECTOR_MARKED_P (ptr
));
5811 for (i
= 0; i
< size
; i
++)
5813 Lisp_Object val
= ptr
->contents
[i
];
5815 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5817 if (SUB_CHAR_TABLE_P (val
))
5819 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5820 mark_char_table (XVECTOR (val
));
5827 /* Mark the chain of overlays starting at PTR. */
5830 mark_overlay (struct Lisp_Overlay
*ptr
)
5832 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
5835 mark_object (MVAR (ptr
, start
));
5836 mark_object (MVAR (ptr
, end
));
5837 mark_object (MVAR (ptr
, plist
));
5841 /* Mark Lisp_Objects and special pointers in BUFFER. */
5844 mark_buffer (struct buffer
*buffer
)
5846 /* This is handled much like other pseudovectors... */
5847 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
5849 /* ...but there are some buffer-specific things. */
5851 MARK_INTERVAL_TREE (BUF_INTERVALS (buffer
));
5853 /* For now, we just don't mark the undo_list. It's done later in
5854 a special way just before the sweep phase, and after stripping
5855 some of its elements that are not needed any more. */
5857 mark_overlay (buffer
->overlays_before
);
5858 mark_overlay (buffer
->overlays_after
);
5860 /* If this is an indirect buffer, mark its base buffer. */
5861 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5862 mark_buffer (buffer
->base_buffer
);
5865 /* Determine type of generic Lisp_Object and mark it accordingly. */
5868 mark_object (Lisp_Object arg
)
5870 register Lisp_Object obj
= arg
;
5871 #ifdef GC_CHECK_MARKED_OBJECTS
5875 ptrdiff_t cdr_count
= 0;
5879 if (PURE_POINTER_P (XPNTR (obj
)))
5882 last_marked
[last_marked_index
++] = obj
;
5883 if (last_marked_index
== LAST_MARKED_SIZE
)
5884 last_marked_index
= 0;
5886 /* Perform some sanity checks on the objects marked here. Abort if
5887 we encounter an object we know is bogus. This increases GC time
5888 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5889 #ifdef GC_CHECK_MARKED_OBJECTS
5891 po
= (void *) XPNTR (obj
);
5893 /* Check that the object pointed to by PO is known to be a Lisp
5894 structure allocated from the heap. */
5895 #define CHECK_ALLOCATED() \
5897 m = mem_find (po); \
5902 /* Check that the object pointed to by PO is live, using predicate
5904 #define CHECK_LIVE(LIVEP) \
5906 if (!LIVEP (m, po)) \
5910 /* Check both of the above conditions. */
5911 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5913 CHECK_ALLOCATED (); \
5914 CHECK_LIVE (LIVEP); \
5917 #else /* not GC_CHECK_MARKED_OBJECTS */
5919 #define CHECK_LIVE(LIVEP) (void) 0
5920 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5922 #endif /* not GC_CHECK_MARKED_OBJECTS */
5924 switch (XTYPE (obj
))
5928 register struct Lisp_String
*ptr
= XSTRING (obj
);
5929 if (STRING_MARKED_P (ptr
))
5931 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
5933 MARK_INTERVAL_TREE (ptr
->intervals
);
5934 #ifdef GC_CHECK_STRING_BYTES
5935 /* Check that the string size recorded in the string is the
5936 same as the one recorded in the sdata structure. */
5938 #endif /* GC_CHECK_STRING_BYTES */
5942 case Lisp_Vectorlike
:
5944 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5945 register ptrdiff_t pvectype
;
5947 if (VECTOR_MARKED_P (ptr
))
5950 #ifdef GC_CHECK_MARKED_OBJECTS
5952 if (m
== MEM_NIL
&& !SUBRP (obj
)
5953 && po
!= &buffer_defaults
5954 && po
!= &buffer_local_symbols
)
5956 #endif /* GC_CHECK_MARKED_OBJECTS */
5958 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
5959 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
5960 >> PSEUDOVECTOR_SIZE_BITS
);
5964 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
5965 CHECK_LIVE (live_vector_p
);
5970 #ifdef GC_CHECK_MARKED_OBJECTS
5971 if (po
!= &buffer_defaults
&& po
!= &buffer_local_symbols
)
5980 #endif /* GC_CHECK_MARKED_OBJECTS */
5981 mark_buffer ((struct buffer
*) ptr
);
5985 { /* We could treat this just like a vector, but it is better
5986 to save the COMPILED_CONSTANTS element for last and avoid
5988 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5992 for (i
= 0; i
< size
; i
++)
5993 if (i
!= COMPILED_CONSTANTS
)
5994 mark_object (ptr
->contents
[i
]);
5995 if (size
> COMPILED_CONSTANTS
)
5997 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
6005 mark_vectorlike (ptr
);
6006 mark_face_cache (((struct frame
*) ptr
)->face_cache
);
6012 struct window
*w
= (struct window
*) ptr
;
6014 mark_vectorlike (ptr
);
6015 /* Mark glyphs for leaf windows. Marking window
6016 matrices is sufficient because frame matrices
6017 use the same glyph memory. */
6018 if (NILP (WVAR (w
, hchild
)) && NILP (WVAR (w
, vchild
))
6019 && w
->current_matrix
)
6021 mark_glyph_matrix (w
->current_matrix
);
6022 mark_glyph_matrix (w
->desired_matrix
);
6027 case PVEC_HASH_TABLE
:
6029 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6031 mark_vectorlike (ptr
);
6032 /* If hash table is not weak, mark all keys and values.
6033 For weak tables, mark only the vector. */
6035 mark_object (h
->key_and_value
);
6037 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6041 case PVEC_CHAR_TABLE
:
6042 mark_char_table (ptr
);
6045 case PVEC_BOOL_VECTOR
:
6046 /* No Lisp_Objects to mark in a bool vector. */
6057 mark_vectorlike (ptr
);
6064 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6065 struct Lisp_Symbol
*ptrx
;
6069 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
6071 mark_object (SVAR (ptr
, function
));
6072 mark_object (SVAR (ptr
, plist
));
6073 switch (ptr
->redirect
)
6075 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6076 case SYMBOL_VARALIAS
:
6079 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6083 case SYMBOL_LOCALIZED
:
6085 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
6086 /* If the value is forwarded to a buffer or keyboard field,
6087 these are marked when we see the corresponding object.
6088 And if it's forwarded to a C variable, either it's not
6089 a Lisp_Object var, or it's staticpro'd already. */
6090 mark_object (blv
->where
);
6091 mark_object (blv
->valcell
);
6092 mark_object (blv
->defcell
);
6095 case SYMBOL_FORWARDED
:
6096 /* If the value is forwarded to a buffer or keyboard field,
6097 these are marked when we see the corresponding object.
6098 And if it's forwarded to a C variable, either it's not
6099 a Lisp_Object var, or it's staticpro'd already. */
6103 if (!PURE_POINTER_P (XSTRING (SVAR (ptr
, xname
))))
6104 MARK_STRING (XSTRING (SVAR (ptr
, xname
)));
6105 MARK_INTERVAL_TREE (STRING_INTERVALS (SVAR (ptr
, xname
)));
6110 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun. */
6111 XSETSYMBOL (obj
, ptrx
);
6118 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6120 if (XMISCANY (obj
)->gcmarkbit
)
6123 switch (XMISCTYPE (obj
))
6125 case Lisp_Misc_Marker
:
6126 /* DO NOT mark thru the marker's chain.
6127 The buffer's markers chain does not preserve markers from gc;
6128 instead, markers are removed from the chain when freed by gc. */
6129 XMISCANY (obj
)->gcmarkbit
= 1;
6132 case Lisp_Misc_Save_Value
:
6133 XMISCANY (obj
)->gcmarkbit
= 1;
6136 register struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
6137 /* If DOGC is set, POINTER is the address of a memory
6138 area containing INTEGER potential Lisp_Objects. */
6141 Lisp_Object
*p
= (Lisp_Object
*) ptr
->pointer
;
6143 for (nelt
= ptr
->integer
; nelt
> 0; nelt
--, p
++)
6144 mark_maybe_object (*p
);
6150 case Lisp_Misc_Overlay
:
6151 mark_overlay (XOVERLAY (obj
));
6161 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6162 if (CONS_MARKED_P (ptr
))
6164 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6166 /* If the cdr is nil, avoid recursion for the car. */
6167 if (EQ (CVAR (ptr
, u
.cdr
), Qnil
))
6169 obj
= CVAR (ptr
, car
);
6173 mark_object (CVAR (ptr
, car
));
6174 obj
= CVAR (ptr
, u
.cdr
);
6176 if (cdr_count
== mark_object_loop_halt
)
6182 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6183 FLOAT_MARK (XFLOAT (obj
));
6194 #undef CHECK_ALLOCATED
6195 #undef CHECK_ALLOCATED_AND_LIVE
6197 /* Mark the Lisp pointers in the terminal objects.
6198 Called by Fgarbage_collect. */
6201 mark_terminals (void)
6204 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6206 eassert (t
->name
!= NULL
);
6207 #ifdef HAVE_WINDOW_SYSTEM
6208 /* If a terminal object is reachable from a stacpro'ed object,
6209 it might have been marked already. Make sure the image cache
6211 mark_image_cache (t
->image_cache
);
6212 #endif /* HAVE_WINDOW_SYSTEM */
6213 if (!VECTOR_MARKED_P (t
))
6214 mark_vectorlike ((struct Lisp_Vector
*)t
);
6220 /* Value is non-zero if OBJ will survive the current GC because it's
6221 either marked or does not need to be marked to survive. */
6224 survives_gc_p (Lisp_Object obj
)
6228 switch (XTYPE (obj
))
6235 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6239 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6243 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6246 case Lisp_Vectorlike
:
6247 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6251 survives_p
= CONS_MARKED_P (XCONS (obj
));
6255 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6262 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
6267 /* Sweep: find all structures not marked, and free them. */
6272 /* Remove or mark entries in weak hash tables.
6273 This must be done before any object is unmarked. */
6274 sweep_weak_hash_tables ();
6277 check_string_bytes (!noninteractive
);
6279 /* Put all unmarked conses on free list */
6281 register struct cons_block
*cblk
;
6282 struct cons_block
**cprev
= &cons_block
;
6283 register int lim
= cons_block_index
;
6284 EMACS_INT num_free
= 0, num_used
= 0;
6288 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6292 int ilim
= (lim
+ BITS_PER_INT
- 1) / BITS_PER_INT
;
6294 /* Scan the mark bits an int at a time. */
6295 for (i
= 0; i
< ilim
; i
++)
6297 if (cblk
->gcmarkbits
[i
] == -1)
6299 /* Fast path - all cons cells for this int are marked. */
6300 cblk
->gcmarkbits
[i
] = 0;
6301 num_used
+= BITS_PER_INT
;
6305 /* Some cons cells for this int are not marked.
6306 Find which ones, and free them. */
6307 int start
, pos
, stop
;
6309 start
= i
* BITS_PER_INT
;
6311 if (stop
> BITS_PER_INT
)
6312 stop
= BITS_PER_INT
;
6315 for (pos
= start
; pos
< stop
; pos
++)
6317 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6320 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6321 cons_free_list
= &cblk
->conses
[pos
];
6323 CVAR (cons_free_list
, car
) = Vdead
;
6329 CONS_UNMARK (&cblk
->conses
[pos
]);
6335 lim
= CONS_BLOCK_SIZE
;
6336 /* If this block contains only free conses and we have already
6337 seen more than two blocks worth of free conses then deallocate
6339 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6341 *cprev
= cblk
->next
;
6342 /* Unhook from the free list. */
6343 cons_free_list
= cblk
->conses
[0].u
.chain
;
6344 lisp_align_free (cblk
);
6348 num_free
+= this_free
;
6349 cprev
= &cblk
->next
;
6352 total_conses
= num_used
;
6353 total_free_conses
= num_free
;
6356 /* Put all unmarked floats on free list */
6358 register struct float_block
*fblk
;
6359 struct float_block
**fprev
= &float_block
;
6360 register int lim
= float_block_index
;
6361 EMACS_INT num_free
= 0, num_used
= 0;
6363 float_free_list
= 0;
6365 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6369 for (i
= 0; i
< lim
; i
++)
6370 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6373 fblk
->floats
[i
].u
.chain
= float_free_list
;
6374 float_free_list
= &fblk
->floats
[i
];
6379 FLOAT_UNMARK (&fblk
->floats
[i
]);
6381 lim
= FLOAT_BLOCK_SIZE
;
6382 /* If this block contains only free floats and we have already
6383 seen more than two blocks worth of free floats then deallocate
6385 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6387 *fprev
= fblk
->next
;
6388 /* Unhook from the free list. */
6389 float_free_list
= fblk
->floats
[0].u
.chain
;
6390 lisp_align_free (fblk
);
6394 num_free
+= this_free
;
6395 fprev
= &fblk
->next
;
6398 total_floats
= num_used
;
6399 total_free_floats
= num_free
;
6402 /* Put all unmarked intervals on free list */
6404 register struct interval_block
*iblk
;
6405 struct interval_block
**iprev
= &interval_block
;
6406 register int lim
= interval_block_index
;
6407 EMACS_INT num_free
= 0, num_used
= 0;
6409 interval_free_list
= 0;
6411 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6416 for (i
= 0; i
< lim
; i
++)
6418 if (!iblk
->intervals
[i
].gcmarkbit
)
6420 SET_INTERVAL_PARENT (&iblk
->intervals
[i
], interval_free_list
);
6421 interval_free_list
= &iblk
->intervals
[i
];
6427 iblk
->intervals
[i
].gcmarkbit
= 0;
6430 lim
= INTERVAL_BLOCK_SIZE
;
6431 /* If this block contains only free intervals and we have already
6432 seen more than two blocks worth of free intervals then
6433 deallocate this block. */
6434 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6436 *iprev
= iblk
->next
;
6437 /* Unhook from the free list. */
6438 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6443 num_free
+= this_free
;
6444 iprev
= &iblk
->next
;
6447 total_intervals
= num_used
;
6448 total_free_intervals
= num_free
;
6451 /* Put all unmarked symbols on free list */
6453 register struct symbol_block
*sblk
;
6454 struct symbol_block
**sprev
= &symbol_block
;
6455 register int lim
= symbol_block_index
;
6456 EMACS_INT num_free
= 0, num_used
= 0;
6458 symbol_free_list
= NULL
;
6460 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6463 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6464 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6466 for (; sym
< end
; ++sym
)
6468 /* Check if the symbol was created during loadup. In such a case
6469 it might be pointed to by pure bytecode which we don't trace,
6470 so we conservatively assume that it is live. */
6471 int pure_p
= PURE_POINTER_P (XSTRING (sym
->s
.INTERNAL_FIELD (xname
)));
6473 if (!sym
->s
.gcmarkbit
&& !pure_p
)
6475 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6476 xfree (SYMBOL_BLV (&sym
->s
));
6477 sym
->s
.next
= symbol_free_list
;
6478 symbol_free_list
= &sym
->s
;
6480 SVAR (symbol_free_list
, function
) = Vdead
;
6488 UNMARK_STRING (XSTRING (sym
->s
.INTERNAL_FIELD (xname
)));
6489 sym
->s
.gcmarkbit
= 0;
6493 lim
= SYMBOL_BLOCK_SIZE
;
6494 /* If this block contains only free symbols and we have already
6495 seen more than two blocks worth of free symbols then deallocate
6497 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6499 *sprev
= sblk
->next
;
6500 /* Unhook from the free list. */
6501 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6506 num_free
+= this_free
;
6507 sprev
= &sblk
->next
;
6510 total_symbols
= num_used
;
6511 total_free_symbols
= num_free
;
6514 /* Put all unmarked misc's on free list.
6515 For a marker, first unchain it from the buffer it points into. */
6517 register struct marker_block
*mblk
;
6518 struct marker_block
**mprev
= &marker_block
;
6519 register int lim
= marker_block_index
;
6520 EMACS_INT num_free
= 0, num_used
= 0;
6522 marker_free_list
= 0;
6524 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6529 for (i
= 0; i
< lim
; i
++)
6531 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6533 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6534 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6535 /* Set the type of the freed object to Lisp_Misc_Free.
6536 We could leave the type alone, since nobody checks it,
6537 but this might catch bugs faster. */
6538 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6539 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6540 marker_free_list
= &mblk
->markers
[i
].m
;
6546 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6549 lim
= MARKER_BLOCK_SIZE
;
6550 /* If this block contains only free markers and we have already
6551 seen more than two blocks worth of free markers then deallocate
6553 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6555 *mprev
= mblk
->next
;
6556 /* Unhook from the free list. */
6557 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6562 num_free
+= this_free
;
6563 mprev
= &mblk
->next
;
6567 total_markers
= num_used
;
6568 total_free_markers
= num_free
;
6571 /* Free all unmarked buffers */
6573 register struct buffer
*buffer
= all_buffers
, *prev
= 0, *next
;
6577 if (!VECTOR_MARKED_P (buffer
))
6580 prev
->header
.next
= buffer
->header
.next
;
6582 all_buffers
= buffer
->header
.next
.buffer
;
6583 next
= buffer
->header
.next
.buffer
;
6589 VECTOR_UNMARK (buffer
);
6590 UNMARK_BALANCE_INTERVALS (BUF_INTERVALS (buffer
));
6592 prev
= buffer
, buffer
= buffer
->header
.next
.buffer
;
6597 check_string_bytes (!noninteractive
);
6603 /* Debugging aids. */
6605 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6606 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6607 This may be helpful in debugging Emacs's memory usage.
6608 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6613 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6618 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6619 doc
: /* Return a list of counters that measure how much consing there has been.
6620 Each of these counters increments for a certain kind of object.
6621 The counters wrap around from the largest positive integer to zero.
6622 Garbage collection does not decrease them.
6623 The elements of the value are as follows:
6624 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6625 All are in units of 1 = one object consed
6626 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6628 MISCS include overlays, markers, and some internal types.
6629 Frames, windows, buffers, and subprocesses count as vectors
6630 (but the contents of a buffer's text do not count here). */)
6633 return listn (CONSTYPE_HEAP
, 8,
6634 bounded_number (cons_cells_consed
),
6635 bounded_number (floats_consed
),
6636 bounded_number (vector_cells_consed
),
6637 bounded_number (symbols_consed
),
6638 bounded_number (string_chars_consed
),
6639 bounded_number (misc_objects_consed
),
6640 bounded_number (intervals_consed
),
6641 bounded_number (strings_consed
));
6644 /* Find at most FIND_MAX symbols which have OBJ as their value or
6645 function. This is used in gdbinit's `xwhichsymbols' command. */
6648 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6650 struct symbol_block
*sblk
;
6651 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6652 Lisp_Object found
= Qnil
;
6656 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6658 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
6661 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
6663 struct Lisp_Symbol
*sym
= &aligned_sym
->s
;
6667 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6670 XSETSYMBOL (tem
, sym
);
6671 val
= find_symbol_value (tem
);
6673 || EQ (SVAR (sym
, function
), obj
)
6674 || (!NILP (SVAR (sym
, function
))
6675 && COMPILEDP (SVAR (sym
, function
))
6676 && EQ (AREF (SVAR (sym
, function
), COMPILED_BYTECODE
), obj
))
6679 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)))
6681 found
= Fcons (tem
, found
);
6682 if (--find_max
== 0)
6690 unbind_to (gc_count
, Qnil
);
6694 #ifdef ENABLE_CHECKING
6695 int suppress_checking
;
6698 die (const char *msg
, const char *file
, int line
)
6700 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: %s\r\n",
6706 /* Initialization */
6709 init_alloc_once (void)
6711 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6713 pure_size
= PURESIZE
;
6715 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6717 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6720 #ifdef DOUG_LEA_MALLOC
6721 mallopt (M_TRIM_THRESHOLD
, 128*1024); /* trim threshold */
6722 mallopt (M_MMAP_THRESHOLD
, 64*1024); /* mmap threshold */
6723 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* max. number of mmap'ed areas */
6729 malloc_hysteresis
= 32;
6731 malloc_hysteresis
= 0;
6734 refill_memory_reserve ();
6735 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
6742 byte_stack_list
= 0;
6744 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6745 setjmp_tested_p
= longjmps_done
= 0;
6748 Vgc_elapsed
= make_float (0.0);
6753 syms_of_alloc (void)
6755 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6756 doc
: /* Number of bytes of consing between garbage collections.
6757 Garbage collection can happen automatically once this many bytes have been
6758 allocated since the last garbage collection. All data types count.
6760 Garbage collection happens automatically only when `eval' is called.
6762 By binding this temporarily to a large number, you can effectively
6763 prevent garbage collection during a part of the program.
6764 See also `gc-cons-percentage'. */);
6766 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6767 doc
: /* Portion of the heap used for allocation.
6768 Garbage collection can happen automatically once this portion of the heap
6769 has been allocated since the last garbage collection.
6770 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6771 Vgc_cons_percentage
= make_float (0.1);
6773 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6774 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
6776 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6777 doc
: /* Number of cons cells that have been consed so far. */);
6779 DEFVAR_INT ("floats-consed", floats_consed
,
6780 doc
: /* Number of floats that have been consed so far. */);
6782 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
6783 doc
: /* Number of vector cells that have been consed so far. */);
6785 DEFVAR_INT ("symbols-consed", symbols_consed
,
6786 doc
: /* Number of symbols that have been consed so far. */);
6788 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
6789 doc
: /* Number of string characters that have been consed so far. */);
6791 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
6792 doc
: /* Number of miscellaneous objects that have been consed so far.
6793 These include markers and overlays, plus certain objects not visible
6796 DEFVAR_INT ("intervals-consed", intervals_consed
,
6797 doc
: /* Number of intervals that have been consed so far. */);
6799 DEFVAR_INT ("strings-consed", strings_consed
,
6800 doc
: /* Number of strings that have been consed so far. */);
6802 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
6803 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
6804 This means that certain objects should be allocated in shared (pure) space.
6805 It can also be set to a hash-table, in which case this table is used to
6806 do hash-consing of the objects allocated to pure space. */);
6808 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
6809 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
6810 garbage_collection_messages
= 0;
6812 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
6813 doc
: /* Hook run after garbage collection has finished. */);
6814 Vpost_gc_hook
= Qnil
;
6815 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
6817 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
6818 doc
: /* Precomputed `signal' argument for memory-full error. */);
6819 /* We build this in advance because if we wait until we need it, we might
6820 not be able to allocate the memory to hold it. */
6822 = listn (CONSTYPE_PURE
, 2, Qerror
,
6823 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
6825 DEFVAR_LISP ("memory-full", Vmemory_full
,
6826 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
6827 Vmemory_full
= Qnil
;
6829 DEFSYM (Qstring_bytes
, "string-bytes");
6830 DEFSYM (Qvector_slots
, "vector-slots");
6831 DEFSYM (Qheap
, "heap");
6833 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
6834 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
6836 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
6837 doc
: /* Accumulated time elapsed in garbage collections.
6838 The time is in seconds as a floating point value. */);
6839 DEFVAR_INT ("gcs-done", gcs_done
,
6840 doc
: /* Accumulated number of garbage collections done. */);
6845 defsubr (&Smake_byte_code
);
6846 defsubr (&Smake_list
);
6847 defsubr (&Smake_vector
);
6848 defsubr (&Smake_string
);
6849 defsubr (&Smake_bool_vector
);
6850 defsubr (&Smake_symbol
);
6851 defsubr (&Smake_marker
);
6852 defsubr (&Spurecopy
);
6853 defsubr (&Sgarbage_collect
);
6854 defsubr (&Smemory_limit
);
6855 defsubr (&Smemory_use_counts
);
6857 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
6858 defsubr (&Sgc_status
);
6862 /* When compiled with GCC, GDB might say "No enum type named
6863 pvec_type" if we don't have at least one symbol with that type, and
6864 then xbacktrace could fail. Similarly for the other enums and
6868 enum CHARTAB_SIZE_BITS CHARTAB_SIZE_BITS
;
6869 enum CHAR_TABLE_STANDARD_SLOTS CHAR_TABLE_STANDARD_SLOTS
;
6870 enum char_bits char_bits
;
6871 enum CHECK_LISP_OBJECT_TYPE CHECK_LISP_OBJECT_TYPE
;
6872 enum DEFAULT_HASH_SIZE DEFAULT_HASH_SIZE
;
6873 enum enum_USE_LSB_TAG enum_USE_LSB_TAG
;
6874 enum FLOAT_TO_STRING_BUFSIZE FLOAT_TO_STRING_BUFSIZE
;
6875 enum Lisp_Bits Lisp_Bits
;
6876 enum Lisp_Compiled Lisp_Compiled
;
6877 enum maxargs maxargs
;
6878 enum MAX_ALLOCA MAX_ALLOCA
;
6879 enum More_Lisp_Bits More_Lisp_Bits
;
6880 enum pvec_type pvec_type
;
6882 enum lsb_bits lsb_bits
;
6884 } const EXTERNALLY_VISIBLE gdb_make_enums_visible
= {0};