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. */
34 #include "intervals.h"
36 #include "character.h"
41 #include "blockinput.h"
42 #include "syssignal.h"
43 #include "termhooks.h" /* For struct terminal. */
47 /* GC_CHECK_MARKED_OBJECTS means do sanity checks on allocated objects.
48 Doable only if GC_MARK_STACK. */
50 # undef GC_CHECK_MARKED_OBJECTS
53 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
54 memory. Can do this only if using gmalloc.c and if not checking
57 #if (defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC \
58 || defined GC_CHECK_MARKED_OBJECTS)
59 #undef GC_MALLOC_CHECK
73 #ifdef DOUG_LEA_MALLOC
77 /* Specify maximum number of areas to mmap. It would be nice to use a
78 value that explicitly means "no limit". */
80 #define MMAP_MAX_AREAS 100000000
82 #else /* not DOUG_LEA_MALLOC */
84 /* The following come from gmalloc.c. */
86 extern size_t _bytes_used
;
87 extern size_t __malloc_extra_blocks
;
88 extern void *_malloc_internal (size_t);
89 extern void _free_internal (void *);
91 #endif /* not DOUG_LEA_MALLOC */
93 #if ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT
96 /* When GTK uses the file chooser dialog, different backends can be loaded
97 dynamically. One such a backend is the Gnome VFS backend that gets loaded
98 if you run Gnome. That backend creates several threads and also allocates
101 Also, gconf and gsettings may create several threads.
103 If Emacs sets malloc hooks (! SYSTEM_MALLOC) and the emacs_blocked_*
104 functions below are called from malloc, there is a chance that one
105 of these threads preempts the Emacs main thread and the hook variables
106 end up in an inconsistent state. So we have a mutex to prevent that (note
107 that the backend handles concurrent access to malloc within its own threads
108 but Emacs code running in the main thread is not included in that control).
110 When UNBLOCK_INPUT is called, reinvoke_input_signal may be called. If this
111 happens in one of the backend threads we will have two threads that tries
112 to run Emacs code at once, and the code is not prepared for that.
113 To prevent that, we only call BLOCK/UNBLOCK from the main thread. */
115 static pthread_mutex_t alloc_mutex
;
117 #define BLOCK_INPUT_ALLOC \
120 if (pthread_equal (pthread_self (), main_thread)) \
122 pthread_mutex_lock (&alloc_mutex); \
125 #define UNBLOCK_INPUT_ALLOC \
128 pthread_mutex_unlock (&alloc_mutex); \
129 if (pthread_equal (pthread_self (), main_thread)) \
134 #else /* ! defined HAVE_PTHREAD */
136 #define BLOCK_INPUT_ALLOC BLOCK_INPUT
137 #define UNBLOCK_INPUT_ALLOC UNBLOCK_INPUT
139 #endif /* ! defined HAVE_PTHREAD */
140 #endif /* ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT */
142 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
143 to a struct Lisp_String. */
145 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
146 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
147 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
149 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
150 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
151 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
153 /* Default value of gc_cons_threshold (see below). */
155 #define GC_DEFAULT_THRESHOLD (100000 * sizeof (Lisp_Object))
157 /* Global variables. */
158 struct emacs_globals globals
;
160 /* Number of bytes of consing done since the last gc. */
162 EMACS_INT consing_since_gc
;
164 /* Similar minimum, computed from Vgc_cons_percentage. */
166 EMACS_INT gc_relative_threshold
;
168 /* Minimum number of bytes of consing since GC before next GC,
169 when memory is full. */
171 EMACS_INT memory_full_cons_threshold
;
173 /* Nonzero during GC. */
177 /* Nonzero means abort if try to GC.
178 This is for code which is written on the assumption that
179 no GC will happen, so as to verify that assumption. */
183 /* Number of live and free conses etc. */
185 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_buffers
;
186 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
187 static EMACS_INT total_free_floats
, total_floats
;
189 /* Points to memory space allocated as "spare", to be freed if we run
190 out of memory. We keep one large block, four cons-blocks, and
191 two string blocks. */
193 static char *spare_memory
[7];
195 /* Amount of spare memory to keep in large reserve block, or to see
196 whether this much is available when malloc fails on a larger request. */
198 #define SPARE_MEMORY (1 << 14)
200 /* Number of extra blocks malloc should get when it needs more core. */
202 static int malloc_hysteresis
;
204 /* Initialize it to a nonzero value to force it into data space
205 (rather than bss space). That way unexec will remap it into text
206 space (pure), on some systems. We have not implemented the
207 remapping on more recent systems because this is less important
208 nowadays than in the days of small memories and timesharing. */
210 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
211 #define PUREBEG (char *) pure
213 /* Pointer to the pure area, and its size. */
215 static char *purebeg
;
216 static ptrdiff_t pure_size
;
218 /* Number of bytes of pure storage used before pure storage overflowed.
219 If this is non-zero, this implies that an overflow occurred. */
221 static ptrdiff_t pure_bytes_used_before_overflow
;
223 /* Value is non-zero if P points into pure space. */
225 #define PURE_POINTER_P(P) \
226 ((uintptr_t) (P) - (uintptr_t) purebeg <= pure_size)
228 /* Index in pure at which next pure Lisp object will be allocated.. */
230 static ptrdiff_t pure_bytes_used_lisp
;
232 /* Number of bytes allocated for non-Lisp objects in pure storage. */
234 static ptrdiff_t pure_bytes_used_non_lisp
;
236 /* If nonzero, this is a warning delivered by malloc and not yet
239 const char *pending_malloc_warning
;
241 /* Maximum amount of C stack to save when a GC happens. */
243 #ifndef MAX_SAVE_STACK
244 #define MAX_SAVE_STACK 16000
247 /* Buffer in which we save a copy of the C stack at each GC. */
249 #if MAX_SAVE_STACK > 0
250 static char *stack_copy
;
251 static ptrdiff_t stack_copy_size
;
254 static Lisp_Object Qstring_bytes
, Qvector_slots
, Qheap
;
255 static Lisp_Object Qgc_cons_threshold
;
256 Lisp_Object Qchar_table_extra_slots
;
258 /* Hook run after GC has finished. */
260 static Lisp_Object Qpost_gc_hook
;
262 static void mark_terminals (void);
263 static void gc_sweep (void);
264 static Lisp_Object
make_pure_vector (ptrdiff_t);
265 static void mark_glyph_matrix (struct glyph_matrix
*);
266 static void mark_face_cache (struct face_cache
*);
268 #if !defined REL_ALLOC || defined SYSTEM_MALLOC
269 static void refill_memory_reserve (void);
271 static struct Lisp_String
*allocate_string (void);
272 static void compact_small_strings (void);
273 static void free_large_strings (void);
274 static void sweep_strings (void);
275 static void free_misc (Lisp_Object
);
276 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
278 /* Handy constants for vectorlike objects. */
281 header_size
= offsetof (struct Lisp_Vector
, contents
),
282 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
283 word_size
= sizeof (Lisp_Object
)
286 /* When scanning the C stack for live Lisp objects, Emacs keeps track
287 of what memory allocated via lisp_malloc is intended for what
288 purpose. This enumeration specifies the type of memory. */
299 /* We used to keep separate mem_types for subtypes of vectors such as
300 process, hash_table, frame, terminal, and window, but we never made
301 use of the distinction, so it only caused source-code complexity
302 and runtime slowdown. Minor but pointless. */
304 /* Special type to denote vector blocks. */
305 MEM_TYPE_VECTOR_BLOCK
308 static void *lisp_malloc (size_t, enum mem_type
);
311 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
313 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
314 #include <stdio.h> /* For fprintf. */
317 /* A unique object in pure space used to make some Lisp objects
318 on free lists recognizable in O(1). */
320 static Lisp_Object Vdead
;
321 #define DEADP(x) EQ (x, Vdead)
323 #ifdef GC_MALLOC_CHECK
325 enum mem_type allocated_mem_type
;
327 #endif /* GC_MALLOC_CHECK */
329 /* A node in the red-black tree describing allocated memory containing
330 Lisp data. Each such block is recorded with its start and end
331 address when it is allocated, and removed from the tree when it
334 A red-black tree is a balanced binary tree with the following
337 1. Every node is either red or black.
338 2. Every leaf is black.
339 3. If a node is red, then both of its children are black.
340 4. Every simple path from a node to a descendant leaf contains
341 the same number of black nodes.
342 5. The root is always black.
344 When nodes are inserted into the tree, or deleted from the tree,
345 the tree is "fixed" so that these properties are always true.
347 A red-black tree with N internal nodes has height at most 2
348 log(N+1). Searches, insertions and deletions are done in O(log N).
349 Please see a text book about data structures for a detailed
350 description of red-black trees. Any book worth its salt should
355 /* Children of this node. These pointers are never NULL. When there
356 is no child, the value is MEM_NIL, which points to a dummy node. */
357 struct mem_node
*left
, *right
;
359 /* The parent of this node. In the root node, this is NULL. */
360 struct mem_node
*parent
;
362 /* Start and end of allocated region. */
366 enum {MEM_BLACK
, MEM_RED
} color
;
372 /* Base address of stack. Set in main. */
374 Lisp_Object
*stack_base
;
376 /* Root of the tree describing allocated Lisp memory. */
378 static struct mem_node
*mem_root
;
380 /* Lowest and highest known address in the heap. */
382 static void *min_heap_address
, *max_heap_address
;
384 /* Sentinel node of the tree. */
386 static struct mem_node mem_z
;
387 #define MEM_NIL &mem_z
389 static struct Lisp_Vector
*allocate_vectorlike (ptrdiff_t);
390 static void lisp_free (void *);
391 static void mark_stack (void);
392 static int live_vector_p (struct mem_node
*, void *);
393 static int live_buffer_p (struct mem_node
*, void *);
394 static int live_string_p (struct mem_node
*, void *);
395 static int live_cons_p (struct mem_node
*, void *);
396 static int live_symbol_p (struct mem_node
*, void *);
397 static int live_float_p (struct mem_node
*, void *);
398 static int live_misc_p (struct mem_node
*, void *);
399 static void mark_maybe_object (Lisp_Object
);
400 static void mark_memory (void *, void *);
401 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
402 static void mem_init (void);
403 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
404 static void mem_insert_fixup (struct mem_node
*);
406 static void mem_rotate_left (struct mem_node
*);
407 static void mem_rotate_right (struct mem_node
*);
408 static void mem_delete (struct mem_node
*);
409 static void mem_delete_fixup (struct mem_node
*);
410 static inline struct mem_node
*mem_find (void *);
413 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
414 static void check_gcpros (void);
417 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
423 /* Recording what needs to be marked for gc. */
425 struct gcpro
*gcprolist
;
427 /* Addresses of staticpro'd variables. Initialize it to a nonzero
428 value; otherwise some compilers put it into BSS. */
430 #define NSTATICS 0x650
431 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
433 /* Index of next unused slot in staticvec. */
435 static int staticidx
;
437 static void *pure_alloc (size_t, int);
440 /* Value is SZ rounded up to the next multiple of ALIGNMENT.
441 ALIGNMENT must be a power of 2. */
443 #define ALIGN(ptr, ALIGNMENT) \
444 ((void *) (((uintptr_t) (ptr) + (ALIGNMENT) - 1) \
445 & ~ ((ALIGNMENT) - 1)))
449 /************************************************************************
451 ************************************************************************/
453 /* Function malloc calls this if it finds we are near exhausting storage. */
456 malloc_warning (const char *str
)
458 pending_malloc_warning
= str
;
462 /* Display an already-pending malloc warning. */
465 display_malloc_warning (void)
467 call3 (intern ("display-warning"),
469 build_string (pending_malloc_warning
),
470 intern ("emergency"));
471 pending_malloc_warning
= 0;
474 /* Called if we can't allocate relocatable space for a buffer. */
477 buffer_memory_full (ptrdiff_t nbytes
)
479 /* If buffers use the relocating allocator, no need to free
480 spare_memory, because we may have plenty of malloc space left
481 that we could get, and if we don't, the malloc that fails will
482 itself cause spare_memory to be freed. If buffers don't use the
483 relocating allocator, treat this like any other failing
487 memory_full (nbytes
);
490 /* This used to call error, but if we've run out of memory, we could
491 get infinite recursion trying to build the string. */
492 xsignal (Qnil
, Vmemory_signal_data
);
495 /* A common multiple of the positive integers A and B. Ideally this
496 would be the least common multiple, but there's no way to do that
497 as a constant expression in C, so do the best that we can easily do. */
498 #define COMMON_MULTIPLE(a, b) \
499 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
501 #ifndef XMALLOC_OVERRUN_CHECK
502 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
505 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
508 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
509 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
510 block size in little-endian order. The trailer consists of
511 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
513 The header is used to detect whether this block has been allocated
514 through these functions, as some low-level libc functions may
515 bypass the malloc hooks. */
517 #define XMALLOC_OVERRUN_CHECK_SIZE 16
518 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
519 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
521 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
522 hold a size_t value and (2) the header size is a multiple of the
523 alignment that Emacs needs for C types and for USE_LSB_TAG. */
524 #define XMALLOC_BASE_ALIGNMENT \
525 alignof (union { long double d; intmax_t i; void *p; })
528 # define XMALLOC_HEADER_ALIGNMENT \
529 COMMON_MULTIPLE (1 << GCTYPEBITS, XMALLOC_BASE_ALIGNMENT)
531 # define XMALLOC_HEADER_ALIGNMENT XMALLOC_BASE_ALIGNMENT
533 #define XMALLOC_OVERRUN_SIZE_SIZE \
534 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
535 + XMALLOC_HEADER_ALIGNMENT - 1) \
536 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
537 - XMALLOC_OVERRUN_CHECK_SIZE)
539 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
540 { '\x9a', '\x9b', '\xae', '\xaf',
541 '\xbf', '\xbe', '\xce', '\xcf',
542 '\xea', '\xeb', '\xec', '\xed',
543 '\xdf', '\xde', '\x9c', '\x9d' };
545 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
546 { '\xaa', '\xab', '\xac', '\xad',
547 '\xba', '\xbb', '\xbc', '\xbd',
548 '\xca', '\xcb', '\xcc', '\xcd',
549 '\xda', '\xdb', '\xdc', '\xdd' };
551 /* Insert and extract the block size in the header. */
554 xmalloc_put_size (unsigned char *ptr
, size_t size
)
557 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
559 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
565 xmalloc_get_size (unsigned char *ptr
)
569 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
570 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
579 /* The call depth in overrun_check functions. For example, this might happen:
581 overrun_check_malloc()
582 -> malloc -> (via hook)_-> emacs_blocked_malloc
583 -> overrun_check_malloc
584 call malloc (hooks are NULL, so real malloc is called).
585 malloc returns 10000.
586 add overhead, return 10016.
587 <- (back in overrun_check_malloc)
588 add overhead again, return 10032
589 xmalloc returns 10032.
594 overrun_check_free(10032)
596 free(10016) <- crash, because 10000 is the original pointer. */
598 static ptrdiff_t check_depth
;
600 /* Like malloc, but wraps allocated block with header and trailer. */
603 overrun_check_malloc (size_t size
)
605 register unsigned char *val
;
606 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
607 if (SIZE_MAX
- overhead
< size
)
610 val
= malloc (size
+ overhead
);
611 if (val
&& check_depth
== 1)
613 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
614 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
615 xmalloc_put_size (val
, size
);
616 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
617 XMALLOC_OVERRUN_CHECK_SIZE
);
624 /* Like realloc, but checks old block for overrun, and wraps new block
625 with header and trailer. */
628 overrun_check_realloc (void *block
, size_t size
)
630 register unsigned char *val
= (unsigned char *) block
;
631 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
632 if (SIZE_MAX
- overhead
< size
)
637 && memcmp (xmalloc_overrun_check_header
,
638 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
639 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
641 size_t osize
= xmalloc_get_size (val
);
642 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
643 XMALLOC_OVERRUN_CHECK_SIZE
))
645 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
646 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
647 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
650 val
= realloc (val
, size
+ overhead
);
652 if (val
&& check_depth
== 1)
654 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
655 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
656 xmalloc_put_size (val
, size
);
657 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
658 XMALLOC_OVERRUN_CHECK_SIZE
);
664 /* Like free, but checks block for overrun. */
667 overrun_check_free (void *block
)
669 unsigned char *val
= (unsigned char *) block
;
674 && memcmp (xmalloc_overrun_check_header
,
675 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
676 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
678 size_t osize
= xmalloc_get_size (val
);
679 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
680 XMALLOC_OVERRUN_CHECK_SIZE
))
682 #ifdef XMALLOC_CLEAR_FREE_MEMORY
683 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
684 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
686 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
687 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
688 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
699 #define malloc overrun_check_malloc
700 #define realloc overrun_check_realloc
701 #define free overrun_check_free
705 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
706 there's no need to block input around malloc. */
707 #define MALLOC_BLOCK_INPUT ((void)0)
708 #define MALLOC_UNBLOCK_INPUT ((void)0)
710 #define MALLOC_BLOCK_INPUT BLOCK_INPUT
711 #define MALLOC_UNBLOCK_INPUT UNBLOCK_INPUT
714 /* Like malloc but check for no memory and block interrupt input.. */
717 xmalloc (size_t size
)
723 MALLOC_UNBLOCK_INPUT
;
730 /* Like the above, but zeroes out the memory just allocated. */
733 xzalloc (size_t size
)
739 MALLOC_UNBLOCK_INPUT
;
743 memset (val
, 0, size
);
747 /* Like realloc but check for no memory and block interrupt input.. */
750 xrealloc (void *block
, size_t size
)
755 /* We must call malloc explicitly when BLOCK is 0, since some
756 reallocs don't do this. */
760 val
= realloc (block
, size
);
761 MALLOC_UNBLOCK_INPUT
;
769 /* Like free but block interrupt input. */
778 MALLOC_UNBLOCK_INPUT
;
779 /* We don't call refill_memory_reserve here
780 because that duplicates doing so in emacs_blocked_free
781 and the criterion should go there. */
785 /* Other parts of Emacs pass large int values to allocator functions
786 expecting ptrdiff_t. This is portable in practice, but check it to
788 verify (INT_MAX
<= PTRDIFF_MAX
);
791 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
792 Signal an error on memory exhaustion, and block interrupt input. */
795 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
797 eassert (0 <= nitems
&& 0 < item_size
);
798 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
799 memory_full (SIZE_MAX
);
800 return xmalloc (nitems
* item_size
);
804 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
805 Signal an error on memory exhaustion, and block interrupt input. */
808 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
810 eassert (0 <= nitems
&& 0 < item_size
);
811 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
812 memory_full (SIZE_MAX
);
813 return xrealloc (pa
, nitems
* item_size
);
817 /* Grow PA, which points to an array of *NITEMS items, and return the
818 location of the reallocated array, updating *NITEMS to reflect its
819 new size. The new array will contain at least NITEMS_INCR_MIN more
820 items, but will not contain more than NITEMS_MAX items total.
821 ITEM_SIZE is the size of each item, in bytes.
823 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
824 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
827 If PA is null, then allocate a new array instead of reallocating
828 the old one. Thus, to grow an array A without saving its old
829 contents, invoke xfree (A) immediately followed by xgrowalloc (0,
832 Block interrupt input as needed. If memory exhaustion occurs, set
833 *NITEMS to zero if PA is null, and signal an error (i.e., do not
837 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
838 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
840 /* The approximate size to use for initial small allocation
841 requests. This is the largest "small" request for the GNU C
843 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
845 /* If the array is tiny, grow it to about (but no greater than)
846 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
847 ptrdiff_t n
= *nitems
;
848 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
849 ptrdiff_t half_again
= n
>> 1;
850 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
852 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
853 NITEMS_MAX, and what the C language can represent safely. */
854 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
855 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
856 ? nitems_max
: C_language_max
);
857 ptrdiff_t nitems_incr_max
= n_max
- n
;
858 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
860 eassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
863 if (nitems_incr_max
< incr
)
864 memory_full (SIZE_MAX
);
866 pa
= xrealloc (pa
, n
* item_size
);
872 /* Like strdup, but uses xmalloc. */
875 xstrdup (const char *s
)
877 size_t len
= strlen (s
) + 1;
878 char *p
= xmalloc (len
);
884 /* Unwind for SAFE_ALLOCA */
887 safe_alloca_unwind (Lisp_Object arg
)
889 register struct Lisp_Save_Value
*p
= XSAVE_VALUE (arg
);
899 /* Like malloc but used for allocating Lisp data. NBYTES is the
900 number of bytes to allocate, TYPE describes the intended use of the
901 allocated memory block (for strings, for conses, ...). */
904 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
908 lisp_malloc (size_t nbytes
, enum mem_type type
)
914 #ifdef GC_MALLOC_CHECK
915 allocated_mem_type
= type
;
918 val
= malloc (nbytes
);
921 /* If the memory just allocated cannot be addressed thru a Lisp
922 object's pointer, and it needs to be,
923 that's equivalent to running out of memory. */
924 if (val
&& type
!= MEM_TYPE_NON_LISP
)
927 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
928 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
930 lisp_malloc_loser
= val
;
937 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
938 if (val
&& type
!= MEM_TYPE_NON_LISP
)
939 mem_insert (val
, (char *) val
+ nbytes
, type
);
942 MALLOC_UNBLOCK_INPUT
;
944 memory_full (nbytes
);
948 /* Free BLOCK. This must be called to free memory allocated with a
949 call to lisp_malloc. */
952 lisp_free (void *block
)
956 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
957 mem_delete (mem_find (block
));
959 MALLOC_UNBLOCK_INPUT
;
962 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
964 /* The entry point is lisp_align_malloc which returns blocks of at most
965 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
967 #if defined (HAVE_POSIX_MEMALIGN) && defined (SYSTEM_MALLOC)
968 #define USE_POSIX_MEMALIGN 1
971 /* BLOCK_ALIGN has to be a power of 2. */
972 #define BLOCK_ALIGN (1 << 10)
974 /* Padding to leave at the end of a malloc'd block. This is to give
975 malloc a chance to minimize the amount of memory wasted to alignment.
976 It should be tuned to the particular malloc library used.
977 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
978 posix_memalign on the other hand would ideally prefer a value of 4
979 because otherwise, there's 1020 bytes wasted between each ablocks.
980 In Emacs, testing shows that those 1020 can most of the time be
981 efficiently used by malloc to place other objects, so a value of 0 can
982 still preferable unless you have a lot of aligned blocks and virtually
984 #define BLOCK_PADDING 0
985 #define BLOCK_BYTES \
986 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
988 /* Internal data structures and constants. */
990 #define ABLOCKS_SIZE 16
992 /* An aligned block of memory. */
997 char payload
[BLOCK_BYTES
];
998 struct ablock
*next_free
;
1000 /* `abase' is the aligned base of the ablocks. */
1001 /* It is overloaded to hold the virtual `busy' field that counts
1002 the number of used ablock in the parent ablocks.
1003 The first ablock has the `busy' field, the others have the `abase'
1004 field. To tell the difference, we assume that pointers will have
1005 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1006 is used to tell whether the real base of the parent ablocks is `abase'
1007 (if not, the word before the first ablock holds a pointer to the
1009 struct ablocks
*abase
;
1010 /* The padding of all but the last ablock is unused. The padding of
1011 the last ablock in an ablocks is not allocated. */
1013 char padding
[BLOCK_PADDING
];
1017 /* A bunch of consecutive aligned blocks. */
1020 struct ablock blocks
[ABLOCKS_SIZE
];
1023 /* Size of the block requested from malloc or posix_memalign. */
1024 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1026 #define ABLOCK_ABASE(block) \
1027 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1028 ? (struct ablocks *)(block) \
1031 /* Virtual `busy' field. */
1032 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1034 /* Pointer to the (not necessarily aligned) malloc block. */
1035 #ifdef USE_POSIX_MEMALIGN
1036 #define ABLOCKS_BASE(abase) (abase)
1038 #define ABLOCKS_BASE(abase) \
1039 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void**)abase)[-1])
1042 /* The list of free ablock. */
1043 static struct ablock
*free_ablock
;
1045 /* Allocate an aligned block of nbytes.
1046 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1047 smaller or equal to BLOCK_BYTES. */
1049 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1052 struct ablocks
*abase
;
1054 eassert (nbytes
<= BLOCK_BYTES
);
1058 #ifdef GC_MALLOC_CHECK
1059 allocated_mem_type
= type
;
1065 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1067 #ifdef DOUG_LEA_MALLOC
1068 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1069 because mapped region contents are not preserved in
1071 mallopt (M_MMAP_MAX
, 0);
1074 #ifdef USE_POSIX_MEMALIGN
1076 int err
= posix_memalign (&base
, BLOCK_ALIGN
, ABLOCKS_BYTES
);
1082 base
= malloc (ABLOCKS_BYTES
);
1083 abase
= ALIGN (base
, BLOCK_ALIGN
);
1088 MALLOC_UNBLOCK_INPUT
;
1089 memory_full (ABLOCKS_BYTES
);
1092 aligned
= (base
== abase
);
1094 ((void**)abase
)[-1] = base
;
1096 #ifdef DOUG_LEA_MALLOC
1097 /* Back to a reasonable maximum of mmap'ed areas. */
1098 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1102 /* If the memory just allocated cannot be addressed thru a Lisp
1103 object's pointer, and it needs to be, that's equivalent to
1104 running out of memory. */
1105 if (type
!= MEM_TYPE_NON_LISP
)
1108 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1109 XSETCONS (tem
, end
);
1110 if ((char *) XCONS (tem
) != end
)
1112 lisp_malloc_loser
= base
;
1114 MALLOC_UNBLOCK_INPUT
;
1115 memory_full (SIZE_MAX
);
1120 /* Initialize the blocks and put them on the free list.
1121 If `base' was not properly aligned, we can't use the last block. */
1122 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1124 abase
->blocks
[i
].abase
= abase
;
1125 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1126 free_ablock
= &abase
->blocks
[i
];
1128 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1130 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1131 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1132 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1133 eassert (ABLOCKS_BASE (abase
) == base
);
1134 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1137 abase
= ABLOCK_ABASE (free_ablock
);
1138 ABLOCKS_BUSY (abase
) =
1139 (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1141 free_ablock
= free_ablock
->x
.next_free
;
1143 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1144 if (type
!= MEM_TYPE_NON_LISP
)
1145 mem_insert (val
, (char *) val
+ nbytes
, type
);
1148 MALLOC_UNBLOCK_INPUT
;
1150 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1155 lisp_align_free (void *block
)
1157 struct ablock
*ablock
= block
;
1158 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1161 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1162 mem_delete (mem_find (block
));
1164 /* Put on free list. */
1165 ablock
->x
.next_free
= free_ablock
;
1166 free_ablock
= ablock
;
1167 /* Update busy count. */
1168 ABLOCKS_BUSY (abase
)
1169 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1171 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1172 { /* All the blocks are free. */
1173 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1174 struct ablock
**tem
= &free_ablock
;
1175 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1179 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1182 *tem
= (*tem
)->x
.next_free
;
1185 tem
= &(*tem
)->x
.next_free
;
1187 eassert ((aligned
& 1) == aligned
);
1188 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1189 #ifdef USE_POSIX_MEMALIGN
1190 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1192 free (ABLOCKS_BASE (abase
));
1194 MALLOC_UNBLOCK_INPUT
;
1198 #ifndef SYSTEM_MALLOC
1200 /* Arranging to disable input signals while we're in malloc.
1202 This only works with GNU malloc. To help out systems which can't
1203 use GNU malloc, all the calls to malloc, realloc, and free
1204 elsewhere in the code should be inside a BLOCK_INPUT/UNBLOCK_INPUT
1205 pair; unfortunately, we have no idea what C library functions
1206 might call malloc, so we can't really protect them unless you're
1207 using GNU malloc. Fortunately, most of the major operating systems
1208 can use GNU malloc. */
1211 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
1212 there's no need to block input around malloc. */
1214 #ifndef DOUG_LEA_MALLOC
1215 extern void * (*__malloc_hook
) (size_t, const void *);
1216 extern void * (*__realloc_hook
) (void *, size_t, const void *);
1217 extern void (*__free_hook
) (void *, const void *);
1218 /* Else declared in malloc.h, perhaps with an extra arg. */
1219 #endif /* DOUG_LEA_MALLOC */
1220 static void * (*old_malloc_hook
) (size_t, const void *);
1221 static void * (*old_realloc_hook
) (void *, size_t, const void*);
1222 static void (*old_free_hook
) (void*, const void*);
1224 #ifdef DOUG_LEA_MALLOC
1225 # define BYTES_USED (mallinfo ().uordblks)
1227 # define BYTES_USED _bytes_used
1230 #ifdef GC_MALLOC_CHECK
1231 static int dont_register_blocks
;
1234 static size_t bytes_used_when_reconsidered
;
1236 /* Value of _bytes_used, when spare_memory was freed. */
1238 static size_t bytes_used_when_full
;
1240 /* This function is used as the hook for free to call. */
1243 emacs_blocked_free (void *ptr
, const void *ptr2
)
1247 #ifdef GC_MALLOC_CHECK
1253 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1256 "Freeing `%p' which wasn't allocated with malloc\n", ptr
);
1261 /* fprintf (stderr, "free %p...%p (%p)\n", m->start, m->end, ptr); */
1265 #endif /* GC_MALLOC_CHECK */
1267 __free_hook
= old_free_hook
;
1270 /* If we released our reserve (due to running out of memory),
1271 and we have a fair amount free once again,
1272 try to set aside another reserve in case we run out once more. */
1273 if (! NILP (Vmemory_full
)
1274 /* Verify there is enough space that even with the malloc
1275 hysteresis this call won't run out again.
1276 The code here is correct as long as SPARE_MEMORY
1277 is substantially larger than the block size malloc uses. */
1278 && (bytes_used_when_full
1279 > ((bytes_used_when_reconsidered
= BYTES_USED
)
1280 + max (malloc_hysteresis
, 4) * SPARE_MEMORY
)))
1281 refill_memory_reserve ();
1283 __free_hook
= emacs_blocked_free
;
1284 UNBLOCK_INPUT_ALLOC
;
1288 /* This function is the malloc hook that Emacs uses. */
1291 emacs_blocked_malloc (size_t size
, const void *ptr
)
1296 __malloc_hook
= old_malloc_hook
;
1297 #ifdef DOUG_LEA_MALLOC
1298 /* Segfaults on my system. --lorentey */
1299 /* mallopt (M_TOP_PAD, malloc_hysteresis * 4096); */
1301 __malloc_extra_blocks
= malloc_hysteresis
;
1304 value
= malloc (size
);
1306 #ifdef GC_MALLOC_CHECK
1308 struct mem_node
*m
= mem_find (value
);
1311 fprintf (stderr
, "Malloc returned %p which is already in use\n",
1313 fprintf (stderr
, "Region in use is %p...%p, %td bytes, type %d\n",
1314 m
->start
, m
->end
, (char *) m
->end
- (char *) m
->start
,
1319 if (!dont_register_blocks
)
1321 mem_insert (value
, (char *) value
+ max (1, size
), allocated_mem_type
);
1322 allocated_mem_type
= MEM_TYPE_NON_LISP
;
1325 #endif /* GC_MALLOC_CHECK */
1327 __malloc_hook
= emacs_blocked_malloc
;
1328 UNBLOCK_INPUT_ALLOC
;
1330 /* fprintf (stderr, "%p malloc\n", value); */
1335 /* This function is the realloc hook that Emacs uses. */
1338 emacs_blocked_realloc (void *ptr
, size_t size
, const void *ptr2
)
1343 __realloc_hook
= old_realloc_hook
;
1345 #ifdef GC_MALLOC_CHECK
1348 struct mem_node
*m
= mem_find (ptr
);
1349 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1352 "Realloc of %p which wasn't allocated with malloc\n",
1360 /* fprintf (stderr, "%p -> realloc\n", ptr); */
1362 /* Prevent malloc from registering blocks. */
1363 dont_register_blocks
= 1;
1364 #endif /* GC_MALLOC_CHECK */
1366 value
= realloc (ptr
, size
);
1368 #ifdef GC_MALLOC_CHECK
1369 dont_register_blocks
= 0;
1372 struct mem_node
*m
= mem_find (value
);
1375 fprintf (stderr
, "Realloc returns memory that is already in use\n");
1379 /* Can't handle zero size regions in the red-black tree. */
1380 mem_insert (value
, (char *) value
+ max (size
, 1), MEM_TYPE_NON_LISP
);
1383 /* fprintf (stderr, "%p <- realloc\n", value); */
1384 #endif /* GC_MALLOC_CHECK */
1386 __realloc_hook
= emacs_blocked_realloc
;
1387 UNBLOCK_INPUT_ALLOC
;
1394 /* Called from Fdump_emacs so that when the dumped Emacs starts, it has a
1395 normal malloc. Some thread implementations need this as they call
1396 malloc before main. The pthread_self call in BLOCK_INPUT_ALLOC then
1397 calls malloc because it is the first call, and we have an endless loop. */
1400 reset_malloc_hooks (void)
1402 __free_hook
= old_free_hook
;
1403 __malloc_hook
= old_malloc_hook
;
1404 __realloc_hook
= old_realloc_hook
;
1406 #endif /* HAVE_PTHREAD */
1409 /* Called from main to set up malloc to use our hooks. */
1412 uninterrupt_malloc (void)
1415 #ifdef DOUG_LEA_MALLOC
1416 pthread_mutexattr_t attr
;
1418 /* GLIBC has a faster way to do this, but let's keep it portable.
1419 This is according to the Single UNIX Specification. */
1420 pthread_mutexattr_init (&attr
);
1421 pthread_mutexattr_settype (&attr
, PTHREAD_MUTEX_RECURSIVE
);
1422 pthread_mutex_init (&alloc_mutex
, &attr
);
1423 #else /* !DOUG_LEA_MALLOC */
1424 /* Some systems such as Solaris 2.6 don't have a recursive mutex,
1425 and the bundled gmalloc.c doesn't require it. */
1426 pthread_mutex_init (&alloc_mutex
, NULL
);
1427 #endif /* !DOUG_LEA_MALLOC */
1428 #endif /* HAVE_PTHREAD */
1430 if (__free_hook
!= emacs_blocked_free
)
1431 old_free_hook
= __free_hook
;
1432 __free_hook
= emacs_blocked_free
;
1434 if (__malloc_hook
!= emacs_blocked_malloc
)
1435 old_malloc_hook
= __malloc_hook
;
1436 __malloc_hook
= emacs_blocked_malloc
;
1438 if (__realloc_hook
!= emacs_blocked_realloc
)
1439 old_realloc_hook
= __realloc_hook
;
1440 __realloc_hook
= emacs_blocked_realloc
;
1443 #endif /* not SYNC_INPUT */
1444 #endif /* not SYSTEM_MALLOC */
1448 /***********************************************************************
1450 ***********************************************************************/
1452 /* Number of intervals allocated in an interval_block structure.
1453 The 1020 is 1024 minus malloc overhead. */
1455 #define INTERVAL_BLOCK_SIZE \
1456 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1458 /* Intervals are allocated in chunks in form of an interval_block
1461 struct interval_block
1463 /* Place `intervals' first, to preserve alignment. */
1464 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1465 struct interval_block
*next
;
1468 /* Current interval block. Its `next' pointer points to older
1471 static struct interval_block
*interval_block
;
1473 /* Index in interval_block above of the next unused interval
1476 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1478 /* Number of free and live intervals. */
1480 static EMACS_INT total_free_intervals
, total_intervals
;
1482 /* List of free intervals. */
1484 static INTERVAL interval_free_list
;
1486 /* Return a new interval. */
1489 make_interval (void)
1493 /* eassert (!handling_signal); */
1497 if (interval_free_list
)
1499 val
= interval_free_list
;
1500 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1504 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1506 struct interval_block
*newi
1507 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1509 newi
->next
= interval_block
;
1510 interval_block
= newi
;
1511 interval_block_index
= 0;
1512 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1514 val
= &interval_block
->intervals
[interval_block_index
++];
1517 MALLOC_UNBLOCK_INPUT
;
1519 consing_since_gc
+= sizeof (struct interval
);
1521 total_free_intervals
--;
1522 RESET_INTERVAL (val
);
1528 /* Mark Lisp objects in interval I. */
1531 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1533 /* Intervals should never be shared. So, if extra internal checking is
1534 enabled, GC aborts if it seems to have visited an interval twice. */
1535 eassert (!i
->gcmarkbit
);
1537 mark_object (i
->plist
);
1541 /* Mark the interval tree rooted in TREE. Don't call this directly;
1542 use the macro MARK_INTERVAL_TREE instead. */
1545 mark_interval_tree (register INTERVAL tree
)
1547 /* No need to test if this tree has been marked already; this
1548 function is always called through the MARK_INTERVAL_TREE macro,
1549 which takes care of that. */
1551 traverse_intervals_noorder (tree
, mark_interval
, Qnil
);
1555 /* Mark the interval tree rooted in I. */
1557 #define MARK_INTERVAL_TREE(i) \
1559 if (!NULL_INTERVAL_P (i) && !i->gcmarkbit) \
1560 mark_interval_tree (i); \
1564 #define UNMARK_BALANCE_INTERVALS(i) \
1566 if (! NULL_INTERVAL_P (i)) \
1567 (i) = balance_intervals (i); \
1570 /***********************************************************************
1572 ***********************************************************************/
1574 /* Lisp_Strings are allocated in string_block structures. When a new
1575 string_block is allocated, all the Lisp_Strings it contains are
1576 added to a free-list string_free_list. When a new Lisp_String is
1577 needed, it is taken from that list. During the sweep phase of GC,
1578 string_blocks that are entirely free are freed, except two which
1581 String data is allocated from sblock structures. Strings larger
1582 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1583 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1585 Sblocks consist internally of sdata structures, one for each
1586 Lisp_String. The sdata structure points to the Lisp_String it
1587 belongs to. The Lisp_String points back to the `u.data' member of
1588 its sdata structure.
1590 When a Lisp_String is freed during GC, it is put back on
1591 string_free_list, and its `data' member and its sdata's `string'
1592 pointer is set to null. The size of the string is recorded in the
1593 `u.nbytes' member of the sdata. So, sdata structures that are no
1594 longer used, can be easily recognized, and it's easy to compact the
1595 sblocks of small strings which we do in compact_small_strings. */
1597 /* Size in bytes of an sblock structure used for small strings. This
1598 is 8192 minus malloc overhead. */
1600 #define SBLOCK_SIZE 8188
1602 /* Strings larger than this are considered large strings. String data
1603 for large strings is allocated from individual sblocks. */
1605 #define LARGE_STRING_BYTES 1024
1607 /* Structure describing string memory sub-allocated from an sblock.
1608 This is where the contents of Lisp strings are stored. */
1612 /* Back-pointer to the string this sdata belongs to. If null, this
1613 structure is free, and the NBYTES member of the union below
1614 contains the string's byte size (the same value that STRING_BYTES
1615 would return if STRING were non-null). If non-null, STRING_BYTES
1616 (STRING) is the size of the data, and DATA contains the string's
1618 struct Lisp_String
*string
;
1620 #ifdef GC_CHECK_STRING_BYTES
1623 unsigned char data
[1];
1625 #define SDATA_NBYTES(S) (S)->nbytes
1626 #define SDATA_DATA(S) (S)->data
1627 #define SDATA_SELECTOR(member) member
1629 #else /* not GC_CHECK_STRING_BYTES */
1633 /* When STRING is non-null. */
1634 unsigned char data
[1];
1636 /* When STRING is null. */
1640 #define SDATA_NBYTES(S) (S)->u.nbytes
1641 #define SDATA_DATA(S) (S)->u.data
1642 #define SDATA_SELECTOR(member) u.member
1644 #endif /* not GC_CHECK_STRING_BYTES */
1646 #define SDATA_DATA_OFFSET offsetof (struct sdata, SDATA_SELECTOR (data))
1650 /* Structure describing a block of memory which is sub-allocated to
1651 obtain string data memory for strings. Blocks for small strings
1652 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1653 as large as needed. */
1658 struct sblock
*next
;
1660 /* Pointer to the next free sdata block. This points past the end
1661 of the sblock if there isn't any space left in this block. */
1662 struct sdata
*next_free
;
1664 /* Start of data. */
1665 struct sdata first_data
;
1668 /* Number of Lisp strings in a string_block structure. The 1020 is
1669 1024 minus malloc overhead. */
1671 #define STRING_BLOCK_SIZE \
1672 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1674 /* Structure describing a block from which Lisp_String structures
1679 /* Place `strings' first, to preserve alignment. */
1680 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1681 struct string_block
*next
;
1684 /* Head and tail of the list of sblock structures holding Lisp string
1685 data. We always allocate from current_sblock. The NEXT pointers
1686 in the sblock structures go from oldest_sblock to current_sblock. */
1688 static struct sblock
*oldest_sblock
, *current_sblock
;
1690 /* List of sblocks for large strings. */
1692 static struct sblock
*large_sblocks
;
1694 /* List of string_block structures. */
1696 static struct string_block
*string_blocks
;
1698 /* Free-list of Lisp_Strings. */
1700 static struct Lisp_String
*string_free_list
;
1702 /* Number of live and free Lisp_Strings. */
1704 static EMACS_INT total_strings
, total_free_strings
;
1706 /* Number of bytes used by live strings. */
1708 static EMACS_INT total_string_bytes
;
1710 /* Given a pointer to a Lisp_String S which is on the free-list
1711 string_free_list, return a pointer to its successor in the
1714 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1716 /* Return a pointer to the sdata structure belonging to Lisp string S.
1717 S must be live, i.e. S->data must not be null. S->data is actually
1718 a pointer to the `u.data' member of its sdata structure; the
1719 structure starts at a constant offset in front of that. */
1721 #define SDATA_OF_STRING(S) ((struct sdata *) ((S)->data - SDATA_DATA_OFFSET))
1724 #ifdef GC_CHECK_STRING_OVERRUN
1726 /* We check for overrun in string data blocks by appending a small
1727 "cookie" after each allocated string data block, and check for the
1728 presence of this cookie during GC. */
1730 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1731 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1732 { '\xde', '\xad', '\xbe', '\xef' };
1735 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1738 /* Value is the size of an sdata structure large enough to hold NBYTES
1739 bytes of string data. The value returned includes a terminating
1740 NUL byte, the size of the sdata structure, and padding. */
1742 #ifdef GC_CHECK_STRING_BYTES
1744 #define SDATA_SIZE(NBYTES) \
1745 ((SDATA_DATA_OFFSET \
1747 + sizeof (ptrdiff_t) - 1) \
1748 & ~(sizeof (ptrdiff_t) - 1))
1750 #else /* not GC_CHECK_STRING_BYTES */
1752 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1753 less than the size of that member. The 'max' is not needed when
1754 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1755 alignment code reserves enough space. */
1757 #define SDATA_SIZE(NBYTES) \
1758 ((SDATA_DATA_OFFSET \
1759 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1761 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1763 + sizeof (ptrdiff_t) - 1) \
1764 & ~(sizeof (ptrdiff_t) - 1))
1766 #endif /* not GC_CHECK_STRING_BYTES */
1768 /* Extra bytes to allocate for each string. */
1770 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1772 /* Exact bound on the number of bytes in a string, not counting the
1773 terminating null. A string cannot contain more bytes than
1774 STRING_BYTES_BOUND, nor can it be so long that the size_t
1775 arithmetic in allocate_string_data would overflow while it is
1776 calculating a value to be passed to malloc. */
1777 static ptrdiff_t const STRING_BYTES_MAX
=
1778 min (STRING_BYTES_BOUND
,
1779 ((SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
1781 - offsetof (struct sblock
, first_data
)
1782 - SDATA_DATA_OFFSET
)
1783 & ~(sizeof (EMACS_INT
) - 1)));
1785 /* Initialize string allocation. Called from init_alloc_once. */
1790 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1791 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1795 #ifdef GC_CHECK_STRING_BYTES
1797 static int check_string_bytes_count
;
1799 /* Like STRING_BYTES, but with debugging check. Can be
1800 called during GC, so pay attention to the mark bit. */
1803 string_bytes (struct Lisp_String
*s
)
1806 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1808 if (!PURE_POINTER_P (s
)
1810 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1815 /* Check validity of Lisp strings' string_bytes member in B. */
1818 check_sblock (struct sblock
*b
)
1820 struct sdata
*from
, *end
, *from_end
;
1824 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1826 /* Compute the next FROM here because copying below may
1827 overwrite data we need to compute it. */
1830 /* Check that the string size recorded in the string is the
1831 same as the one recorded in the sdata structure. */
1832 nbytes
= SDATA_SIZE (from
->string
? string_bytes (from
->string
)
1833 : SDATA_NBYTES (from
));
1834 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1839 /* Check validity of Lisp strings' string_bytes member. ALL_P
1840 non-zero means check all strings, otherwise check only most
1841 recently allocated strings. Used for hunting a bug. */
1844 check_string_bytes (int all_p
)
1850 for (b
= large_sblocks
; b
; b
= b
->next
)
1852 struct Lisp_String
*s
= b
->first_data
.string
;
1857 for (b
= oldest_sblock
; b
; b
= b
->next
)
1860 else if (current_sblock
)
1861 check_sblock (current_sblock
);
1864 #else /* not GC_CHECK_STRING_BYTES */
1866 #define check_string_bytes(all) ((void) 0)
1868 #endif /* GC_CHECK_STRING_BYTES */
1870 #ifdef GC_CHECK_STRING_FREE_LIST
1872 /* Walk through the string free list looking for bogus next pointers.
1873 This may catch buffer overrun from a previous string. */
1876 check_string_free_list (void)
1878 struct Lisp_String
*s
;
1880 /* Pop a Lisp_String off the free-list. */
1881 s
= string_free_list
;
1884 if ((uintptr_t) s
< 1024)
1886 s
= NEXT_FREE_LISP_STRING (s
);
1890 #define check_string_free_list()
1893 /* Return a new Lisp_String. */
1895 static struct Lisp_String
*
1896 allocate_string (void)
1898 struct Lisp_String
*s
;
1900 /* eassert (!handling_signal); */
1904 /* If the free-list is empty, allocate a new string_block, and
1905 add all the Lisp_Strings in it to the free-list. */
1906 if (string_free_list
== NULL
)
1908 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1911 b
->next
= string_blocks
;
1914 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1917 /* Every string on a free list should have NULL data pointer. */
1919 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1920 string_free_list
= s
;
1923 total_free_strings
+= STRING_BLOCK_SIZE
;
1926 check_string_free_list ();
1928 /* Pop a Lisp_String off the free-list. */
1929 s
= string_free_list
;
1930 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1932 MALLOC_UNBLOCK_INPUT
;
1934 --total_free_strings
;
1937 consing_since_gc
+= sizeof *s
;
1939 #ifdef GC_CHECK_STRING_BYTES
1940 if (!noninteractive
)
1942 if (++check_string_bytes_count
== 200)
1944 check_string_bytes_count
= 0;
1945 check_string_bytes (1);
1948 check_string_bytes (0);
1950 #endif /* GC_CHECK_STRING_BYTES */
1956 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1957 plus a NUL byte at the end. Allocate an sdata structure for S, and
1958 set S->data to its `u.data' member. Store a NUL byte at the end of
1959 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1960 S->data if it was initially non-null. */
1963 allocate_string_data (struct Lisp_String
*s
,
1964 EMACS_INT nchars
, EMACS_INT nbytes
)
1966 struct sdata
*data
, *old_data
;
1968 ptrdiff_t needed
, old_nbytes
;
1970 if (STRING_BYTES_MAX
< nbytes
)
1973 /* Determine the number of bytes needed to store NBYTES bytes
1975 needed
= SDATA_SIZE (nbytes
);
1978 old_data
= SDATA_OF_STRING (s
);
1979 old_nbytes
= STRING_BYTES (s
);
1986 if (nbytes
> LARGE_STRING_BYTES
)
1988 size_t size
= offsetof (struct sblock
, first_data
) + needed
;
1990 #ifdef DOUG_LEA_MALLOC
1991 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1992 because mapped region contents are not preserved in
1995 In case you think of allowing it in a dumped Emacs at the
1996 cost of not being able to re-dump, there's another reason:
1997 mmap'ed data typically have an address towards the top of the
1998 address space, which won't fit into an EMACS_INT (at least on
1999 32-bit systems with the current tagging scheme). --fx */
2000 mallopt (M_MMAP_MAX
, 0);
2003 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
2005 #ifdef DOUG_LEA_MALLOC
2006 /* Back to a reasonable maximum of mmap'ed areas. */
2007 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2010 b
->next_free
= &b
->first_data
;
2011 b
->first_data
.string
= NULL
;
2012 b
->next
= large_sblocks
;
2015 else if (current_sblock
== NULL
2016 || (((char *) current_sblock
+ SBLOCK_SIZE
2017 - (char *) current_sblock
->next_free
)
2018 < (needed
+ GC_STRING_EXTRA
)))
2020 /* Not enough room in the current sblock. */
2021 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
2022 b
->next_free
= &b
->first_data
;
2023 b
->first_data
.string
= NULL
;
2027 current_sblock
->next
= b
;
2035 data
= b
->next_free
;
2036 b
->next_free
= (struct sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
2038 MALLOC_UNBLOCK_INPUT
;
2041 s
->data
= SDATA_DATA (data
);
2042 #ifdef GC_CHECK_STRING_BYTES
2043 SDATA_NBYTES (data
) = nbytes
;
2046 s
->size_byte
= nbytes
;
2047 s
->data
[nbytes
] = '\0';
2048 #ifdef GC_CHECK_STRING_OVERRUN
2049 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
2050 GC_STRING_OVERRUN_COOKIE_SIZE
);
2053 /* Note that Faset may call to this function when S has already data
2054 assigned. In this case, mark data as free by setting it's string
2055 back-pointer to null, and record the size of the data in it. */
2058 SDATA_NBYTES (old_data
) = old_nbytes
;
2059 old_data
->string
= NULL
;
2062 consing_since_gc
+= needed
;
2066 /* Sweep and compact strings. */
2069 sweep_strings (void)
2071 struct string_block
*b
, *next
;
2072 struct string_block
*live_blocks
= NULL
;
2074 string_free_list
= NULL
;
2075 total_strings
= total_free_strings
= 0;
2076 total_string_bytes
= 0;
2078 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
2079 for (b
= string_blocks
; b
; b
= next
)
2082 struct Lisp_String
*free_list_before
= string_free_list
;
2086 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
2088 struct Lisp_String
*s
= b
->strings
+ i
;
2092 /* String was not on free-list before. */
2093 if (STRING_MARKED_P (s
))
2095 /* String is live; unmark it and its intervals. */
2098 if (!NULL_INTERVAL_P (s
->intervals
))
2099 UNMARK_BALANCE_INTERVALS (s
->intervals
);
2102 total_string_bytes
+= STRING_BYTES (s
);
2106 /* String is dead. Put it on the free-list. */
2107 struct sdata
*data
= SDATA_OF_STRING (s
);
2109 /* Save the size of S in its sdata so that we know
2110 how large that is. Reset the sdata's string
2111 back-pointer so that we know it's free. */
2112 #ifdef GC_CHECK_STRING_BYTES
2113 if (string_bytes (s
) != SDATA_NBYTES (data
))
2116 data
->u
.nbytes
= STRING_BYTES (s
);
2118 data
->string
= NULL
;
2120 /* Reset the strings's `data' member so that we
2124 /* Put the string on the free-list. */
2125 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2126 string_free_list
= s
;
2132 /* S was on the free-list before. Put it there again. */
2133 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2134 string_free_list
= s
;
2139 /* Free blocks that contain free Lisp_Strings only, except
2140 the first two of them. */
2141 if (nfree
== STRING_BLOCK_SIZE
2142 && total_free_strings
> STRING_BLOCK_SIZE
)
2145 string_free_list
= free_list_before
;
2149 total_free_strings
+= nfree
;
2150 b
->next
= live_blocks
;
2155 check_string_free_list ();
2157 string_blocks
= live_blocks
;
2158 free_large_strings ();
2159 compact_small_strings ();
2161 check_string_free_list ();
2165 /* Free dead large strings. */
2168 free_large_strings (void)
2170 struct sblock
*b
, *next
;
2171 struct sblock
*live_blocks
= NULL
;
2173 for (b
= large_sblocks
; b
; b
= next
)
2177 if (b
->first_data
.string
== NULL
)
2181 b
->next
= live_blocks
;
2186 large_sblocks
= live_blocks
;
2190 /* Compact data of small strings. Free sblocks that don't contain
2191 data of live strings after compaction. */
2194 compact_small_strings (void)
2196 struct sblock
*b
, *tb
, *next
;
2197 struct sdata
*from
, *to
, *end
, *tb_end
;
2198 struct sdata
*to_end
, *from_end
;
2200 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2201 to, and TB_END is the end of TB. */
2203 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2204 to
= &tb
->first_data
;
2206 /* Step through the blocks from the oldest to the youngest. We
2207 expect that old blocks will stabilize over time, so that less
2208 copying will happen this way. */
2209 for (b
= oldest_sblock
; b
; b
= b
->next
)
2212 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2214 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
2216 /* Compute the next FROM here because copying below may
2217 overwrite data we need to compute it. */
2219 struct Lisp_String
*s
= from
->string
;
2221 #ifdef GC_CHECK_STRING_BYTES
2222 /* Check that the string size recorded in the string is the
2223 same as the one recorded in the sdata structure. */
2224 if (s
&& string_bytes (s
) != SDATA_NBYTES (from
))
2226 #endif /* GC_CHECK_STRING_BYTES */
2228 nbytes
= s
? STRING_BYTES (s
) : SDATA_NBYTES (from
);
2229 eassert (nbytes
<= LARGE_STRING_BYTES
);
2231 nbytes
= SDATA_SIZE (nbytes
);
2232 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2234 #ifdef GC_CHECK_STRING_OVERRUN
2235 if (memcmp (string_overrun_cookie
,
2236 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2237 GC_STRING_OVERRUN_COOKIE_SIZE
))
2241 /* Non-NULL S means it's alive. Copy its data. */
2244 /* If TB is full, proceed with the next sblock. */
2245 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2246 if (to_end
> tb_end
)
2250 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2251 to
= &tb
->first_data
;
2252 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2255 /* Copy, and update the string's `data' pointer. */
2258 eassert (tb
!= b
|| to
< from
);
2259 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2260 to
->string
->data
= SDATA_DATA (to
);
2263 /* Advance past the sdata we copied to. */
2269 /* The rest of the sblocks following TB don't contain live data, so
2270 we can free them. */
2271 for (b
= tb
->next
; b
; b
= next
)
2279 current_sblock
= tb
;
2283 string_overflow (void)
2285 error ("Maximum string size exceeded");
2288 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2289 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2290 LENGTH must be an integer.
2291 INIT must be an integer that represents a character. */)
2292 (Lisp_Object length
, Lisp_Object init
)
2294 register Lisp_Object val
;
2295 register unsigned char *p
, *end
;
2299 CHECK_NATNUM (length
);
2300 CHECK_CHARACTER (init
);
2302 c
= XFASTINT (init
);
2303 if (ASCII_CHAR_P (c
))
2305 nbytes
= XINT (length
);
2306 val
= make_uninit_string (nbytes
);
2308 end
= p
+ SCHARS (val
);
2314 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2315 int len
= CHAR_STRING (c
, str
);
2316 EMACS_INT string_len
= XINT (length
);
2318 if (string_len
> STRING_BYTES_MAX
/ len
)
2320 nbytes
= len
* string_len
;
2321 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2326 memcpy (p
, str
, len
);
2336 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2337 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2338 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2339 (Lisp_Object length
, Lisp_Object init
)
2341 register Lisp_Object val
;
2342 struct Lisp_Bool_Vector
*p
;
2343 ptrdiff_t length_in_chars
;
2344 EMACS_INT length_in_elts
;
2346 int extra_bool_elts
= ((bool_header_size
- header_size
+ word_size
- 1)
2349 CHECK_NATNUM (length
);
2351 bits_per_value
= sizeof (EMACS_INT
) * BOOL_VECTOR_BITS_PER_CHAR
;
2353 length_in_elts
= (XFASTINT (length
) + bits_per_value
- 1) / bits_per_value
;
2355 val
= Fmake_vector (make_number (length_in_elts
+ extra_bool_elts
), Qnil
);
2357 /* No Lisp_Object to trace in there. */
2358 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0);
2360 p
= XBOOL_VECTOR (val
);
2361 p
->size
= XFASTINT (length
);
2363 length_in_chars
= ((XFASTINT (length
) + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2364 / BOOL_VECTOR_BITS_PER_CHAR
);
2365 if (length_in_chars
)
2367 memset (p
->data
, ! NILP (init
) ? -1 : 0, length_in_chars
);
2369 /* Clear any extraneous bits in the last byte. */
2370 p
->data
[length_in_chars
- 1]
2371 &= (1 << ((XFASTINT (length
) - 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1)) - 1;
2378 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2379 of characters from the contents. This string may be unibyte or
2380 multibyte, depending on the contents. */
2383 make_string (const char *contents
, ptrdiff_t nbytes
)
2385 register Lisp_Object val
;
2386 ptrdiff_t nchars
, multibyte_nbytes
;
2388 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2389 &nchars
, &multibyte_nbytes
);
2390 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2391 /* CONTENTS contains no multibyte sequences or contains an invalid
2392 multibyte sequence. We must make unibyte string. */
2393 val
= make_unibyte_string (contents
, nbytes
);
2395 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2400 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2403 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2405 register Lisp_Object val
;
2406 val
= make_uninit_string (length
);
2407 memcpy (SDATA (val
), contents
, length
);
2412 /* Make a multibyte string from NCHARS characters occupying NBYTES
2413 bytes at CONTENTS. */
2416 make_multibyte_string (const char *contents
,
2417 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2419 register Lisp_Object val
;
2420 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2421 memcpy (SDATA (val
), contents
, nbytes
);
2426 /* Make a string from NCHARS characters occupying NBYTES bytes at
2427 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2430 make_string_from_bytes (const char *contents
,
2431 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2433 register Lisp_Object val
;
2434 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2435 memcpy (SDATA (val
), contents
, nbytes
);
2436 if (SBYTES (val
) == SCHARS (val
))
2437 STRING_SET_UNIBYTE (val
);
2442 /* Make a string from NCHARS characters occupying NBYTES bytes at
2443 CONTENTS. The argument MULTIBYTE controls whether to label the
2444 string as multibyte. If NCHARS is negative, it counts the number of
2445 characters by itself. */
2448 make_specified_string (const char *contents
,
2449 ptrdiff_t nchars
, ptrdiff_t nbytes
, int multibyte
)
2451 register Lisp_Object val
;
2456 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2461 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2462 memcpy (SDATA (val
), contents
, nbytes
);
2464 STRING_SET_UNIBYTE (val
);
2469 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2470 occupying LENGTH bytes. */
2473 make_uninit_string (EMACS_INT length
)
2478 return empty_unibyte_string
;
2479 val
= make_uninit_multibyte_string (length
, length
);
2480 STRING_SET_UNIBYTE (val
);
2485 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2486 which occupy NBYTES bytes. */
2489 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2492 struct Lisp_String
*s
;
2497 return empty_multibyte_string
;
2499 s
= allocate_string ();
2500 s
->intervals
= NULL_INTERVAL
;
2501 allocate_string_data (s
, nchars
, nbytes
);
2502 XSETSTRING (string
, s
);
2503 string_chars_consed
+= nbytes
;
2507 /* Print arguments to BUF according to a FORMAT, then return
2508 a Lisp_String initialized with the data from BUF. */
2511 make_formatted_string (char *buf
, const char *format
, ...)
2516 va_start (ap
, format
);
2517 length
= vsprintf (buf
, format
, ap
);
2519 return make_string (buf
, length
);
2523 /***********************************************************************
2525 ***********************************************************************/
2527 /* We store float cells inside of float_blocks, allocating a new
2528 float_block with malloc whenever necessary. Float cells reclaimed
2529 by GC are put on a free list to be reallocated before allocating
2530 any new float cells from the latest float_block. */
2532 #define FLOAT_BLOCK_SIZE \
2533 (((BLOCK_BYTES - sizeof (struct float_block *) \
2534 /* The compiler might add padding at the end. */ \
2535 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2536 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2538 #define GETMARKBIT(block,n) \
2539 (((block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2540 >> ((n) % (sizeof (int) * CHAR_BIT))) \
2543 #define SETMARKBIT(block,n) \
2544 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2545 |= 1 << ((n) % (sizeof (int) * CHAR_BIT))
2547 #define UNSETMARKBIT(block,n) \
2548 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2549 &= ~(1 << ((n) % (sizeof (int) * CHAR_BIT)))
2551 #define FLOAT_BLOCK(fptr) \
2552 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2554 #define FLOAT_INDEX(fptr) \
2555 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2559 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2560 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2561 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2562 struct float_block
*next
;
2565 #define FLOAT_MARKED_P(fptr) \
2566 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2568 #define FLOAT_MARK(fptr) \
2569 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2571 #define FLOAT_UNMARK(fptr) \
2572 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2574 /* Current float_block. */
2576 static struct float_block
*float_block
;
2578 /* Index of first unused Lisp_Float in the current float_block. */
2580 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2582 /* Free-list of Lisp_Floats. */
2584 static struct Lisp_Float
*float_free_list
;
2586 /* Return a new float object with value FLOAT_VALUE. */
2589 make_float (double float_value
)
2591 register Lisp_Object val
;
2593 /* eassert (!handling_signal); */
2597 if (float_free_list
)
2599 /* We use the data field for chaining the free list
2600 so that we won't use the same field that has the mark bit. */
2601 XSETFLOAT (val
, float_free_list
);
2602 float_free_list
= float_free_list
->u
.chain
;
2606 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2608 struct float_block
*new
2609 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2610 new->next
= float_block
;
2611 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2613 float_block_index
= 0;
2614 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2616 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2617 float_block_index
++;
2620 MALLOC_UNBLOCK_INPUT
;
2622 XFLOAT_INIT (val
, float_value
);
2623 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2624 consing_since_gc
+= sizeof (struct Lisp_Float
);
2626 total_free_floats
--;
2632 /***********************************************************************
2634 ***********************************************************************/
2636 /* We store cons cells inside of cons_blocks, allocating a new
2637 cons_block with malloc whenever necessary. Cons cells reclaimed by
2638 GC are put on a free list to be reallocated before allocating
2639 any new cons cells from the latest cons_block. */
2641 #define CONS_BLOCK_SIZE \
2642 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2643 /* The compiler might add padding at the end. */ \
2644 - (sizeof (struct Lisp_Cons) - sizeof (int))) * CHAR_BIT) \
2645 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2647 #define CONS_BLOCK(fptr) \
2648 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2650 #define CONS_INDEX(fptr) \
2651 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2655 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2656 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2657 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2658 struct cons_block
*next
;
2661 #define CONS_MARKED_P(fptr) \
2662 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2664 #define CONS_MARK(fptr) \
2665 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2667 #define CONS_UNMARK(fptr) \
2668 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2670 /* Current cons_block. */
2672 static struct cons_block
*cons_block
;
2674 /* Index of first unused Lisp_Cons in the current block. */
2676 static int cons_block_index
= CONS_BLOCK_SIZE
;
2678 /* Free-list of Lisp_Cons structures. */
2680 static struct Lisp_Cons
*cons_free_list
;
2682 /* Explicitly free a cons cell by putting it on the free-list. */
2685 free_cons (struct Lisp_Cons
*ptr
)
2687 ptr
->u
.chain
= cons_free_list
;
2691 cons_free_list
= ptr
;
2692 consing_since_gc
-= sizeof *ptr
;
2693 total_free_conses
++;
2696 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2697 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2698 (Lisp_Object car
, Lisp_Object cdr
)
2700 register Lisp_Object val
;
2702 /* eassert (!handling_signal); */
2708 /* We use the cdr for chaining the free list
2709 so that we won't use the same field that has the mark bit. */
2710 XSETCONS (val
, cons_free_list
);
2711 cons_free_list
= cons_free_list
->u
.chain
;
2715 if (cons_block_index
== CONS_BLOCK_SIZE
)
2717 struct cons_block
*new
2718 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2719 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2720 new->next
= cons_block
;
2722 cons_block_index
= 0;
2723 total_free_conses
+= CONS_BLOCK_SIZE
;
2725 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2729 MALLOC_UNBLOCK_INPUT
;
2733 eassert (!CONS_MARKED_P (XCONS (val
)));
2734 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2735 total_free_conses
--;
2736 cons_cells_consed
++;
2740 #ifdef GC_CHECK_CONS_LIST
2741 /* Get an error now if there's any junk in the cons free list. */
2743 check_cons_list (void)
2745 struct Lisp_Cons
*tail
= cons_free_list
;
2748 tail
= tail
->u
.chain
;
2752 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2755 list1 (Lisp_Object arg1
)
2757 return Fcons (arg1
, Qnil
);
2761 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2763 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2768 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2770 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2775 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2777 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2782 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2784 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2785 Fcons (arg5
, Qnil
)))));
2788 /* Make a list of COUNT Lisp_Objects, where ARG is the
2789 first one. Allocate conses from pure space if TYPE
2790 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2793 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2797 Lisp_Object val
, *objp
;
2799 /* Change to SAFE_ALLOCA if you hit this eassert. */
2800 eassert (count
<= MAX_ALLOCA
/ sizeof (Lisp_Object
));
2802 objp
= alloca (count
* sizeof (Lisp_Object
));
2805 for (i
= 1; i
< count
; i
++)
2806 objp
[i
] = va_arg (ap
, Lisp_Object
);
2809 for (val
= Qnil
, i
= count
- 1; i
>= 0; i
--)
2811 if (type
== CONSTYPE_PURE
)
2812 val
= pure_cons (objp
[i
], val
);
2813 else if (type
== CONSTYPE_HEAP
)
2814 val
= Fcons (objp
[i
], val
);
2821 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2822 doc
: /* Return a newly created list with specified arguments as elements.
2823 Any number of arguments, even zero arguments, are allowed.
2824 usage: (list &rest OBJECTS) */)
2825 (ptrdiff_t nargs
, Lisp_Object
*args
)
2827 register Lisp_Object val
;
2833 val
= Fcons (args
[nargs
], val
);
2839 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2840 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2841 (register Lisp_Object length
, Lisp_Object init
)
2843 register Lisp_Object val
;
2844 register EMACS_INT size
;
2846 CHECK_NATNUM (length
);
2847 size
= XFASTINT (length
);
2852 val
= Fcons (init
, val
);
2857 val
= Fcons (init
, val
);
2862 val
= Fcons (init
, val
);
2867 val
= Fcons (init
, val
);
2872 val
= Fcons (init
, val
);
2887 /***********************************************************************
2889 ***********************************************************************/
2891 /* This value is balanced well enough to avoid too much internal overhead
2892 for the most common cases; it's not required to be a power of two, but
2893 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2895 #define VECTOR_BLOCK_SIZE 4096
2897 /* Align allocation request sizes to be a multiple of ROUNDUP_SIZE. */
2900 roundup_size
= COMMON_MULTIPLE (word_size
,
2901 USE_LSB_TAG
? 1 << GCTYPEBITS
: 1)
2904 /* ROUNDUP_SIZE must be a power of 2. */
2905 verify ((roundup_size
& (roundup_size
- 1)) == 0);
2907 /* Verify assumptions described above. */
2908 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2909 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2911 /* Round up X to nearest mult-of-ROUNDUP_SIZE. */
2913 #define vroundup(x) (((x) + (roundup_size - 1)) & ~(roundup_size - 1))
2915 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2917 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup (sizeof (void *)))
2919 /* Size of the minimal vector allocated from block. */
2921 #define VBLOCK_BYTES_MIN vroundup (sizeof (struct Lisp_Vector))
2923 /* Size of the largest vector allocated from block. */
2925 #define VBLOCK_BYTES_MAX \
2926 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2928 /* We maintain one free list for each possible block-allocated
2929 vector size, and this is the number of free lists we have. */
2931 #define VECTOR_MAX_FREE_LIST_INDEX \
2932 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2934 /* Common shortcut to advance vector pointer over a block data. */
2936 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2938 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2940 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2942 /* Common shortcut to setup vector on a free list. */
2944 #define SETUP_ON_FREE_LIST(v, nbytes, index) \
2946 XSETPVECTYPESIZE (v, PVEC_FREE, nbytes); \
2947 eassert ((nbytes) % roundup_size == 0); \
2948 (index) = VINDEX (nbytes); \
2949 eassert ((index) < VECTOR_MAX_FREE_LIST_INDEX); \
2950 (v)->header.next.vector = vector_free_lists[index]; \
2951 vector_free_lists[index] = (v); \
2952 total_free_vector_slots += (nbytes) / word_size; \
2957 char data
[VECTOR_BLOCK_BYTES
];
2958 struct vector_block
*next
;
2961 /* Chain of vector blocks. */
2963 static struct vector_block
*vector_blocks
;
2965 /* Vector free lists, where NTH item points to a chain of free
2966 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2968 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2970 /* Singly-linked list of large vectors. */
2972 static struct Lisp_Vector
*large_vectors
;
2974 /* The only vector with 0 slots, allocated from pure space. */
2976 Lisp_Object zero_vector
;
2978 /* Number of live vectors. */
2980 static EMACS_INT total_vectors
;
2982 /* Total size of live and free vectors, in Lisp_Object units. */
2984 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
2986 /* Get a new vector block. */
2988 static struct vector_block
*
2989 allocate_vector_block (void)
2991 struct vector_block
*block
= xmalloc (sizeof *block
);
2993 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
2994 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
2995 MEM_TYPE_VECTOR_BLOCK
);
2998 block
->next
= vector_blocks
;
2999 vector_blocks
= block
;
3003 /* Called once to initialize vector allocation. */
3008 zero_vector
= make_pure_vector (0);
3011 /* Allocate vector from a vector block. */
3013 static struct Lisp_Vector
*
3014 allocate_vector_from_block (size_t nbytes
)
3016 struct Lisp_Vector
*vector
, *rest
;
3017 struct vector_block
*block
;
3018 size_t index
, restbytes
;
3020 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
3021 eassert (nbytes
% roundup_size
== 0);
3023 /* First, try to allocate from a free list
3024 containing vectors of the requested size. */
3025 index
= VINDEX (nbytes
);
3026 if (vector_free_lists
[index
])
3028 vector
= vector_free_lists
[index
];
3029 vector_free_lists
[index
] = vector
->header
.next
.vector
;
3030 vector
->header
.next
.nbytes
= nbytes
;
3031 total_free_vector_slots
-= nbytes
/ word_size
;
3035 /* Next, check free lists containing larger vectors. Since
3036 we will split the result, we should have remaining space
3037 large enough to use for one-slot vector at least. */
3038 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
3039 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
3040 if (vector_free_lists
[index
])
3042 /* This vector is larger than requested. */
3043 vector
= vector_free_lists
[index
];
3044 vector_free_lists
[index
] = vector
->header
.next
.vector
;
3045 vector
->header
.next
.nbytes
= nbytes
;
3046 total_free_vector_slots
-= nbytes
/ word_size
;
3048 /* Excess bytes are used for the smaller vector,
3049 which should be set on an appropriate free list. */
3050 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
3051 eassert (restbytes
% roundup_size
== 0);
3052 rest
= ADVANCE (vector
, nbytes
);
3053 SETUP_ON_FREE_LIST (rest
, restbytes
, index
);
3057 /* Finally, need a new vector block. */
3058 block
= allocate_vector_block ();
3060 /* New vector will be at the beginning of this block. */
3061 vector
= (struct Lisp_Vector
*) block
->data
;
3062 vector
->header
.next
.nbytes
= nbytes
;
3064 /* If the rest of space from this block is large enough
3065 for one-slot vector at least, set up it on a free list. */
3066 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
3067 if (restbytes
>= VBLOCK_BYTES_MIN
)
3069 eassert (restbytes
% roundup_size
== 0);
3070 rest
= ADVANCE (vector
, nbytes
);
3071 SETUP_ON_FREE_LIST (rest
, restbytes
, index
);
3076 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
3078 #define VECTOR_IN_BLOCK(vector, block) \
3079 ((char *) (vector) <= (block)->data \
3080 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
3082 /* Number of bytes used by vector-block-allocated object. This is the only
3083 place where we actually use the `nbytes' field of the vector-header.
3084 I.e. we could get rid of the `nbytes' field by computing it based on the
3087 #define PSEUDOVECTOR_NBYTES(vector) \
3088 (PSEUDOVECTOR_TYPEP (&vector->header, PVEC_FREE) \
3089 ? vector->header.size & PSEUDOVECTOR_SIZE_MASK \
3090 : vector->header.next.nbytes)
3092 /* Reclaim space used by unmarked vectors. */
3095 sweep_vectors (void)
3097 struct vector_block
*block
= vector_blocks
, **bprev
= &vector_blocks
;
3098 struct Lisp_Vector
*vector
, *next
, **vprev
= &large_vectors
;
3100 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
3101 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
3103 /* Looking through vector blocks. */
3105 for (block
= vector_blocks
; block
; block
= *bprev
)
3107 int free_this_block
= 0;
3109 for (vector
= (struct Lisp_Vector
*) block
->data
;
3110 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
3112 if (VECTOR_MARKED_P (vector
))
3114 VECTOR_UNMARK (vector
);
3116 total_vector_slots
+= vector
->header
.next
.nbytes
/ word_size
;
3117 next
= ADVANCE (vector
, vector
->header
.next
.nbytes
);
3121 ptrdiff_t nbytes
= PSEUDOVECTOR_NBYTES (vector
);
3122 ptrdiff_t total_bytes
= nbytes
;
3124 next
= ADVANCE (vector
, nbytes
);
3126 /* While NEXT is not marked, try to coalesce with VECTOR,
3127 thus making VECTOR of the largest possible size. */
3129 while (VECTOR_IN_BLOCK (next
, block
))
3131 if (VECTOR_MARKED_P (next
))
3133 nbytes
= PSEUDOVECTOR_NBYTES (next
);
3134 total_bytes
+= nbytes
;
3135 next
= ADVANCE (next
, nbytes
);
3138 eassert (total_bytes
% roundup_size
== 0);
3140 if (vector
== (struct Lisp_Vector
*) block
->data
3141 && !VECTOR_IN_BLOCK (next
, block
))
3142 /* This block should be freed because all of it's
3143 space was coalesced into the only free vector. */
3144 free_this_block
= 1;
3148 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
3153 if (free_this_block
)
3155 *bprev
= block
->next
;
3156 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
3157 mem_delete (mem_find (block
->data
));
3162 bprev
= &block
->next
;
3165 /* Sweep large vectors. */
3167 for (vector
= large_vectors
; vector
; vector
= *vprev
)
3169 if (VECTOR_MARKED_P (vector
))
3171 VECTOR_UNMARK (vector
);
3173 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
3175 struct Lisp_Bool_Vector
*b
= (struct Lisp_Bool_Vector
*) vector
;
3177 /* All non-bool pseudovectors are small enough to be allocated
3178 from vector blocks. This code should be redesigned if some
3179 pseudovector type grows beyond VBLOCK_BYTES_MAX. */
3180 eassert (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_BOOL_VECTOR
));
3183 += (bool_header_size
3184 + ((b
->size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1)
3185 / BOOL_VECTOR_BITS_PER_CHAR
)) / word_size
;
3189 += header_size
/ word_size
+ vector
->header
.size
;
3190 vprev
= &vector
->header
.next
.vector
;
3194 *vprev
= vector
->header
.next
.vector
;
3200 /* Value is a pointer to a newly allocated Lisp_Vector structure
3201 with room for LEN Lisp_Objects. */
3203 static struct Lisp_Vector
*
3204 allocate_vectorlike (ptrdiff_t len
)
3206 struct Lisp_Vector
*p
;
3210 /* This gets triggered by code which I haven't bothered to fix. --Stef */
3211 /* eassert (!handling_signal); */
3214 p
= XVECTOR (zero_vector
);
3217 size_t nbytes
= header_size
+ len
* word_size
;
3219 #ifdef DOUG_LEA_MALLOC
3220 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
3221 because mapped region contents are not preserved in
3223 mallopt (M_MMAP_MAX
, 0);
3226 if (nbytes
<= VBLOCK_BYTES_MAX
)
3227 p
= allocate_vector_from_block (vroundup (nbytes
));
3230 p
= lisp_malloc (nbytes
, MEM_TYPE_VECTORLIKE
);
3231 p
->header
.next
.vector
= large_vectors
;
3235 #ifdef DOUG_LEA_MALLOC
3236 /* Back to a reasonable maximum of mmap'ed areas. */
3237 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3240 consing_since_gc
+= nbytes
;
3241 vector_cells_consed
+= len
;
3244 MALLOC_UNBLOCK_INPUT
;
3250 /* Allocate a vector with LEN slots. */
3252 struct Lisp_Vector
*
3253 allocate_vector (EMACS_INT len
)
3255 struct Lisp_Vector
*v
;
3256 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3258 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3259 memory_full (SIZE_MAX
);
3260 v
= allocate_vectorlike (len
);
3261 v
->header
.size
= len
;
3266 /* Allocate other vector-like structures. */
3268 struct Lisp_Vector
*
3269 allocate_pseudovector (int memlen
, int lisplen
, int tag
)
3271 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3274 /* Only the first lisplen slots will be traced normally by the GC. */
3275 for (i
= 0; i
< lisplen
; ++i
)
3276 v
->contents
[i
] = Qnil
;
3278 XSETPVECTYPESIZE (v
, tag
, lisplen
);
3283 allocate_buffer (void)
3285 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3287 XSETPVECTYPESIZE (b
, PVEC_BUFFER
, (offsetof (struct buffer
, own_text
)
3288 - header_size
) / word_size
);
3289 /* Note that the fields of B are not initialized. */
3293 struct Lisp_Hash_Table
*
3294 allocate_hash_table (void)
3296 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
3300 allocate_window (void)
3304 w
= ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
3305 /* Users assumes that non-Lisp data is zeroed. */
3306 memset (&w
->current_matrix
, 0,
3307 sizeof (*w
) - offsetof (struct window
, current_matrix
));
3312 allocate_terminal (void)
3316 t
= ALLOCATE_PSEUDOVECTOR (struct terminal
, next_terminal
, PVEC_TERMINAL
);
3317 /* Users assumes that non-Lisp data is zeroed. */
3318 memset (&t
->next_terminal
, 0,
3319 sizeof (*t
) - offsetof (struct terminal
, next_terminal
));
3324 allocate_frame (void)
3328 f
= ALLOCATE_PSEUDOVECTOR (struct frame
, face_cache
, PVEC_FRAME
);
3329 /* Users assumes that non-Lisp data is zeroed. */
3330 memset (&f
->face_cache
, 0,
3331 sizeof (*f
) - offsetof (struct frame
, face_cache
));
3335 struct Lisp_Process
*
3336 allocate_process (void)
3338 struct Lisp_Process
*p
;
3340 p
= ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3341 /* Users assumes that non-Lisp data is zeroed. */
3343 sizeof (*p
) - offsetof (struct Lisp_Process
, pid
));
3347 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3348 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3349 See also the function `vector'. */)
3350 (register Lisp_Object length
, Lisp_Object init
)
3353 register ptrdiff_t sizei
;
3354 register ptrdiff_t i
;
3355 register struct Lisp_Vector
*p
;
3357 CHECK_NATNUM (length
);
3359 p
= allocate_vector (XFASTINT (length
));
3360 sizei
= XFASTINT (length
);
3361 for (i
= 0; i
< sizei
; i
++)
3362 p
->contents
[i
] = init
;
3364 XSETVECTOR (vector
, p
);
3369 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3370 doc
: /* Return a newly created vector with specified arguments as elements.
3371 Any number of arguments, even zero arguments, are allowed.
3372 usage: (vector &rest OBJECTS) */)
3373 (ptrdiff_t nargs
, Lisp_Object
*args
)
3375 register Lisp_Object len
, val
;
3377 register struct Lisp_Vector
*p
;
3379 XSETFASTINT (len
, nargs
);
3380 val
= Fmake_vector (len
, Qnil
);
3382 for (i
= 0; i
< nargs
; i
++)
3383 p
->contents
[i
] = args
[i
];
3388 make_byte_code (struct Lisp_Vector
*v
)
3390 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3391 && STRING_MULTIBYTE (v
->contents
[1]))
3392 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3393 earlier because they produced a raw 8-bit string for byte-code
3394 and now such a byte-code string is loaded as multibyte while
3395 raw 8-bit characters converted to multibyte form. Thus, now we
3396 must convert them back to the original unibyte form. */
3397 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3398 XSETPVECTYPE (v
, PVEC_COMPILED
);
3401 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3402 doc
: /* Create a byte-code object with specified arguments as elements.
3403 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3404 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3405 and (optional) INTERACTIVE-SPEC.
3406 The first four arguments are required; at most six have any
3408 The ARGLIST can be either like the one of `lambda', in which case the arguments
3409 will be dynamically bound before executing the byte code, or it can be an
3410 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3411 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3412 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3413 argument to catch the left-over arguments. If such an integer is used, the
3414 arguments will not be dynamically bound but will be instead pushed on the
3415 stack before executing the byte-code.
3416 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3417 (ptrdiff_t nargs
, Lisp_Object
*args
)
3419 register Lisp_Object len
, val
;
3421 register struct Lisp_Vector
*p
;
3423 /* We used to purecopy everything here, if purify-flga was set. This worked
3424 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3425 dangerous, since make-byte-code is used during execution to build
3426 closures, so any closure built during the preload phase would end up
3427 copied into pure space, including its free variables, which is sometimes
3428 just wasteful and other times plainly wrong (e.g. those free vars may want
3431 XSETFASTINT (len
, nargs
);
3432 val
= Fmake_vector (len
, Qnil
);
3435 for (i
= 0; i
< nargs
; i
++)
3436 p
->contents
[i
] = args
[i
];
3438 XSETCOMPILED (val
, p
);
3444 /***********************************************************************
3446 ***********************************************************************/
3448 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3449 of the required alignment if LSB tags are used. */
3451 union aligned_Lisp_Symbol
3453 struct Lisp_Symbol s
;
3455 unsigned char c
[(sizeof (struct Lisp_Symbol
) + (1 << GCTYPEBITS
) - 1)
3456 & -(1 << GCTYPEBITS
)];
3460 /* Each symbol_block is just under 1020 bytes long, since malloc
3461 really allocates in units of powers of two and uses 4 bytes for its
3464 #define SYMBOL_BLOCK_SIZE \
3465 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3469 /* Place `symbols' first, to preserve alignment. */
3470 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3471 struct symbol_block
*next
;
3474 /* Current symbol block and index of first unused Lisp_Symbol
3477 static struct symbol_block
*symbol_block
;
3478 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3480 /* List of free symbols. */
3482 static struct Lisp_Symbol
*symbol_free_list
;
3484 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3485 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3486 Its value and function definition are void, and its property list is nil. */)
3489 register Lisp_Object val
;
3490 register struct Lisp_Symbol
*p
;
3492 CHECK_STRING (name
);
3494 /* eassert (!handling_signal); */
3498 if (symbol_free_list
)
3500 XSETSYMBOL (val
, symbol_free_list
);
3501 symbol_free_list
= symbol_free_list
->next
;
3505 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3507 struct symbol_block
*new
3508 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3509 new->next
= symbol_block
;
3511 symbol_block_index
= 0;
3512 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3514 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3515 symbol_block_index
++;
3518 MALLOC_UNBLOCK_INPUT
;
3521 SVAR (p
, xname
) = name
;
3522 SVAR (p
, plist
) = Qnil
;
3523 p
->redirect
= SYMBOL_PLAINVAL
;
3524 SET_SYMBOL_VAL (p
, Qunbound
);
3525 SVAR (p
, function
) = Qunbound
;
3528 p
->interned
= SYMBOL_UNINTERNED
;
3530 p
->declared_special
= 0;
3531 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3533 total_free_symbols
--;
3539 /***********************************************************************
3540 Marker (Misc) Allocation
3541 ***********************************************************************/
3543 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3544 the required alignment when LSB tags are used. */
3546 union aligned_Lisp_Misc
3550 unsigned char c
[(sizeof (union Lisp_Misc
) + (1 << GCTYPEBITS
) - 1)
3551 & -(1 << GCTYPEBITS
)];
3555 /* Allocation of markers and other objects that share that structure.
3556 Works like allocation of conses. */
3558 #define MARKER_BLOCK_SIZE \
3559 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3563 /* Place `markers' first, to preserve alignment. */
3564 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3565 struct marker_block
*next
;
3568 static struct marker_block
*marker_block
;
3569 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3571 static union Lisp_Misc
*marker_free_list
;
3573 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3576 allocate_misc (enum Lisp_Misc_Type type
)
3580 /* eassert (!handling_signal); */
3584 if (marker_free_list
)
3586 XSETMISC (val
, marker_free_list
);
3587 marker_free_list
= marker_free_list
->u_free
.chain
;
3591 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3593 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3594 new->next
= marker_block
;
3596 marker_block_index
= 0;
3597 total_free_markers
+= MARKER_BLOCK_SIZE
;
3599 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3600 marker_block_index
++;
3603 MALLOC_UNBLOCK_INPUT
;
3605 --total_free_markers
;
3606 consing_since_gc
+= sizeof (union Lisp_Misc
);
3607 misc_objects_consed
++;
3608 XMISCTYPE (val
) = type
;
3609 XMISCANY (val
)->gcmarkbit
= 0;
3613 /* Free a Lisp_Misc object */
3616 free_misc (Lisp_Object misc
)
3618 XMISCTYPE (misc
) = Lisp_Misc_Free
;
3619 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3620 marker_free_list
= XMISC (misc
);
3621 consing_since_gc
-= sizeof (union Lisp_Misc
);
3622 total_free_markers
++;
3625 /* Return a Lisp_Misc_Save_Value object containing POINTER and
3626 INTEGER. This is used to package C values to call record_unwind_protect.
3627 The unwind function can get the C values back using XSAVE_VALUE. */
3630 make_save_value (void *pointer
, ptrdiff_t integer
)
3632 register Lisp_Object val
;
3633 register struct Lisp_Save_Value
*p
;
3635 val
= allocate_misc (Lisp_Misc_Save_Value
);
3636 p
= XSAVE_VALUE (val
);
3637 p
->pointer
= pointer
;
3638 p
->integer
= integer
;
3643 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3646 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3648 register Lisp_Object overlay
;
3650 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3651 OVERLAY_START (overlay
) = start
;
3652 OVERLAY_END (overlay
) = end
;
3653 OVERLAY_PLIST (overlay
) = plist
;
3654 XOVERLAY (overlay
)->next
= NULL
;
3658 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3659 doc
: /* Return a newly allocated marker which does not point at any place. */)
3662 register Lisp_Object val
;
3663 register struct Lisp_Marker
*p
;
3665 val
= allocate_misc (Lisp_Misc_Marker
);
3671 p
->insertion_type
= 0;
3675 /* Return a newly allocated marker which points into BUF
3676 at character position CHARPOS and byte position BYTEPOS. */
3679 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3682 struct Lisp_Marker
*m
;
3684 /* No dead buffers here. */
3685 eassert (!NILP (BVAR (buf
, name
)));
3687 /* Every character is at least one byte. */
3688 eassert (charpos
<= bytepos
);
3690 obj
= allocate_misc (Lisp_Misc_Marker
);
3693 m
->charpos
= charpos
;
3694 m
->bytepos
= bytepos
;
3695 m
->insertion_type
= 0;
3696 m
->next
= BUF_MARKERS (buf
);
3697 BUF_MARKERS (buf
) = m
;
3701 /* Put MARKER back on the free list after using it temporarily. */
3704 free_marker (Lisp_Object marker
)
3706 unchain_marker (XMARKER (marker
));
3711 /* Return a newly created vector or string with specified arguments as
3712 elements. If all the arguments are characters that can fit
3713 in a string of events, make a string; otherwise, make a vector.
3715 Any number of arguments, even zero arguments, are allowed. */
3718 make_event_array (register int nargs
, Lisp_Object
*args
)
3722 for (i
= 0; i
< nargs
; i
++)
3723 /* The things that fit in a string
3724 are characters that are in 0...127,
3725 after discarding the meta bit and all the bits above it. */
3726 if (!INTEGERP (args
[i
])
3727 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3728 return Fvector (nargs
, args
);
3730 /* Since the loop exited, we know that all the things in it are
3731 characters, so we can make a string. */
3735 result
= Fmake_string (make_number (nargs
), make_number (0));
3736 for (i
= 0; i
< nargs
; i
++)
3738 SSET (result
, i
, XINT (args
[i
]));
3739 /* Move the meta bit to the right place for a string char. */
3740 if (XINT (args
[i
]) & CHAR_META
)
3741 SSET (result
, i
, SREF (result
, i
) | 0x80);
3750 /************************************************************************
3751 Memory Full Handling
3752 ************************************************************************/
3755 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3756 there may have been size_t overflow so that malloc was never
3757 called, or perhaps malloc was invoked successfully but the
3758 resulting pointer had problems fitting into a tagged EMACS_INT. In
3759 either case this counts as memory being full even though malloc did
3763 memory_full (size_t nbytes
)
3765 /* Do not go into hysterics merely because a large request failed. */
3766 int enough_free_memory
= 0;
3767 if (SPARE_MEMORY
< nbytes
)
3772 p
= malloc (SPARE_MEMORY
);
3776 enough_free_memory
= 1;
3778 MALLOC_UNBLOCK_INPUT
;
3781 if (! enough_free_memory
)
3787 memory_full_cons_threshold
= sizeof (struct cons_block
);
3789 /* The first time we get here, free the spare memory. */
3790 for (i
= 0; i
< sizeof (spare_memory
) / sizeof (char *); i
++)
3791 if (spare_memory
[i
])
3794 free (spare_memory
[i
]);
3795 else if (i
>= 1 && i
<= 4)
3796 lisp_align_free (spare_memory
[i
]);
3798 lisp_free (spare_memory
[i
]);
3799 spare_memory
[i
] = 0;
3802 /* Record the space now used. When it decreases substantially,
3803 we can refill the memory reserve. */
3804 #if !defined SYSTEM_MALLOC && !defined SYNC_INPUT
3805 bytes_used_when_full
= BYTES_USED
;
3809 /* This used to call error, but if we've run out of memory, we could
3810 get infinite recursion trying to build the string. */
3811 xsignal (Qnil
, Vmemory_signal_data
);
3814 /* If we released our reserve (due to running out of memory),
3815 and we have a fair amount free once again,
3816 try to set aside another reserve in case we run out once more.
3818 This is called when a relocatable block is freed in ralloc.c,
3819 and also directly from this file, in case we're not using ralloc.c. */
3822 refill_memory_reserve (void)
3824 #ifndef SYSTEM_MALLOC
3825 if (spare_memory
[0] == 0)
3826 spare_memory
[0] = malloc (SPARE_MEMORY
);
3827 if (spare_memory
[1] == 0)
3828 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
3830 if (spare_memory
[2] == 0)
3831 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
3833 if (spare_memory
[3] == 0)
3834 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
3836 if (spare_memory
[4] == 0)
3837 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
3839 if (spare_memory
[5] == 0)
3840 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
3842 if (spare_memory
[6] == 0)
3843 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
3845 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3846 Vmemory_full
= Qnil
;
3850 /************************************************************************
3852 ************************************************************************/
3854 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3856 /* Conservative C stack marking requires a method to identify possibly
3857 live Lisp objects given a pointer value. We do this by keeping
3858 track of blocks of Lisp data that are allocated in a red-black tree
3859 (see also the comment of mem_node which is the type of nodes in
3860 that tree). Function lisp_malloc adds information for an allocated
3861 block to the red-black tree with calls to mem_insert, and function
3862 lisp_free removes it with mem_delete. Functions live_string_p etc
3863 call mem_find to lookup information about a given pointer in the
3864 tree, and use that to determine if the pointer points to a Lisp
3867 /* Initialize this part of alloc.c. */
3872 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3873 mem_z
.parent
= NULL
;
3874 mem_z
.color
= MEM_BLACK
;
3875 mem_z
.start
= mem_z
.end
= NULL
;
3880 /* Value is a pointer to the mem_node containing START. Value is
3881 MEM_NIL if there is no node in the tree containing START. */
3883 static inline struct mem_node
*
3884 mem_find (void *start
)
3888 if (start
< min_heap_address
|| start
> max_heap_address
)
3891 /* Make the search always successful to speed up the loop below. */
3892 mem_z
.start
= start
;
3893 mem_z
.end
= (char *) start
+ 1;
3896 while (start
< p
->start
|| start
>= p
->end
)
3897 p
= start
< p
->start
? p
->left
: p
->right
;
3902 /* Insert a new node into the tree for a block of memory with start
3903 address START, end address END, and type TYPE. Value is a
3904 pointer to the node that was inserted. */
3906 static struct mem_node
*
3907 mem_insert (void *start
, void *end
, enum mem_type type
)
3909 struct mem_node
*c
, *parent
, *x
;
3911 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3912 min_heap_address
= start
;
3913 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3914 max_heap_address
= end
;
3916 /* See where in the tree a node for START belongs. In this
3917 particular application, it shouldn't happen that a node is already
3918 present. For debugging purposes, let's check that. */
3922 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3924 while (c
!= MEM_NIL
)
3926 if (start
>= c
->start
&& start
< c
->end
)
3929 c
= start
< c
->start
? c
->left
: c
->right
;
3932 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3934 while (c
!= MEM_NIL
)
3937 c
= start
< c
->start
? c
->left
: c
->right
;
3940 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3942 /* Create a new node. */
3943 #ifdef GC_MALLOC_CHECK
3944 x
= _malloc_internal (sizeof *x
);
3948 x
= xmalloc (sizeof *x
);
3954 x
->left
= x
->right
= MEM_NIL
;
3957 /* Insert it as child of PARENT or install it as root. */
3960 if (start
< parent
->start
)
3968 /* Re-establish red-black tree properties. */
3969 mem_insert_fixup (x
);
3975 /* Re-establish the red-black properties of the tree, and thereby
3976 balance the tree, after node X has been inserted; X is always red. */
3979 mem_insert_fixup (struct mem_node
*x
)
3981 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3983 /* X is red and its parent is red. This is a violation of
3984 red-black tree property #3. */
3986 if (x
->parent
== x
->parent
->parent
->left
)
3988 /* We're on the left side of our grandparent, and Y is our
3990 struct mem_node
*y
= x
->parent
->parent
->right
;
3992 if (y
->color
== MEM_RED
)
3994 /* Uncle and parent are red but should be black because
3995 X is red. Change the colors accordingly and proceed
3996 with the grandparent. */
3997 x
->parent
->color
= MEM_BLACK
;
3998 y
->color
= MEM_BLACK
;
3999 x
->parent
->parent
->color
= MEM_RED
;
4000 x
= x
->parent
->parent
;
4004 /* Parent and uncle have different colors; parent is
4005 red, uncle is black. */
4006 if (x
== x
->parent
->right
)
4009 mem_rotate_left (x
);
4012 x
->parent
->color
= MEM_BLACK
;
4013 x
->parent
->parent
->color
= MEM_RED
;
4014 mem_rotate_right (x
->parent
->parent
);
4019 /* This is the symmetrical case of above. */
4020 struct mem_node
*y
= x
->parent
->parent
->left
;
4022 if (y
->color
== MEM_RED
)
4024 x
->parent
->color
= MEM_BLACK
;
4025 y
->color
= MEM_BLACK
;
4026 x
->parent
->parent
->color
= MEM_RED
;
4027 x
= x
->parent
->parent
;
4031 if (x
== x
->parent
->left
)
4034 mem_rotate_right (x
);
4037 x
->parent
->color
= MEM_BLACK
;
4038 x
->parent
->parent
->color
= MEM_RED
;
4039 mem_rotate_left (x
->parent
->parent
);
4044 /* The root may have been changed to red due to the algorithm. Set
4045 it to black so that property #5 is satisfied. */
4046 mem_root
->color
= MEM_BLACK
;
4057 mem_rotate_left (struct mem_node
*x
)
4061 /* Turn y's left sub-tree into x's right sub-tree. */
4064 if (y
->left
!= MEM_NIL
)
4065 y
->left
->parent
= x
;
4067 /* Y's parent was x's parent. */
4069 y
->parent
= x
->parent
;
4071 /* Get the parent to point to y instead of x. */
4074 if (x
== x
->parent
->left
)
4075 x
->parent
->left
= y
;
4077 x
->parent
->right
= y
;
4082 /* Put x on y's left. */
4096 mem_rotate_right (struct mem_node
*x
)
4098 struct mem_node
*y
= x
->left
;
4101 if (y
->right
!= MEM_NIL
)
4102 y
->right
->parent
= x
;
4105 y
->parent
= x
->parent
;
4108 if (x
== x
->parent
->right
)
4109 x
->parent
->right
= y
;
4111 x
->parent
->left
= y
;
4122 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4125 mem_delete (struct mem_node
*z
)
4127 struct mem_node
*x
, *y
;
4129 if (!z
|| z
== MEM_NIL
)
4132 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4137 while (y
->left
!= MEM_NIL
)
4141 if (y
->left
!= MEM_NIL
)
4146 x
->parent
= y
->parent
;
4149 if (y
== y
->parent
->left
)
4150 y
->parent
->left
= x
;
4152 y
->parent
->right
= x
;
4159 z
->start
= y
->start
;
4164 if (y
->color
== MEM_BLACK
)
4165 mem_delete_fixup (x
);
4167 #ifdef GC_MALLOC_CHECK
4175 /* Re-establish the red-black properties of the tree, after a
4179 mem_delete_fixup (struct mem_node
*x
)
4181 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4183 if (x
== x
->parent
->left
)
4185 struct mem_node
*w
= x
->parent
->right
;
4187 if (w
->color
== MEM_RED
)
4189 w
->color
= MEM_BLACK
;
4190 x
->parent
->color
= MEM_RED
;
4191 mem_rotate_left (x
->parent
);
4192 w
= x
->parent
->right
;
4195 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4202 if (w
->right
->color
== MEM_BLACK
)
4204 w
->left
->color
= MEM_BLACK
;
4206 mem_rotate_right (w
);
4207 w
= x
->parent
->right
;
4209 w
->color
= x
->parent
->color
;
4210 x
->parent
->color
= MEM_BLACK
;
4211 w
->right
->color
= MEM_BLACK
;
4212 mem_rotate_left (x
->parent
);
4218 struct mem_node
*w
= x
->parent
->left
;
4220 if (w
->color
== MEM_RED
)
4222 w
->color
= MEM_BLACK
;
4223 x
->parent
->color
= MEM_RED
;
4224 mem_rotate_right (x
->parent
);
4225 w
= x
->parent
->left
;
4228 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4235 if (w
->left
->color
== MEM_BLACK
)
4237 w
->right
->color
= MEM_BLACK
;
4239 mem_rotate_left (w
);
4240 w
= x
->parent
->left
;
4243 w
->color
= x
->parent
->color
;
4244 x
->parent
->color
= MEM_BLACK
;
4245 w
->left
->color
= MEM_BLACK
;
4246 mem_rotate_right (x
->parent
);
4252 x
->color
= MEM_BLACK
;
4256 /* Value is non-zero if P is a pointer to a live Lisp string on
4257 the heap. M is a pointer to the mem_block for P. */
4260 live_string_p (struct mem_node
*m
, void *p
)
4262 if (m
->type
== MEM_TYPE_STRING
)
4264 struct string_block
*b
= (struct string_block
*) m
->start
;
4265 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4267 /* P must point to the start of a Lisp_String structure, and it
4268 must not be on the free-list. */
4270 && offset
% sizeof b
->strings
[0] == 0
4271 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4272 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4279 /* Value is non-zero if P is a pointer to a live Lisp cons on
4280 the heap. M is a pointer to the mem_block for P. */
4283 live_cons_p (struct mem_node
*m
, void *p
)
4285 if (m
->type
== MEM_TYPE_CONS
)
4287 struct cons_block
*b
= (struct cons_block
*) m
->start
;
4288 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4290 /* P must point to the start of a Lisp_Cons, not be
4291 one of the unused cells in the current cons block,
4292 and not be on the free-list. */
4294 && offset
% sizeof b
->conses
[0] == 0
4295 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4297 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4298 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
4305 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4306 the heap. M is a pointer to the mem_block for P. */
4309 live_symbol_p (struct mem_node
*m
, void *p
)
4311 if (m
->type
== MEM_TYPE_SYMBOL
)
4313 struct symbol_block
*b
= (struct symbol_block
*) m
->start
;
4314 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4316 /* P must point to the start of a Lisp_Symbol, not be
4317 one of the unused cells in the current symbol block,
4318 and not be on the free-list. */
4320 && offset
% sizeof b
->symbols
[0] == 0
4321 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4322 && (b
!= symbol_block
4323 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4324 && !EQ (SVAR (((struct Lisp_Symbol
*)p
), function
), Vdead
));
4331 /* Value is non-zero if P is a pointer to a live Lisp float on
4332 the heap. M is a pointer to the mem_block for P. */
4335 live_float_p (struct mem_node
*m
, void *p
)
4337 if (m
->type
== MEM_TYPE_FLOAT
)
4339 struct float_block
*b
= (struct float_block
*) m
->start
;
4340 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4342 /* P must point to the start of a Lisp_Float and not be
4343 one of the unused cells in the current float block. */
4345 && offset
% sizeof b
->floats
[0] == 0
4346 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4347 && (b
!= float_block
4348 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4355 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4356 the heap. M is a pointer to the mem_block for P. */
4359 live_misc_p (struct mem_node
*m
, void *p
)
4361 if (m
->type
== MEM_TYPE_MISC
)
4363 struct marker_block
*b
= (struct marker_block
*) m
->start
;
4364 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4366 /* P must point to the start of a Lisp_Misc, not be
4367 one of the unused cells in the current misc block,
4368 and not be on the free-list. */
4370 && offset
% sizeof b
->markers
[0] == 0
4371 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4372 && (b
!= marker_block
4373 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4374 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4381 /* Value is non-zero if P is a pointer to a live vector-like object.
4382 M is a pointer to the mem_block for P. */
4385 live_vector_p (struct mem_node
*m
, void *p
)
4387 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4389 /* This memory node corresponds to a vector block. */
4390 struct vector_block
*block
= (struct vector_block
*) m
->start
;
4391 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4393 /* P is in the block's allocation range. Scan the block
4394 up to P and see whether P points to the start of some
4395 vector which is not on a free list. FIXME: check whether
4396 some allocation patterns (probably a lot of short vectors)
4397 may cause a substantial overhead of this loop. */
4398 while (VECTOR_IN_BLOCK (vector
, block
)
4399 && vector
<= (struct Lisp_Vector
*) p
)
4401 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
))
4402 vector
= ADVANCE (vector
, (vector
->header
.size
4403 & PSEUDOVECTOR_SIZE_MASK
));
4404 else if (vector
== p
)
4407 vector
= ADVANCE (vector
, vector
->header
.next
.nbytes
);
4410 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== m
->start
)
4411 /* This memory node corresponds to a large vector. */
4417 /* Value is non-zero if P is a pointer to a live buffer. M is a
4418 pointer to the mem_block for P. */
4421 live_buffer_p (struct mem_node
*m
, void *p
)
4423 /* P must point to the start of the block, and the buffer
4424 must not have been killed. */
4425 return (m
->type
== MEM_TYPE_BUFFER
4427 && !NILP (((struct buffer
*) p
)->INTERNAL_FIELD (name
)));
4430 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4434 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4436 /* Array of objects that are kept alive because the C stack contains
4437 a pattern that looks like a reference to them . */
4439 #define MAX_ZOMBIES 10
4440 static Lisp_Object zombies
[MAX_ZOMBIES
];
4442 /* Number of zombie objects. */
4444 static EMACS_INT nzombies
;
4446 /* Number of garbage collections. */
4448 static EMACS_INT ngcs
;
4450 /* Average percentage of zombies per collection. */
4452 static double avg_zombies
;
4454 /* Max. number of live and zombie objects. */
4456 static EMACS_INT max_live
, max_zombies
;
4458 /* Average number of live objects per GC. */
4460 static double avg_live
;
4462 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4463 doc
: /* Show information about live and zombie objects. */)
4466 Lisp_Object args
[8], zombie_list
= Qnil
;
4468 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); i
++)
4469 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4470 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4471 args
[1] = make_number (ngcs
);
4472 args
[2] = make_float (avg_live
);
4473 args
[3] = make_float (avg_zombies
);
4474 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4475 args
[5] = make_number (max_live
);
4476 args
[6] = make_number (max_zombies
);
4477 args
[7] = zombie_list
;
4478 return Fmessage (8, args
);
4481 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4484 /* Mark OBJ if we can prove it's a Lisp_Object. */
4487 mark_maybe_object (Lisp_Object obj
)
4495 po
= (void *) XPNTR (obj
);
4502 switch (XTYPE (obj
))
4505 mark_p
= (live_string_p (m
, po
)
4506 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4510 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4514 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4518 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4521 case Lisp_Vectorlike
:
4522 /* Note: can't check BUFFERP before we know it's a
4523 buffer because checking that dereferences the pointer
4524 PO which might point anywhere. */
4525 if (live_vector_p (m
, po
))
4526 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4527 else if (live_buffer_p (m
, po
))
4528 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4532 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4541 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4542 if (nzombies
< MAX_ZOMBIES
)
4543 zombies
[nzombies
] = obj
;
4552 /* If P points to Lisp data, mark that as live if it isn't already
4556 mark_maybe_pointer (void *p
)
4560 /* Quickly rule out some values which can't point to Lisp data.
4561 USE_LSB_TAG needs Lisp data to be aligned on multiples of 1 << GCTYPEBITS.
4562 Otherwise, assume that Lisp data is aligned on even addresses. */
4563 if ((intptr_t) p
% (USE_LSB_TAG
? 1 << GCTYPEBITS
: 2))
4569 Lisp_Object obj
= Qnil
;
4573 case MEM_TYPE_NON_LISP
:
4574 /* Nothing to do; not a pointer to Lisp memory. */
4577 case MEM_TYPE_BUFFER
:
4578 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4579 XSETVECTOR (obj
, p
);
4583 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4587 case MEM_TYPE_STRING
:
4588 if (live_string_p (m
, p
)
4589 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4590 XSETSTRING (obj
, p
);
4594 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4598 case MEM_TYPE_SYMBOL
:
4599 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4600 XSETSYMBOL (obj
, p
);
4603 case MEM_TYPE_FLOAT
:
4604 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4608 case MEM_TYPE_VECTORLIKE
:
4609 case MEM_TYPE_VECTOR_BLOCK
:
4610 if (live_vector_p (m
, p
))
4613 XSETVECTOR (tem
, p
);
4614 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4629 /* Alignment of pointer values. Use alignof, as it sometimes returns
4630 a smaller alignment than GCC's __alignof__ and mark_memory might
4631 miss objects if __alignof__ were used. */
4632 #define GC_POINTER_ALIGNMENT alignof (void *)
4634 /* Define POINTERS_MIGHT_HIDE_IN_OBJECTS to 1 if marking via C pointers does
4635 not suffice, which is the typical case. A host where a Lisp_Object is
4636 wider than a pointer might allocate a Lisp_Object in non-adjacent halves.
4637 If USE_LSB_TAG, the bottom half is not a valid pointer, but it should
4638 suffice to widen it to to a Lisp_Object and check it that way. */
4639 #if USE_LSB_TAG || VAL_MAX < UINTPTR_MAX
4640 # if !USE_LSB_TAG && VAL_MAX < UINTPTR_MAX >> GCTYPEBITS
4641 /* If tag bits straddle pointer-word boundaries, neither mark_maybe_pointer
4642 nor mark_maybe_object can follow the pointers. This should not occur on
4643 any practical porting target. */
4644 # error "MSB type bits straddle pointer-word boundaries"
4646 /* Marking via C pointers does not suffice, because Lisp_Objects contain
4647 pointer words that hold pointers ORed with type bits. */
4648 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 1
4650 /* Marking via C pointers suffices, because Lisp_Objects contain pointer
4651 words that hold unmodified pointers. */
4652 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 0
4655 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4656 or END+OFFSET..START. */
4659 mark_memory (void *start
, void *end
)
4660 #if defined (__clang__) && defined (__has_feature)
4661 #if __has_feature(address_sanitizer)
4662 /* Do not allow -faddress-sanitizer to check this function, since it
4663 crosses the function stack boundary, and thus would yield many
4665 __attribute__((no_address_safety_analysis
))
4672 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4676 /* Make START the pointer to the start of the memory region,
4677 if it isn't already. */
4685 /* Mark Lisp data pointed to. This is necessary because, in some
4686 situations, the C compiler optimizes Lisp objects away, so that
4687 only a pointer to them remains. Example:
4689 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4692 Lisp_Object obj = build_string ("test");
4693 struct Lisp_String *s = XSTRING (obj);
4694 Fgarbage_collect ();
4695 fprintf (stderr, "test `%s'\n", s->data);
4699 Here, `obj' isn't really used, and the compiler optimizes it
4700 away. The only reference to the life string is through the
4703 for (pp
= start
; (void *) pp
< end
; pp
++)
4704 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4706 void *p
= *(void **) ((char *) pp
+ i
);
4707 mark_maybe_pointer (p
);
4708 if (POINTERS_MIGHT_HIDE_IN_OBJECTS
)
4709 mark_maybe_object (XIL ((intptr_t) p
));
4713 /* setjmp will work with GCC unless NON_SAVING_SETJMP is defined in
4714 the GCC system configuration. In gcc 3.2, the only systems for
4715 which this is so are i386-sco5 non-ELF, i386-sysv3 (maybe included
4716 by others?) and ns32k-pc532-min. */
4718 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4720 static int setjmp_tested_p
, longjmps_done
;
4722 #define SETJMP_WILL_LIKELY_WORK "\
4724 Emacs garbage collector has been changed to use conservative stack\n\
4725 marking. Emacs has determined that the method it uses to do the\n\
4726 marking will likely work on your system, but this isn't sure.\n\
4728 If you are a system-programmer, or can get the help of a local wizard\n\
4729 who is, please take a look at the function mark_stack in alloc.c, and\n\
4730 verify that the methods used are appropriate for your system.\n\
4732 Please mail the result to <emacs-devel@gnu.org>.\n\
4735 #define SETJMP_WILL_NOT_WORK "\
4737 Emacs garbage collector has been changed to use conservative stack\n\
4738 marking. Emacs has determined that the default method it uses to do the\n\
4739 marking will not work on your system. We will need a system-dependent\n\
4740 solution for your system.\n\
4742 Please take a look at the function mark_stack in alloc.c, and\n\
4743 try to find a way to make it work on your system.\n\
4745 Note that you may get false negatives, depending on the compiler.\n\
4746 In particular, you need to use -O with GCC for this test.\n\
4748 Please mail the result to <emacs-devel@gnu.org>.\n\
4752 /* Perform a quick check if it looks like setjmp saves registers in a
4753 jmp_buf. Print a message to stderr saying so. When this test
4754 succeeds, this is _not_ a proof that setjmp is sufficient for
4755 conservative stack marking. Only the sources or a disassembly
4766 /* Arrange for X to be put in a register. */
4772 if (longjmps_done
== 1)
4774 /* Came here after the longjmp at the end of the function.
4776 If x == 1, the longjmp has restored the register to its
4777 value before the setjmp, and we can hope that setjmp
4778 saves all such registers in the jmp_buf, although that
4781 For other values of X, either something really strange is
4782 taking place, or the setjmp just didn't save the register. */
4785 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4788 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4795 if (longjmps_done
== 1)
4799 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4802 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4804 /* Abort if anything GCPRO'd doesn't survive the GC. */
4812 for (p
= gcprolist
; p
; p
= p
->next
)
4813 for (i
= 0; i
< p
->nvars
; ++i
)
4814 if (!survives_gc_p (p
->var
[i
]))
4815 /* FIXME: It's not necessarily a bug. It might just be that the
4816 GCPRO is unnecessary or should release the object sooner. */
4820 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4827 fprintf (stderr
, "\nZombies kept alive = %"pI
"d:\n", nzombies
);
4828 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4830 fprintf (stderr
, " %d = ", i
);
4831 debug_print (zombies
[i
]);
4835 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4838 /* Mark live Lisp objects on the C stack.
4840 There are several system-dependent problems to consider when
4841 porting this to new architectures:
4845 We have to mark Lisp objects in CPU registers that can hold local
4846 variables or are used to pass parameters.
4848 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4849 something that either saves relevant registers on the stack, or
4850 calls mark_maybe_object passing it each register's contents.
4852 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4853 implementation assumes that calling setjmp saves registers we need
4854 to see in a jmp_buf which itself lies on the stack. This doesn't
4855 have to be true! It must be verified for each system, possibly
4856 by taking a look at the source code of setjmp.
4858 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4859 can use it as a machine independent method to store all registers
4860 to the stack. In this case the macros described in the previous
4861 two paragraphs are not used.
4865 Architectures differ in the way their processor stack is organized.
4866 For example, the stack might look like this
4869 | Lisp_Object | size = 4
4871 | something else | size = 2
4873 | Lisp_Object | size = 4
4877 In such a case, not every Lisp_Object will be aligned equally. To
4878 find all Lisp_Object on the stack it won't be sufficient to walk
4879 the stack in steps of 4 bytes. Instead, two passes will be
4880 necessary, one starting at the start of the stack, and a second
4881 pass starting at the start of the stack + 2. Likewise, if the
4882 minimal alignment of Lisp_Objects on the stack is 1, four passes
4883 would be necessary, each one starting with one byte more offset
4884 from the stack start. */
4891 #ifdef HAVE___BUILTIN_UNWIND_INIT
4892 /* Force callee-saved registers and register windows onto the stack.
4893 This is the preferred method if available, obviating the need for
4894 machine dependent methods. */
4895 __builtin_unwind_init ();
4897 #else /* not HAVE___BUILTIN_UNWIND_INIT */
4898 #ifndef GC_SAVE_REGISTERS_ON_STACK
4899 /* jmp_buf may not be aligned enough on darwin-ppc64 */
4900 union aligned_jmpbuf
{
4904 volatile int stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4906 /* This trick flushes the register windows so that all the state of
4907 the process is contained in the stack. */
4908 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4909 needed on ia64 too. See mach_dep.c, where it also says inline
4910 assembler doesn't work with relevant proprietary compilers. */
4912 #if defined (__sparc64__) && defined (__FreeBSD__)
4913 /* FreeBSD does not have a ta 3 handler. */
4920 /* Save registers that we need to see on the stack. We need to see
4921 registers used to hold register variables and registers used to
4923 #ifdef GC_SAVE_REGISTERS_ON_STACK
4924 GC_SAVE_REGISTERS_ON_STACK (end
);
4925 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4927 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4928 setjmp will definitely work, test it
4929 and print a message with the result
4931 if (!setjmp_tested_p
)
4933 setjmp_tested_p
= 1;
4936 #endif /* GC_SETJMP_WORKS */
4939 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4940 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4941 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
4943 /* This assumes that the stack is a contiguous region in memory. If
4944 that's not the case, something has to be done here to iterate
4945 over the stack segments. */
4946 mark_memory (stack_base
, end
);
4948 /* Allow for marking a secondary stack, like the register stack on the
4950 #ifdef GC_MARK_SECONDARY_STACK
4951 GC_MARK_SECONDARY_STACK ();
4954 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4959 #endif /* GC_MARK_STACK != 0 */
4962 /* Determine whether it is safe to access memory at address P. */
4964 valid_pointer_p (void *p
)
4967 return w32_valid_pointer_p (p
, 16);
4971 /* Obviously, we cannot just access it (we would SEGV trying), so we
4972 trick the o/s to tell us whether p is a valid pointer.
4973 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4974 not validate p in that case. */
4978 int valid
= (emacs_write (fd
[1], (char *) p
, 16) == 16);
4979 emacs_close (fd
[1]);
4980 emacs_close (fd
[0]);
4988 /* Return 1 if OBJ is a valid lisp object.
4989 Return 0 if OBJ is NOT a valid lisp object.
4990 Return -1 if we cannot validate OBJ.
4991 This function can be quite slow,
4992 so it should only be used in code for manual debugging. */
4995 valid_lisp_object_p (Lisp_Object obj
)
5005 p
= (void *) XPNTR (obj
);
5006 if (PURE_POINTER_P (p
))
5010 return valid_pointer_p (p
);
5017 int valid
= valid_pointer_p (p
);
5029 case MEM_TYPE_NON_LISP
:
5032 case MEM_TYPE_BUFFER
:
5033 return live_buffer_p (m
, p
);
5036 return live_cons_p (m
, p
);
5038 case MEM_TYPE_STRING
:
5039 return live_string_p (m
, p
);
5042 return live_misc_p (m
, p
);
5044 case MEM_TYPE_SYMBOL
:
5045 return live_symbol_p (m
, p
);
5047 case MEM_TYPE_FLOAT
:
5048 return live_float_p (m
, p
);
5050 case MEM_TYPE_VECTORLIKE
:
5051 case MEM_TYPE_VECTOR_BLOCK
:
5052 return live_vector_p (m
, p
);
5065 /***********************************************************************
5066 Pure Storage Management
5067 ***********************************************************************/
5069 /* Allocate room for SIZE bytes from pure Lisp storage and return a
5070 pointer to it. TYPE is the Lisp type for which the memory is
5071 allocated. TYPE < 0 means it's not used for a Lisp object. */
5074 pure_alloc (size_t size
, int type
)
5078 size_t alignment
= (1 << GCTYPEBITS
);
5080 size_t alignment
= alignof (EMACS_INT
);
5082 /* Give Lisp_Floats an extra alignment. */
5083 if (type
== Lisp_Float
)
5084 alignment
= alignof (struct Lisp_Float
);
5090 /* Allocate space for a Lisp object from the beginning of the free
5091 space with taking account of alignment. */
5092 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
5093 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
5097 /* Allocate space for a non-Lisp object from the end of the free
5099 pure_bytes_used_non_lisp
+= size
;
5100 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5102 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
5104 if (pure_bytes_used
<= pure_size
)
5107 /* Don't allocate a large amount here,
5108 because it might get mmap'd and then its address
5109 might not be usable. */
5110 purebeg
= xmalloc (10000);
5112 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
5113 pure_bytes_used
= 0;
5114 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
5119 /* Print a warning if PURESIZE is too small. */
5122 check_pure_size (void)
5124 if (pure_bytes_used_before_overflow
)
5125 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
5127 pure_bytes_used
+ pure_bytes_used_before_overflow
);
5131 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
5132 the non-Lisp data pool of the pure storage, and return its start
5133 address. Return NULL if not found. */
5136 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5139 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5140 const unsigned char *p
;
5143 if (pure_bytes_used_non_lisp
<= nbytes
)
5146 /* Set up the Boyer-Moore table. */
5148 for (i
= 0; i
< 256; i
++)
5151 p
= (const unsigned char *) data
;
5153 bm_skip
[*p
++] = skip
;
5155 last_char_skip
= bm_skip
['\0'];
5157 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5158 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5160 /* See the comments in the function `boyer_moore' (search.c) for the
5161 use of `infinity'. */
5162 infinity
= pure_bytes_used_non_lisp
+ 1;
5163 bm_skip
['\0'] = infinity
;
5165 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5169 /* Check the last character (== '\0'). */
5172 start
+= bm_skip
[*(p
+ start
)];
5174 while (start
<= start_max
);
5176 if (start
< infinity
)
5177 /* Couldn't find the last character. */
5180 /* No less than `infinity' means we could find the last
5181 character at `p[start - infinity]'. */
5184 /* Check the remaining characters. */
5185 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5187 return non_lisp_beg
+ start
;
5189 start
+= last_char_skip
;
5191 while (start
<= start_max
);
5197 /* Return a string allocated in pure space. DATA is a buffer holding
5198 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5199 non-zero means make the result string multibyte.
5201 Must get an error if pure storage is full, since if it cannot hold
5202 a large string it may be able to hold conses that point to that
5203 string; then the string is not protected from gc. */
5206 make_pure_string (const char *data
,
5207 ptrdiff_t nchars
, ptrdiff_t nbytes
, int multibyte
)
5210 struct Lisp_String
*s
;
5212 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
5213 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5214 if (s
->data
== NULL
)
5216 s
->data
= (unsigned char *) pure_alloc (nbytes
+ 1, -1);
5217 memcpy (s
->data
, data
, nbytes
);
5218 s
->data
[nbytes
] = '\0';
5221 s
->size_byte
= multibyte
? nbytes
: -1;
5222 s
->intervals
= NULL_INTERVAL
;
5223 XSETSTRING (string
, s
);
5227 /* Return a string allocated in pure space. Do not
5228 allocate the string data, just point to DATA. */
5231 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5234 struct Lisp_String
*s
;
5236 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
5239 s
->data
= (unsigned char *) data
;
5240 s
->intervals
= NULL_INTERVAL
;
5241 XSETSTRING (string
, s
);
5245 /* Return a cons allocated from pure space. Give it pure copies
5246 of CAR as car and CDR as cdr. */
5249 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5251 register Lisp_Object
new;
5252 struct Lisp_Cons
*p
;
5254 p
= (struct Lisp_Cons
*) pure_alloc (sizeof *p
, Lisp_Cons
);
5256 XSETCAR (new, Fpurecopy (car
));
5257 XSETCDR (new, Fpurecopy (cdr
));
5262 /* Value is a float object with value NUM allocated from pure space. */
5265 make_pure_float (double num
)
5267 register Lisp_Object
new;
5268 struct Lisp_Float
*p
;
5270 p
= (struct Lisp_Float
*) pure_alloc (sizeof *p
, Lisp_Float
);
5272 XFLOAT_INIT (new, num
);
5277 /* Return a vector with room for LEN Lisp_Objects allocated from
5281 make_pure_vector (ptrdiff_t len
)
5284 struct Lisp_Vector
*p
;
5285 size_t size
= header_size
+ len
* word_size
;
5287 p
= (struct Lisp_Vector
*) pure_alloc (size
, Lisp_Vectorlike
);
5288 XSETVECTOR (new, p
);
5289 XVECTOR (new)->header
.size
= len
;
5294 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5295 doc
: /* Make a copy of object OBJ in pure storage.
5296 Recursively copies contents of vectors and cons cells.
5297 Does not copy symbols. Copies strings without text properties. */)
5298 (register Lisp_Object obj
)
5300 if (NILP (Vpurify_flag
))
5303 if (PURE_POINTER_P (XPNTR (obj
)))
5306 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5308 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5314 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5315 else if (FLOATP (obj
))
5316 obj
= make_pure_float (XFLOAT_DATA (obj
));
5317 else if (STRINGP (obj
))
5318 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5320 STRING_MULTIBYTE (obj
));
5321 else if (COMPILEDP (obj
) || VECTORP (obj
))
5323 register struct Lisp_Vector
*vec
;
5324 register ptrdiff_t i
;
5328 if (size
& PSEUDOVECTOR_FLAG
)
5329 size
&= PSEUDOVECTOR_SIZE_MASK
;
5330 vec
= XVECTOR (make_pure_vector (size
));
5331 for (i
= 0; i
< size
; i
++)
5332 vec
->contents
[i
] = Fpurecopy (AREF (obj
, i
));
5333 if (COMPILEDP (obj
))
5335 XSETPVECTYPE (vec
, PVEC_COMPILED
);
5336 XSETCOMPILED (obj
, vec
);
5339 XSETVECTOR (obj
, vec
);
5341 else if (MARKERP (obj
))
5342 error ("Attempt to copy a marker to pure storage");
5344 /* Not purified, don't hash-cons. */
5347 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5348 Fputhash (obj
, obj
, Vpurify_flag
);
5355 /***********************************************************************
5357 ***********************************************************************/
5359 /* Put an entry in staticvec, pointing at the variable with address
5363 staticpro (Lisp_Object
*varaddress
)
5365 staticvec
[staticidx
++] = varaddress
;
5366 if (staticidx
>= NSTATICS
)
5371 /***********************************************************************
5373 ***********************************************************************/
5375 /* Temporarily prevent garbage collection. */
5378 inhibit_garbage_collection (void)
5380 ptrdiff_t count
= SPECPDL_INDEX ();
5382 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5386 /* Used to avoid possible overflows when
5387 converting from C to Lisp integers. */
5389 static inline Lisp_Object
5390 bounded_number (EMACS_INT number
)
5392 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5395 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5396 doc
: /* Reclaim storage for Lisp objects no longer needed.
5397 Garbage collection happens automatically if you cons more than
5398 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5399 `garbage-collect' normally returns a list with info on amount of space in use,
5400 where each entry has the form (NAME SIZE USED FREE), where:
5401 - NAME is a symbol describing the kind of objects this entry represents,
5402 - SIZE is the number of bytes used by each one,
5403 - USED is the number of those objects that were found live in the heap,
5404 - FREE is the number of those objects that are not live but that Emacs
5405 keeps around for future allocations (maybe because it does not know how
5406 to return them to the OS).
5407 However, if there was overflow in pure space, `garbage-collect'
5408 returns nil, because real GC can't be done.
5409 See Info node `(elisp)Garbage Collection'. */)
5412 register struct specbinding
*bind
;
5413 register struct buffer
*nextb
;
5414 char stack_top_variable
;
5417 Lisp_Object total
[11];
5418 ptrdiff_t count
= SPECPDL_INDEX ();
5424 /* Can't GC if pure storage overflowed because we can't determine
5425 if something is a pure object or not. */
5426 if (pure_bytes_used_before_overflow
)
5431 /* Don't keep undo information around forever.
5432 Do this early on, so it is no problem if the user quits. */
5433 FOR_EACH_BUFFER (nextb
)
5434 compact_buffer (nextb
);
5436 start
= current_emacs_time ();
5438 /* In case user calls debug_print during GC,
5439 don't let that cause a recursive GC. */
5440 consing_since_gc
= 0;
5442 /* Save what's currently displayed in the echo area. */
5443 message_p
= push_message ();
5444 record_unwind_protect (pop_message_unwind
, Qnil
);
5446 /* Save a copy of the contents of the stack, for debugging. */
5447 #if MAX_SAVE_STACK > 0
5448 if (NILP (Vpurify_flag
))
5451 ptrdiff_t stack_size
;
5452 if (&stack_top_variable
< stack_bottom
)
5454 stack
= &stack_top_variable
;
5455 stack_size
= stack_bottom
- &stack_top_variable
;
5459 stack
= stack_bottom
;
5460 stack_size
= &stack_top_variable
- stack_bottom
;
5462 if (stack_size
<= MAX_SAVE_STACK
)
5464 if (stack_copy_size
< stack_size
)
5466 stack_copy
= xrealloc (stack_copy
, stack_size
);
5467 stack_copy_size
= stack_size
;
5469 memcpy (stack_copy
, stack
, stack_size
);
5472 #endif /* MAX_SAVE_STACK > 0 */
5474 if (garbage_collection_messages
)
5475 message1_nolog ("Garbage collecting...");
5479 shrink_regexp_cache ();
5483 /* Mark all the special slots that serve as the roots of accessibility. */
5485 for (i
= 0; i
< staticidx
; i
++)
5486 mark_object (*staticvec
[i
]);
5488 for (bind
= specpdl
; bind
!= specpdl_ptr
; bind
++)
5490 mark_object (bind
->symbol
);
5491 mark_object (bind
->old_value
);
5499 extern void xg_mark_data (void);
5504 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5505 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5509 register struct gcpro
*tail
;
5510 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5511 for (i
= 0; i
< tail
->nvars
; i
++)
5512 mark_object (tail
->var
[i
]);
5516 struct catchtag
*catch;
5517 struct handler
*handler
;
5519 for (catch = catchlist
; catch; catch = catch->next
)
5521 mark_object (catch->tag
);
5522 mark_object (catch->val
);
5524 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5526 mark_object (handler
->handler
);
5527 mark_object (handler
->var
);
5533 #ifdef HAVE_WINDOW_SYSTEM
5534 mark_fringe_data ();
5537 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5541 /* Everything is now marked, except for the things that require special
5542 finalization, i.e. the undo_list.
5543 Look thru every buffer's undo list
5544 for elements that update markers that were not marked,
5546 FOR_EACH_BUFFER (nextb
)
5548 /* If a buffer's undo list is Qt, that means that undo is
5549 turned off in that buffer. Calling truncate_undo_list on
5550 Qt tends to return NULL, which effectively turns undo back on.
5551 So don't call truncate_undo_list if undo_list is Qt. */
5552 if (! EQ (nextb
->INTERNAL_FIELD (undo_list
), Qt
))
5554 Lisp_Object tail
, prev
;
5555 tail
= nextb
->INTERNAL_FIELD (undo_list
);
5557 while (CONSP (tail
))
5559 if (CONSP (XCAR (tail
))
5560 && MARKERP (XCAR (XCAR (tail
)))
5561 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5564 nextb
->INTERNAL_FIELD (undo_list
) = tail
= XCDR (tail
);
5568 XSETCDR (prev
, tail
);
5578 /* Now that we have stripped the elements that need not be in the
5579 undo_list any more, we can finally mark the list. */
5580 mark_object (nextb
->INTERNAL_FIELD (undo_list
));
5585 /* Clear the mark bits that we set in certain root slots. */
5587 unmark_byte_stack ();
5588 VECTOR_UNMARK (&buffer_defaults
);
5589 VECTOR_UNMARK (&buffer_local_symbols
);
5591 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5601 consing_since_gc
= 0;
5602 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
5603 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
5605 gc_relative_threshold
= 0;
5606 if (FLOATP (Vgc_cons_percentage
))
5607 { /* Set gc_cons_combined_threshold. */
5610 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5611 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5612 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5613 tot
+= total_string_bytes
;
5614 tot
+= total_vector_slots
* word_size
;
5615 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5616 tot
+= total_intervals
* sizeof (struct interval
);
5617 tot
+= total_strings
* sizeof (struct Lisp_String
);
5619 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5622 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5623 gc_relative_threshold
= tot
;
5625 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5629 if (garbage_collection_messages
)
5631 if (message_p
|| minibuf_level
> 0)
5634 message1_nolog ("Garbage collecting...done");
5637 unbind_to (count
, Qnil
);
5639 total
[0] = list4 (Qcons
, make_number (sizeof (struct Lisp_Cons
)),
5640 bounded_number (total_conses
),
5641 bounded_number (total_free_conses
));
5643 total
[1] = list4 (Qsymbol
, make_number (sizeof (struct Lisp_Symbol
)),
5644 bounded_number (total_symbols
),
5645 bounded_number (total_free_symbols
));
5647 total
[2] = list4 (Qmisc
, make_number (sizeof (union Lisp_Misc
)),
5648 bounded_number (total_markers
),
5649 bounded_number (total_free_markers
));
5651 total
[3] = list4 (Qstring
, make_number (sizeof (struct Lisp_String
)),
5652 bounded_number (total_strings
),
5653 bounded_number (total_free_strings
));
5655 total
[4] = list3 (Qstring_bytes
, make_number (1),
5656 bounded_number (total_string_bytes
));
5658 total
[5] = list3 (Qvector
, make_number (sizeof (struct Lisp_Vector
)),
5659 bounded_number (total_vectors
));
5661 total
[6] = list4 (Qvector_slots
, make_number (word_size
),
5662 bounded_number (total_vector_slots
),
5663 bounded_number (total_free_vector_slots
));
5665 total
[7] = list4 (Qfloat
, make_number (sizeof (struct Lisp_Float
)),
5666 bounded_number (total_floats
),
5667 bounded_number (total_free_floats
));
5669 total
[8] = list4 (Qinterval
, make_number (sizeof (struct interval
)),
5670 bounded_number (total_intervals
),
5671 bounded_number (total_free_intervals
));
5673 total
[9] = list3 (Qbuffer
, make_number (sizeof (struct buffer
)),
5674 bounded_number (total_buffers
));
5676 total
[10] = list4 (Qheap
, make_number (1024),
5677 #ifdef DOUG_LEA_MALLOC
5678 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
5679 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10)
5685 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5687 /* Compute average percentage of zombies. */
5689 (total_conses
+ total_symbols
+ total_markers
+ total_strings
5690 + total_vectors
+ total_floats
+ total_intervals
+ total_buffers
);
5692 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5693 max_live
= max (nlive
, max_live
);
5694 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5695 max_zombies
= max (nzombies
, max_zombies
);
5700 if (!NILP (Vpost_gc_hook
))
5702 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5703 safe_run_hooks (Qpost_gc_hook
);
5704 unbind_to (gc_count
, Qnil
);
5707 /* Accumulate statistics. */
5708 if (FLOATP (Vgc_elapsed
))
5710 EMACS_TIME since_start
= sub_emacs_time (current_emacs_time (), start
);
5711 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5712 + EMACS_TIME_TO_DOUBLE (since_start
));
5717 return Flist (sizeof total
/ sizeof *total
, total
);
5721 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5722 only interesting objects referenced from glyphs are strings. */
5725 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5727 struct glyph_row
*row
= matrix
->rows
;
5728 struct glyph_row
*end
= row
+ matrix
->nrows
;
5730 for (; row
< end
; ++row
)
5734 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5736 struct glyph
*glyph
= row
->glyphs
[area
];
5737 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5739 for (; glyph
< end_glyph
; ++glyph
)
5740 if (STRINGP (glyph
->object
)
5741 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5742 mark_object (glyph
->object
);
5748 /* Mark Lisp faces in the face cache C. */
5751 mark_face_cache (struct face_cache
*c
)
5756 for (i
= 0; i
< c
->used
; ++i
)
5758 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5762 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5763 mark_object (face
->lface
[j
]);
5771 /* Mark reference to a Lisp_Object.
5772 If the object referred to has not been seen yet, recursively mark
5773 all the references contained in it. */
5775 #define LAST_MARKED_SIZE 500
5776 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5777 static int last_marked_index
;
5779 /* For debugging--call abort when we cdr down this many
5780 links of a list, in mark_object. In debugging,
5781 the call to abort will hit a breakpoint.
5782 Normally this is zero and the check never goes off. */
5783 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5786 mark_vectorlike (struct Lisp_Vector
*ptr
)
5788 ptrdiff_t size
= ptr
->header
.size
;
5791 eassert (!VECTOR_MARKED_P (ptr
));
5792 VECTOR_MARK (ptr
); /* Else mark it. */
5793 if (size
& PSEUDOVECTOR_FLAG
)
5794 size
&= PSEUDOVECTOR_SIZE_MASK
;
5796 /* Note that this size is not the memory-footprint size, but only
5797 the number of Lisp_Object fields that we should trace.
5798 The distinction is used e.g. by Lisp_Process which places extra
5799 non-Lisp_Object fields at the end of the structure... */
5800 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
5801 mark_object (ptr
->contents
[i
]);
5804 /* Like mark_vectorlike but optimized for char-tables (and
5805 sub-char-tables) assuming that the contents are mostly integers or
5809 mark_char_table (struct Lisp_Vector
*ptr
)
5811 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5814 eassert (!VECTOR_MARKED_P (ptr
));
5816 for (i
= 0; i
< size
; i
++)
5818 Lisp_Object val
= ptr
->contents
[i
];
5820 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5822 if (SUB_CHAR_TABLE_P (val
))
5824 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5825 mark_char_table (XVECTOR (val
));
5832 /* Mark the chain of overlays starting at PTR. */
5835 mark_overlay (struct Lisp_Overlay
*ptr
)
5837 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
5840 mark_object (ptr
->start
);
5841 mark_object (ptr
->end
);
5842 mark_object (ptr
->plist
);
5846 /* Mark Lisp_Objects and special pointers in BUFFER. */
5849 mark_buffer (struct buffer
*buffer
)
5851 /* This is handled much like other pseudovectors... */
5852 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
5854 /* ...but there are some buffer-specific things. */
5856 MARK_INTERVAL_TREE (BUF_INTERVALS (buffer
));
5858 /* For now, we just don't mark the undo_list. It's done later in
5859 a special way just before the sweep phase, and after stripping
5860 some of its elements that are not needed any more. */
5862 mark_overlay (buffer
->overlays_before
);
5863 mark_overlay (buffer
->overlays_after
);
5865 /* If this is an indirect buffer, mark its base buffer. */
5866 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5867 mark_buffer (buffer
->base_buffer
);
5870 /* Determine type of generic Lisp_Object and mark it accordingly. */
5873 mark_object (Lisp_Object arg
)
5875 register Lisp_Object obj
= arg
;
5876 #ifdef GC_CHECK_MARKED_OBJECTS
5880 ptrdiff_t cdr_count
= 0;
5884 if (PURE_POINTER_P (XPNTR (obj
)))
5887 last_marked
[last_marked_index
++] = obj
;
5888 if (last_marked_index
== LAST_MARKED_SIZE
)
5889 last_marked_index
= 0;
5891 /* Perform some sanity checks on the objects marked here. Abort if
5892 we encounter an object we know is bogus. This increases GC time
5893 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5894 #ifdef GC_CHECK_MARKED_OBJECTS
5896 po
= (void *) XPNTR (obj
);
5898 /* Check that the object pointed to by PO is known to be a Lisp
5899 structure allocated from the heap. */
5900 #define CHECK_ALLOCATED() \
5902 m = mem_find (po); \
5907 /* Check that the object pointed to by PO is live, using predicate
5909 #define CHECK_LIVE(LIVEP) \
5911 if (!LIVEP (m, po)) \
5915 /* Check both of the above conditions. */
5916 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5918 CHECK_ALLOCATED (); \
5919 CHECK_LIVE (LIVEP); \
5922 #else /* not GC_CHECK_MARKED_OBJECTS */
5924 #define CHECK_LIVE(LIVEP) (void) 0
5925 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5927 #endif /* not GC_CHECK_MARKED_OBJECTS */
5929 switch (XTYPE (obj
))
5933 register struct Lisp_String
*ptr
= XSTRING (obj
);
5934 if (STRING_MARKED_P (ptr
))
5936 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
5938 MARK_INTERVAL_TREE (ptr
->intervals
);
5939 #ifdef GC_CHECK_STRING_BYTES
5940 /* Check that the string size recorded in the string is the
5941 same as the one recorded in the sdata structure. */
5943 #endif /* GC_CHECK_STRING_BYTES */
5947 case Lisp_Vectorlike
:
5949 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5950 register ptrdiff_t pvectype
;
5952 if (VECTOR_MARKED_P (ptr
))
5955 #ifdef GC_CHECK_MARKED_OBJECTS
5957 if (m
== MEM_NIL
&& !SUBRP (obj
)
5958 && po
!= &buffer_defaults
5959 && po
!= &buffer_local_symbols
)
5961 #endif /* GC_CHECK_MARKED_OBJECTS */
5963 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
5964 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
5965 >> PSEUDOVECTOR_SIZE_BITS
);
5969 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
5970 CHECK_LIVE (live_vector_p
);
5975 #ifdef GC_CHECK_MARKED_OBJECTS
5976 if (po
!= &buffer_defaults
&& po
!= &buffer_local_symbols
)
5985 #endif /* GC_CHECK_MARKED_OBJECTS */
5986 mark_buffer ((struct buffer
*) ptr
);
5990 { /* We could treat this just like a vector, but it is better
5991 to save the COMPILED_CONSTANTS element for last and avoid
5993 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5997 for (i
= 0; i
< size
; i
++)
5998 if (i
!= COMPILED_CONSTANTS
)
5999 mark_object (ptr
->contents
[i
]);
6000 if (size
> COMPILED_CONSTANTS
)
6002 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
6010 mark_vectorlike (ptr
);
6011 mark_face_cache (((struct frame
*) ptr
)->face_cache
);
6017 struct window
*w
= (struct window
*) ptr
;
6019 mark_vectorlike (ptr
);
6020 /* Mark glyphs for leaf windows. Marking window
6021 matrices is sufficient because frame matrices
6022 use the same glyph memory. */
6023 if (NILP (WVAR (w
, hchild
)) && NILP (WVAR (w
, vchild
))
6024 && w
->current_matrix
)
6026 mark_glyph_matrix (w
->current_matrix
);
6027 mark_glyph_matrix (w
->desired_matrix
);
6032 case PVEC_HASH_TABLE
:
6034 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6036 mark_vectorlike (ptr
);
6037 /* If hash table is not weak, mark all keys and values.
6038 For weak tables, mark only the vector. */
6040 mark_object (h
->key_and_value
);
6042 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6046 case PVEC_CHAR_TABLE
:
6047 mark_char_table (ptr
);
6050 case PVEC_BOOL_VECTOR
:
6051 /* No Lisp_Objects to mark in a bool vector. */
6062 mark_vectorlike (ptr
);
6069 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6070 struct Lisp_Symbol
*ptrx
;
6074 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
6076 mark_object (SVAR (ptr
, function
));
6077 mark_object (SVAR (ptr
, plist
));
6078 switch (ptr
->redirect
)
6080 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6081 case SYMBOL_VARALIAS
:
6084 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6088 case SYMBOL_LOCALIZED
:
6090 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
6091 /* If the value is forwarded to a buffer or keyboard field,
6092 these are marked when we see the corresponding object.
6093 And if it's forwarded to a C variable, either it's not
6094 a Lisp_Object var, or it's staticpro'd already. */
6095 mark_object (blv
->where
);
6096 mark_object (blv
->valcell
);
6097 mark_object (blv
->defcell
);
6100 case SYMBOL_FORWARDED
:
6101 /* If the value is forwarded to a buffer or keyboard field,
6102 these are marked when we see the corresponding object.
6103 And if it's forwarded to a C variable, either it's not
6104 a Lisp_Object var, or it's staticpro'd already. */
6108 if (!PURE_POINTER_P (XSTRING (SVAR (ptr
, xname
))))
6109 MARK_STRING (XSTRING (SVAR (ptr
, xname
)));
6110 MARK_INTERVAL_TREE (STRING_INTERVALS (SVAR (ptr
, xname
)));
6115 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun. */
6116 XSETSYMBOL (obj
, ptrx
);
6123 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6125 if (XMISCANY (obj
)->gcmarkbit
)
6128 switch (XMISCTYPE (obj
))
6130 case Lisp_Misc_Marker
:
6131 /* DO NOT mark thru the marker's chain.
6132 The buffer's markers chain does not preserve markers from gc;
6133 instead, markers are removed from the chain when freed by gc. */
6134 XMISCANY (obj
)->gcmarkbit
= 1;
6137 case Lisp_Misc_Save_Value
:
6138 XMISCANY (obj
)->gcmarkbit
= 1;
6141 register struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
6142 /* If DOGC is set, POINTER is the address of a memory
6143 area containing INTEGER potential Lisp_Objects. */
6146 Lisp_Object
*p
= (Lisp_Object
*) ptr
->pointer
;
6148 for (nelt
= ptr
->integer
; nelt
> 0; nelt
--, p
++)
6149 mark_maybe_object (*p
);
6155 case Lisp_Misc_Overlay
:
6156 mark_overlay (XOVERLAY (obj
));
6166 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6167 if (CONS_MARKED_P (ptr
))
6169 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6171 /* If the cdr is nil, avoid recursion for the car. */
6172 if (EQ (ptr
->u
.cdr
, Qnil
))
6178 mark_object (ptr
->car
);
6181 if (cdr_count
== mark_object_loop_halt
)
6187 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6188 FLOAT_MARK (XFLOAT (obj
));
6199 #undef CHECK_ALLOCATED
6200 #undef CHECK_ALLOCATED_AND_LIVE
6202 /* Mark the Lisp pointers in the terminal objects.
6203 Called by Fgarbage_collect. */
6206 mark_terminals (void)
6209 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6211 eassert (t
->name
!= NULL
);
6212 #ifdef HAVE_WINDOW_SYSTEM
6213 /* If a terminal object is reachable from a stacpro'ed object,
6214 it might have been marked already. Make sure the image cache
6216 mark_image_cache (t
->image_cache
);
6217 #endif /* HAVE_WINDOW_SYSTEM */
6218 if (!VECTOR_MARKED_P (t
))
6219 mark_vectorlike ((struct Lisp_Vector
*)t
);
6225 /* Value is non-zero if OBJ will survive the current GC because it's
6226 either marked or does not need to be marked to survive. */
6229 survives_gc_p (Lisp_Object obj
)
6233 switch (XTYPE (obj
))
6240 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6244 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6248 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6251 case Lisp_Vectorlike
:
6252 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6256 survives_p
= CONS_MARKED_P (XCONS (obj
));
6260 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6267 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
6272 /* Sweep: find all structures not marked, and free them. */
6277 /* Remove or mark entries in weak hash tables.
6278 This must be done before any object is unmarked. */
6279 sweep_weak_hash_tables ();
6282 check_string_bytes (!noninteractive
);
6284 /* Put all unmarked conses on free list */
6286 register struct cons_block
*cblk
;
6287 struct cons_block
**cprev
= &cons_block
;
6288 register int lim
= cons_block_index
;
6289 EMACS_INT num_free
= 0, num_used
= 0;
6293 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6297 int ilim
= (lim
+ BITS_PER_INT
- 1) / BITS_PER_INT
;
6299 /* Scan the mark bits an int at a time. */
6300 for (i
= 0; i
< ilim
; i
++)
6302 if (cblk
->gcmarkbits
[i
] == -1)
6304 /* Fast path - all cons cells for this int are marked. */
6305 cblk
->gcmarkbits
[i
] = 0;
6306 num_used
+= BITS_PER_INT
;
6310 /* Some cons cells for this int are not marked.
6311 Find which ones, and free them. */
6312 int start
, pos
, stop
;
6314 start
= i
* BITS_PER_INT
;
6316 if (stop
> BITS_PER_INT
)
6317 stop
= BITS_PER_INT
;
6320 for (pos
= start
; pos
< stop
; pos
++)
6322 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6325 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6326 cons_free_list
= &cblk
->conses
[pos
];
6328 cons_free_list
->car
= Vdead
;
6334 CONS_UNMARK (&cblk
->conses
[pos
]);
6340 lim
= CONS_BLOCK_SIZE
;
6341 /* If this block contains only free conses and we have already
6342 seen more than two blocks worth of free conses then deallocate
6344 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6346 *cprev
= cblk
->next
;
6347 /* Unhook from the free list. */
6348 cons_free_list
= cblk
->conses
[0].u
.chain
;
6349 lisp_align_free (cblk
);
6353 num_free
+= this_free
;
6354 cprev
= &cblk
->next
;
6357 total_conses
= num_used
;
6358 total_free_conses
= num_free
;
6361 /* Put all unmarked floats on free list */
6363 register struct float_block
*fblk
;
6364 struct float_block
**fprev
= &float_block
;
6365 register int lim
= float_block_index
;
6366 EMACS_INT num_free
= 0, num_used
= 0;
6368 float_free_list
= 0;
6370 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6374 for (i
= 0; i
< lim
; i
++)
6375 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6378 fblk
->floats
[i
].u
.chain
= float_free_list
;
6379 float_free_list
= &fblk
->floats
[i
];
6384 FLOAT_UNMARK (&fblk
->floats
[i
]);
6386 lim
= FLOAT_BLOCK_SIZE
;
6387 /* If this block contains only free floats and we have already
6388 seen more than two blocks worth of free floats then deallocate
6390 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6392 *fprev
= fblk
->next
;
6393 /* Unhook from the free list. */
6394 float_free_list
= fblk
->floats
[0].u
.chain
;
6395 lisp_align_free (fblk
);
6399 num_free
+= this_free
;
6400 fprev
= &fblk
->next
;
6403 total_floats
= num_used
;
6404 total_free_floats
= num_free
;
6407 /* Put all unmarked intervals on free list */
6409 register struct interval_block
*iblk
;
6410 struct interval_block
**iprev
= &interval_block
;
6411 register int lim
= interval_block_index
;
6412 EMACS_INT num_free
= 0, num_used
= 0;
6414 interval_free_list
= 0;
6416 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6421 for (i
= 0; i
< lim
; i
++)
6423 if (!iblk
->intervals
[i
].gcmarkbit
)
6425 SET_INTERVAL_PARENT (&iblk
->intervals
[i
], interval_free_list
);
6426 interval_free_list
= &iblk
->intervals
[i
];
6432 iblk
->intervals
[i
].gcmarkbit
= 0;
6435 lim
= INTERVAL_BLOCK_SIZE
;
6436 /* If this block contains only free intervals and we have already
6437 seen more than two blocks worth of free intervals then
6438 deallocate this block. */
6439 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6441 *iprev
= iblk
->next
;
6442 /* Unhook from the free list. */
6443 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6448 num_free
+= this_free
;
6449 iprev
= &iblk
->next
;
6452 total_intervals
= num_used
;
6453 total_free_intervals
= num_free
;
6456 /* Put all unmarked symbols on free list */
6458 register struct symbol_block
*sblk
;
6459 struct symbol_block
**sprev
= &symbol_block
;
6460 register int lim
= symbol_block_index
;
6461 EMACS_INT num_free
= 0, num_used
= 0;
6463 symbol_free_list
= NULL
;
6465 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6468 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6469 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6471 for (; sym
< end
; ++sym
)
6473 /* Check if the symbol was created during loadup. In such a case
6474 it might be pointed to by pure bytecode which we don't trace,
6475 so we conservatively assume that it is live. */
6476 int pure_p
= PURE_POINTER_P (XSTRING (sym
->s
.INTERNAL_FIELD (xname
)));
6478 if (!sym
->s
.gcmarkbit
&& !pure_p
)
6480 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6481 xfree (SYMBOL_BLV (&sym
->s
));
6482 sym
->s
.next
= symbol_free_list
;
6483 symbol_free_list
= &sym
->s
;
6485 SVAR (symbol_free_list
, function
) = Vdead
;
6493 UNMARK_STRING (XSTRING (sym
->s
.INTERNAL_FIELD (xname
)));
6494 sym
->s
.gcmarkbit
= 0;
6498 lim
= SYMBOL_BLOCK_SIZE
;
6499 /* If this block contains only free symbols and we have already
6500 seen more than two blocks worth of free symbols then deallocate
6502 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6504 *sprev
= sblk
->next
;
6505 /* Unhook from the free list. */
6506 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6511 num_free
+= this_free
;
6512 sprev
= &sblk
->next
;
6515 total_symbols
= num_used
;
6516 total_free_symbols
= num_free
;
6519 /* Put all unmarked misc's on free list.
6520 For a marker, first unchain it from the buffer it points into. */
6522 register struct marker_block
*mblk
;
6523 struct marker_block
**mprev
= &marker_block
;
6524 register int lim
= marker_block_index
;
6525 EMACS_INT num_free
= 0, num_used
= 0;
6527 marker_free_list
= 0;
6529 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6534 for (i
= 0; i
< lim
; i
++)
6536 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6538 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6539 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6540 /* Set the type of the freed object to Lisp_Misc_Free.
6541 We could leave the type alone, since nobody checks it,
6542 but this might catch bugs faster. */
6543 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6544 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6545 marker_free_list
= &mblk
->markers
[i
].m
;
6551 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6554 lim
= MARKER_BLOCK_SIZE
;
6555 /* If this block contains only free markers and we have already
6556 seen more than two blocks worth of free markers then deallocate
6558 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6560 *mprev
= mblk
->next
;
6561 /* Unhook from the free list. */
6562 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6567 num_free
+= this_free
;
6568 mprev
= &mblk
->next
;
6572 total_markers
= num_used
;
6573 total_free_markers
= num_free
;
6576 /* Free all unmarked buffers */
6578 register struct buffer
*buffer
= all_buffers
, *prev
= 0, *next
;
6582 if (!VECTOR_MARKED_P (buffer
))
6585 prev
->header
.next
= buffer
->header
.next
;
6587 all_buffers
= buffer
->header
.next
.buffer
;
6588 next
= buffer
->header
.next
.buffer
;
6594 VECTOR_UNMARK (buffer
);
6595 UNMARK_BALANCE_INTERVALS (BUF_INTERVALS (buffer
));
6597 prev
= buffer
, buffer
= buffer
->header
.next
.buffer
;
6602 check_string_bytes (!noninteractive
);
6608 /* Debugging aids. */
6610 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6611 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6612 This may be helpful in debugging Emacs's memory usage.
6613 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6618 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6623 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6624 doc
: /* Return a list of counters that measure how much consing there has been.
6625 Each of these counters increments for a certain kind of object.
6626 The counters wrap around from the largest positive integer to zero.
6627 Garbage collection does not decrease them.
6628 The elements of the value are as follows:
6629 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6630 All are in units of 1 = one object consed
6631 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6633 MISCS include overlays, markers, and some internal types.
6634 Frames, windows, buffers, and subprocesses count as vectors
6635 (but the contents of a buffer's text do not count here). */)
6638 return listn (CONSTYPE_HEAP
, 8,
6639 bounded_number (cons_cells_consed
),
6640 bounded_number (floats_consed
),
6641 bounded_number (vector_cells_consed
),
6642 bounded_number (symbols_consed
),
6643 bounded_number (string_chars_consed
),
6644 bounded_number (misc_objects_consed
),
6645 bounded_number (intervals_consed
),
6646 bounded_number (strings_consed
));
6649 /* Find at most FIND_MAX symbols which have OBJ as their value or
6650 function. This is used in gdbinit's `xwhichsymbols' command. */
6653 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6655 struct symbol_block
*sblk
;
6656 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6657 Lisp_Object found
= Qnil
;
6661 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6663 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
6666 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
6668 struct Lisp_Symbol
*sym
= &aligned_sym
->s
;
6672 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6675 XSETSYMBOL (tem
, sym
);
6676 val
= find_symbol_value (tem
);
6678 || EQ (SVAR (sym
, function
), obj
)
6679 || (!NILP (SVAR (sym
, function
))
6680 && COMPILEDP (SVAR (sym
, function
))
6681 && EQ (AREF (SVAR (sym
, function
), COMPILED_BYTECODE
), obj
))
6684 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)))
6686 found
= Fcons (tem
, found
);
6687 if (--find_max
== 0)
6695 unbind_to (gc_count
, Qnil
);
6699 #ifdef ENABLE_CHECKING
6700 int suppress_checking
;
6703 die (const char *msg
, const char *file
, int line
)
6705 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: %s\r\n",
6711 /* Initialization */
6714 init_alloc_once (void)
6716 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6718 pure_size
= PURESIZE
;
6720 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6722 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6725 #ifdef DOUG_LEA_MALLOC
6726 mallopt (M_TRIM_THRESHOLD
, 128*1024); /* trim threshold */
6727 mallopt (M_MMAP_THRESHOLD
, 64*1024); /* mmap threshold */
6728 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* max. number of mmap'ed areas */
6734 malloc_hysteresis
= 32;
6736 malloc_hysteresis
= 0;
6739 refill_memory_reserve ();
6740 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
6747 byte_stack_list
= 0;
6749 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6750 setjmp_tested_p
= longjmps_done
= 0;
6753 Vgc_elapsed
= make_float (0.0);
6758 syms_of_alloc (void)
6760 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6761 doc
: /* Number of bytes of consing between garbage collections.
6762 Garbage collection can happen automatically once this many bytes have been
6763 allocated since the last garbage collection. All data types count.
6765 Garbage collection happens automatically only when `eval' is called.
6767 By binding this temporarily to a large number, you can effectively
6768 prevent garbage collection during a part of the program.
6769 See also `gc-cons-percentage'. */);
6771 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6772 doc
: /* Portion of the heap used for allocation.
6773 Garbage collection can happen automatically once this portion of the heap
6774 has been allocated since the last garbage collection.
6775 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6776 Vgc_cons_percentage
= make_float (0.1);
6778 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6779 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
6781 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6782 doc
: /* Number of cons cells that have been consed so far. */);
6784 DEFVAR_INT ("floats-consed", floats_consed
,
6785 doc
: /* Number of floats that have been consed so far. */);
6787 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
6788 doc
: /* Number of vector cells that have been consed so far. */);
6790 DEFVAR_INT ("symbols-consed", symbols_consed
,
6791 doc
: /* Number of symbols that have been consed so far. */);
6793 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
6794 doc
: /* Number of string characters that have been consed so far. */);
6796 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
6797 doc
: /* Number of miscellaneous objects that have been consed so far.
6798 These include markers and overlays, plus certain objects not visible
6801 DEFVAR_INT ("intervals-consed", intervals_consed
,
6802 doc
: /* Number of intervals that have been consed so far. */);
6804 DEFVAR_INT ("strings-consed", strings_consed
,
6805 doc
: /* Number of strings that have been consed so far. */);
6807 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
6808 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
6809 This means that certain objects should be allocated in shared (pure) space.
6810 It can also be set to a hash-table, in which case this table is used to
6811 do hash-consing of the objects allocated to pure space. */);
6813 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
6814 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
6815 garbage_collection_messages
= 0;
6817 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
6818 doc
: /* Hook run after garbage collection has finished. */);
6819 Vpost_gc_hook
= Qnil
;
6820 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
6822 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
6823 doc
: /* Precomputed `signal' argument for memory-full error. */);
6824 /* We build this in advance because if we wait until we need it, we might
6825 not be able to allocate the memory to hold it. */
6827 = listn (CONSTYPE_PURE
, 2, Qerror
,
6828 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
6830 DEFVAR_LISP ("memory-full", Vmemory_full
,
6831 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
6832 Vmemory_full
= Qnil
;
6834 DEFSYM (Qstring_bytes
, "string-bytes");
6835 DEFSYM (Qvector_slots
, "vector-slots");
6836 DEFSYM (Qheap
, "heap");
6838 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
6839 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
6841 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
6842 doc
: /* Accumulated time elapsed in garbage collections.
6843 The time is in seconds as a floating point value. */);
6844 DEFVAR_INT ("gcs-done", gcs_done
,
6845 doc
: /* Accumulated number of garbage collections done. */);
6850 defsubr (&Smake_byte_code
);
6851 defsubr (&Smake_list
);
6852 defsubr (&Smake_vector
);
6853 defsubr (&Smake_string
);
6854 defsubr (&Smake_bool_vector
);
6855 defsubr (&Smake_symbol
);
6856 defsubr (&Smake_marker
);
6857 defsubr (&Spurecopy
);
6858 defsubr (&Sgarbage_collect
);
6859 defsubr (&Smemory_limit
);
6860 defsubr (&Smemory_use_counts
);
6862 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
6863 defsubr (&Sgc_status
);
6867 /* When compiled with GCC, GDB might say "No enum type named
6868 pvec_type" if we don't have at least one symbol with that type, and
6869 then xbacktrace could fail. Similarly for the other enums and
6873 enum CHARTAB_SIZE_BITS CHARTAB_SIZE_BITS
;
6874 enum CHAR_TABLE_STANDARD_SLOTS CHAR_TABLE_STANDARD_SLOTS
;
6875 enum char_bits char_bits
;
6876 enum CHECK_LISP_OBJECT_TYPE CHECK_LISP_OBJECT_TYPE
;
6877 enum DEFAULT_HASH_SIZE DEFAULT_HASH_SIZE
;
6878 enum enum_USE_LSB_TAG enum_USE_LSB_TAG
;
6879 enum FLOAT_TO_STRING_BUFSIZE FLOAT_TO_STRING_BUFSIZE
;
6880 enum Lisp_Bits Lisp_Bits
;
6881 enum Lisp_Compiled Lisp_Compiled
;
6882 enum maxargs maxargs
;
6883 enum MAX_ALLOCA MAX_ALLOCA
;
6884 enum More_Lisp_Bits More_Lisp_Bits
;
6885 enum pvec_type pvec_type
;
6887 enum lsb_bits lsb_bits
;
6889 } const EXTERNALLY_VISIBLE gdb_make_enums_visible
= {0};