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 #include <limits.h> /* For CHAR_BIT. */
32 /* This file is part of the core Lisp implementation, and thus must
33 deal with the real data structures. If the Lisp implementation is
34 replaced, this file likely will not be used. */
36 #undef HIDE_LISP_IMPLEMENTATION
39 #include "intervals.h"
41 #include "character.h"
46 #include "blockinput.h"
47 #include "syssignal.h"
48 #include "termhooks.h" /* For struct terminal. */
52 /* GC_CHECK_MARKED_OBJECTS means do sanity checks on allocated objects.
53 Doable only if GC_MARK_STACK. */
55 # undef GC_CHECK_MARKED_OBJECTS
58 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
59 memory. Can do this only if using gmalloc.c and if not checking
62 #if (defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC \
63 || defined GC_CHECK_MARKED_OBJECTS)
64 #undef GC_MALLOC_CHECK
78 #ifdef DOUG_LEA_MALLOC
82 /* Specify maximum number of areas to mmap. It would be nice to use a
83 value that explicitly means "no limit". */
85 #define MMAP_MAX_AREAS 100000000
87 #else /* not DOUG_LEA_MALLOC */
89 /* The following come from gmalloc.c. */
91 extern size_t _bytes_used
;
92 extern size_t __malloc_extra_blocks
;
93 extern void *_malloc_internal (size_t);
94 extern void _free_internal (void *);
96 #endif /* not DOUG_LEA_MALLOC */
98 #if ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT
101 /* When GTK uses the file chooser dialog, different backends can be loaded
102 dynamically. One such a backend is the Gnome VFS backend that gets loaded
103 if you run Gnome. That backend creates several threads and also allocates
106 Also, gconf and gsettings may create several threads.
108 If Emacs sets malloc hooks (! SYSTEM_MALLOC) and the emacs_blocked_*
109 functions below are called from malloc, there is a chance that one
110 of these threads preempts the Emacs main thread and the hook variables
111 end up in an inconsistent state. So we have a mutex to prevent that (note
112 that the backend handles concurrent access to malloc within its own threads
113 but Emacs code running in the main thread is not included in that control).
115 When UNBLOCK_INPUT is called, reinvoke_input_signal may be called. If this
116 happens in one of the backend threads we will have two threads that tries
117 to run Emacs code at once, and the code is not prepared for that.
118 To prevent that, we only call BLOCK/UNBLOCK from the main thread. */
120 static pthread_mutex_t alloc_mutex
;
122 #define BLOCK_INPUT_ALLOC \
125 if (pthread_equal (pthread_self (), main_thread)) \
127 pthread_mutex_lock (&alloc_mutex); \
130 #define UNBLOCK_INPUT_ALLOC \
133 pthread_mutex_unlock (&alloc_mutex); \
134 if (pthread_equal (pthread_self (), main_thread)) \
139 #else /* ! defined HAVE_PTHREAD */
141 #define BLOCK_INPUT_ALLOC BLOCK_INPUT
142 #define UNBLOCK_INPUT_ALLOC UNBLOCK_INPUT
144 #endif /* ! defined HAVE_PTHREAD */
145 #endif /* ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT */
147 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
148 to a struct Lisp_String. */
150 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
151 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
152 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
154 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
155 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
156 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
158 /* Value is the number of bytes of S, a pointer to a struct Lisp_String.
159 Be careful during GC, because S->size contains the mark bit for
162 #define GC_STRING_BYTES(S) (STRING_BYTES (S))
164 /* Default value of gc_cons_threshold (see below). */
166 #define GC_DEFAULT_THRESHOLD (100000 * sizeof (Lisp_Object))
168 /* Global variables. */
169 struct emacs_globals globals
;
171 /* Number of bytes of consing done since the last gc. */
173 EMACS_INT consing_since_gc
;
175 /* Similar minimum, computed from Vgc_cons_percentage. */
177 EMACS_INT gc_relative_threshold
;
179 /* Minimum number of bytes of consing since GC before next GC,
180 when memory is full. */
182 EMACS_INT memory_full_cons_threshold
;
184 /* Nonzero during GC. */
188 /* Nonzero means abort if try to GC.
189 This is for code which is written on the assumption that
190 no GC will happen, so as to verify that assumption. */
194 /* Number of live and free conses etc. */
196 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_buffers
;
197 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
198 static EMACS_INT total_free_floats
, total_floats
;
200 /* Points to memory space allocated as "spare", to be freed if we run
201 out of memory. We keep one large block, four cons-blocks, and
202 two string blocks. */
204 static char *spare_memory
[7];
206 /* Amount of spare memory to keep in large reserve block, or to see
207 whether this much is available when malloc fails on a larger request. */
209 #define SPARE_MEMORY (1 << 14)
211 /* Number of extra blocks malloc should get when it needs more core. */
213 static int malloc_hysteresis
;
215 /* Initialize it to a nonzero value to force it into data space
216 (rather than bss space). That way unexec will remap it into text
217 space (pure), on some systems. We have not implemented the
218 remapping on more recent systems because this is less important
219 nowadays than in the days of small memories and timesharing. */
221 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
222 #define PUREBEG (char *) pure
224 /* Pointer to the pure area, and its size. */
226 static char *purebeg
;
227 static ptrdiff_t pure_size
;
229 /* Number of bytes of pure storage used before pure storage overflowed.
230 If this is non-zero, this implies that an overflow occurred. */
232 static ptrdiff_t pure_bytes_used_before_overflow
;
234 /* Value is non-zero if P points into pure space. */
236 #define PURE_POINTER_P(P) \
237 ((uintptr_t) (P) - (uintptr_t) purebeg <= pure_size)
239 /* Index in pure at which next pure Lisp object will be allocated.. */
241 static ptrdiff_t pure_bytes_used_lisp
;
243 /* Number of bytes allocated for non-Lisp objects in pure storage. */
245 static ptrdiff_t pure_bytes_used_non_lisp
;
247 /* If nonzero, this is a warning delivered by malloc and not yet
250 const char *pending_malloc_warning
;
252 /* Maximum amount of C stack to save when a GC happens. */
254 #ifndef MAX_SAVE_STACK
255 #define MAX_SAVE_STACK 16000
258 /* Buffer in which we save a copy of the C stack at each GC. */
260 #if MAX_SAVE_STACK > 0
261 static char *stack_copy
;
262 static ptrdiff_t stack_copy_size
;
265 static Lisp_Object Qstring_bytes
, Qvector_slots
, Qheap
;
266 static Lisp_Object Qgc_cons_threshold
;
267 Lisp_Object Qchar_table_extra_slots
;
269 /* Hook run after GC has finished. */
271 static Lisp_Object Qpost_gc_hook
;
273 static void mark_terminals (void);
274 static void gc_sweep (void);
275 static Lisp_Object
make_pure_vector (ptrdiff_t);
276 static void mark_glyph_matrix (struct glyph_matrix
*);
277 static void mark_face_cache (struct face_cache
*);
279 #if !defined REL_ALLOC || defined SYSTEM_MALLOC
280 static void refill_memory_reserve (void);
282 static struct Lisp_String
*allocate_string (void);
283 static void compact_small_strings (void);
284 static void free_large_strings (void);
285 static void sweep_strings (void);
286 static void free_misc (Lisp_Object
);
287 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
289 /* Handy constants for vectorlike objects. */
292 header_size
= offsetof (struct Lisp_Vector
, contents
),
293 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
294 word_size
= sizeof (Lisp_Object
)
297 /* When scanning the C stack for live Lisp objects, Emacs keeps track
298 of what memory allocated via lisp_malloc is intended for what
299 purpose. This enumeration specifies the type of memory. */
310 /* We used to keep separate mem_types for subtypes of vectors such as
311 process, hash_table, frame, terminal, and window, but we never made
312 use of the distinction, so it only caused source-code complexity
313 and runtime slowdown. Minor but pointless. */
315 /* Special type to denote vector blocks. */
316 MEM_TYPE_VECTOR_BLOCK
319 static void *lisp_malloc (size_t, enum mem_type
);
322 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
324 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
325 #include <stdio.h> /* For fprintf. */
328 /* A unique object in pure space used to make some Lisp objects
329 on free lists recognizable in O(1). */
331 static Lisp_Object Vdead
;
332 #define DEADP(x) EQ (x, Vdead)
334 #ifdef GC_MALLOC_CHECK
336 enum mem_type allocated_mem_type
;
338 #endif /* GC_MALLOC_CHECK */
340 /* A node in the red-black tree describing allocated memory containing
341 Lisp data. Each such block is recorded with its start and end
342 address when it is allocated, and removed from the tree when it
345 A red-black tree is a balanced binary tree with the following
348 1. Every node is either red or black.
349 2. Every leaf is black.
350 3. If a node is red, then both of its children are black.
351 4. Every simple path from a node to a descendant leaf contains
352 the same number of black nodes.
353 5. The root is always black.
355 When nodes are inserted into the tree, or deleted from the tree,
356 the tree is "fixed" so that these properties are always true.
358 A red-black tree with N internal nodes has height at most 2
359 log(N+1). Searches, insertions and deletions are done in O(log N).
360 Please see a text book about data structures for a detailed
361 description of red-black trees. Any book worth its salt should
366 /* Children of this node. These pointers are never NULL. When there
367 is no child, the value is MEM_NIL, which points to a dummy node. */
368 struct mem_node
*left
, *right
;
370 /* The parent of this node. In the root node, this is NULL. */
371 struct mem_node
*parent
;
373 /* Start and end of allocated region. */
377 enum {MEM_BLACK
, MEM_RED
} color
;
383 /* Base address of stack. Set in main. */
385 Lisp_Object
*stack_base
;
387 /* Root of the tree describing allocated Lisp memory. */
389 static struct mem_node
*mem_root
;
391 /* Lowest and highest known address in the heap. */
393 static void *min_heap_address
, *max_heap_address
;
395 /* Sentinel node of the tree. */
397 static struct mem_node mem_z
;
398 #define MEM_NIL &mem_z
400 static struct Lisp_Vector
*allocate_vectorlike (ptrdiff_t);
401 static void lisp_free (void *);
402 static void mark_stack (void);
403 static int live_vector_p (struct mem_node
*, void *);
404 static int live_buffer_p (struct mem_node
*, void *);
405 static int live_string_p (struct mem_node
*, void *);
406 static int live_cons_p (struct mem_node
*, void *);
407 static int live_symbol_p (struct mem_node
*, void *);
408 static int live_float_p (struct mem_node
*, void *);
409 static int live_misc_p (struct mem_node
*, void *);
410 static void mark_maybe_object (Lisp_Object
);
411 static void mark_memory (void *, void *);
412 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
413 static void mem_init (void);
414 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
415 static void mem_insert_fixup (struct mem_node
*);
417 static void mem_rotate_left (struct mem_node
*);
418 static void mem_rotate_right (struct mem_node
*);
419 static void mem_delete (struct mem_node
*);
420 static void mem_delete_fixup (struct mem_node
*);
421 static inline struct mem_node
*mem_find (void *);
424 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
425 static void check_gcpros (void);
428 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
434 /* Recording what needs to be marked for gc. */
436 struct gcpro
*gcprolist
;
438 /* Addresses of staticpro'd variables. Initialize it to a nonzero
439 value; otherwise some compilers put it into BSS. */
441 #define NSTATICS 0x650
442 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
444 /* Index of next unused slot in staticvec. */
446 static int staticidx
;
448 static void *pure_alloc (size_t, int);
451 /* Value is SZ rounded up to the next multiple of ALIGNMENT.
452 ALIGNMENT must be a power of 2. */
454 #define ALIGN(ptr, ALIGNMENT) \
455 ((void *) (((uintptr_t) (ptr) + (ALIGNMENT) - 1) \
456 & ~ ((ALIGNMENT) - 1)))
460 /************************************************************************
462 ************************************************************************/
464 /* Function malloc calls this if it finds we are near exhausting storage. */
467 malloc_warning (const char *str
)
469 pending_malloc_warning
= str
;
473 /* Display an already-pending malloc warning. */
476 display_malloc_warning (void)
478 call3 (intern ("display-warning"),
480 build_string (pending_malloc_warning
),
481 intern ("emergency"));
482 pending_malloc_warning
= 0;
485 /* Called if we can't allocate relocatable space for a buffer. */
488 buffer_memory_full (ptrdiff_t nbytes
)
490 /* If buffers use the relocating allocator, no need to free
491 spare_memory, because we may have plenty of malloc space left
492 that we could get, and if we don't, the malloc that fails will
493 itself cause spare_memory to be freed. If buffers don't use the
494 relocating allocator, treat this like any other failing
498 memory_full (nbytes
);
501 /* This used to call error, but if we've run out of memory, we could
502 get infinite recursion trying to build the string. */
503 xsignal (Qnil
, Vmemory_signal_data
);
506 /* A common multiple of the positive integers A and B. Ideally this
507 would be the least common multiple, but there's no way to do that
508 as a constant expression in C, so do the best that we can easily do. */
509 #define COMMON_MULTIPLE(a, b) \
510 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
512 #ifndef XMALLOC_OVERRUN_CHECK
513 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
516 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
519 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
520 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
521 block size in little-endian order. The trailer consists of
522 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
524 The header is used to detect whether this block has been allocated
525 through these functions, as some low-level libc functions may
526 bypass the malloc hooks. */
528 #define XMALLOC_OVERRUN_CHECK_SIZE 16
529 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
530 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
532 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
533 hold a size_t value and (2) the header size is a multiple of the
534 alignment that Emacs needs for C types and for USE_LSB_TAG. */
535 #define XMALLOC_BASE_ALIGNMENT \
536 alignof (union { long double d; intmax_t i; void *p; })
539 # define XMALLOC_HEADER_ALIGNMENT \
540 COMMON_MULTIPLE (1 << GCTYPEBITS, XMALLOC_BASE_ALIGNMENT)
542 # define XMALLOC_HEADER_ALIGNMENT XMALLOC_BASE_ALIGNMENT
544 #define XMALLOC_OVERRUN_SIZE_SIZE \
545 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
546 + XMALLOC_HEADER_ALIGNMENT - 1) \
547 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
548 - XMALLOC_OVERRUN_CHECK_SIZE)
550 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
551 { '\x9a', '\x9b', '\xae', '\xaf',
552 '\xbf', '\xbe', '\xce', '\xcf',
553 '\xea', '\xeb', '\xec', '\xed',
554 '\xdf', '\xde', '\x9c', '\x9d' };
556 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
557 { '\xaa', '\xab', '\xac', '\xad',
558 '\xba', '\xbb', '\xbc', '\xbd',
559 '\xca', '\xcb', '\xcc', '\xcd',
560 '\xda', '\xdb', '\xdc', '\xdd' };
562 /* Insert and extract the block size in the header. */
565 xmalloc_put_size (unsigned char *ptr
, size_t size
)
568 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
570 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
576 xmalloc_get_size (unsigned char *ptr
)
580 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
581 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
590 /* The call depth in overrun_check functions. For example, this might happen:
592 overrun_check_malloc()
593 -> malloc -> (via hook)_-> emacs_blocked_malloc
594 -> overrun_check_malloc
595 call malloc (hooks are NULL, so real malloc is called).
596 malloc returns 10000.
597 add overhead, return 10016.
598 <- (back in overrun_check_malloc)
599 add overhead again, return 10032
600 xmalloc returns 10032.
605 overrun_check_free(10032)
607 free(10016) <- crash, because 10000 is the original pointer. */
609 static ptrdiff_t check_depth
;
611 /* Like malloc, but wraps allocated block with header and trailer. */
614 overrun_check_malloc (size_t size
)
616 register unsigned char *val
;
617 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
618 if (SIZE_MAX
- overhead
< size
)
621 val
= malloc (size
+ overhead
);
622 if (val
&& check_depth
== 1)
624 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
625 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
626 xmalloc_put_size (val
, size
);
627 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
628 XMALLOC_OVERRUN_CHECK_SIZE
);
635 /* Like realloc, but checks old block for overrun, and wraps new block
636 with header and trailer. */
639 overrun_check_realloc (void *block
, size_t size
)
641 register unsigned char *val
= (unsigned char *) block
;
642 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
643 if (SIZE_MAX
- overhead
< size
)
648 && memcmp (xmalloc_overrun_check_header
,
649 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
650 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
652 size_t osize
= xmalloc_get_size (val
);
653 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
654 XMALLOC_OVERRUN_CHECK_SIZE
))
656 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
657 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
658 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
661 val
= realloc (val
, size
+ overhead
);
663 if (val
&& check_depth
== 1)
665 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
666 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
667 xmalloc_put_size (val
, size
);
668 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
669 XMALLOC_OVERRUN_CHECK_SIZE
);
675 /* Like free, but checks block for overrun. */
678 overrun_check_free (void *block
)
680 unsigned char *val
= (unsigned char *) block
;
685 && memcmp (xmalloc_overrun_check_header
,
686 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
687 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
689 size_t osize
= xmalloc_get_size (val
);
690 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
691 XMALLOC_OVERRUN_CHECK_SIZE
))
693 #ifdef XMALLOC_CLEAR_FREE_MEMORY
694 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
695 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
697 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
698 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
699 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
710 #define malloc overrun_check_malloc
711 #define realloc overrun_check_realloc
712 #define free overrun_check_free
716 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
717 there's no need to block input around malloc. */
718 #define MALLOC_BLOCK_INPUT ((void)0)
719 #define MALLOC_UNBLOCK_INPUT ((void)0)
721 #define MALLOC_BLOCK_INPUT BLOCK_INPUT
722 #define MALLOC_UNBLOCK_INPUT UNBLOCK_INPUT
725 /* Like malloc but check for no memory and block interrupt input.. */
728 xmalloc (size_t size
)
734 MALLOC_UNBLOCK_INPUT
;
741 /* Like the above, but zeroes out the memory just allocated. */
744 xzalloc (size_t size
)
750 MALLOC_UNBLOCK_INPUT
;
754 memset (val
, 0, size
);
758 /* Like realloc but check for no memory and block interrupt input.. */
761 xrealloc (void *block
, size_t size
)
766 /* We must call malloc explicitly when BLOCK is 0, since some
767 reallocs don't do this. */
771 val
= realloc (block
, size
);
772 MALLOC_UNBLOCK_INPUT
;
780 /* Like free but block interrupt input. */
789 MALLOC_UNBLOCK_INPUT
;
790 /* We don't call refill_memory_reserve here
791 because that duplicates doing so in emacs_blocked_free
792 and the criterion should go there. */
796 /* Other parts of Emacs pass large int values to allocator functions
797 expecting ptrdiff_t. This is portable in practice, but check it to
799 verify (INT_MAX
<= PTRDIFF_MAX
);
802 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
803 Signal an error on memory exhaustion, and block interrupt input. */
806 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
808 eassert (0 <= nitems
&& 0 < item_size
);
809 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
810 memory_full (SIZE_MAX
);
811 return xmalloc (nitems
* item_size
);
815 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
816 Signal an error on memory exhaustion, and block interrupt input. */
819 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
821 eassert (0 <= nitems
&& 0 < item_size
);
822 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
823 memory_full (SIZE_MAX
);
824 return xrealloc (pa
, nitems
* item_size
);
828 /* Grow PA, which points to an array of *NITEMS items, and return the
829 location of the reallocated array, updating *NITEMS to reflect its
830 new size. The new array will contain at least NITEMS_INCR_MIN more
831 items, but will not contain more than NITEMS_MAX items total.
832 ITEM_SIZE is the size of each item, in bytes.
834 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
835 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
838 If PA is null, then allocate a new array instead of reallocating
839 the old one. Thus, to grow an array A without saving its old
840 contents, invoke xfree (A) immediately followed by xgrowalloc (0,
843 Block interrupt input as needed. If memory exhaustion occurs, set
844 *NITEMS to zero if PA is null, and signal an error (i.e., do not
848 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
849 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
851 /* The approximate size to use for initial small allocation
852 requests. This is the largest "small" request for the GNU C
854 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
856 /* If the array is tiny, grow it to about (but no greater than)
857 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
858 ptrdiff_t n
= *nitems
;
859 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
860 ptrdiff_t half_again
= n
>> 1;
861 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
863 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
864 NITEMS_MAX, and what the C language can represent safely. */
865 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
866 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
867 ? nitems_max
: C_language_max
);
868 ptrdiff_t nitems_incr_max
= n_max
- n
;
869 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
871 eassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
874 if (nitems_incr_max
< incr
)
875 memory_full (SIZE_MAX
);
877 pa
= xrealloc (pa
, n
* item_size
);
883 /* Like strdup, but uses xmalloc. */
886 xstrdup (const char *s
)
888 size_t len
= strlen (s
) + 1;
889 char *p
= xmalloc (len
);
895 /* Unwind for SAFE_ALLOCA */
898 safe_alloca_unwind (Lisp_Object arg
)
900 register struct Lisp_Save_Value
*p
= XSAVE_VALUE (arg
);
910 /* Like malloc but used for allocating Lisp data. NBYTES is the
911 number of bytes to allocate, TYPE describes the intended use of the
912 allocated memory block (for strings, for conses, ...). */
915 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
919 lisp_malloc (size_t nbytes
, enum mem_type type
)
925 #ifdef GC_MALLOC_CHECK
926 allocated_mem_type
= type
;
929 val
= malloc (nbytes
);
932 /* If the memory just allocated cannot be addressed thru a Lisp
933 object's pointer, and it needs to be,
934 that's equivalent to running out of memory. */
935 if (val
&& type
!= MEM_TYPE_NON_LISP
)
938 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
939 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
941 lisp_malloc_loser
= val
;
948 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
949 if (val
&& type
!= MEM_TYPE_NON_LISP
)
950 mem_insert (val
, (char *) val
+ nbytes
, type
);
953 MALLOC_UNBLOCK_INPUT
;
955 memory_full (nbytes
);
959 /* Free BLOCK. This must be called to free memory allocated with a
960 call to lisp_malloc. */
963 lisp_free (void *block
)
967 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
968 mem_delete (mem_find (block
));
970 MALLOC_UNBLOCK_INPUT
;
973 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
975 /* The entry point is lisp_align_malloc which returns blocks of at most
976 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
978 #if defined (HAVE_POSIX_MEMALIGN) && defined (SYSTEM_MALLOC)
979 #define USE_POSIX_MEMALIGN 1
982 /* BLOCK_ALIGN has to be a power of 2. */
983 #define BLOCK_ALIGN (1 << 10)
985 /* Padding to leave at the end of a malloc'd block. This is to give
986 malloc a chance to minimize the amount of memory wasted to alignment.
987 It should be tuned to the particular malloc library used.
988 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
989 posix_memalign on the other hand would ideally prefer a value of 4
990 because otherwise, there's 1020 bytes wasted between each ablocks.
991 In Emacs, testing shows that those 1020 can most of the time be
992 efficiently used by malloc to place other objects, so a value of 0 can
993 still preferable unless you have a lot of aligned blocks and virtually
995 #define BLOCK_PADDING 0
996 #define BLOCK_BYTES \
997 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
999 /* Internal data structures and constants. */
1001 #define ABLOCKS_SIZE 16
1003 /* An aligned block of memory. */
1008 char payload
[BLOCK_BYTES
];
1009 struct ablock
*next_free
;
1011 /* `abase' is the aligned base of the ablocks. */
1012 /* It is overloaded to hold the virtual `busy' field that counts
1013 the number of used ablock in the parent ablocks.
1014 The first ablock has the `busy' field, the others have the `abase'
1015 field. To tell the difference, we assume that pointers will have
1016 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1017 is used to tell whether the real base of the parent ablocks is `abase'
1018 (if not, the word before the first ablock holds a pointer to the
1020 struct ablocks
*abase
;
1021 /* The padding of all but the last ablock is unused. The padding of
1022 the last ablock in an ablocks is not allocated. */
1024 char padding
[BLOCK_PADDING
];
1028 /* A bunch of consecutive aligned blocks. */
1031 struct ablock blocks
[ABLOCKS_SIZE
];
1034 /* Size of the block requested from malloc or posix_memalign. */
1035 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1037 #define ABLOCK_ABASE(block) \
1038 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1039 ? (struct ablocks *)(block) \
1042 /* Virtual `busy' field. */
1043 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1045 /* Pointer to the (not necessarily aligned) malloc block. */
1046 #ifdef USE_POSIX_MEMALIGN
1047 #define ABLOCKS_BASE(abase) (abase)
1049 #define ABLOCKS_BASE(abase) \
1050 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void**)abase)[-1])
1053 /* The list of free ablock. */
1054 static struct ablock
*free_ablock
;
1056 /* Allocate an aligned block of nbytes.
1057 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1058 smaller or equal to BLOCK_BYTES. */
1060 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1063 struct ablocks
*abase
;
1065 eassert (nbytes
<= BLOCK_BYTES
);
1069 #ifdef GC_MALLOC_CHECK
1070 allocated_mem_type
= type
;
1076 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1078 #ifdef DOUG_LEA_MALLOC
1079 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1080 because mapped region contents are not preserved in
1082 mallopt (M_MMAP_MAX
, 0);
1085 #ifdef USE_POSIX_MEMALIGN
1087 int err
= posix_memalign (&base
, BLOCK_ALIGN
, ABLOCKS_BYTES
);
1093 base
= malloc (ABLOCKS_BYTES
);
1094 abase
= ALIGN (base
, BLOCK_ALIGN
);
1099 MALLOC_UNBLOCK_INPUT
;
1100 memory_full (ABLOCKS_BYTES
);
1103 aligned
= (base
== abase
);
1105 ((void**)abase
)[-1] = base
;
1107 #ifdef DOUG_LEA_MALLOC
1108 /* Back to a reasonable maximum of mmap'ed areas. */
1109 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1113 /* If the memory just allocated cannot be addressed thru a Lisp
1114 object's pointer, and it needs to be, that's equivalent to
1115 running out of memory. */
1116 if (type
!= MEM_TYPE_NON_LISP
)
1119 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1120 XSETCONS (tem
, end
);
1121 if ((char *) XCONS (tem
) != end
)
1123 lisp_malloc_loser
= base
;
1125 MALLOC_UNBLOCK_INPUT
;
1126 memory_full (SIZE_MAX
);
1131 /* Initialize the blocks and put them on the free list.
1132 If `base' was not properly aligned, we can't use the last block. */
1133 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1135 abase
->blocks
[i
].abase
= abase
;
1136 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1137 free_ablock
= &abase
->blocks
[i
];
1139 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1141 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1142 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1143 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1144 eassert (ABLOCKS_BASE (abase
) == base
);
1145 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1148 abase
= ABLOCK_ABASE (free_ablock
);
1149 ABLOCKS_BUSY (abase
) =
1150 (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1152 free_ablock
= free_ablock
->x
.next_free
;
1154 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1155 if (type
!= MEM_TYPE_NON_LISP
)
1156 mem_insert (val
, (char *) val
+ nbytes
, type
);
1159 MALLOC_UNBLOCK_INPUT
;
1161 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1166 lisp_align_free (void *block
)
1168 struct ablock
*ablock
= block
;
1169 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1172 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1173 mem_delete (mem_find (block
));
1175 /* Put on free list. */
1176 ablock
->x
.next_free
= free_ablock
;
1177 free_ablock
= ablock
;
1178 /* Update busy count. */
1179 ABLOCKS_BUSY (abase
)
1180 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1182 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1183 { /* All the blocks are free. */
1184 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1185 struct ablock
**tem
= &free_ablock
;
1186 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1190 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1193 *tem
= (*tem
)->x
.next_free
;
1196 tem
= &(*tem
)->x
.next_free
;
1198 eassert ((aligned
& 1) == aligned
);
1199 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1200 #ifdef USE_POSIX_MEMALIGN
1201 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1203 free (ABLOCKS_BASE (abase
));
1205 MALLOC_UNBLOCK_INPUT
;
1209 #ifndef SYSTEM_MALLOC
1211 /* Arranging to disable input signals while we're in malloc.
1213 This only works with GNU malloc. To help out systems which can't
1214 use GNU malloc, all the calls to malloc, realloc, and free
1215 elsewhere in the code should be inside a BLOCK_INPUT/UNBLOCK_INPUT
1216 pair; unfortunately, we have no idea what C library functions
1217 might call malloc, so we can't really protect them unless you're
1218 using GNU malloc. Fortunately, most of the major operating systems
1219 can use GNU malloc. */
1222 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
1223 there's no need to block input around malloc. */
1225 #ifndef DOUG_LEA_MALLOC
1226 extern void * (*__malloc_hook
) (size_t, const void *);
1227 extern void * (*__realloc_hook
) (void *, size_t, const void *);
1228 extern void (*__free_hook
) (void *, const void *);
1229 /* Else declared in malloc.h, perhaps with an extra arg. */
1230 #endif /* DOUG_LEA_MALLOC */
1231 static void * (*old_malloc_hook
) (size_t, const void *);
1232 static void * (*old_realloc_hook
) (void *, size_t, const void*);
1233 static void (*old_free_hook
) (void*, const void*);
1235 #ifdef DOUG_LEA_MALLOC
1236 # define BYTES_USED (mallinfo ().uordblks)
1238 # define BYTES_USED _bytes_used
1241 #ifdef GC_MALLOC_CHECK
1242 static int dont_register_blocks
;
1245 static size_t bytes_used_when_reconsidered
;
1247 /* Value of _bytes_used, when spare_memory was freed. */
1249 static size_t bytes_used_when_full
;
1251 /* This function is used as the hook for free to call. */
1254 emacs_blocked_free (void *ptr
, const void *ptr2
)
1258 #ifdef GC_MALLOC_CHECK
1264 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1267 "Freeing `%p' which wasn't allocated with malloc\n", ptr
);
1272 /* fprintf (stderr, "free %p...%p (%p)\n", m->start, m->end, ptr); */
1276 #endif /* GC_MALLOC_CHECK */
1278 __free_hook
= old_free_hook
;
1281 /* If we released our reserve (due to running out of memory),
1282 and we have a fair amount free once again,
1283 try to set aside another reserve in case we run out once more. */
1284 if (! NILP (Vmemory_full
)
1285 /* Verify there is enough space that even with the malloc
1286 hysteresis this call won't run out again.
1287 The code here is correct as long as SPARE_MEMORY
1288 is substantially larger than the block size malloc uses. */
1289 && (bytes_used_when_full
1290 > ((bytes_used_when_reconsidered
= BYTES_USED
)
1291 + max (malloc_hysteresis
, 4) * SPARE_MEMORY
)))
1292 refill_memory_reserve ();
1294 __free_hook
= emacs_blocked_free
;
1295 UNBLOCK_INPUT_ALLOC
;
1299 /* This function is the malloc hook that Emacs uses. */
1302 emacs_blocked_malloc (size_t size
, const void *ptr
)
1307 __malloc_hook
= old_malloc_hook
;
1308 #ifdef DOUG_LEA_MALLOC
1309 /* Segfaults on my system. --lorentey */
1310 /* mallopt (M_TOP_PAD, malloc_hysteresis * 4096); */
1312 __malloc_extra_blocks
= malloc_hysteresis
;
1315 value
= malloc (size
);
1317 #ifdef GC_MALLOC_CHECK
1319 struct mem_node
*m
= mem_find (value
);
1322 fprintf (stderr
, "Malloc returned %p which is already in use\n",
1324 fprintf (stderr
, "Region in use is %p...%p, %td bytes, type %d\n",
1325 m
->start
, m
->end
, (char *) m
->end
- (char *) m
->start
,
1330 if (!dont_register_blocks
)
1332 mem_insert (value
, (char *) value
+ max (1, size
), allocated_mem_type
);
1333 allocated_mem_type
= MEM_TYPE_NON_LISP
;
1336 #endif /* GC_MALLOC_CHECK */
1338 __malloc_hook
= emacs_blocked_malloc
;
1339 UNBLOCK_INPUT_ALLOC
;
1341 /* fprintf (stderr, "%p malloc\n", value); */
1346 /* This function is the realloc hook that Emacs uses. */
1349 emacs_blocked_realloc (void *ptr
, size_t size
, const void *ptr2
)
1354 __realloc_hook
= old_realloc_hook
;
1356 #ifdef GC_MALLOC_CHECK
1359 struct mem_node
*m
= mem_find (ptr
);
1360 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1363 "Realloc of %p which wasn't allocated with malloc\n",
1371 /* fprintf (stderr, "%p -> realloc\n", ptr); */
1373 /* Prevent malloc from registering blocks. */
1374 dont_register_blocks
= 1;
1375 #endif /* GC_MALLOC_CHECK */
1377 value
= realloc (ptr
, size
);
1379 #ifdef GC_MALLOC_CHECK
1380 dont_register_blocks
= 0;
1383 struct mem_node
*m
= mem_find (value
);
1386 fprintf (stderr
, "Realloc returns memory that is already in use\n");
1390 /* Can't handle zero size regions in the red-black tree. */
1391 mem_insert (value
, (char *) value
+ max (size
, 1), MEM_TYPE_NON_LISP
);
1394 /* fprintf (stderr, "%p <- realloc\n", value); */
1395 #endif /* GC_MALLOC_CHECK */
1397 __realloc_hook
= emacs_blocked_realloc
;
1398 UNBLOCK_INPUT_ALLOC
;
1405 /* Called from Fdump_emacs so that when the dumped Emacs starts, it has a
1406 normal malloc. Some thread implementations need this as they call
1407 malloc before main. The pthread_self call in BLOCK_INPUT_ALLOC then
1408 calls malloc because it is the first call, and we have an endless loop. */
1411 reset_malloc_hooks (void)
1413 __free_hook
= old_free_hook
;
1414 __malloc_hook
= old_malloc_hook
;
1415 __realloc_hook
= old_realloc_hook
;
1417 #endif /* HAVE_PTHREAD */
1420 /* Called from main to set up malloc to use our hooks. */
1423 uninterrupt_malloc (void)
1426 #ifdef DOUG_LEA_MALLOC
1427 pthread_mutexattr_t attr
;
1429 /* GLIBC has a faster way to do this, but let's keep it portable.
1430 This is according to the Single UNIX Specification. */
1431 pthread_mutexattr_init (&attr
);
1432 pthread_mutexattr_settype (&attr
, PTHREAD_MUTEX_RECURSIVE
);
1433 pthread_mutex_init (&alloc_mutex
, &attr
);
1434 #else /* !DOUG_LEA_MALLOC */
1435 /* Some systems such as Solaris 2.6 don't have a recursive mutex,
1436 and the bundled gmalloc.c doesn't require it. */
1437 pthread_mutex_init (&alloc_mutex
, NULL
);
1438 #endif /* !DOUG_LEA_MALLOC */
1439 #endif /* HAVE_PTHREAD */
1441 if (__free_hook
!= emacs_blocked_free
)
1442 old_free_hook
= __free_hook
;
1443 __free_hook
= emacs_blocked_free
;
1445 if (__malloc_hook
!= emacs_blocked_malloc
)
1446 old_malloc_hook
= __malloc_hook
;
1447 __malloc_hook
= emacs_blocked_malloc
;
1449 if (__realloc_hook
!= emacs_blocked_realloc
)
1450 old_realloc_hook
= __realloc_hook
;
1451 __realloc_hook
= emacs_blocked_realloc
;
1454 #endif /* not SYNC_INPUT */
1455 #endif /* not SYSTEM_MALLOC */
1459 /***********************************************************************
1461 ***********************************************************************/
1463 /* Number of intervals allocated in an interval_block structure.
1464 The 1020 is 1024 minus malloc overhead. */
1466 #define INTERVAL_BLOCK_SIZE \
1467 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1469 /* Intervals are allocated in chunks in form of an interval_block
1472 struct interval_block
1474 /* Place `intervals' first, to preserve alignment. */
1475 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1476 struct interval_block
*next
;
1479 /* Current interval block. Its `next' pointer points to older
1482 static struct interval_block
*interval_block
;
1484 /* Index in interval_block above of the next unused interval
1487 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1489 /* Number of free and live intervals. */
1491 static EMACS_INT total_free_intervals
, total_intervals
;
1493 /* List of free intervals. */
1495 static INTERVAL interval_free_list
;
1497 /* Return a new interval. */
1500 make_interval (void)
1504 /* eassert (!handling_signal); */
1508 if (interval_free_list
)
1510 val
= interval_free_list
;
1511 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1515 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1517 struct interval_block
*newi
1518 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1520 newi
->next
= interval_block
;
1521 interval_block
= newi
;
1522 interval_block_index
= 0;
1523 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1525 val
= &interval_block
->intervals
[interval_block_index
++];
1528 MALLOC_UNBLOCK_INPUT
;
1530 consing_since_gc
+= sizeof (struct interval
);
1532 total_free_intervals
--;
1533 RESET_INTERVAL (val
);
1539 /* Mark Lisp objects in interval I. */
1542 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1544 /* Intervals should never be shared. So, if extra internal checking is
1545 enabled, GC aborts if it seems to have visited an interval twice. */
1546 eassert (!i
->gcmarkbit
);
1548 mark_object (i
->plist
);
1552 /* Mark the interval tree rooted in TREE. Don't call this directly;
1553 use the macro MARK_INTERVAL_TREE instead. */
1556 mark_interval_tree (register INTERVAL tree
)
1558 /* No need to test if this tree has been marked already; this
1559 function is always called through the MARK_INTERVAL_TREE macro,
1560 which takes care of that. */
1562 traverse_intervals_noorder (tree
, mark_interval
, Qnil
);
1566 /* Mark the interval tree rooted in I. */
1568 #define MARK_INTERVAL_TREE(i) \
1570 if (!NULL_INTERVAL_P (i) && !i->gcmarkbit) \
1571 mark_interval_tree (i); \
1575 #define UNMARK_BALANCE_INTERVALS(i) \
1577 if (! NULL_INTERVAL_P (i)) \
1578 (i) = balance_intervals (i); \
1581 /***********************************************************************
1583 ***********************************************************************/
1585 /* Lisp_Strings are allocated in string_block structures. When a new
1586 string_block is allocated, all the Lisp_Strings it contains are
1587 added to a free-list string_free_list. When a new Lisp_String is
1588 needed, it is taken from that list. During the sweep phase of GC,
1589 string_blocks that are entirely free are freed, except two which
1592 String data is allocated from sblock structures. Strings larger
1593 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1594 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1596 Sblocks consist internally of sdata structures, one for each
1597 Lisp_String. The sdata structure points to the Lisp_String it
1598 belongs to. The Lisp_String points back to the `u.data' member of
1599 its sdata structure.
1601 When a Lisp_String is freed during GC, it is put back on
1602 string_free_list, and its `data' member and its sdata's `string'
1603 pointer is set to null. The size of the string is recorded in the
1604 `u.nbytes' member of the sdata. So, sdata structures that are no
1605 longer used, can be easily recognized, and it's easy to compact the
1606 sblocks of small strings which we do in compact_small_strings. */
1608 /* Size in bytes of an sblock structure used for small strings. This
1609 is 8192 minus malloc overhead. */
1611 #define SBLOCK_SIZE 8188
1613 /* Strings larger than this are considered large strings. String data
1614 for large strings is allocated from individual sblocks. */
1616 #define LARGE_STRING_BYTES 1024
1618 /* Structure describing string memory sub-allocated from an sblock.
1619 This is where the contents of Lisp strings are stored. */
1623 /* Back-pointer to the string this sdata belongs to. If null, this
1624 structure is free, and the NBYTES member of the union below
1625 contains the string's byte size (the same value that STRING_BYTES
1626 would return if STRING were non-null). If non-null, STRING_BYTES
1627 (STRING) is the size of the data, and DATA contains the string's
1629 struct Lisp_String
*string
;
1631 #ifdef GC_CHECK_STRING_BYTES
1634 unsigned char data
[1];
1636 #define SDATA_NBYTES(S) (S)->nbytes
1637 #define SDATA_DATA(S) (S)->data
1638 #define SDATA_SELECTOR(member) member
1640 #else /* not GC_CHECK_STRING_BYTES */
1644 /* When STRING is non-null. */
1645 unsigned char data
[1];
1647 /* When STRING is null. */
1651 #define SDATA_NBYTES(S) (S)->u.nbytes
1652 #define SDATA_DATA(S) (S)->u.data
1653 #define SDATA_SELECTOR(member) u.member
1655 #endif /* not GC_CHECK_STRING_BYTES */
1657 #define SDATA_DATA_OFFSET offsetof (struct sdata, SDATA_SELECTOR (data))
1661 /* Structure describing a block of memory which is sub-allocated to
1662 obtain string data memory for strings. Blocks for small strings
1663 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1664 as large as needed. */
1669 struct sblock
*next
;
1671 /* Pointer to the next free sdata block. This points past the end
1672 of the sblock if there isn't any space left in this block. */
1673 struct sdata
*next_free
;
1675 /* Start of data. */
1676 struct sdata first_data
;
1679 /* Number of Lisp strings in a string_block structure. The 1020 is
1680 1024 minus malloc overhead. */
1682 #define STRING_BLOCK_SIZE \
1683 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1685 /* Structure describing a block from which Lisp_String structures
1690 /* Place `strings' first, to preserve alignment. */
1691 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1692 struct string_block
*next
;
1695 /* Head and tail of the list of sblock structures holding Lisp string
1696 data. We always allocate from current_sblock. The NEXT pointers
1697 in the sblock structures go from oldest_sblock to current_sblock. */
1699 static struct sblock
*oldest_sblock
, *current_sblock
;
1701 /* List of sblocks for large strings. */
1703 static struct sblock
*large_sblocks
;
1705 /* List of string_block structures. */
1707 static struct string_block
*string_blocks
;
1709 /* Free-list of Lisp_Strings. */
1711 static struct Lisp_String
*string_free_list
;
1713 /* Number of live and free Lisp_Strings. */
1715 static EMACS_INT total_strings
, total_free_strings
;
1717 /* Number of bytes used by live strings. */
1719 static EMACS_INT total_string_bytes
;
1721 /* Given a pointer to a Lisp_String S which is on the free-list
1722 string_free_list, return a pointer to its successor in the
1725 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1727 /* Return a pointer to the sdata structure belonging to Lisp string S.
1728 S must be live, i.e. S->data must not be null. S->data is actually
1729 a pointer to the `u.data' member of its sdata structure; the
1730 structure starts at a constant offset in front of that. */
1732 #define SDATA_OF_STRING(S) ((struct sdata *) ((S)->data - SDATA_DATA_OFFSET))
1735 #ifdef GC_CHECK_STRING_OVERRUN
1737 /* We check for overrun in string data blocks by appending a small
1738 "cookie" after each allocated string data block, and check for the
1739 presence of this cookie during GC. */
1741 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1742 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1743 { '\xde', '\xad', '\xbe', '\xef' };
1746 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1749 /* Value is the size of an sdata structure large enough to hold NBYTES
1750 bytes of string data. The value returned includes a terminating
1751 NUL byte, the size of the sdata structure, and padding. */
1753 #ifdef GC_CHECK_STRING_BYTES
1755 #define SDATA_SIZE(NBYTES) \
1756 ((SDATA_DATA_OFFSET \
1758 + sizeof (ptrdiff_t) - 1) \
1759 & ~(sizeof (ptrdiff_t) - 1))
1761 #else /* not GC_CHECK_STRING_BYTES */
1763 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1764 less than the size of that member. The 'max' is not needed when
1765 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1766 alignment code reserves enough space. */
1768 #define SDATA_SIZE(NBYTES) \
1769 ((SDATA_DATA_OFFSET \
1770 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1772 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1774 + sizeof (ptrdiff_t) - 1) \
1775 & ~(sizeof (ptrdiff_t) - 1))
1777 #endif /* not GC_CHECK_STRING_BYTES */
1779 /* Extra bytes to allocate for each string. */
1781 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1783 /* Exact bound on the number of bytes in a string, not counting the
1784 terminating null. A string cannot contain more bytes than
1785 STRING_BYTES_BOUND, nor can it be so long that the size_t
1786 arithmetic in allocate_string_data would overflow while it is
1787 calculating a value to be passed to malloc. */
1788 #define STRING_BYTES_MAX \
1789 min (STRING_BYTES_BOUND, \
1790 ((SIZE_MAX - XMALLOC_OVERRUN_CHECK_OVERHEAD \
1792 - offsetof (struct sblock, first_data) \
1793 - SDATA_DATA_OFFSET) \
1794 & ~(sizeof (EMACS_INT) - 1)))
1796 /* Initialize string allocation. Called from init_alloc_once. */
1801 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1802 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1806 #ifdef GC_CHECK_STRING_BYTES
1808 static int check_string_bytes_count
;
1810 #define CHECK_STRING_BYTES(S) STRING_BYTES (S)
1813 /* Like GC_STRING_BYTES, but with debugging check. */
1816 string_bytes (struct Lisp_String
*s
)
1819 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1821 if (!PURE_POINTER_P (s
)
1823 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1828 /* Check validity of Lisp strings' string_bytes member in B. */
1831 check_sblock (struct sblock
*b
)
1833 struct sdata
*from
, *end
, *from_end
;
1837 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1839 /* Compute the next FROM here because copying below may
1840 overwrite data we need to compute it. */
1843 /* Check that the string size recorded in the string is the
1844 same as the one recorded in the sdata structure. */
1846 CHECK_STRING_BYTES (from
->string
);
1849 nbytes
= GC_STRING_BYTES (from
->string
);
1851 nbytes
= SDATA_NBYTES (from
);
1853 nbytes
= SDATA_SIZE (nbytes
);
1854 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1859 /* Check validity of Lisp strings' string_bytes member. ALL_P
1860 non-zero means check all strings, otherwise check only most
1861 recently allocated strings. Used for hunting a bug. */
1864 check_string_bytes (int all_p
)
1870 for (b
= large_sblocks
; b
; b
= b
->next
)
1872 struct Lisp_String
*s
= b
->first_data
.string
;
1874 CHECK_STRING_BYTES (s
);
1877 for (b
= oldest_sblock
; b
; b
= b
->next
)
1880 else if (current_sblock
)
1881 check_sblock (current_sblock
);
1884 #endif /* GC_CHECK_STRING_BYTES */
1886 #ifdef GC_CHECK_STRING_FREE_LIST
1888 /* Walk through the string free list looking for bogus next pointers.
1889 This may catch buffer overrun from a previous string. */
1892 check_string_free_list (void)
1894 struct Lisp_String
*s
;
1896 /* Pop a Lisp_String off the free-list. */
1897 s
= string_free_list
;
1900 if ((uintptr_t) s
< 1024)
1902 s
= NEXT_FREE_LISP_STRING (s
);
1906 #define check_string_free_list()
1909 /* Return a new Lisp_String. */
1911 static struct Lisp_String
*
1912 allocate_string (void)
1914 struct Lisp_String
*s
;
1916 /* eassert (!handling_signal); */
1920 /* If the free-list is empty, allocate a new string_block, and
1921 add all the Lisp_Strings in it to the free-list. */
1922 if (string_free_list
== NULL
)
1924 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1927 b
->next
= string_blocks
;
1930 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1933 /* Every string on a free list should have NULL data pointer. */
1935 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1936 string_free_list
= s
;
1939 total_free_strings
+= STRING_BLOCK_SIZE
;
1942 check_string_free_list ();
1944 /* Pop a Lisp_String off the free-list. */
1945 s
= string_free_list
;
1946 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1948 MALLOC_UNBLOCK_INPUT
;
1950 --total_free_strings
;
1953 consing_since_gc
+= sizeof *s
;
1955 #ifdef GC_CHECK_STRING_BYTES
1956 if (!noninteractive
)
1958 if (++check_string_bytes_count
== 200)
1960 check_string_bytes_count
= 0;
1961 check_string_bytes (1);
1964 check_string_bytes (0);
1966 #endif /* GC_CHECK_STRING_BYTES */
1972 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1973 plus a NUL byte at the end. Allocate an sdata structure for S, and
1974 set S->data to its `u.data' member. Store a NUL byte at the end of
1975 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1976 S->data if it was initially non-null. */
1979 allocate_string_data (struct Lisp_String
*s
,
1980 EMACS_INT nchars
, EMACS_INT nbytes
)
1982 struct sdata
*data
, *old_data
;
1984 ptrdiff_t needed
, old_nbytes
;
1986 if (STRING_BYTES_MAX
< nbytes
)
1989 /* Determine the number of bytes needed to store NBYTES bytes
1991 needed
= SDATA_SIZE (nbytes
);
1994 old_data
= SDATA_OF_STRING (s
);
1995 old_nbytes
= GC_STRING_BYTES (s
);
2002 if (nbytes
> LARGE_STRING_BYTES
)
2004 size_t size
= offsetof (struct sblock
, first_data
) + needed
;
2006 #ifdef DOUG_LEA_MALLOC
2007 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
2008 because mapped region contents are not preserved in
2011 In case you think of allowing it in a dumped Emacs at the
2012 cost of not being able to re-dump, there's another reason:
2013 mmap'ed data typically have an address towards the top of the
2014 address space, which won't fit into an EMACS_INT (at least on
2015 32-bit systems with the current tagging scheme). --fx */
2016 mallopt (M_MMAP_MAX
, 0);
2019 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
2021 #ifdef DOUG_LEA_MALLOC
2022 /* Back to a reasonable maximum of mmap'ed areas. */
2023 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2026 b
->next_free
= &b
->first_data
;
2027 b
->first_data
.string
= NULL
;
2028 b
->next
= large_sblocks
;
2031 else if (current_sblock
== NULL
2032 || (((char *) current_sblock
+ SBLOCK_SIZE
2033 - (char *) current_sblock
->next_free
)
2034 < (needed
+ GC_STRING_EXTRA
)))
2036 /* Not enough room in the current sblock. */
2037 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
2038 b
->next_free
= &b
->first_data
;
2039 b
->first_data
.string
= NULL
;
2043 current_sblock
->next
= b
;
2051 data
= b
->next_free
;
2052 b
->next_free
= (struct sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
2054 MALLOC_UNBLOCK_INPUT
;
2057 s
->data
= SDATA_DATA (data
);
2058 #ifdef GC_CHECK_STRING_BYTES
2059 SDATA_NBYTES (data
) = nbytes
;
2062 s
->size_byte
= nbytes
;
2063 s
->data
[nbytes
] = '\0';
2064 #ifdef GC_CHECK_STRING_OVERRUN
2065 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
2066 GC_STRING_OVERRUN_COOKIE_SIZE
);
2069 /* Note that Faset may call to this function when S has already data
2070 assigned. In this case, mark data as free by setting it's string
2071 back-pointer to null, and record the size of the data in it. */
2074 SDATA_NBYTES (old_data
) = old_nbytes
;
2075 old_data
->string
= NULL
;
2078 consing_since_gc
+= needed
;
2082 /* Sweep and compact strings. */
2085 sweep_strings (void)
2087 struct string_block
*b
, *next
;
2088 struct string_block
*live_blocks
= NULL
;
2090 string_free_list
= NULL
;
2091 total_strings
= total_free_strings
= 0;
2092 total_string_bytes
= 0;
2094 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
2095 for (b
= string_blocks
; b
; b
= next
)
2098 struct Lisp_String
*free_list_before
= string_free_list
;
2102 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
2104 struct Lisp_String
*s
= b
->strings
+ i
;
2108 /* String was not on free-list before. */
2109 if (STRING_MARKED_P (s
))
2111 /* String is live; unmark it and its intervals. */
2114 if (!NULL_INTERVAL_P (s
->intervals
))
2115 UNMARK_BALANCE_INTERVALS (s
->intervals
);
2118 total_string_bytes
+= STRING_BYTES (s
);
2122 /* String is dead. Put it on the free-list. */
2123 struct sdata
*data
= SDATA_OF_STRING (s
);
2125 /* Save the size of S in its sdata so that we know
2126 how large that is. Reset the sdata's string
2127 back-pointer so that we know it's free. */
2128 #ifdef GC_CHECK_STRING_BYTES
2129 if (GC_STRING_BYTES (s
) != SDATA_NBYTES (data
))
2132 data
->u
.nbytes
= GC_STRING_BYTES (s
);
2134 data
->string
= NULL
;
2136 /* Reset the strings's `data' member so that we
2140 /* Put the string on the free-list. */
2141 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2142 string_free_list
= s
;
2148 /* S was on the free-list before. Put it there again. */
2149 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2150 string_free_list
= s
;
2155 /* Free blocks that contain free Lisp_Strings only, except
2156 the first two of them. */
2157 if (nfree
== STRING_BLOCK_SIZE
2158 && total_free_strings
> STRING_BLOCK_SIZE
)
2161 string_free_list
= free_list_before
;
2165 total_free_strings
+= nfree
;
2166 b
->next
= live_blocks
;
2171 check_string_free_list ();
2173 string_blocks
= live_blocks
;
2174 free_large_strings ();
2175 compact_small_strings ();
2177 check_string_free_list ();
2181 /* Free dead large strings. */
2184 free_large_strings (void)
2186 struct sblock
*b
, *next
;
2187 struct sblock
*live_blocks
= NULL
;
2189 for (b
= large_sblocks
; b
; b
= next
)
2193 if (b
->first_data
.string
== NULL
)
2197 b
->next
= live_blocks
;
2202 large_sblocks
= live_blocks
;
2206 /* Compact data of small strings. Free sblocks that don't contain
2207 data of live strings after compaction. */
2210 compact_small_strings (void)
2212 struct sblock
*b
, *tb
, *next
;
2213 struct sdata
*from
, *to
, *end
, *tb_end
;
2214 struct sdata
*to_end
, *from_end
;
2216 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2217 to, and TB_END is the end of TB. */
2219 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2220 to
= &tb
->first_data
;
2222 /* Step through the blocks from the oldest to the youngest. We
2223 expect that old blocks will stabilize over time, so that less
2224 copying will happen this way. */
2225 for (b
= oldest_sblock
; b
; b
= b
->next
)
2228 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2230 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
2232 /* Compute the next FROM here because copying below may
2233 overwrite data we need to compute it. */
2236 #ifdef GC_CHECK_STRING_BYTES
2237 /* Check that the string size recorded in the string is the
2238 same as the one recorded in the sdata structure. */
2240 && GC_STRING_BYTES (from
->string
) != SDATA_NBYTES (from
))
2242 #endif /* GC_CHECK_STRING_BYTES */
2245 nbytes
= GC_STRING_BYTES (from
->string
);
2247 nbytes
= SDATA_NBYTES (from
);
2249 if (nbytes
> LARGE_STRING_BYTES
)
2252 nbytes
= SDATA_SIZE (nbytes
);
2253 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2255 #ifdef GC_CHECK_STRING_OVERRUN
2256 if (memcmp (string_overrun_cookie
,
2257 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2258 GC_STRING_OVERRUN_COOKIE_SIZE
))
2262 /* FROM->string non-null means it's alive. Copy its data. */
2265 /* If TB is full, proceed with the next sblock. */
2266 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2267 if (to_end
> tb_end
)
2271 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2272 to
= &tb
->first_data
;
2273 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2276 /* Copy, and update the string's `data' pointer. */
2279 eassert (tb
!= b
|| to
< from
);
2280 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2281 to
->string
->data
= SDATA_DATA (to
);
2284 /* Advance past the sdata we copied to. */
2290 /* The rest of the sblocks following TB don't contain live data, so
2291 we can free them. */
2292 for (b
= tb
->next
; b
; b
= next
)
2300 current_sblock
= tb
;
2304 string_overflow (void)
2306 error ("Maximum string size exceeded");
2309 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2310 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2311 LENGTH must be an integer.
2312 INIT must be an integer that represents a character. */)
2313 (Lisp_Object length
, Lisp_Object init
)
2315 register Lisp_Object val
;
2316 register unsigned char *p
, *end
;
2320 CHECK_NATNUM (length
);
2321 CHECK_CHARACTER (init
);
2323 c
= XFASTINT (init
);
2324 if (ASCII_CHAR_P (c
))
2326 nbytes
= XINT (length
);
2327 val
= make_uninit_string (nbytes
);
2329 end
= p
+ SCHARS (val
);
2335 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2336 int len
= CHAR_STRING (c
, str
);
2337 EMACS_INT string_len
= XINT (length
);
2339 if (string_len
> STRING_BYTES_MAX
/ len
)
2341 nbytes
= len
* string_len
;
2342 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2347 memcpy (p
, str
, len
);
2357 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2358 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2359 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2360 (Lisp_Object length
, Lisp_Object init
)
2362 register Lisp_Object val
;
2363 struct Lisp_Bool_Vector
*p
;
2364 ptrdiff_t length_in_chars
;
2365 EMACS_INT length_in_elts
;
2367 int extra_bool_elts
= ((bool_header_size
- header_size
+ word_size
- 1)
2370 CHECK_NATNUM (length
);
2372 bits_per_value
= sizeof (EMACS_INT
) * BOOL_VECTOR_BITS_PER_CHAR
;
2374 length_in_elts
= (XFASTINT (length
) + bits_per_value
- 1) / bits_per_value
;
2376 val
= Fmake_vector (make_number (length_in_elts
+ extra_bool_elts
), Qnil
);
2378 /* No Lisp_Object to trace in there. */
2379 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0);
2381 p
= XBOOL_VECTOR (val
);
2382 p
->size
= XFASTINT (length
);
2384 length_in_chars
= ((XFASTINT (length
) + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2385 / BOOL_VECTOR_BITS_PER_CHAR
);
2386 if (length_in_chars
)
2388 memset (p
->data
, ! NILP (init
) ? -1 : 0, length_in_chars
);
2390 /* Clear any extraneous bits in the last byte. */
2391 p
->data
[length_in_chars
- 1]
2392 &= (1 << ((XFASTINT (length
) - 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1)) - 1;
2399 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2400 of characters from the contents. This string may be unibyte or
2401 multibyte, depending on the contents. */
2404 make_string (const char *contents
, ptrdiff_t nbytes
)
2406 register Lisp_Object val
;
2407 ptrdiff_t nchars
, multibyte_nbytes
;
2409 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2410 &nchars
, &multibyte_nbytes
);
2411 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2412 /* CONTENTS contains no multibyte sequences or contains an invalid
2413 multibyte sequence. We must make unibyte string. */
2414 val
= make_unibyte_string (contents
, nbytes
);
2416 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2421 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2424 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2426 register Lisp_Object val
;
2427 val
= make_uninit_string (length
);
2428 memcpy (SDATA (val
), contents
, length
);
2433 /* Make a multibyte string from NCHARS characters occupying NBYTES
2434 bytes at CONTENTS. */
2437 make_multibyte_string (const char *contents
,
2438 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2440 register Lisp_Object val
;
2441 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2442 memcpy (SDATA (val
), contents
, nbytes
);
2447 /* Make a string from NCHARS characters occupying NBYTES bytes at
2448 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2451 make_string_from_bytes (const char *contents
,
2452 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2454 register Lisp_Object val
;
2455 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2456 memcpy (SDATA (val
), contents
, nbytes
);
2457 if (SBYTES (val
) == SCHARS (val
))
2458 STRING_SET_UNIBYTE (val
);
2463 /* Make a string from NCHARS characters occupying NBYTES bytes at
2464 CONTENTS. The argument MULTIBYTE controls whether to label the
2465 string as multibyte. If NCHARS is negative, it counts the number of
2466 characters by itself. */
2469 make_specified_string (const char *contents
,
2470 ptrdiff_t nchars
, ptrdiff_t nbytes
, int multibyte
)
2472 register Lisp_Object val
;
2477 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2482 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2483 memcpy (SDATA (val
), contents
, nbytes
);
2485 STRING_SET_UNIBYTE (val
);
2490 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2491 occupying LENGTH bytes. */
2494 make_uninit_string (EMACS_INT length
)
2499 return empty_unibyte_string
;
2500 val
= make_uninit_multibyte_string (length
, length
);
2501 STRING_SET_UNIBYTE (val
);
2506 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2507 which occupy NBYTES bytes. */
2510 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2513 struct Lisp_String
*s
;
2518 return empty_multibyte_string
;
2520 s
= allocate_string ();
2521 s
->intervals
= NULL_INTERVAL
;
2522 allocate_string_data (s
, nchars
, nbytes
);
2523 XSETSTRING (string
, s
);
2524 string_chars_consed
+= nbytes
;
2528 /* Print arguments to BUF according to a FORMAT, then return
2529 a Lisp_String initialized with the data from BUF. */
2532 make_formatted_string (char *buf
, const char *format
, ...)
2537 va_start (ap
, format
);
2538 length
= vsprintf (buf
, format
, ap
);
2540 return make_string (buf
, length
);
2544 /***********************************************************************
2546 ***********************************************************************/
2548 /* We store float cells inside of float_blocks, allocating a new
2549 float_block with malloc whenever necessary. Float cells reclaimed
2550 by GC are put on a free list to be reallocated before allocating
2551 any new float cells from the latest float_block. */
2553 #define FLOAT_BLOCK_SIZE \
2554 (((BLOCK_BYTES - sizeof (struct float_block *) \
2555 /* The compiler might add padding at the end. */ \
2556 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2557 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2559 #define GETMARKBIT(block,n) \
2560 (((block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2561 >> ((n) % (sizeof (int) * CHAR_BIT))) \
2564 #define SETMARKBIT(block,n) \
2565 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2566 |= 1 << ((n) % (sizeof (int) * CHAR_BIT))
2568 #define UNSETMARKBIT(block,n) \
2569 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2570 &= ~(1 << ((n) % (sizeof (int) * CHAR_BIT)))
2572 #define FLOAT_BLOCK(fptr) \
2573 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2575 #define FLOAT_INDEX(fptr) \
2576 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2580 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2581 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2582 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2583 struct float_block
*next
;
2586 #define FLOAT_MARKED_P(fptr) \
2587 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2589 #define FLOAT_MARK(fptr) \
2590 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2592 #define FLOAT_UNMARK(fptr) \
2593 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2595 /* Current float_block. */
2597 static struct float_block
*float_block
;
2599 /* Index of first unused Lisp_Float in the current float_block. */
2601 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2603 /* Free-list of Lisp_Floats. */
2605 static struct Lisp_Float
*float_free_list
;
2607 /* Return a new float object with value FLOAT_VALUE. */
2610 make_float (double float_value
)
2612 register Lisp_Object val
;
2614 /* eassert (!handling_signal); */
2618 if (float_free_list
)
2620 /* We use the data field for chaining the free list
2621 so that we won't use the same field that has the mark bit. */
2622 XSETFLOAT (val
, float_free_list
);
2623 float_free_list
= float_free_list
->u
.chain
;
2627 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2629 struct float_block
*new
2630 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2631 new->next
= float_block
;
2632 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2634 float_block_index
= 0;
2635 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2637 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2638 float_block_index
++;
2641 MALLOC_UNBLOCK_INPUT
;
2643 XFLOAT_INIT (val
, float_value
);
2644 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2645 consing_since_gc
+= sizeof (struct Lisp_Float
);
2647 total_free_floats
--;
2653 /***********************************************************************
2655 ***********************************************************************/
2657 /* We store cons cells inside of cons_blocks, allocating a new
2658 cons_block with malloc whenever necessary. Cons cells reclaimed by
2659 GC are put on a free list to be reallocated before allocating
2660 any new cons cells from the latest cons_block. */
2662 #define CONS_BLOCK_SIZE \
2663 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2664 /* The compiler might add padding at the end. */ \
2665 - (sizeof (struct Lisp_Cons) - sizeof (int))) * CHAR_BIT) \
2666 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2668 #define CONS_BLOCK(fptr) \
2669 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2671 #define CONS_INDEX(fptr) \
2672 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2676 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2677 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2678 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2679 struct cons_block
*next
;
2682 #define CONS_MARKED_P(fptr) \
2683 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2685 #define CONS_MARK(fptr) \
2686 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2688 #define CONS_UNMARK(fptr) \
2689 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2691 /* Current cons_block. */
2693 static struct cons_block
*cons_block
;
2695 /* Index of first unused Lisp_Cons in the current block. */
2697 static int cons_block_index
= CONS_BLOCK_SIZE
;
2699 /* Free-list of Lisp_Cons structures. */
2701 static struct Lisp_Cons
*cons_free_list
;
2703 /* Explicitly free a cons cell by putting it on the free-list. */
2706 free_cons (struct Lisp_Cons
*ptr
)
2708 ptr
->u
.chain
= cons_free_list
;
2712 cons_free_list
= ptr
;
2713 consing_since_gc
-= sizeof *ptr
;
2714 total_free_conses
++;
2717 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2718 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2719 (Lisp_Object car
, Lisp_Object cdr
)
2721 register Lisp_Object val
;
2723 /* eassert (!handling_signal); */
2729 /* We use the cdr for chaining the free list
2730 so that we won't use the same field that has the mark bit. */
2731 XSETCONS (val
, cons_free_list
);
2732 cons_free_list
= cons_free_list
->u
.chain
;
2736 if (cons_block_index
== CONS_BLOCK_SIZE
)
2738 struct cons_block
*new
2739 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2740 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2741 new->next
= cons_block
;
2743 cons_block_index
= 0;
2744 total_free_conses
+= CONS_BLOCK_SIZE
;
2746 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2750 MALLOC_UNBLOCK_INPUT
;
2754 eassert (!CONS_MARKED_P (XCONS (val
)));
2755 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2756 total_free_conses
--;
2757 cons_cells_consed
++;
2761 #ifdef GC_CHECK_CONS_LIST
2762 /* Get an error now if there's any junk in the cons free list. */
2764 check_cons_list (void)
2766 struct Lisp_Cons
*tail
= cons_free_list
;
2769 tail
= tail
->u
.chain
;
2773 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2776 list1 (Lisp_Object arg1
)
2778 return Fcons (arg1
, Qnil
);
2782 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2784 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2789 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2791 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2796 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2798 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2803 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2805 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2806 Fcons (arg5
, Qnil
)))));
2809 /* Make a list of COUNT Lisp_Objects, where ARG is the
2810 first one. Allocate conses from pure space if TYPE
2811 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2814 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2818 Lisp_Object val
, *objp
;
2820 /* Change to SAFE_ALLOCA if you hit this eassert. */
2821 eassert (count
<= MAX_ALLOCA
/ sizeof (Lisp_Object
));
2823 objp
= alloca (count
* sizeof (Lisp_Object
));
2826 for (i
= 1; i
< count
; i
++)
2827 objp
[i
] = va_arg (ap
, Lisp_Object
);
2830 for (val
= Qnil
, i
= count
- 1; i
>= 0; i
--)
2832 if (type
== CONSTYPE_PURE
)
2833 val
= pure_cons (objp
[i
], val
);
2834 else if (type
== CONSTYPE_HEAP
)
2835 val
= Fcons (objp
[i
], val
);
2842 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2843 doc
: /* Return a newly created list with specified arguments as elements.
2844 Any number of arguments, even zero arguments, are allowed.
2845 usage: (list &rest OBJECTS) */)
2846 (ptrdiff_t nargs
, Lisp_Object
*args
)
2848 register Lisp_Object val
;
2854 val
= Fcons (args
[nargs
], val
);
2860 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2861 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2862 (register Lisp_Object length
, Lisp_Object init
)
2864 register Lisp_Object val
;
2865 register EMACS_INT size
;
2867 CHECK_NATNUM (length
);
2868 size
= XFASTINT (length
);
2873 val
= Fcons (init
, val
);
2878 val
= Fcons (init
, val
);
2883 val
= Fcons (init
, val
);
2888 val
= Fcons (init
, val
);
2893 val
= Fcons (init
, val
);
2908 /***********************************************************************
2910 ***********************************************************************/
2912 /* This value is balanced well enough to avoid too much internal overhead
2913 for the most common cases; it's not required to be a power of two, but
2914 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2916 #define VECTOR_BLOCK_SIZE 4096
2918 /* Align allocation request sizes to be a multiple of ROUNDUP_SIZE. */
2921 roundup_size
= COMMON_MULTIPLE (word_size
,
2922 USE_LSB_TAG
? 1 << GCTYPEBITS
: 1)
2925 /* ROUNDUP_SIZE must be a power of 2. */
2926 verify ((roundup_size
& (roundup_size
- 1)) == 0);
2928 /* Verify assumptions described above. */
2929 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2930 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2932 /* Round up X to nearest mult-of-ROUNDUP_SIZE. */
2934 #define vroundup(x) (((x) + (roundup_size - 1)) & ~(roundup_size - 1))
2936 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2938 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup (sizeof (void *)))
2940 /* Size of the minimal vector allocated from block. */
2942 #define VBLOCK_BYTES_MIN vroundup (sizeof (struct Lisp_Vector))
2944 /* Size of the largest vector allocated from block. */
2946 #define VBLOCK_BYTES_MAX \
2947 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2949 /* We maintain one free list for each possible block-allocated
2950 vector size, and this is the number of free lists we have. */
2952 #define VECTOR_MAX_FREE_LIST_INDEX \
2953 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2955 /* Common shortcut to advance vector pointer over a block data. */
2957 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2959 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2961 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2963 /* Common shortcut to setup vector on a free list. */
2965 #define SETUP_ON_FREE_LIST(v, nbytes, index) \
2967 XSETPVECTYPESIZE (v, PVEC_FREE, nbytes); \
2968 eassert ((nbytes) % roundup_size == 0); \
2969 (index) = VINDEX (nbytes); \
2970 eassert ((index) < VECTOR_MAX_FREE_LIST_INDEX); \
2971 (v)->header.next.vector = vector_free_lists[index]; \
2972 vector_free_lists[index] = (v); \
2973 total_free_vector_slots += (nbytes) / word_size; \
2978 char data
[VECTOR_BLOCK_BYTES
];
2979 struct vector_block
*next
;
2982 /* Chain of vector blocks. */
2984 static struct vector_block
*vector_blocks
;
2986 /* Vector free lists, where NTH item points to a chain of free
2987 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2989 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2991 /* Singly-linked list of large vectors. */
2993 static struct Lisp_Vector
*large_vectors
;
2995 /* The only vector with 0 slots, allocated from pure space. */
2997 Lisp_Object zero_vector
;
2999 /* Number of live vectors. */
3001 static EMACS_INT total_vectors
;
3003 /* Total size of live and free vectors, in Lisp_Object units. */
3005 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
3007 /* Get a new vector block. */
3009 static struct vector_block
*
3010 allocate_vector_block (void)
3012 struct vector_block
*block
= xmalloc (sizeof *block
);
3014 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
3015 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
3016 MEM_TYPE_VECTOR_BLOCK
);
3019 block
->next
= vector_blocks
;
3020 vector_blocks
= block
;
3024 /* Called once to initialize vector allocation. */
3029 zero_vector
= make_pure_vector (0);
3032 /* Allocate vector from a vector block. */
3034 static struct Lisp_Vector
*
3035 allocate_vector_from_block (size_t nbytes
)
3037 struct Lisp_Vector
*vector
, *rest
;
3038 struct vector_block
*block
;
3039 size_t index
, restbytes
;
3041 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
3042 eassert (nbytes
% roundup_size
== 0);
3044 /* First, try to allocate from a free list
3045 containing vectors of the requested size. */
3046 index
= VINDEX (nbytes
);
3047 if (vector_free_lists
[index
])
3049 vector
= vector_free_lists
[index
];
3050 vector_free_lists
[index
] = vector
->header
.next
.vector
;
3051 vector
->header
.next
.nbytes
= nbytes
;
3052 total_free_vector_slots
-= nbytes
/ word_size
;
3056 /* Next, check free lists containing larger vectors. Since
3057 we will split the result, we should have remaining space
3058 large enough to use for one-slot vector at least. */
3059 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
3060 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
3061 if (vector_free_lists
[index
])
3063 /* This vector is larger than requested. */
3064 vector
= vector_free_lists
[index
];
3065 vector_free_lists
[index
] = vector
->header
.next
.vector
;
3066 vector
->header
.next
.nbytes
= nbytes
;
3067 total_free_vector_slots
-= nbytes
/ word_size
;
3069 /* Excess bytes are used for the smaller vector,
3070 which should be set on an appropriate free list. */
3071 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
3072 eassert (restbytes
% roundup_size
== 0);
3073 rest
= ADVANCE (vector
, nbytes
);
3074 SETUP_ON_FREE_LIST (rest
, restbytes
, index
);
3078 /* Finally, need a new vector block. */
3079 block
= allocate_vector_block ();
3081 /* New vector will be at the beginning of this block. */
3082 vector
= (struct Lisp_Vector
*) block
->data
;
3083 vector
->header
.next
.nbytes
= nbytes
;
3085 /* If the rest of space from this block is large enough
3086 for one-slot vector at least, set up it on a free list. */
3087 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
3088 if (restbytes
>= VBLOCK_BYTES_MIN
)
3090 eassert (restbytes
% roundup_size
== 0);
3091 rest
= ADVANCE (vector
, nbytes
);
3092 SETUP_ON_FREE_LIST (rest
, restbytes
, index
);
3097 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
3099 #define VECTOR_IN_BLOCK(vector, block) \
3100 ((char *) (vector) <= (block)->data \
3101 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
3103 /* Number of bytes used by vector-block-allocated object. This is the only
3104 place where we actually use the `nbytes' field of the vector-header.
3105 I.e. we could get rid of the `nbytes' field by computing it based on the
3108 #define PSEUDOVECTOR_NBYTES(vector) \
3109 (PSEUDOVECTOR_TYPEP (&vector->header, PVEC_FREE) \
3110 ? vector->header.size & PSEUDOVECTOR_SIZE_MASK \
3111 : vector->header.next.nbytes)
3113 /* Reclaim space used by unmarked vectors. */
3116 sweep_vectors (void)
3118 struct vector_block
*block
= vector_blocks
, **bprev
= &vector_blocks
;
3119 struct Lisp_Vector
*vector
, *next
, **vprev
= &large_vectors
;
3121 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
3122 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
3124 /* Looking through vector blocks. */
3126 for (block
= vector_blocks
; block
; block
= *bprev
)
3128 int free_this_block
= 0;
3130 for (vector
= (struct Lisp_Vector
*) block
->data
;
3131 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
3133 if (VECTOR_MARKED_P (vector
))
3135 VECTOR_UNMARK (vector
);
3137 total_vector_slots
+= vector
->header
.next
.nbytes
/ word_size
;
3138 next
= ADVANCE (vector
, vector
->header
.next
.nbytes
);
3142 ptrdiff_t nbytes
= PSEUDOVECTOR_NBYTES (vector
);
3143 ptrdiff_t total_bytes
= nbytes
;
3145 next
= ADVANCE (vector
, nbytes
);
3147 /* While NEXT is not marked, try to coalesce with VECTOR,
3148 thus making VECTOR of the largest possible size. */
3150 while (VECTOR_IN_BLOCK (next
, block
))
3152 if (VECTOR_MARKED_P (next
))
3154 nbytes
= PSEUDOVECTOR_NBYTES (next
);
3155 total_bytes
+= nbytes
;
3156 next
= ADVANCE (next
, nbytes
);
3159 eassert (total_bytes
% roundup_size
== 0);
3161 if (vector
== (struct Lisp_Vector
*) block
->data
3162 && !VECTOR_IN_BLOCK (next
, block
))
3163 /* This block should be freed because all of it's
3164 space was coalesced into the only free vector. */
3165 free_this_block
= 1;
3169 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
3174 if (free_this_block
)
3176 *bprev
= block
->next
;
3177 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
3178 mem_delete (mem_find (block
->data
));
3183 bprev
= &block
->next
;
3186 /* Sweep large vectors. */
3188 for (vector
= large_vectors
; vector
; vector
= *vprev
)
3190 if (VECTOR_MARKED_P (vector
))
3192 VECTOR_UNMARK (vector
);
3194 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
3196 struct Lisp_Bool_Vector
*b
= (struct Lisp_Bool_Vector
*) vector
;
3198 /* All non-bool pseudovectors are small enough to be allocated
3199 from vector blocks. This code should be redesigned if some
3200 pseudovector type grows beyond VBLOCK_BYTES_MAX. */
3201 eassert (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_BOOL_VECTOR
));
3204 += (bool_header_size
3205 + ((b
->size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1)
3206 / BOOL_VECTOR_BITS_PER_CHAR
)) / word_size
;
3210 += header_size
/ word_size
+ vector
->header
.size
;
3211 vprev
= &vector
->header
.next
.vector
;
3215 *vprev
= vector
->header
.next
.vector
;
3221 /* Value is a pointer to a newly allocated Lisp_Vector structure
3222 with room for LEN Lisp_Objects. */
3224 static struct Lisp_Vector
*
3225 allocate_vectorlike (ptrdiff_t len
)
3227 struct Lisp_Vector
*p
;
3231 /* This gets triggered by code which I haven't bothered to fix. --Stef */
3232 /* eassert (!handling_signal); */
3235 p
= XVECTOR (zero_vector
);
3238 size_t nbytes
= header_size
+ len
* word_size
;
3240 #ifdef DOUG_LEA_MALLOC
3241 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
3242 because mapped region contents are not preserved in
3244 mallopt (M_MMAP_MAX
, 0);
3247 if (nbytes
<= VBLOCK_BYTES_MAX
)
3248 p
= allocate_vector_from_block (vroundup (nbytes
));
3251 p
= lisp_malloc (nbytes
, MEM_TYPE_VECTORLIKE
);
3252 p
->header
.next
.vector
= large_vectors
;
3256 #ifdef DOUG_LEA_MALLOC
3257 /* Back to a reasonable maximum of mmap'ed areas. */
3258 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3261 consing_since_gc
+= nbytes
;
3262 vector_cells_consed
+= len
;
3265 MALLOC_UNBLOCK_INPUT
;
3271 /* Allocate a vector with LEN slots. */
3273 struct Lisp_Vector
*
3274 allocate_vector (EMACS_INT len
)
3276 struct Lisp_Vector
*v
;
3277 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3279 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3280 memory_full (SIZE_MAX
);
3281 v
= allocate_vectorlike (len
);
3282 v
->header
.size
= len
;
3287 /* Allocate other vector-like structures. */
3289 struct Lisp_Vector
*
3290 allocate_pseudovector (int memlen
, int lisplen
, int tag
)
3292 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3295 /* Only the first lisplen slots will be traced normally by the GC. */
3296 for (i
= 0; i
< lisplen
; ++i
)
3297 v
->contents
[i
] = Qnil
;
3299 XSETPVECTYPESIZE (v
, tag
, lisplen
);
3304 allocate_buffer (void)
3306 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3308 XSETPVECTYPESIZE (b
, PVEC_BUFFER
, (offsetof (struct buffer
, own_text
)
3309 - header_size
) / word_size
);
3310 /* Note that the fields of B are not initialized. */
3314 struct Lisp_Hash_Table
*
3315 allocate_hash_table (void)
3317 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
3321 allocate_window (void)
3325 w
= ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
3326 /* Users assumes that non-Lisp data is zeroed. */
3327 memset (&w
->current_matrix
, 0,
3328 sizeof (*w
) - offsetof (struct window
, current_matrix
));
3333 allocate_terminal (void)
3337 t
= ALLOCATE_PSEUDOVECTOR (struct terminal
, next_terminal
, PVEC_TERMINAL
);
3338 /* Users assumes that non-Lisp data is zeroed. */
3339 memset (&t
->next_terminal
, 0,
3340 sizeof (*t
) - offsetof (struct terminal
, next_terminal
));
3345 allocate_frame (void)
3349 f
= ALLOCATE_PSEUDOVECTOR (struct frame
, face_cache
, PVEC_FRAME
);
3350 /* Users assumes that non-Lisp data is zeroed. */
3351 memset (&f
->face_cache
, 0,
3352 sizeof (*f
) - offsetof (struct frame
, face_cache
));
3356 struct Lisp_Process
*
3357 allocate_process (void)
3359 struct Lisp_Process
*p
;
3361 p
= ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3362 /* Users assumes that non-Lisp data is zeroed. */
3364 sizeof (*p
) - offsetof (struct Lisp_Process
, pid
));
3368 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3369 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3370 See also the function `vector'. */)
3371 (register Lisp_Object length
, Lisp_Object init
)
3374 register ptrdiff_t sizei
;
3375 register ptrdiff_t i
;
3376 register struct Lisp_Vector
*p
;
3378 CHECK_NATNUM (length
);
3380 p
= allocate_vector (XFASTINT (length
));
3381 sizei
= XFASTINT (length
);
3382 for (i
= 0; i
< sizei
; i
++)
3383 p
->contents
[i
] = init
;
3385 XSETVECTOR (vector
, p
);
3390 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3391 doc
: /* Return a newly created vector with specified arguments as elements.
3392 Any number of arguments, even zero arguments, are allowed.
3393 usage: (vector &rest OBJECTS) */)
3394 (ptrdiff_t nargs
, Lisp_Object
*args
)
3396 register Lisp_Object len
, val
;
3398 register struct Lisp_Vector
*p
;
3400 XSETFASTINT (len
, nargs
);
3401 val
= Fmake_vector (len
, Qnil
);
3403 for (i
= 0; i
< nargs
; i
++)
3404 p
->contents
[i
] = args
[i
];
3409 make_byte_code (struct Lisp_Vector
*v
)
3411 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3412 && STRING_MULTIBYTE (v
->contents
[1]))
3413 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3414 earlier because they produced a raw 8-bit string for byte-code
3415 and now such a byte-code string is loaded as multibyte while
3416 raw 8-bit characters converted to multibyte form. Thus, now we
3417 must convert them back to the original unibyte form. */
3418 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3419 XSETPVECTYPE (v
, PVEC_COMPILED
);
3422 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3423 doc
: /* Create a byte-code object with specified arguments as elements.
3424 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3425 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3426 and (optional) INTERACTIVE-SPEC.
3427 The first four arguments are required; at most six have any
3429 The ARGLIST can be either like the one of `lambda', in which case the arguments
3430 will be dynamically bound before executing the byte code, or it can be an
3431 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3432 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3433 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3434 argument to catch the left-over arguments. If such an integer is used, the
3435 arguments will not be dynamically bound but will be instead pushed on the
3436 stack before executing the byte-code.
3437 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3438 (ptrdiff_t nargs
, Lisp_Object
*args
)
3440 register Lisp_Object len
, val
;
3442 register struct Lisp_Vector
*p
;
3444 /* We used to purecopy everything here, if purify-flga was set. This worked
3445 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3446 dangerous, since make-byte-code is used during execution to build
3447 closures, so any closure built during the preload phase would end up
3448 copied into pure space, including its free variables, which is sometimes
3449 just wasteful and other times plainly wrong (e.g. those free vars may want
3452 XSETFASTINT (len
, nargs
);
3453 val
= Fmake_vector (len
, Qnil
);
3456 for (i
= 0; i
< nargs
; i
++)
3457 p
->contents
[i
] = args
[i
];
3459 XSETCOMPILED (val
, p
);
3465 /***********************************************************************
3467 ***********************************************************************/
3469 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3470 of the required alignment if LSB tags are used. */
3472 union aligned_Lisp_Symbol
3474 struct Lisp_Symbol s
;
3476 unsigned char c
[(sizeof (struct Lisp_Symbol
) + (1 << GCTYPEBITS
) - 1)
3477 & -(1 << GCTYPEBITS
)];
3481 /* Each symbol_block is just under 1020 bytes long, since malloc
3482 really allocates in units of powers of two and uses 4 bytes for its
3485 #define SYMBOL_BLOCK_SIZE \
3486 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3490 /* Place `symbols' first, to preserve alignment. */
3491 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3492 struct symbol_block
*next
;
3495 /* Current symbol block and index of first unused Lisp_Symbol
3498 static struct symbol_block
*symbol_block
;
3499 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3501 /* List of free symbols. */
3503 static struct Lisp_Symbol
*symbol_free_list
;
3505 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3506 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3507 Its value and function definition are void, and its property list is nil. */)
3510 register Lisp_Object val
;
3511 register struct Lisp_Symbol
*p
;
3513 CHECK_STRING (name
);
3515 /* eassert (!handling_signal); */
3519 if (symbol_free_list
)
3521 XSETSYMBOL (val
, symbol_free_list
);
3522 symbol_free_list
= symbol_free_list
->next
;
3526 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3528 struct symbol_block
*new
3529 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3530 new->next
= symbol_block
;
3532 symbol_block_index
= 0;
3533 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3535 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3536 symbol_block_index
++;
3539 MALLOC_UNBLOCK_INPUT
;
3544 p
->redirect
= SYMBOL_PLAINVAL
;
3545 SET_SYMBOL_VAL (p
, Qunbound
);
3546 p
->function
= Qunbound
;
3549 p
->interned
= SYMBOL_UNINTERNED
;
3551 p
->declared_special
= 0;
3552 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3554 total_free_symbols
--;
3560 /***********************************************************************
3561 Marker (Misc) Allocation
3562 ***********************************************************************/
3564 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3565 the required alignment when LSB tags are used. */
3567 union aligned_Lisp_Misc
3571 unsigned char c
[(sizeof (union Lisp_Misc
) + (1 << GCTYPEBITS
) - 1)
3572 & -(1 << GCTYPEBITS
)];
3576 /* Allocation of markers and other objects that share that structure.
3577 Works like allocation of conses. */
3579 #define MARKER_BLOCK_SIZE \
3580 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3584 /* Place `markers' first, to preserve alignment. */
3585 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3586 struct marker_block
*next
;
3589 static struct marker_block
*marker_block
;
3590 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3592 static union Lisp_Misc
*marker_free_list
;
3594 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3597 allocate_misc (enum Lisp_Misc_Type type
)
3601 /* eassert (!handling_signal); */
3605 if (marker_free_list
)
3607 XSETMISC (val
, marker_free_list
);
3608 marker_free_list
= marker_free_list
->u_free
.chain
;
3612 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3614 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3615 new->next
= marker_block
;
3617 marker_block_index
= 0;
3618 total_free_markers
+= MARKER_BLOCK_SIZE
;
3620 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3621 marker_block_index
++;
3624 MALLOC_UNBLOCK_INPUT
;
3626 --total_free_markers
;
3627 consing_since_gc
+= sizeof (union Lisp_Misc
);
3628 misc_objects_consed
++;
3629 XMISCTYPE (val
) = type
;
3630 XMISCANY (val
)->gcmarkbit
= 0;
3634 /* Free a Lisp_Misc object */
3637 free_misc (Lisp_Object misc
)
3639 XMISCTYPE (misc
) = Lisp_Misc_Free
;
3640 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3641 marker_free_list
= XMISC (misc
);
3642 consing_since_gc
-= sizeof (union Lisp_Misc
);
3643 total_free_markers
++;
3646 /* Return a Lisp_Misc_Save_Value object containing POINTER and
3647 INTEGER. This is used to package C values to call record_unwind_protect.
3648 The unwind function can get the C values back using XSAVE_VALUE. */
3651 make_save_value (void *pointer
, ptrdiff_t integer
)
3653 register Lisp_Object val
;
3654 register struct Lisp_Save_Value
*p
;
3656 val
= allocate_misc (Lisp_Misc_Save_Value
);
3657 p
= XSAVE_VALUE (val
);
3658 p
->pointer
= pointer
;
3659 p
->integer
= integer
;
3664 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3667 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3669 register Lisp_Object overlay
;
3671 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3672 OVERLAY_START (overlay
) = start
;
3673 OVERLAY_END (overlay
) = end
;
3674 OVERLAY_PLIST (overlay
) = plist
;
3675 XOVERLAY (overlay
)->next
= NULL
;
3679 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3680 doc
: /* Return a newly allocated marker which does not point at any place. */)
3683 register Lisp_Object val
;
3684 register struct Lisp_Marker
*p
;
3686 val
= allocate_misc (Lisp_Misc_Marker
);
3692 p
->insertion_type
= 0;
3696 /* Return a newly allocated marker which points into BUF
3697 at character position CHARPOS and byte position BYTEPOS. */
3700 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3703 struct Lisp_Marker
*m
;
3705 /* No dead buffers here. */
3706 eassert (!NILP (BVAR (buf
, name
)));
3708 /* Every character is at least one byte. */
3709 eassert (charpos
<= bytepos
);
3711 obj
= allocate_misc (Lisp_Misc_Marker
);
3714 m
->charpos
= charpos
;
3715 m
->bytepos
= bytepos
;
3716 m
->insertion_type
= 0;
3717 m
->next
= BUF_MARKERS (buf
);
3718 BUF_MARKERS (buf
) = m
;
3722 /* Put MARKER back on the free list after using it temporarily. */
3725 free_marker (Lisp_Object marker
)
3727 unchain_marker (XMARKER (marker
));
3732 /* Return a newly created vector or string with specified arguments as
3733 elements. If all the arguments are characters that can fit
3734 in a string of events, make a string; otherwise, make a vector.
3736 Any number of arguments, even zero arguments, are allowed. */
3739 make_event_array (register int nargs
, Lisp_Object
*args
)
3743 for (i
= 0; i
< nargs
; i
++)
3744 /* The things that fit in a string
3745 are characters that are in 0...127,
3746 after discarding the meta bit and all the bits above it. */
3747 if (!INTEGERP (args
[i
])
3748 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3749 return Fvector (nargs
, args
);
3751 /* Since the loop exited, we know that all the things in it are
3752 characters, so we can make a string. */
3756 result
= Fmake_string (make_number (nargs
), make_number (0));
3757 for (i
= 0; i
< nargs
; i
++)
3759 SSET (result
, i
, XINT (args
[i
]));
3760 /* Move the meta bit to the right place for a string char. */
3761 if (XINT (args
[i
]) & CHAR_META
)
3762 SSET (result
, i
, SREF (result
, i
) | 0x80);
3771 /************************************************************************
3772 Memory Full Handling
3773 ************************************************************************/
3776 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3777 there may have been size_t overflow so that malloc was never
3778 called, or perhaps malloc was invoked successfully but the
3779 resulting pointer had problems fitting into a tagged EMACS_INT. In
3780 either case this counts as memory being full even though malloc did
3784 memory_full (size_t nbytes
)
3786 /* Do not go into hysterics merely because a large request failed. */
3787 int enough_free_memory
= 0;
3788 if (SPARE_MEMORY
< nbytes
)
3793 p
= malloc (SPARE_MEMORY
);
3797 enough_free_memory
= 1;
3799 MALLOC_UNBLOCK_INPUT
;
3802 if (! enough_free_memory
)
3808 memory_full_cons_threshold
= sizeof (struct cons_block
);
3810 /* The first time we get here, free the spare memory. */
3811 for (i
= 0; i
< sizeof (spare_memory
) / sizeof (char *); i
++)
3812 if (spare_memory
[i
])
3815 free (spare_memory
[i
]);
3816 else if (i
>= 1 && i
<= 4)
3817 lisp_align_free (spare_memory
[i
]);
3819 lisp_free (spare_memory
[i
]);
3820 spare_memory
[i
] = 0;
3823 /* Record the space now used. When it decreases substantially,
3824 we can refill the memory reserve. */
3825 #if !defined SYSTEM_MALLOC && !defined SYNC_INPUT
3826 bytes_used_when_full
= BYTES_USED
;
3830 /* This used to call error, but if we've run out of memory, we could
3831 get infinite recursion trying to build the string. */
3832 xsignal (Qnil
, Vmemory_signal_data
);
3835 /* If we released our reserve (due to running out of memory),
3836 and we have a fair amount free once again,
3837 try to set aside another reserve in case we run out once more.
3839 This is called when a relocatable block is freed in ralloc.c,
3840 and also directly from this file, in case we're not using ralloc.c. */
3843 refill_memory_reserve (void)
3845 #ifndef SYSTEM_MALLOC
3846 if (spare_memory
[0] == 0)
3847 spare_memory
[0] = malloc (SPARE_MEMORY
);
3848 if (spare_memory
[1] == 0)
3849 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
3851 if (spare_memory
[2] == 0)
3852 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
3854 if (spare_memory
[3] == 0)
3855 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
3857 if (spare_memory
[4] == 0)
3858 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
3860 if (spare_memory
[5] == 0)
3861 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
3863 if (spare_memory
[6] == 0)
3864 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
3866 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3867 Vmemory_full
= Qnil
;
3871 /************************************************************************
3873 ************************************************************************/
3875 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3877 /* Conservative C stack marking requires a method to identify possibly
3878 live Lisp objects given a pointer value. We do this by keeping
3879 track of blocks of Lisp data that are allocated in a red-black tree
3880 (see also the comment of mem_node which is the type of nodes in
3881 that tree). Function lisp_malloc adds information for an allocated
3882 block to the red-black tree with calls to mem_insert, and function
3883 lisp_free removes it with mem_delete. Functions live_string_p etc
3884 call mem_find to lookup information about a given pointer in the
3885 tree, and use that to determine if the pointer points to a Lisp
3888 /* Initialize this part of alloc.c. */
3893 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3894 mem_z
.parent
= NULL
;
3895 mem_z
.color
= MEM_BLACK
;
3896 mem_z
.start
= mem_z
.end
= NULL
;
3901 /* Value is a pointer to the mem_node containing START. Value is
3902 MEM_NIL if there is no node in the tree containing START. */
3904 static inline struct mem_node
*
3905 mem_find (void *start
)
3909 if (start
< min_heap_address
|| start
> max_heap_address
)
3912 /* Make the search always successful to speed up the loop below. */
3913 mem_z
.start
= start
;
3914 mem_z
.end
= (char *) start
+ 1;
3917 while (start
< p
->start
|| start
>= p
->end
)
3918 p
= start
< p
->start
? p
->left
: p
->right
;
3923 /* Insert a new node into the tree for a block of memory with start
3924 address START, end address END, and type TYPE. Value is a
3925 pointer to the node that was inserted. */
3927 static struct mem_node
*
3928 mem_insert (void *start
, void *end
, enum mem_type type
)
3930 struct mem_node
*c
, *parent
, *x
;
3932 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3933 min_heap_address
= start
;
3934 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3935 max_heap_address
= end
;
3937 /* See where in the tree a node for START belongs. In this
3938 particular application, it shouldn't happen that a node is already
3939 present. For debugging purposes, let's check that. */
3943 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3945 while (c
!= MEM_NIL
)
3947 if (start
>= c
->start
&& start
< c
->end
)
3950 c
= start
< c
->start
? c
->left
: c
->right
;
3953 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3955 while (c
!= MEM_NIL
)
3958 c
= start
< c
->start
? c
->left
: c
->right
;
3961 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3963 /* Create a new node. */
3964 #ifdef GC_MALLOC_CHECK
3965 x
= _malloc_internal (sizeof *x
);
3969 x
= xmalloc (sizeof *x
);
3975 x
->left
= x
->right
= MEM_NIL
;
3978 /* Insert it as child of PARENT or install it as root. */
3981 if (start
< parent
->start
)
3989 /* Re-establish red-black tree properties. */
3990 mem_insert_fixup (x
);
3996 /* Re-establish the red-black properties of the tree, and thereby
3997 balance the tree, after node X has been inserted; X is always red. */
4000 mem_insert_fixup (struct mem_node
*x
)
4002 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
4004 /* X is red and its parent is red. This is a violation of
4005 red-black tree property #3. */
4007 if (x
->parent
== x
->parent
->parent
->left
)
4009 /* We're on the left side of our grandparent, and Y is our
4011 struct mem_node
*y
= x
->parent
->parent
->right
;
4013 if (y
->color
== MEM_RED
)
4015 /* Uncle and parent are red but should be black because
4016 X is red. Change the colors accordingly and proceed
4017 with the grandparent. */
4018 x
->parent
->color
= MEM_BLACK
;
4019 y
->color
= MEM_BLACK
;
4020 x
->parent
->parent
->color
= MEM_RED
;
4021 x
= x
->parent
->parent
;
4025 /* Parent and uncle have different colors; parent is
4026 red, uncle is black. */
4027 if (x
== x
->parent
->right
)
4030 mem_rotate_left (x
);
4033 x
->parent
->color
= MEM_BLACK
;
4034 x
->parent
->parent
->color
= MEM_RED
;
4035 mem_rotate_right (x
->parent
->parent
);
4040 /* This is the symmetrical case of above. */
4041 struct mem_node
*y
= x
->parent
->parent
->left
;
4043 if (y
->color
== MEM_RED
)
4045 x
->parent
->color
= MEM_BLACK
;
4046 y
->color
= MEM_BLACK
;
4047 x
->parent
->parent
->color
= MEM_RED
;
4048 x
= x
->parent
->parent
;
4052 if (x
== x
->parent
->left
)
4055 mem_rotate_right (x
);
4058 x
->parent
->color
= MEM_BLACK
;
4059 x
->parent
->parent
->color
= MEM_RED
;
4060 mem_rotate_left (x
->parent
->parent
);
4065 /* The root may have been changed to red due to the algorithm. Set
4066 it to black so that property #5 is satisfied. */
4067 mem_root
->color
= MEM_BLACK
;
4078 mem_rotate_left (struct mem_node
*x
)
4082 /* Turn y's left sub-tree into x's right sub-tree. */
4085 if (y
->left
!= MEM_NIL
)
4086 y
->left
->parent
= x
;
4088 /* Y's parent was x's parent. */
4090 y
->parent
= x
->parent
;
4092 /* Get the parent to point to y instead of x. */
4095 if (x
== x
->parent
->left
)
4096 x
->parent
->left
= y
;
4098 x
->parent
->right
= y
;
4103 /* Put x on y's left. */
4117 mem_rotate_right (struct mem_node
*x
)
4119 struct mem_node
*y
= x
->left
;
4122 if (y
->right
!= MEM_NIL
)
4123 y
->right
->parent
= x
;
4126 y
->parent
= x
->parent
;
4129 if (x
== x
->parent
->right
)
4130 x
->parent
->right
= y
;
4132 x
->parent
->left
= y
;
4143 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4146 mem_delete (struct mem_node
*z
)
4148 struct mem_node
*x
, *y
;
4150 if (!z
|| z
== MEM_NIL
)
4153 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4158 while (y
->left
!= MEM_NIL
)
4162 if (y
->left
!= MEM_NIL
)
4167 x
->parent
= y
->parent
;
4170 if (y
== y
->parent
->left
)
4171 y
->parent
->left
= x
;
4173 y
->parent
->right
= x
;
4180 z
->start
= y
->start
;
4185 if (y
->color
== MEM_BLACK
)
4186 mem_delete_fixup (x
);
4188 #ifdef GC_MALLOC_CHECK
4196 /* Re-establish the red-black properties of the tree, after a
4200 mem_delete_fixup (struct mem_node
*x
)
4202 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4204 if (x
== x
->parent
->left
)
4206 struct mem_node
*w
= x
->parent
->right
;
4208 if (w
->color
== MEM_RED
)
4210 w
->color
= MEM_BLACK
;
4211 x
->parent
->color
= MEM_RED
;
4212 mem_rotate_left (x
->parent
);
4213 w
= x
->parent
->right
;
4216 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4223 if (w
->right
->color
== MEM_BLACK
)
4225 w
->left
->color
= MEM_BLACK
;
4227 mem_rotate_right (w
);
4228 w
= x
->parent
->right
;
4230 w
->color
= x
->parent
->color
;
4231 x
->parent
->color
= MEM_BLACK
;
4232 w
->right
->color
= MEM_BLACK
;
4233 mem_rotate_left (x
->parent
);
4239 struct mem_node
*w
= x
->parent
->left
;
4241 if (w
->color
== MEM_RED
)
4243 w
->color
= MEM_BLACK
;
4244 x
->parent
->color
= MEM_RED
;
4245 mem_rotate_right (x
->parent
);
4246 w
= x
->parent
->left
;
4249 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4256 if (w
->left
->color
== MEM_BLACK
)
4258 w
->right
->color
= MEM_BLACK
;
4260 mem_rotate_left (w
);
4261 w
= x
->parent
->left
;
4264 w
->color
= x
->parent
->color
;
4265 x
->parent
->color
= MEM_BLACK
;
4266 w
->left
->color
= MEM_BLACK
;
4267 mem_rotate_right (x
->parent
);
4273 x
->color
= MEM_BLACK
;
4277 /* Value is non-zero if P is a pointer to a live Lisp string on
4278 the heap. M is a pointer to the mem_block for P. */
4281 live_string_p (struct mem_node
*m
, void *p
)
4283 if (m
->type
== MEM_TYPE_STRING
)
4285 struct string_block
*b
= (struct string_block
*) m
->start
;
4286 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4288 /* P must point to the start of a Lisp_String structure, and it
4289 must not be on the free-list. */
4291 && offset
% sizeof b
->strings
[0] == 0
4292 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4293 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4300 /* Value is non-zero if P is a pointer to a live Lisp cons on
4301 the heap. M is a pointer to the mem_block for P. */
4304 live_cons_p (struct mem_node
*m
, void *p
)
4306 if (m
->type
== MEM_TYPE_CONS
)
4308 struct cons_block
*b
= (struct cons_block
*) m
->start
;
4309 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4311 /* P must point to the start of a Lisp_Cons, not be
4312 one of the unused cells in the current cons block,
4313 and not be on the free-list. */
4315 && offset
% sizeof b
->conses
[0] == 0
4316 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4318 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4319 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
4326 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4327 the heap. M is a pointer to the mem_block for P. */
4330 live_symbol_p (struct mem_node
*m
, void *p
)
4332 if (m
->type
== MEM_TYPE_SYMBOL
)
4334 struct symbol_block
*b
= (struct symbol_block
*) m
->start
;
4335 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4337 /* P must point to the start of a Lisp_Symbol, not be
4338 one of the unused cells in the current symbol block,
4339 and not be on the free-list. */
4341 && offset
% sizeof b
->symbols
[0] == 0
4342 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4343 && (b
!= symbol_block
4344 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4345 && !EQ (((struct Lisp_Symbol
*) p
)->function
, Vdead
));
4352 /* Value is non-zero if P is a pointer to a live Lisp float on
4353 the heap. M is a pointer to the mem_block for P. */
4356 live_float_p (struct mem_node
*m
, void *p
)
4358 if (m
->type
== MEM_TYPE_FLOAT
)
4360 struct float_block
*b
= (struct float_block
*) m
->start
;
4361 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4363 /* P must point to the start of a Lisp_Float and not be
4364 one of the unused cells in the current float block. */
4366 && offset
% sizeof b
->floats
[0] == 0
4367 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4368 && (b
!= float_block
4369 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4376 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4377 the heap. M is a pointer to the mem_block for P. */
4380 live_misc_p (struct mem_node
*m
, void *p
)
4382 if (m
->type
== MEM_TYPE_MISC
)
4384 struct marker_block
*b
= (struct marker_block
*) m
->start
;
4385 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4387 /* P must point to the start of a Lisp_Misc, not be
4388 one of the unused cells in the current misc block,
4389 and not be on the free-list. */
4391 && offset
% sizeof b
->markers
[0] == 0
4392 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4393 && (b
!= marker_block
4394 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4395 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4402 /* Value is non-zero if P is a pointer to a live vector-like object.
4403 M is a pointer to the mem_block for P. */
4406 live_vector_p (struct mem_node
*m
, void *p
)
4408 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4410 /* This memory node corresponds to a vector block. */
4411 struct vector_block
*block
= (struct vector_block
*) m
->start
;
4412 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4414 /* P is in the block's allocation range. Scan the block
4415 up to P and see whether P points to the start of some
4416 vector which is not on a free list. FIXME: check whether
4417 some allocation patterns (probably a lot of short vectors)
4418 may cause a substantial overhead of this loop. */
4419 while (VECTOR_IN_BLOCK (vector
, block
)
4420 && vector
<= (struct Lisp_Vector
*) p
)
4422 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
))
4423 vector
= ADVANCE (vector
, (vector
->header
.size
4424 & PSEUDOVECTOR_SIZE_MASK
));
4425 else if (vector
== p
)
4428 vector
= ADVANCE (vector
, vector
->header
.next
.nbytes
);
4431 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== m
->start
)
4432 /* This memory node corresponds to a large vector. */
4438 /* Value is non-zero if P is a pointer to a live buffer. M is a
4439 pointer to the mem_block for P. */
4442 live_buffer_p (struct mem_node
*m
, void *p
)
4444 /* P must point to the start of the block, and the buffer
4445 must not have been killed. */
4446 return (m
->type
== MEM_TYPE_BUFFER
4448 && !NILP (((struct buffer
*) p
)->BUFFER_INTERNAL_FIELD (name
)));
4451 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4455 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4457 /* Array of objects that are kept alive because the C stack contains
4458 a pattern that looks like a reference to them . */
4460 #define MAX_ZOMBIES 10
4461 static Lisp_Object zombies
[MAX_ZOMBIES
];
4463 /* Number of zombie objects. */
4465 static EMACS_INT nzombies
;
4467 /* Number of garbage collections. */
4469 static EMACS_INT ngcs
;
4471 /* Average percentage of zombies per collection. */
4473 static double avg_zombies
;
4475 /* Max. number of live and zombie objects. */
4477 static EMACS_INT max_live
, max_zombies
;
4479 /* Average number of live objects per GC. */
4481 static double avg_live
;
4483 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4484 doc
: /* Show information about live and zombie objects. */)
4487 Lisp_Object args
[8], zombie_list
= Qnil
;
4489 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); i
++)
4490 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4491 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4492 args
[1] = make_number (ngcs
);
4493 args
[2] = make_float (avg_live
);
4494 args
[3] = make_float (avg_zombies
);
4495 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4496 args
[5] = make_number (max_live
);
4497 args
[6] = make_number (max_zombies
);
4498 args
[7] = zombie_list
;
4499 return Fmessage (8, args
);
4502 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4505 /* Mark OBJ if we can prove it's a Lisp_Object. */
4508 mark_maybe_object (Lisp_Object obj
)
4516 po
= (void *) XPNTR (obj
);
4523 switch (XTYPE (obj
))
4526 mark_p
= (live_string_p (m
, po
)
4527 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4531 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4535 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4539 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4542 case Lisp_Vectorlike
:
4543 /* Note: can't check BUFFERP before we know it's a
4544 buffer because checking that dereferences the pointer
4545 PO which might point anywhere. */
4546 if (live_vector_p (m
, po
))
4547 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4548 else if (live_buffer_p (m
, po
))
4549 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4553 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4562 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4563 if (nzombies
< MAX_ZOMBIES
)
4564 zombies
[nzombies
] = obj
;
4573 /* If P points to Lisp data, mark that as live if it isn't already
4577 mark_maybe_pointer (void *p
)
4581 /* Quickly rule out some values which can't point to Lisp data.
4582 USE_LSB_TAG needs Lisp data to be aligned on multiples of 1 << GCTYPEBITS.
4583 Otherwise, assume that Lisp data is aligned on even addresses. */
4584 if ((intptr_t) p
% (USE_LSB_TAG
? 1 << GCTYPEBITS
: 2))
4590 Lisp_Object obj
= Qnil
;
4594 case MEM_TYPE_NON_LISP
:
4595 /* Nothing to do; not a pointer to Lisp memory. */
4598 case MEM_TYPE_BUFFER
:
4599 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4600 XSETVECTOR (obj
, p
);
4604 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4608 case MEM_TYPE_STRING
:
4609 if (live_string_p (m
, p
)
4610 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4611 XSETSTRING (obj
, p
);
4615 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4619 case MEM_TYPE_SYMBOL
:
4620 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4621 XSETSYMBOL (obj
, p
);
4624 case MEM_TYPE_FLOAT
:
4625 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4629 case MEM_TYPE_VECTORLIKE
:
4630 case MEM_TYPE_VECTOR_BLOCK
:
4631 if (live_vector_p (m
, p
))
4634 XSETVECTOR (tem
, p
);
4635 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4650 /* Alignment of pointer values. Use alignof, as it sometimes returns
4651 a smaller alignment than GCC's __alignof__ and mark_memory might
4652 miss objects if __alignof__ were used. */
4653 #define GC_POINTER_ALIGNMENT alignof (void *)
4655 /* Define POINTERS_MIGHT_HIDE_IN_OBJECTS to 1 if marking via C pointers does
4656 not suffice, which is the typical case. A host where a Lisp_Object is
4657 wider than a pointer might allocate a Lisp_Object in non-adjacent halves.
4658 If USE_LSB_TAG, the bottom half is not a valid pointer, but it should
4659 suffice to widen it to to a Lisp_Object and check it that way. */
4660 #if USE_LSB_TAG || VAL_MAX < UINTPTR_MAX
4661 # if !USE_LSB_TAG && VAL_MAX < UINTPTR_MAX >> GCTYPEBITS
4662 /* If tag bits straddle pointer-word boundaries, neither mark_maybe_pointer
4663 nor mark_maybe_object can follow the pointers. This should not occur on
4664 any practical porting target. */
4665 # error "MSB type bits straddle pointer-word boundaries"
4667 /* Marking via C pointers does not suffice, because Lisp_Objects contain
4668 pointer words that hold pointers ORed with type bits. */
4669 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 1
4671 /* Marking via C pointers suffices, because Lisp_Objects contain pointer
4672 words that hold unmodified pointers. */
4673 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 0
4676 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4677 or END+OFFSET..START. */
4680 mark_memory (void *start
, void *end
)
4681 #if defined (__clang__) && defined (__has_feature)
4682 #if __has_feature(address_sanitizer)
4683 /* Do not allow -faddress-sanitizer to check this function, since it
4684 crosses the function stack boundary, and thus would yield many
4686 __attribute__((no_address_safety_analysis
))
4693 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4697 /* Make START the pointer to the start of the memory region,
4698 if it isn't already. */
4706 /* Mark Lisp data pointed to. This is necessary because, in some
4707 situations, the C compiler optimizes Lisp objects away, so that
4708 only a pointer to them remains. Example:
4710 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4713 Lisp_Object obj = build_string ("test");
4714 struct Lisp_String *s = XSTRING (obj);
4715 Fgarbage_collect ();
4716 fprintf (stderr, "test `%s'\n", s->data);
4720 Here, `obj' isn't really used, and the compiler optimizes it
4721 away. The only reference to the life string is through the
4724 for (pp
= start
; (void *) pp
< end
; pp
++)
4725 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4727 void *p
= *(void **) ((char *) pp
+ i
);
4728 mark_maybe_pointer (p
);
4729 if (POINTERS_MIGHT_HIDE_IN_OBJECTS
)
4730 mark_maybe_object (XIL ((intptr_t) p
));
4734 /* setjmp will work with GCC unless NON_SAVING_SETJMP is defined in
4735 the GCC system configuration. In gcc 3.2, the only systems for
4736 which this is so are i386-sco5 non-ELF, i386-sysv3 (maybe included
4737 by others?) and ns32k-pc532-min. */
4739 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4741 static int setjmp_tested_p
, longjmps_done
;
4743 #define SETJMP_WILL_LIKELY_WORK "\
4745 Emacs garbage collector has been changed to use conservative stack\n\
4746 marking. Emacs has determined that the method it uses to do the\n\
4747 marking will likely work on your system, but this isn't sure.\n\
4749 If you are a system-programmer, or can get the help of a local wizard\n\
4750 who is, please take a look at the function mark_stack in alloc.c, and\n\
4751 verify that the methods used are appropriate for your system.\n\
4753 Please mail the result to <emacs-devel@gnu.org>.\n\
4756 #define SETJMP_WILL_NOT_WORK "\
4758 Emacs garbage collector has been changed to use conservative stack\n\
4759 marking. Emacs has determined that the default method it uses to do the\n\
4760 marking will not work on your system. We will need a system-dependent\n\
4761 solution for your system.\n\
4763 Please take a look at the function mark_stack in alloc.c, and\n\
4764 try to find a way to make it work on your system.\n\
4766 Note that you may get false negatives, depending on the compiler.\n\
4767 In particular, you need to use -O with GCC for this test.\n\
4769 Please mail the result to <emacs-devel@gnu.org>.\n\
4773 /* Perform a quick check if it looks like setjmp saves registers in a
4774 jmp_buf. Print a message to stderr saying so. When this test
4775 succeeds, this is _not_ a proof that setjmp is sufficient for
4776 conservative stack marking. Only the sources or a disassembly
4787 /* Arrange for X to be put in a register. */
4793 if (longjmps_done
== 1)
4795 /* Came here after the longjmp at the end of the function.
4797 If x == 1, the longjmp has restored the register to its
4798 value before the setjmp, and we can hope that setjmp
4799 saves all such registers in the jmp_buf, although that
4802 For other values of X, either something really strange is
4803 taking place, or the setjmp just didn't save the register. */
4806 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4809 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4816 if (longjmps_done
== 1)
4820 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4823 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4825 /* Abort if anything GCPRO'd doesn't survive the GC. */
4833 for (p
= gcprolist
; p
; p
= p
->next
)
4834 for (i
= 0; i
< p
->nvars
; ++i
)
4835 if (!survives_gc_p (p
->var
[i
]))
4836 /* FIXME: It's not necessarily a bug. It might just be that the
4837 GCPRO is unnecessary or should release the object sooner. */
4841 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4848 fprintf (stderr
, "\nZombies kept alive = %"pI
"d:\n", nzombies
);
4849 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4851 fprintf (stderr
, " %d = ", i
);
4852 debug_print (zombies
[i
]);
4856 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4859 /* Mark live Lisp objects on the C stack.
4861 There are several system-dependent problems to consider when
4862 porting this to new architectures:
4866 We have to mark Lisp objects in CPU registers that can hold local
4867 variables or are used to pass parameters.
4869 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4870 something that either saves relevant registers on the stack, or
4871 calls mark_maybe_object passing it each register's contents.
4873 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4874 implementation assumes that calling setjmp saves registers we need
4875 to see in a jmp_buf which itself lies on the stack. This doesn't
4876 have to be true! It must be verified for each system, possibly
4877 by taking a look at the source code of setjmp.
4879 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4880 can use it as a machine independent method to store all registers
4881 to the stack. In this case the macros described in the previous
4882 two paragraphs are not used.
4886 Architectures differ in the way their processor stack is organized.
4887 For example, the stack might look like this
4890 | Lisp_Object | size = 4
4892 | something else | size = 2
4894 | Lisp_Object | size = 4
4898 In such a case, not every Lisp_Object will be aligned equally. To
4899 find all Lisp_Object on the stack it won't be sufficient to walk
4900 the stack in steps of 4 bytes. Instead, two passes will be
4901 necessary, one starting at the start of the stack, and a second
4902 pass starting at the start of the stack + 2. Likewise, if the
4903 minimal alignment of Lisp_Objects on the stack is 1, four passes
4904 would be necessary, each one starting with one byte more offset
4905 from the stack start. */
4912 #ifdef HAVE___BUILTIN_UNWIND_INIT
4913 /* Force callee-saved registers and register windows onto the stack.
4914 This is the preferred method if available, obviating the need for
4915 machine dependent methods. */
4916 __builtin_unwind_init ();
4918 #else /* not HAVE___BUILTIN_UNWIND_INIT */
4919 #ifndef GC_SAVE_REGISTERS_ON_STACK
4920 /* jmp_buf may not be aligned enough on darwin-ppc64 */
4921 union aligned_jmpbuf
{
4925 volatile int stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4927 /* This trick flushes the register windows so that all the state of
4928 the process is contained in the stack. */
4929 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4930 needed on ia64 too. See mach_dep.c, where it also says inline
4931 assembler doesn't work with relevant proprietary compilers. */
4933 #if defined (__sparc64__) && defined (__FreeBSD__)
4934 /* FreeBSD does not have a ta 3 handler. */
4941 /* Save registers that we need to see on the stack. We need to see
4942 registers used to hold register variables and registers used to
4944 #ifdef GC_SAVE_REGISTERS_ON_STACK
4945 GC_SAVE_REGISTERS_ON_STACK (end
);
4946 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4948 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4949 setjmp will definitely work, test it
4950 and print a message with the result
4952 if (!setjmp_tested_p
)
4954 setjmp_tested_p
= 1;
4957 #endif /* GC_SETJMP_WORKS */
4960 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4961 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4962 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
4964 /* This assumes that the stack is a contiguous region in memory. If
4965 that's not the case, something has to be done here to iterate
4966 over the stack segments. */
4967 mark_memory (stack_base
, end
);
4969 /* Allow for marking a secondary stack, like the register stack on the
4971 #ifdef GC_MARK_SECONDARY_STACK
4972 GC_MARK_SECONDARY_STACK ();
4975 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4980 #endif /* GC_MARK_STACK != 0 */
4983 /* Determine whether it is safe to access memory at address P. */
4985 valid_pointer_p (void *p
)
4988 return w32_valid_pointer_p (p
, 16);
4992 /* Obviously, we cannot just access it (we would SEGV trying), so we
4993 trick the o/s to tell us whether p is a valid pointer.
4994 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4995 not validate p in that case. */
4999 int valid
= (emacs_write (fd
[1], (char *) p
, 16) == 16);
5000 emacs_close (fd
[1]);
5001 emacs_close (fd
[0]);
5009 /* Return 1 if OBJ is a valid lisp object.
5010 Return 0 if OBJ is NOT a valid lisp object.
5011 Return -1 if we cannot validate OBJ.
5012 This function can be quite slow,
5013 so it should only be used in code for manual debugging. */
5016 valid_lisp_object_p (Lisp_Object obj
)
5026 p
= (void *) XPNTR (obj
);
5027 if (PURE_POINTER_P (p
))
5031 return valid_pointer_p (p
);
5038 int valid
= valid_pointer_p (p
);
5050 case MEM_TYPE_NON_LISP
:
5053 case MEM_TYPE_BUFFER
:
5054 return live_buffer_p (m
, p
);
5057 return live_cons_p (m
, p
);
5059 case MEM_TYPE_STRING
:
5060 return live_string_p (m
, p
);
5063 return live_misc_p (m
, p
);
5065 case MEM_TYPE_SYMBOL
:
5066 return live_symbol_p (m
, p
);
5068 case MEM_TYPE_FLOAT
:
5069 return live_float_p (m
, p
);
5071 case MEM_TYPE_VECTORLIKE
:
5072 case MEM_TYPE_VECTOR_BLOCK
:
5073 return live_vector_p (m
, p
);
5086 /***********************************************************************
5087 Pure Storage Management
5088 ***********************************************************************/
5090 /* Allocate room for SIZE bytes from pure Lisp storage and return a
5091 pointer to it. TYPE is the Lisp type for which the memory is
5092 allocated. TYPE < 0 means it's not used for a Lisp object. */
5095 pure_alloc (size_t size
, int type
)
5099 size_t alignment
= (1 << GCTYPEBITS
);
5101 size_t alignment
= alignof (EMACS_INT
);
5103 /* Give Lisp_Floats an extra alignment. */
5104 if (type
== Lisp_Float
)
5105 alignment
= alignof (struct Lisp_Float
);
5111 /* Allocate space for a Lisp object from the beginning of the free
5112 space with taking account of alignment. */
5113 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
5114 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
5118 /* Allocate space for a non-Lisp object from the end of the free
5120 pure_bytes_used_non_lisp
+= size
;
5121 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5123 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
5125 if (pure_bytes_used
<= pure_size
)
5128 /* Don't allocate a large amount here,
5129 because it might get mmap'd and then its address
5130 might not be usable. */
5131 purebeg
= xmalloc (10000);
5133 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
5134 pure_bytes_used
= 0;
5135 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
5140 /* Print a warning if PURESIZE is too small. */
5143 check_pure_size (void)
5145 if (pure_bytes_used_before_overflow
)
5146 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
5148 pure_bytes_used
+ pure_bytes_used_before_overflow
);
5152 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
5153 the non-Lisp data pool of the pure storage, and return its start
5154 address. Return NULL if not found. */
5157 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5160 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5161 const unsigned char *p
;
5164 if (pure_bytes_used_non_lisp
<= nbytes
)
5167 /* Set up the Boyer-Moore table. */
5169 for (i
= 0; i
< 256; i
++)
5172 p
= (const unsigned char *) data
;
5174 bm_skip
[*p
++] = skip
;
5176 last_char_skip
= bm_skip
['\0'];
5178 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5179 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5181 /* See the comments in the function `boyer_moore' (search.c) for the
5182 use of `infinity'. */
5183 infinity
= pure_bytes_used_non_lisp
+ 1;
5184 bm_skip
['\0'] = infinity
;
5186 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5190 /* Check the last character (== '\0'). */
5193 start
+= bm_skip
[*(p
+ start
)];
5195 while (start
<= start_max
);
5197 if (start
< infinity
)
5198 /* Couldn't find the last character. */
5201 /* No less than `infinity' means we could find the last
5202 character at `p[start - infinity]'. */
5205 /* Check the remaining characters. */
5206 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5208 return non_lisp_beg
+ start
;
5210 start
+= last_char_skip
;
5212 while (start
<= start_max
);
5218 /* Return a string allocated in pure space. DATA is a buffer holding
5219 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5220 non-zero means make the result string multibyte.
5222 Must get an error if pure storage is full, since if it cannot hold
5223 a large string it may be able to hold conses that point to that
5224 string; then the string is not protected from gc. */
5227 make_pure_string (const char *data
,
5228 ptrdiff_t nchars
, ptrdiff_t nbytes
, int multibyte
)
5231 struct Lisp_String
*s
;
5233 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
5234 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5235 if (s
->data
== NULL
)
5237 s
->data
= (unsigned char *) pure_alloc (nbytes
+ 1, -1);
5238 memcpy (s
->data
, data
, nbytes
);
5239 s
->data
[nbytes
] = '\0';
5242 s
->size_byte
= multibyte
? nbytes
: -1;
5243 s
->intervals
= NULL_INTERVAL
;
5244 XSETSTRING (string
, s
);
5248 /* Return a string allocated in pure space. Do not
5249 allocate the string data, just point to DATA. */
5252 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5255 struct Lisp_String
*s
;
5257 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
5260 s
->data
= (unsigned char *) data
;
5261 s
->intervals
= NULL_INTERVAL
;
5262 XSETSTRING (string
, s
);
5266 /* Return a cons allocated from pure space. Give it pure copies
5267 of CAR as car and CDR as cdr. */
5270 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5272 register Lisp_Object
new;
5273 struct Lisp_Cons
*p
;
5275 p
= (struct Lisp_Cons
*) pure_alloc (sizeof *p
, Lisp_Cons
);
5277 XSETCAR (new, Fpurecopy (car
));
5278 XSETCDR (new, Fpurecopy (cdr
));
5283 /* Value is a float object with value NUM allocated from pure space. */
5286 make_pure_float (double num
)
5288 register Lisp_Object
new;
5289 struct Lisp_Float
*p
;
5291 p
= (struct Lisp_Float
*) pure_alloc (sizeof *p
, Lisp_Float
);
5293 XFLOAT_INIT (new, num
);
5298 /* Return a vector with room for LEN Lisp_Objects allocated from
5302 make_pure_vector (ptrdiff_t len
)
5305 struct Lisp_Vector
*p
;
5306 size_t size
= header_size
+ len
* word_size
;
5308 p
= (struct Lisp_Vector
*) pure_alloc (size
, Lisp_Vectorlike
);
5309 XSETVECTOR (new, p
);
5310 XVECTOR (new)->header
.size
= len
;
5315 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5316 doc
: /* Make a copy of object OBJ in pure storage.
5317 Recursively copies contents of vectors and cons cells.
5318 Does not copy symbols. Copies strings without text properties. */)
5319 (register Lisp_Object obj
)
5321 if (NILP (Vpurify_flag
))
5324 if (PURE_POINTER_P (XPNTR (obj
)))
5327 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5329 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5335 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5336 else if (FLOATP (obj
))
5337 obj
= make_pure_float (XFLOAT_DATA (obj
));
5338 else if (STRINGP (obj
))
5339 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5341 STRING_MULTIBYTE (obj
));
5342 else if (COMPILEDP (obj
) || VECTORP (obj
))
5344 register struct Lisp_Vector
*vec
;
5345 register ptrdiff_t i
;
5349 if (size
& PSEUDOVECTOR_FLAG
)
5350 size
&= PSEUDOVECTOR_SIZE_MASK
;
5351 vec
= XVECTOR (make_pure_vector (size
));
5352 for (i
= 0; i
< size
; i
++)
5353 vec
->contents
[i
] = Fpurecopy (AREF (obj
, i
));
5354 if (COMPILEDP (obj
))
5356 XSETPVECTYPE (vec
, PVEC_COMPILED
);
5357 XSETCOMPILED (obj
, vec
);
5360 XSETVECTOR (obj
, vec
);
5362 else if (MARKERP (obj
))
5363 error ("Attempt to copy a marker to pure storage");
5365 /* Not purified, don't hash-cons. */
5368 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5369 Fputhash (obj
, obj
, Vpurify_flag
);
5376 /***********************************************************************
5378 ***********************************************************************/
5380 /* Put an entry in staticvec, pointing at the variable with address
5384 staticpro (Lisp_Object
*varaddress
)
5386 staticvec
[staticidx
++] = varaddress
;
5387 if (staticidx
>= NSTATICS
)
5392 /***********************************************************************
5394 ***********************************************************************/
5396 /* Temporarily prevent garbage collection. */
5399 inhibit_garbage_collection (void)
5401 ptrdiff_t count
= SPECPDL_INDEX ();
5403 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5407 /* Used to avoid possible overflows when
5408 converting from C to Lisp integers. */
5410 static inline Lisp_Object
5411 bounded_number (EMACS_INT number
)
5413 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5416 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5417 doc
: /* Reclaim storage for Lisp objects no longer needed.
5418 Garbage collection happens automatically if you cons more than
5419 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5420 `garbage-collect' normally returns a list with info on amount of space in use,
5421 where each entry has the form (NAME SIZE USED FREE), where:
5422 - NAME is a symbol describing the kind of objects this entry represents,
5423 - SIZE is the number of bytes used by each one,
5424 - USED is the number of those objects that were found live in the heap,
5425 - FREE is the number of those objects that are not live but that Emacs
5426 keeps around for future allocations (maybe because it does not know how
5427 to return them to the OS).
5428 However, if there was overflow in pure space, `garbage-collect'
5429 returns nil, because real GC can't be done.
5430 See Info node `(elisp)Garbage Collection'. */)
5433 register struct specbinding
*bind
;
5434 register struct buffer
*nextb
;
5435 char stack_top_variable
;
5438 Lisp_Object total
[11];
5439 ptrdiff_t count
= SPECPDL_INDEX ();
5445 /* Can't GC if pure storage overflowed because we can't determine
5446 if something is a pure object or not. */
5447 if (pure_bytes_used_before_overflow
)
5452 /* Don't keep undo information around forever.
5453 Do this early on, so it is no problem if the user quits. */
5454 FOR_EACH_BUFFER (nextb
)
5455 compact_buffer (nextb
);
5457 start
= current_emacs_time ();
5459 /* In case user calls debug_print during GC,
5460 don't let that cause a recursive GC. */
5461 consing_since_gc
= 0;
5463 /* Save what's currently displayed in the echo area. */
5464 message_p
= push_message ();
5465 record_unwind_protect (pop_message_unwind
, Qnil
);
5467 /* Save a copy of the contents of the stack, for debugging. */
5468 #if MAX_SAVE_STACK > 0
5469 if (NILP (Vpurify_flag
))
5472 ptrdiff_t stack_size
;
5473 if (&stack_top_variable
< stack_bottom
)
5475 stack
= &stack_top_variable
;
5476 stack_size
= stack_bottom
- &stack_top_variable
;
5480 stack
= stack_bottom
;
5481 stack_size
= &stack_top_variable
- stack_bottom
;
5483 if (stack_size
<= MAX_SAVE_STACK
)
5485 if (stack_copy_size
< stack_size
)
5487 stack_copy
= xrealloc (stack_copy
, stack_size
);
5488 stack_copy_size
= stack_size
;
5490 memcpy (stack_copy
, stack
, stack_size
);
5493 #endif /* MAX_SAVE_STACK > 0 */
5495 if (garbage_collection_messages
)
5496 message1_nolog ("Garbage collecting...");
5500 shrink_regexp_cache ();
5504 /* Mark all the special slots that serve as the roots of accessibility. */
5506 for (i
= 0; i
< staticidx
; i
++)
5507 mark_object (*staticvec
[i
]);
5509 for (bind
= specpdl
; bind
!= specpdl_ptr
; bind
++)
5511 mark_object (bind
->symbol
);
5512 mark_object (bind
->old_value
);
5520 extern void xg_mark_data (void);
5525 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5526 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5530 register struct gcpro
*tail
;
5531 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5532 for (i
= 0; i
< tail
->nvars
; i
++)
5533 mark_object (tail
->var
[i
]);
5537 struct catchtag
*catch;
5538 struct handler
*handler
;
5540 for (catch = catchlist
; catch; catch = catch->next
)
5542 mark_object (catch->tag
);
5543 mark_object (catch->val
);
5545 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5547 mark_object (handler
->handler
);
5548 mark_object (handler
->var
);
5554 #ifdef HAVE_WINDOW_SYSTEM
5555 mark_fringe_data ();
5558 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5562 /* Everything is now marked, except for the things that require special
5563 finalization, i.e. the undo_list.
5564 Look thru every buffer's undo list
5565 for elements that update markers that were not marked,
5567 FOR_EACH_BUFFER (nextb
)
5569 /* If a buffer's undo list is Qt, that means that undo is
5570 turned off in that buffer. Calling truncate_undo_list on
5571 Qt tends to return NULL, which effectively turns undo back on.
5572 So don't call truncate_undo_list if undo_list is Qt. */
5573 if (! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
5575 Lisp_Object tail
, prev
;
5576 tail
= nextb
->BUFFER_INTERNAL_FIELD (undo_list
);
5578 while (CONSP (tail
))
5580 if (CONSP (XCAR (tail
))
5581 && MARKERP (XCAR (XCAR (tail
)))
5582 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5585 nextb
->BUFFER_INTERNAL_FIELD (undo_list
) = tail
= XCDR (tail
);
5589 XSETCDR (prev
, tail
);
5599 /* Now that we have stripped the elements that need not be in the
5600 undo_list any more, we can finally mark the list. */
5601 mark_object (nextb
->BUFFER_INTERNAL_FIELD (undo_list
));
5606 /* Clear the mark bits that we set in certain root slots. */
5608 unmark_byte_stack ();
5609 VECTOR_UNMARK (&buffer_defaults
);
5610 VECTOR_UNMARK (&buffer_local_symbols
);
5612 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5622 consing_since_gc
= 0;
5623 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
5624 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
5626 gc_relative_threshold
= 0;
5627 if (FLOATP (Vgc_cons_percentage
))
5628 { /* Set gc_cons_combined_threshold. */
5631 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5632 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5633 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5634 tot
+= total_string_bytes
;
5635 tot
+= total_vector_slots
* word_size
;
5636 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5637 tot
+= total_intervals
* sizeof (struct interval
);
5638 tot
+= total_strings
* sizeof (struct Lisp_String
);
5640 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5643 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5644 gc_relative_threshold
= tot
;
5646 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5650 if (garbage_collection_messages
)
5652 if (message_p
|| minibuf_level
> 0)
5655 message1_nolog ("Garbage collecting...done");
5658 unbind_to (count
, Qnil
);
5660 total
[0] = list4 (Qcons
, make_number (sizeof (struct Lisp_Cons
)),
5661 bounded_number (total_conses
),
5662 bounded_number (total_free_conses
));
5664 total
[1] = list4 (Qsymbol
, make_number (sizeof (struct Lisp_Symbol
)),
5665 bounded_number (total_symbols
),
5666 bounded_number (total_free_symbols
));
5668 total
[2] = list4 (Qmisc
, make_number (sizeof (union Lisp_Misc
)),
5669 bounded_number (total_markers
),
5670 bounded_number (total_free_markers
));
5672 total
[3] = list4 (Qstring
, make_number (sizeof (struct Lisp_String
)),
5673 bounded_number (total_strings
),
5674 bounded_number (total_free_strings
));
5676 total
[4] = list3 (Qstring_bytes
, make_number (1),
5677 bounded_number (total_string_bytes
));
5679 total
[5] = list3 (Qvector
, make_number (sizeof (struct Lisp_Vector
)),
5680 bounded_number (total_vectors
));
5682 total
[6] = list4 (Qvector_slots
, make_number (word_size
),
5683 bounded_number (total_vector_slots
),
5684 bounded_number (total_free_vector_slots
));
5686 total
[7] = list4 (Qfloat
, make_number (sizeof (struct Lisp_Float
)),
5687 bounded_number (total_floats
),
5688 bounded_number (total_free_floats
));
5690 total
[8] = list4 (Qinterval
, make_number (sizeof (struct interval
)),
5691 bounded_number (total_intervals
),
5692 bounded_number (total_free_intervals
));
5694 total
[9] = list3 (Qbuffer
, make_number (sizeof (struct buffer
)),
5695 bounded_number (total_buffers
));
5697 total
[10] = list4 (Qheap
, make_number (1024),
5698 #ifdef DOUG_LEA_MALLOC
5699 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
5700 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10)
5706 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5708 /* Compute average percentage of zombies. */
5710 total_conses
+ total_symbols
+ total_markers
+ total_strings
5711 + total_vectors
+ total_floats
+ total_intervals
+ total_buffers
;
5713 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5714 max_live
= max (nlive
, max_live
);
5715 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5716 max_zombies
= max (nzombies
, max_zombies
);
5721 if (!NILP (Vpost_gc_hook
))
5723 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5724 safe_run_hooks (Qpost_gc_hook
);
5725 unbind_to (gc_count
, Qnil
);
5728 /* Accumulate statistics. */
5729 if (FLOATP (Vgc_elapsed
))
5730 Vgc_elapsed
= make_float
5731 (XFLOAT_DATA (Vgc_elapsed
) + EMACS_TIME_TO_DOUBLE
5732 (sub_emacs_time (current_emacs_time (), start
)));
5736 return Flist (sizeof total
/ sizeof *total
, total
);
5740 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5741 only interesting objects referenced from glyphs are strings. */
5744 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5746 struct glyph_row
*row
= matrix
->rows
;
5747 struct glyph_row
*end
= row
+ matrix
->nrows
;
5749 for (; row
< end
; ++row
)
5753 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5755 struct glyph
*glyph
= row
->glyphs
[area
];
5756 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5758 for (; glyph
< end_glyph
; ++glyph
)
5759 if (STRINGP (glyph
->object
)
5760 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5761 mark_object (glyph
->object
);
5767 /* Mark Lisp faces in the face cache C. */
5770 mark_face_cache (struct face_cache
*c
)
5775 for (i
= 0; i
< c
->used
; ++i
)
5777 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5781 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5782 mark_object (face
->lface
[j
]);
5790 /* Mark reference to a Lisp_Object.
5791 If the object referred to has not been seen yet, recursively mark
5792 all the references contained in it. */
5794 #define LAST_MARKED_SIZE 500
5795 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5796 static int last_marked_index
;
5798 /* For debugging--call abort when we cdr down this many
5799 links of a list, in mark_object. In debugging,
5800 the call to abort will hit a breakpoint.
5801 Normally this is zero and the check never goes off. */
5802 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5805 mark_vectorlike (struct Lisp_Vector
*ptr
)
5807 ptrdiff_t size
= ptr
->header
.size
;
5810 eassert (!VECTOR_MARKED_P (ptr
));
5811 VECTOR_MARK (ptr
); /* Else mark it. */
5812 if (size
& PSEUDOVECTOR_FLAG
)
5813 size
&= PSEUDOVECTOR_SIZE_MASK
;
5815 /* Note that this size is not the memory-footprint size, but only
5816 the number of Lisp_Object fields that we should trace.
5817 The distinction is used e.g. by Lisp_Process which places extra
5818 non-Lisp_Object fields at the end of the structure... */
5819 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
5820 mark_object (ptr
->contents
[i
]);
5823 /* Like mark_vectorlike but optimized for char-tables (and
5824 sub-char-tables) assuming that the contents are mostly integers or
5828 mark_char_table (struct Lisp_Vector
*ptr
)
5830 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5833 eassert (!VECTOR_MARKED_P (ptr
));
5835 for (i
= 0; i
< size
; i
++)
5837 Lisp_Object val
= ptr
->contents
[i
];
5839 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5841 if (SUB_CHAR_TABLE_P (val
))
5843 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5844 mark_char_table (XVECTOR (val
));
5851 /* Mark the chain of overlays starting at PTR. */
5854 mark_overlay (struct Lisp_Overlay
*ptr
)
5856 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
5859 mark_object (ptr
->start
);
5860 mark_object (ptr
->end
);
5861 mark_object (ptr
->plist
);
5865 /* Mark Lisp_Objects and special pointers in BUFFER. */
5868 mark_buffer (struct buffer
*buffer
)
5870 /* This is handled much like other pseudovectors... */
5871 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
5873 /* ...but there are some buffer-specific things. */
5875 MARK_INTERVAL_TREE (BUF_INTERVALS (buffer
));
5877 /* For now, we just don't mark the undo_list. It's done later in
5878 a special way just before the sweep phase, and after stripping
5879 some of its elements that are not needed any more. */
5881 mark_overlay (buffer
->overlays_before
);
5882 mark_overlay (buffer
->overlays_after
);
5884 /* If this is an indirect buffer, mark its base buffer. */
5885 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5886 mark_buffer (buffer
->base_buffer
);
5889 /* Determine type of generic Lisp_Object and mark it accordingly. */
5892 mark_object (Lisp_Object arg
)
5894 register Lisp_Object obj
= arg
;
5895 #ifdef GC_CHECK_MARKED_OBJECTS
5899 ptrdiff_t cdr_count
= 0;
5903 if (PURE_POINTER_P (XPNTR (obj
)))
5906 last_marked
[last_marked_index
++] = obj
;
5907 if (last_marked_index
== LAST_MARKED_SIZE
)
5908 last_marked_index
= 0;
5910 /* Perform some sanity checks on the objects marked here. Abort if
5911 we encounter an object we know is bogus. This increases GC time
5912 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5913 #ifdef GC_CHECK_MARKED_OBJECTS
5915 po
= (void *) XPNTR (obj
);
5917 /* Check that the object pointed to by PO is known to be a Lisp
5918 structure allocated from the heap. */
5919 #define CHECK_ALLOCATED() \
5921 m = mem_find (po); \
5926 /* Check that the object pointed to by PO is live, using predicate
5928 #define CHECK_LIVE(LIVEP) \
5930 if (!LIVEP (m, po)) \
5934 /* Check both of the above conditions. */
5935 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5937 CHECK_ALLOCATED (); \
5938 CHECK_LIVE (LIVEP); \
5941 #else /* not GC_CHECK_MARKED_OBJECTS */
5943 #define CHECK_LIVE(LIVEP) (void) 0
5944 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5946 #endif /* not GC_CHECK_MARKED_OBJECTS */
5948 switch (SWITCH_ENUM_CAST (XTYPE (obj
)))
5952 register struct Lisp_String
*ptr
= XSTRING (obj
);
5953 if (STRING_MARKED_P (ptr
))
5955 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
5957 MARK_INTERVAL_TREE (ptr
->intervals
);
5958 #ifdef GC_CHECK_STRING_BYTES
5959 /* Check that the string size recorded in the string is the
5960 same as the one recorded in the sdata structure. */
5961 CHECK_STRING_BYTES (ptr
);
5962 #endif /* GC_CHECK_STRING_BYTES */
5966 case Lisp_Vectorlike
:
5968 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5969 register ptrdiff_t pvectype
;
5971 if (VECTOR_MARKED_P (ptr
))
5974 #ifdef GC_CHECK_MARKED_OBJECTS
5976 if (m
== MEM_NIL
&& !SUBRP (obj
)
5977 && po
!= &buffer_defaults
5978 && po
!= &buffer_local_symbols
)
5980 #endif /* GC_CHECK_MARKED_OBJECTS */
5982 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
5983 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
5984 >> PSEUDOVECTOR_SIZE_BITS
);
5988 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
5989 CHECK_LIVE (live_vector_p
);
5994 #ifdef GC_CHECK_MARKED_OBJECTS
5995 if (po
!= &buffer_defaults
&& po
!= &buffer_local_symbols
)
6004 #endif /* GC_CHECK_MARKED_OBJECTS */
6005 mark_buffer ((struct buffer
*) ptr
);
6009 { /* We could treat this just like a vector, but it is better
6010 to save the COMPILED_CONSTANTS element for last and avoid
6012 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
6016 for (i
= 0; i
< size
; i
++)
6017 if (i
!= COMPILED_CONSTANTS
)
6018 mark_object (ptr
->contents
[i
]);
6019 if (size
> COMPILED_CONSTANTS
)
6021 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
6029 mark_vectorlike (ptr
);
6030 mark_face_cache (((struct frame
*) ptr
)->face_cache
);
6036 struct window
*w
= (struct window
*) ptr
;
6038 mark_vectorlike (ptr
);
6039 /* Mark glyphs for leaf windows. Marking window
6040 matrices is sufficient because frame matrices
6041 use the same glyph memory. */
6042 if (NILP (w
->hchild
) && NILP (w
->vchild
) && w
->current_matrix
)
6044 mark_glyph_matrix (w
->current_matrix
);
6045 mark_glyph_matrix (w
->desired_matrix
);
6050 case PVEC_HASH_TABLE
:
6052 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6054 mark_vectorlike (ptr
);
6055 /* If hash table is not weak, mark all keys and values.
6056 For weak tables, mark only the vector. */
6058 mark_object (h
->key_and_value
);
6060 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6064 case PVEC_CHAR_TABLE
:
6065 mark_char_table (ptr
);
6068 case PVEC_BOOL_VECTOR
:
6069 /* No Lisp_Objects to mark in a bool vector. */
6080 mark_vectorlike (ptr
);
6087 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6088 struct Lisp_Symbol
*ptrx
;
6092 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
6094 mark_object (ptr
->function
);
6095 mark_object (ptr
->plist
);
6096 switch (ptr
->redirect
)
6098 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6099 case SYMBOL_VARALIAS
:
6102 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6106 case SYMBOL_LOCALIZED
:
6108 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
6109 /* If the value is forwarded to a buffer or keyboard field,
6110 these are marked when we see the corresponding object.
6111 And if it's forwarded to a C variable, either it's not
6112 a Lisp_Object var, or it's staticpro'd already. */
6113 mark_object (blv
->where
);
6114 mark_object (blv
->valcell
);
6115 mark_object (blv
->defcell
);
6118 case SYMBOL_FORWARDED
:
6119 /* If the value is forwarded to a buffer or keyboard field,
6120 these are marked when we see the corresponding object.
6121 And if it's forwarded to a C variable, either it's not
6122 a Lisp_Object var, or it's staticpro'd already. */
6126 if (!PURE_POINTER_P (XSTRING (ptr
->xname
)))
6127 MARK_STRING (XSTRING (ptr
->xname
));
6128 MARK_INTERVAL_TREE (STRING_INTERVALS (ptr
->xname
));
6133 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun. */
6134 XSETSYMBOL (obj
, ptrx
);
6141 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6143 if (XMISCANY (obj
)->gcmarkbit
)
6146 switch (XMISCTYPE (obj
))
6148 case Lisp_Misc_Marker
:
6149 /* DO NOT mark thru the marker's chain.
6150 The buffer's markers chain does not preserve markers from gc;
6151 instead, markers are removed from the chain when freed by gc. */
6152 XMISCANY (obj
)->gcmarkbit
= 1;
6155 case Lisp_Misc_Save_Value
:
6156 XMISCANY (obj
)->gcmarkbit
= 1;
6159 register struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
6160 /* If DOGC is set, POINTER is the address of a memory
6161 area containing INTEGER potential Lisp_Objects. */
6164 Lisp_Object
*p
= (Lisp_Object
*) ptr
->pointer
;
6166 for (nelt
= ptr
->integer
; nelt
> 0; nelt
--, p
++)
6167 mark_maybe_object (*p
);
6173 case Lisp_Misc_Overlay
:
6174 mark_overlay (XOVERLAY (obj
));
6184 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6185 if (CONS_MARKED_P (ptr
))
6187 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6189 /* If the cdr is nil, avoid recursion for the car. */
6190 if (EQ (ptr
->u
.cdr
, Qnil
))
6196 mark_object (ptr
->car
);
6199 if (cdr_count
== mark_object_loop_halt
)
6205 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6206 FLOAT_MARK (XFLOAT (obj
));
6217 #undef CHECK_ALLOCATED
6218 #undef CHECK_ALLOCATED_AND_LIVE
6220 /* Mark the Lisp pointers in the terminal objects.
6221 Called by Fgarbage_collect. */
6224 mark_terminals (void)
6227 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6229 eassert (t
->name
!= NULL
);
6230 #ifdef HAVE_WINDOW_SYSTEM
6231 /* If a terminal object is reachable from a stacpro'ed object,
6232 it might have been marked already. Make sure the image cache
6234 mark_image_cache (t
->image_cache
);
6235 #endif /* HAVE_WINDOW_SYSTEM */
6236 if (!VECTOR_MARKED_P (t
))
6237 mark_vectorlike ((struct Lisp_Vector
*)t
);
6243 /* Value is non-zero if OBJ will survive the current GC because it's
6244 either marked or does not need to be marked to survive. */
6247 survives_gc_p (Lisp_Object obj
)
6251 switch (XTYPE (obj
))
6258 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6262 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6266 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6269 case Lisp_Vectorlike
:
6270 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6274 survives_p
= CONS_MARKED_P (XCONS (obj
));
6278 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6285 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
6290 /* Sweep: find all structures not marked, and free them. */
6295 /* Remove or mark entries in weak hash tables.
6296 This must be done before any object is unmarked. */
6297 sweep_weak_hash_tables ();
6300 #ifdef GC_CHECK_STRING_BYTES
6301 if (!noninteractive
)
6302 check_string_bytes (1);
6305 /* Put all unmarked conses on free list */
6307 register struct cons_block
*cblk
;
6308 struct cons_block
**cprev
= &cons_block
;
6309 register int lim
= cons_block_index
;
6310 EMACS_INT num_free
= 0, num_used
= 0;
6314 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6318 int ilim
= (lim
+ BITS_PER_INT
- 1) / BITS_PER_INT
;
6320 /* Scan the mark bits an int at a time. */
6321 for (i
= 0; i
< ilim
; i
++)
6323 if (cblk
->gcmarkbits
[i
] == -1)
6325 /* Fast path - all cons cells for this int are marked. */
6326 cblk
->gcmarkbits
[i
] = 0;
6327 num_used
+= BITS_PER_INT
;
6331 /* Some cons cells for this int are not marked.
6332 Find which ones, and free them. */
6333 int start
, pos
, stop
;
6335 start
= i
* BITS_PER_INT
;
6337 if (stop
> BITS_PER_INT
)
6338 stop
= BITS_PER_INT
;
6341 for (pos
= start
; pos
< stop
; pos
++)
6343 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6346 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6347 cons_free_list
= &cblk
->conses
[pos
];
6349 cons_free_list
->car
= Vdead
;
6355 CONS_UNMARK (&cblk
->conses
[pos
]);
6361 lim
= CONS_BLOCK_SIZE
;
6362 /* If this block contains only free conses and we have already
6363 seen more than two blocks worth of free conses then deallocate
6365 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6367 *cprev
= cblk
->next
;
6368 /* Unhook from the free list. */
6369 cons_free_list
= cblk
->conses
[0].u
.chain
;
6370 lisp_align_free (cblk
);
6374 num_free
+= this_free
;
6375 cprev
= &cblk
->next
;
6378 total_conses
= num_used
;
6379 total_free_conses
= num_free
;
6382 /* Put all unmarked floats on free list */
6384 register struct float_block
*fblk
;
6385 struct float_block
**fprev
= &float_block
;
6386 register int lim
= float_block_index
;
6387 EMACS_INT num_free
= 0, num_used
= 0;
6389 float_free_list
= 0;
6391 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6395 for (i
= 0; i
< lim
; i
++)
6396 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6399 fblk
->floats
[i
].u
.chain
= float_free_list
;
6400 float_free_list
= &fblk
->floats
[i
];
6405 FLOAT_UNMARK (&fblk
->floats
[i
]);
6407 lim
= FLOAT_BLOCK_SIZE
;
6408 /* If this block contains only free floats and we have already
6409 seen more than two blocks worth of free floats then deallocate
6411 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6413 *fprev
= fblk
->next
;
6414 /* Unhook from the free list. */
6415 float_free_list
= fblk
->floats
[0].u
.chain
;
6416 lisp_align_free (fblk
);
6420 num_free
+= this_free
;
6421 fprev
= &fblk
->next
;
6424 total_floats
= num_used
;
6425 total_free_floats
= num_free
;
6428 /* Put all unmarked intervals on free list */
6430 register struct interval_block
*iblk
;
6431 struct interval_block
**iprev
= &interval_block
;
6432 register int lim
= interval_block_index
;
6433 EMACS_INT num_free
= 0, num_used
= 0;
6435 interval_free_list
= 0;
6437 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6442 for (i
= 0; i
< lim
; i
++)
6444 if (!iblk
->intervals
[i
].gcmarkbit
)
6446 SET_INTERVAL_PARENT (&iblk
->intervals
[i
], interval_free_list
);
6447 interval_free_list
= &iblk
->intervals
[i
];
6453 iblk
->intervals
[i
].gcmarkbit
= 0;
6456 lim
= INTERVAL_BLOCK_SIZE
;
6457 /* If this block contains only free intervals and we have already
6458 seen more than two blocks worth of free intervals then
6459 deallocate this block. */
6460 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6462 *iprev
= iblk
->next
;
6463 /* Unhook from the free list. */
6464 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6469 num_free
+= this_free
;
6470 iprev
= &iblk
->next
;
6473 total_intervals
= num_used
;
6474 total_free_intervals
= num_free
;
6477 /* Put all unmarked symbols on free list */
6479 register struct symbol_block
*sblk
;
6480 struct symbol_block
**sprev
= &symbol_block
;
6481 register int lim
= symbol_block_index
;
6482 EMACS_INT num_free
= 0, num_used
= 0;
6484 symbol_free_list
= NULL
;
6486 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6489 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6490 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6492 for (; sym
< end
; ++sym
)
6494 /* Check if the symbol was created during loadup. In such a case
6495 it might be pointed to by pure bytecode which we don't trace,
6496 so we conservatively assume that it is live. */
6497 int pure_p
= PURE_POINTER_P (XSTRING (sym
->s
.xname
));
6499 if (!sym
->s
.gcmarkbit
&& !pure_p
)
6501 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6502 xfree (SYMBOL_BLV (&sym
->s
));
6503 sym
->s
.next
= symbol_free_list
;
6504 symbol_free_list
= &sym
->s
;
6506 symbol_free_list
->function
= Vdead
;
6514 UNMARK_STRING (XSTRING (sym
->s
.xname
));
6515 sym
->s
.gcmarkbit
= 0;
6519 lim
= SYMBOL_BLOCK_SIZE
;
6520 /* If this block contains only free symbols and we have already
6521 seen more than two blocks worth of free symbols then deallocate
6523 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6525 *sprev
= sblk
->next
;
6526 /* Unhook from the free list. */
6527 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6532 num_free
+= this_free
;
6533 sprev
= &sblk
->next
;
6536 total_symbols
= num_used
;
6537 total_free_symbols
= num_free
;
6540 /* Put all unmarked misc's on free list.
6541 For a marker, first unchain it from the buffer it points into. */
6543 register struct marker_block
*mblk
;
6544 struct marker_block
**mprev
= &marker_block
;
6545 register int lim
= marker_block_index
;
6546 EMACS_INT num_free
= 0, num_used
= 0;
6548 marker_free_list
= 0;
6550 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6555 for (i
= 0; i
< lim
; i
++)
6557 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6559 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6560 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6561 /* Set the type of the freed object to Lisp_Misc_Free.
6562 We could leave the type alone, since nobody checks it,
6563 but this might catch bugs faster. */
6564 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6565 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6566 marker_free_list
= &mblk
->markers
[i
].m
;
6572 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6575 lim
= MARKER_BLOCK_SIZE
;
6576 /* If this block contains only free markers and we have already
6577 seen more than two blocks worth of free markers then deallocate
6579 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6581 *mprev
= mblk
->next
;
6582 /* Unhook from the free list. */
6583 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6588 num_free
+= this_free
;
6589 mprev
= &mblk
->next
;
6593 total_markers
= num_used
;
6594 total_free_markers
= num_free
;
6597 /* Free all unmarked buffers */
6599 register struct buffer
*buffer
= all_buffers
, *prev
= 0, *next
;
6603 if (!VECTOR_MARKED_P (buffer
))
6606 prev
->header
.next
= buffer
->header
.next
;
6608 all_buffers
= buffer
->header
.next
.buffer
;
6609 next
= buffer
->header
.next
.buffer
;
6615 VECTOR_UNMARK (buffer
);
6616 UNMARK_BALANCE_INTERVALS (BUF_INTERVALS (buffer
));
6618 prev
= buffer
, buffer
= buffer
->header
.next
.buffer
;
6624 #ifdef GC_CHECK_STRING_BYTES
6625 if (!noninteractive
)
6626 check_string_bytes (1);
6633 /* Debugging aids. */
6635 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6636 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6637 This may be helpful in debugging Emacs's memory usage.
6638 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6643 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6648 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6649 doc
: /* Return a list of counters that measure how much consing there has been.
6650 Each of these counters increments for a certain kind of object.
6651 The counters wrap around from the largest positive integer to zero.
6652 Garbage collection does not decrease them.
6653 The elements of the value are as follows:
6654 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6655 All are in units of 1 = one object consed
6656 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6658 MISCS include overlays, markers, and some internal types.
6659 Frames, windows, buffers, and subprocesses count as vectors
6660 (but the contents of a buffer's text do not count here). */)
6663 return listn (CONSTYPE_HEAP
, 8,
6664 bounded_number (cons_cells_consed
),
6665 bounded_number (floats_consed
),
6666 bounded_number (vector_cells_consed
),
6667 bounded_number (symbols_consed
),
6668 bounded_number (string_chars_consed
),
6669 bounded_number (misc_objects_consed
),
6670 bounded_number (intervals_consed
),
6671 bounded_number (strings_consed
));
6674 /* Find at most FIND_MAX symbols which have OBJ as their value or
6675 function. This is used in gdbinit's `xwhichsymbols' command. */
6678 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6680 struct symbol_block
*sblk
;
6681 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6682 Lisp_Object found
= Qnil
;
6686 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6688 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
6691 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
6693 struct Lisp_Symbol
*sym
= &aligned_sym
->s
;
6697 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6700 XSETSYMBOL (tem
, sym
);
6701 val
= find_symbol_value (tem
);
6703 || EQ (sym
->function
, obj
)
6704 || (!NILP (sym
->function
)
6705 && COMPILEDP (sym
->function
)
6706 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
6709 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)))
6711 found
= Fcons (tem
, found
);
6712 if (--find_max
== 0)
6720 unbind_to (gc_count
, Qnil
);
6724 #ifdef ENABLE_CHECKING
6725 int suppress_checking
;
6728 die (const char *msg
, const char *file
, int line
)
6730 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: %s\r\n",
6736 /* Initialization */
6739 init_alloc_once (void)
6741 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6743 pure_size
= PURESIZE
;
6745 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6747 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6750 #ifdef DOUG_LEA_MALLOC
6751 mallopt (M_TRIM_THRESHOLD
, 128*1024); /* trim threshold */
6752 mallopt (M_MMAP_THRESHOLD
, 64*1024); /* mmap threshold */
6753 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* max. number of mmap'ed areas */
6759 malloc_hysteresis
= 32;
6761 malloc_hysteresis
= 0;
6764 refill_memory_reserve ();
6765 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
6772 byte_stack_list
= 0;
6774 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6775 setjmp_tested_p
= longjmps_done
= 0;
6778 Vgc_elapsed
= make_float (0.0);
6783 syms_of_alloc (void)
6785 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6786 doc
: /* Number of bytes of consing between garbage collections.
6787 Garbage collection can happen automatically once this many bytes have been
6788 allocated since the last garbage collection. All data types count.
6790 Garbage collection happens automatically only when `eval' is called.
6792 By binding this temporarily to a large number, you can effectively
6793 prevent garbage collection during a part of the program.
6794 See also `gc-cons-percentage'. */);
6796 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6797 doc
: /* Portion of the heap used for allocation.
6798 Garbage collection can happen automatically once this portion of the heap
6799 has been allocated since the last garbage collection.
6800 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6801 Vgc_cons_percentage
= make_float (0.1);
6803 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6804 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
6806 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6807 doc
: /* Number of cons cells that have been consed so far. */);
6809 DEFVAR_INT ("floats-consed", floats_consed
,
6810 doc
: /* Number of floats that have been consed so far. */);
6812 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
6813 doc
: /* Number of vector cells that have been consed so far. */);
6815 DEFVAR_INT ("symbols-consed", symbols_consed
,
6816 doc
: /* Number of symbols that have been consed so far. */);
6818 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
6819 doc
: /* Number of string characters that have been consed so far. */);
6821 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
6822 doc
: /* Number of miscellaneous objects that have been consed so far.
6823 These include markers and overlays, plus certain objects not visible
6826 DEFVAR_INT ("intervals-consed", intervals_consed
,
6827 doc
: /* Number of intervals that have been consed so far. */);
6829 DEFVAR_INT ("strings-consed", strings_consed
,
6830 doc
: /* Number of strings that have been consed so far. */);
6832 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
6833 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
6834 This means that certain objects should be allocated in shared (pure) space.
6835 It can also be set to a hash-table, in which case this table is used to
6836 do hash-consing of the objects allocated to pure space. */);
6838 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
6839 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
6840 garbage_collection_messages
= 0;
6842 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
6843 doc
: /* Hook run after garbage collection has finished. */);
6844 Vpost_gc_hook
= Qnil
;
6845 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
6847 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
6848 doc
: /* Precomputed `signal' argument for memory-full error. */);
6849 /* We build this in advance because if we wait until we need it, we might
6850 not be able to allocate the memory to hold it. */
6852 = listn (CONSTYPE_PURE
, 2, Qerror
,
6853 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
6855 DEFVAR_LISP ("memory-full", Vmemory_full
,
6856 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
6857 Vmemory_full
= Qnil
;
6859 DEFSYM (Qstring_bytes
, "string-bytes");
6860 DEFSYM (Qvector_slots
, "vector-slots");
6861 DEFSYM (Qheap
, "heap");
6863 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
6864 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
6866 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
6867 doc
: /* Accumulated time elapsed in garbage collections.
6868 The time is in seconds as a floating point value. */);
6869 DEFVAR_INT ("gcs-done", gcs_done
,
6870 doc
: /* Accumulated number of garbage collections done. */);
6875 defsubr (&Smake_byte_code
);
6876 defsubr (&Smake_list
);
6877 defsubr (&Smake_vector
);
6878 defsubr (&Smake_string
);
6879 defsubr (&Smake_bool_vector
);
6880 defsubr (&Smake_symbol
);
6881 defsubr (&Smake_marker
);
6882 defsubr (&Spurecopy
);
6883 defsubr (&Sgarbage_collect
);
6884 defsubr (&Smemory_limit
);
6885 defsubr (&Smemory_use_counts
);
6887 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
6888 defsubr (&Sgc_status
);
6892 /* Make some symbols visible to GDB. This section is last, so that
6893 the #undef lines don't mess up later code. */
6895 /* When compiled with GCC, GDB might say "No enum type named
6896 pvec_type" if we don't have at least one symbol with that type, and
6897 then xbacktrace could fail. Similarly for the other enums and
6901 enum CHECK_LISP_OBJECT_TYPE CHECK_LISP_OBJECT_TYPE
;
6902 enum enum_USE_LSB_TAG enum_USE_LSB_TAG
;
6903 enum Lisp_Bits Lisp_Bits
;
6904 enum More_Lisp_Bits More_Lisp_Bits
;
6905 enum pvec_type pvec_type
;
6906 } const EXTERNALLY_VISIBLE gdb_make_enums_visible
= {0};
6908 /* These symbols cannot be done as enums, since values might not be
6909 in 'int' range. Each symbol X has a corresponding X_VAL symbol,
6910 verified to have the correct value. */
6912 #define ARRAY_MARK_FLAG_VAL PTRDIFF_MIN
6913 #define PSEUDOVECTOR_FLAG_VAL (PTRDIFF_MAX - PTRDIFF_MAX / 2)
6914 #define VALMASK_VAL (USE_LSB_TAG ? -1 << GCTYPEBITS : VAL_MAX)
6916 verify (ARRAY_MARK_FLAG_VAL
== ARRAY_MARK_FLAG
);
6917 verify (PSEUDOVECTOR_FLAG_VAL
== PSEUDOVECTOR_FLAG
);
6918 verify (VALMASK_VAL
== VALMASK
);
6920 #undef ARRAY_MARK_FLAG
6921 #undef PSEUDOVECTOR_FLAG
6924 ptrdiff_t const EXTERNALLY_VISIBLE
6925 ARRAY_MARK_FLAG
= ARRAY_MARK_FLAG_VAL
,
6926 PSEUDOVECTOR_FLAG
= PSEUDOVECTOR_FLAG_VAL
;
6928 EMACS_INT
const EXTERNALLY_VISIBLE
6929 VALMASK
= VALMASK_VAL
;