1 /* Storage allocation and gc for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2012
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
23 #include <limits.h> /* For CHAR_BIT. */
32 /* This file is part of the core Lisp implementation, and thus must
33 deal with the real data structures. If the Lisp implementation is
34 replaced, this file likely will not be used. */
36 #undef HIDE_LISP_IMPLEMENTATION
39 #include "intervals.h"
41 #include "character.h"
46 #include "blockinput.h"
47 #include "syssignal.h"
48 #include "termhooks.h" /* For struct terminal. */
52 /* GC_CHECK_MARKED_OBJECTS means do sanity checks on allocated objects.
53 Doable only if GC_MARK_STACK. */
55 # undef GC_CHECK_MARKED_OBJECTS
58 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
59 memory. Can do this only if using gmalloc.c and if not checking
62 #if (defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC \
63 || defined GC_CHECK_MARKED_OBJECTS)
64 #undef GC_MALLOC_CHECK
78 #ifdef DOUG_LEA_MALLOC
82 /* Specify maximum number of areas to mmap. It would be nice to use a
83 value that explicitly means "no limit". */
85 #define MMAP_MAX_AREAS 100000000
87 #else /* not DOUG_LEA_MALLOC */
89 /* The following come from gmalloc.c. */
91 extern size_t _bytes_used
;
92 extern size_t __malloc_extra_blocks
;
93 extern void *_malloc_internal (size_t);
94 extern void _free_internal (void *);
96 #endif /* not DOUG_LEA_MALLOC */
98 #if ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT
101 /* When GTK uses the file chooser dialog, different backends can be loaded
102 dynamically. One such a backend is the Gnome VFS backend that gets loaded
103 if you run Gnome. That backend creates several threads and also allocates
106 Also, gconf and gsettings may create several threads.
108 If Emacs sets malloc hooks (! SYSTEM_MALLOC) and the emacs_blocked_*
109 functions below are called from malloc, there is a chance that one
110 of these threads preempts the Emacs main thread and the hook variables
111 end up in an inconsistent state. So we have a mutex to prevent that (note
112 that the backend handles concurrent access to malloc within its own threads
113 but Emacs code running in the main thread is not included in that control).
115 When UNBLOCK_INPUT is called, reinvoke_input_signal may be called. If this
116 happens in one of the backend threads we will have two threads that tries
117 to run Emacs code at once, and the code is not prepared for that.
118 To prevent that, we only call BLOCK/UNBLOCK from the main thread. */
120 static pthread_mutex_t alloc_mutex
;
122 #define BLOCK_INPUT_ALLOC \
125 if (pthread_equal (pthread_self (), main_thread)) \
127 pthread_mutex_lock (&alloc_mutex); \
130 #define UNBLOCK_INPUT_ALLOC \
133 pthread_mutex_unlock (&alloc_mutex); \
134 if (pthread_equal (pthread_self (), main_thread)) \
139 #else /* ! defined HAVE_PTHREAD */
141 #define BLOCK_INPUT_ALLOC BLOCK_INPUT
142 #define UNBLOCK_INPUT_ALLOC UNBLOCK_INPUT
144 #endif /* ! defined HAVE_PTHREAD */
145 #endif /* ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT */
147 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
148 to a struct Lisp_String. */
150 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
151 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
152 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
154 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
155 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
156 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
158 /* Value is the number of bytes of S, a pointer to a struct Lisp_String.
159 Be careful during GC, because S->size contains the mark bit for
162 #define GC_STRING_BYTES(S) (STRING_BYTES (S))
164 /* Global variables. */
165 struct emacs_globals globals
;
167 /* Number of bytes of consing done since the last gc. */
169 EMACS_INT consing_since_gc
;
171 /* Similar minimum, computed from Vgc_cons_percentage. */
173 EMACS_INT gc_relative_threshold
;
175 /* Minimum number of bytes of consing since GC before next GC,
176 when memory is full. */
178 EMACS_INT memory_full_cons_threshold
;
180 /* Nonzero during GC. */
184 /* Nonzero means abort if try to GC.
185 This is for code which is written on the assumption that
186 no GC will happen, so as to verify that assumption. */
190 /* Number of live and free conses etc. */
192 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_vector_size
;
193 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
194 static EMACS_INT total_free_floats
, total_floats
, total_free_vector_bytes
;
196 /* Points to memory space allocated as "spare", to be freed if we run
197 out of memory. We keep one large block, four cons-blocks, and
198 two string blocks. */
200 static char *spare_memory
[7];
202 /* Amount of spare memory to keep in large reserve block, or to see
203 whether this much is available when malloc fails on a larger request. */
205 #define SPARE_MEMORY (1 << 14)
207 /* Number of extra blocks malloc should get when it needs more core. */
209 static int malloc_hysteresis
;
211 /* Initialize it to a nonzero value to force it into data space
212 (rather than bss space). That way unexec will remap it into text
213 space (pure), on some systems. We have not implemented the
214 remapping on more recent systems because this is less important
215 nowadays than in the days of small memories and timesharing. */
217 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
218 #define PUREBEG (char *) pure
220 /* Pointer to the pure area, and its size. */
222 static char *purebeg
;
223 static ptrdiff_t pure_size
;
225 /* Number of bytes of pure storage used before pure storage overflowed.
226 If this is non-zero, this implies that an overflow occurred. */
228 static ptrdiff_t pure_bytes_used_before_overflow
;
230 /* Value is non-zero if P points into pure space. */
232 #define PURE_POINTER_P(P) \
233 ((uintptr_t) (P) - (uintptr_t) purebeg <= pure_size)
235 /* Index in pure at which next pure Lisp object will be allocated.. */
237 static ptrdiff_t pure_bytes_used_lisp
;
239 /* Number of bytes allocated for non-Lisp objects in pure storage. */
241 static ptrdiff_t pure_bytes_used_non_lisp
;
243 /* If nonzero, this is a warning delivered by malloc and not yet
246 const char *pending_malloc_warning
;
248 /* Maximum amount of C stack to save when a GC happens. */
250 #ifndef MAX_SAVE_STACK
251 #define MAX_SAVE_STACK 16000
254 /* Buffer in which we save a copy of the C stack at each GC. */
256 #if MAX_SAVE_STACK > 0
257 static char *stack_copy
;
258 static ptrdiff_t stack_copy_size
;
261 static Lisp_Object Qgc_cons_threshold
;
262 Lisp_Object Qchar_table_extra_slots
;
264 /* Hook run after GC has finished. */
266 static Lisp_Object Qpost_gc_hook
;
268 static void mark_terminals (void);
269 static void gc_sweep (void);
270 static Lisp_Object
make_pure_vector (ptrdiff_t);
271 static void mark_glyph_matrix (struct glyph_matrix
*);
272 static void mark_face_cache (struct face_cache
*);
274 #if !defined REL_ALLOC || defined SYSTEM_MALLOC
275 static void refill_memory_reserve (void);
277 static struct Lisp_String
*allocate_string (void);
278 static void compact_small_strings (void);
279 static void free_large_strings (void);
280 static void sweep_strings (void);
281 static void free_misc (Lisp_Object
);
282 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
284 /* When scanning the C stack for live Lisp objects, Emacs keeps track
285 of what memory allocated via lisp_malloc is intended for what
286 purpose. This enumeration specifies the type of memory. */
297 /* We used to keep separate mem_types for subtypes of vectors such as
298 process, hash_table, frame, terminal, and window, but we never made
299 use of the distinction, so it only caused source-code complexity
300 and runtime slowdown. Minor but pointless. */
302 /* Special type to denote vector blocks. */
303 MEM_TYPE_VECTOR_BLOCK
306 static void *lisp_malloc (size_t, enum mem_type
);
309 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
311 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
312 #include <stdio.h> /* For fprintf. */
315 /* A unique object in pure space used to make some Lisp objects
316 on free lists recognizable in O(1). */
318 static Lisp_Object Vdead
;
319 #define DEADP(x) EQ (x, Vdead)
321 #ifdef GC_MALLOC_CHECK
323 enum mem_type allocated_mem_type
;
325 #endif /* GC_MALLOC_CHECK */
327 /* A node in the red-black tree describing allocated memory containing
328 Lisp data. Each such block is recorded with its start and end
329 address when it is allocated, and removed from the tree when it
332 A red-black tree is a balanced binary tree with the following
335 1. Every node is either red or black.
336 2. Every leaf is black.
337 3. If a node is red, then both of its children are black.
338 4. Every simple path from a node to a descendant leaf contains
339 the same number of black nodes.
340 5. The root is always black.
342 When nodes are inserted into the tree, or deleted from the tree,
343 the tree is "fixed" so that these properties are always true.
345 A red-black tree with N internal nodes has height at most 2
346 log(N+1). Searches, insertions and deletions are done in O(log N).
347 Please see a text book about data structures for a detailed
348 description of red-black trees. Any book worth its salt should
353 /* Children of this node. These pointers are never NULL. When there
354 is no child, the value is MEM_NIL, which points to a dummy node. */
355 struct mem_node
*left
, *right
;
357 /* The parent of this node. In the root node, this is NULL. */
358 struct mem_node
*parent
;
360 /* Start and end of allocated region. */
364 enum {MEM_BLACK
, MEM_RED
} color
;
370 /* Base address of stack. Set in main. */
372 Lisp_Object
*stack_base
;
374 /* Root of the tree describing allocated Lisp memory. */
376 static struct mem_node
*mem_root
;
378 /* Lowest and highest known address in the heap. */
380 static void *min_heap_address
, *max_heap_address
;
382 /* Sentinel node of the tree. */
384 static struct mem_node mem_z
;
385 #define MEM_NIL &mem_z
387 static struct Lisp_Vector
*allocate_vectorlike (ptrdiff_t);
388 static void lisp_free (void *);
389 static void mark_stack (void);
390 static int live_vector_p (struct mem_node
*, void *);
391 static int live_buffer_p (struct mem_node
*, void *);
392 static int live_string_p (struct mem_node
*, void *);
393 static int live_cons_p (struct mem_node
*, void *);
394 static int live_symbol_p (struct mem_node
*, void *);
395 static int live_float_p (struct mem_node
*, void *);
396 static int live_misc_p (struct mem_node
*, void *);
397 static void mark_maybe_object (Lisp_Object
);
398 static void mark_memory (void *, void *);
399 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
400 static void mem_init (void);
401 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
402 static void mem_insert_fixup (struct mem_node
*);
404 static void mem_rotate_left (struct mem_node
*);
405 static void mem_rotate_right (struct mem_node
*);
406 static void mem_delete (struct mem_node
*);
407 static void mem_delete_fixup (struct mem_node
*);
408 static inline struct mem_node
*mem_find (void *);
411 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
412 static void check_gcpros (void);
415 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
421 /* Recording what needs to be marked for gc. */
423 struct gcpro
*gcprolist
;
425 /* Addresses of staticpro'd variables. Initialize it to a nonzero
426 value; otherwise some compilers put it into BSS. */
428 #define NSTATICS 0x650
429 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
431 /* Index of next unused slot in staticvec. */
433 static int staticidx
;
435 static void *pure_alloc (size_t, int);
438 /* Value is SZ rounded up to the next multiple of ALIGNMENT.
439 ALIGNMENT must be a power of 2. */
441 #define ALIGN(ptr, ALIGNMENT) \
442 ((void *) (((uintptr_t) (ptr) + (ALIGNMENT) - 1) \
443 & ~ ((ALIGNMENT) - 1)))
447 /************************************************************************
449 ************************************************************************/
451 /* Function malloc calls this if it finds we are near exhausting storage. */
454 malloc_warning (const char *str
)
456 pending_malloc_warning
= str
;
460 /* Display an already-pending malloc warning. */
463 display_malloc_warning (void)
465 call3 (intern ("display-warning"),
467 build_string (pending_malloc_warning
),
468 intern ("emergency"));
469 pending_malloc_warning
= 0;
472 /* Called if we can't allocate relocatable space for a buffer. */
475 buffer_memory_full (ptrdiff_t nbytes
)
477 /* If buffers use the relocating allocator, no need to free
478 spare_memory, because we may have plenty of malloc space left
479 that we could get, and if we don't, the malloc that fails will
480 itself cause spare_memory to be freed. If buffers don't use the
481 relocating allocator, treat this like any other failing
485 memory_full (nbytes
);
488 /* This used to call error, but if we've run out of memory, we could
489 get infinite recursion trying to build the string. */
490 xsignal (Qnil
, Vmemory_signal_data
);
493 /* A common multiple of the positive integers A and B. Ideally this
494 would be the least common multiple, but there's no way to do that
495 as a constant expression in C, so do the best that we can easily do. */
496 #define COMMON_MULTIPLE(a, b) \
497 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
499 #ifndef XMALLOC_OVERRUN_CHECK
500 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
503 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
506 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
507 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
508 block size in little-endian order. The trailer consists of
509 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
511 The header is used to detect whether this block has been allocated
512 through these functions, as some low-level libc functions may
513 bypass the malloc hooks. */
515 #define XMALLOC_OVERRUN_CHECK_SIZE 16
516 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
517 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
519 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
520 hold a size_t value and (2) the header size is a multiple of the
521 alignment that Emacs needs for C types and for USE_LSB_TAG. */
522 #define XMALLOC_BASE_ALIGNMENT \
525 union { long double d; intmax_t i; void *p; } u; \
531 # define XMALLOC_HEADER_ALIGNMENT \
532 COMMON_MULTIPLE (1 << GCTYPEBITS, XMALLOC_BASE_ALIGNMENT)
534 # define XMALLOC_HEADER_ALIGNMENT XMALLOC_BASE_ALIGNMENT
536 #define XMALLOC_OVERRUN_SIZE_SIZE \
537 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
538 + XMALLOC_HEADER_ALIGNMENT - 1) \
539 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
540 - XMALLOC_OVERRUN_CHECK_SIZE)
542 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
543 { '\x9a', '\x9b', '\xae', '\xaf',
544 '\xbf', '\xbe', '\xce', '\xcf',
545 '\xea', '\xeb', '\xec', '\xed',
546 '\xdf', '\xde', '\x9c', '\x9d' };
548 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
549 { '\xaa', '\xab', '\xac', '\xad',
550 '\xba', '\xbb', '\xbc', '\xbd',
551 '\xca', '\xcb', '\xcc', '\xcd',
552 '\xda', '\xdb', '\xdc', '\xdd' };
554 /* Insert and extract the block size in the header. */
557 xmalloc_put_size (unsigned char *ptr
, size_t size
)
560 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
562 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
568 xmalloc_get_size (unsigned char *ptr
)
572 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
573 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
582 /* The call depth in overrun_check functions. For example, this might happen:
584 overrun_check_malloc()
585 -> malloc -> (via hook)_-> emacs_blocked_malloc
586 -> overrun_check_malloc
587 call malloc (hooks are NULL, so real malloc is called).
588 malloc returns 10000.
589 add overhead, return 10016.
590 <- (back in overrun_check_malloc)
591 add overhead again, return 10032
592 xmalloc returns 10032.
597 overrun_check_free(10032)
599 free(10016) <- crash, because 10000 is the original pointer. */
601 static ptrdiff_t check_depth
;
603 /* Like malloc, but wraps allocated block with header and trailer. */
606 overrun_check_malloc (size_t size
)
608 register unsigned char *val
;
609 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
610 if (SIZE_MAX
- overhead
< size
)
613 val
= malloc (size
+ overhead
);
614 if (val
&& check_depth
== 1)
616 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
617 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
618 xmalloc_put_size (val
, size
);
619 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
620 XMALLOC_OVERRUN_CHECK_SIZE
);
627 /* Like realloc, but checks old block for overrun, and wraps new block
628 with header and trailer. */
631 overrun_check_realloc (void *block
, size_t size
)
633 register unsigned char *val
= (unsigned char *) block
;
634 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
635 if (SIZE_MAX
- overhead
< size
)
640 && memcmp (xmalloc_overrun_check_header
,
641 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
642 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
644 size_t osize
= xmalloc_get_size (val
);
645 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
646 XMALLOC_OVERRUN_CHECK_SIZE
))
648 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
649 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
650 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
653 val
= realloc (val
, size
+ overhead
);
655 if (val
&& check_depth
== 1)
657 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
658 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
659 xmalloc_put_size (val
, size
);
660 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
661 XMALLOC_OVERRUN_CHECK_SIZE
);
667 /* Like free, but checks block for overrun. */
670 overrun_check_free (void *block
)
672 unsigned char *val
= (unsigned char *) block
;
677 && memcmp (xmalloc_overrun_check_header
,
678 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
679 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
681 size_t osize
= xmalloc_get_size (val
);
682 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
683 XMALLOC_OVERRUN_CHECK_SIZE
))
685 #ifdef XMALLOC_CLEAR_FREE_MEMORY
686 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
687 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
689 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
690 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
691 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
702 #define malloc overrun_check_malloc
703 #define realloc overrun_check_realloc
704 #define free overrun_check_free
708 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
709 there's no need to block input around malloc. */
710 #define MALLOC_BLOCK_INPUT ((void)0)
711 #define MALLOC_UNBLOCK_INPUT ((void)0)
713 #define MALLOC_BLOCK_INPUT BLOCK_INPUT
714 #define MALLOC_UNBLOCK_INPUT UNBLOCK_INPUT
717 /* Like malloc but check for no memory and block interrupt input.. */
720 xmalloc (size_t size
)
726 MALLOC_UNBLOCK_INPUT
;
733 /* Like the above, but zeroes out the memory just allocated. */
736 xzalloc (size_t size
)
742 MALLOC_UNBLOCK_INPUT
;
746 memset (val
, 0, size
);
750 /* Like realloc but check for no memory and block interrupt input.. */
753 xrealloc (void *block
, size_t size
)
758 /* We must call malloc explicitly when BLOCK is 0, since some
759 reallocs don't do this. */
763 val
= realloc (block
, size
);
764 MALLOC_UNBLOCK_INPUT
;
772 /* Like free but block interrupt input. */
781 MALLOC_UNBLOCK_INPUT
;
782 /* We don't call refill_memory_reserve here
783 because that duplicates doing so in emacs_blocked_free
784 and the criterion should go there. */
788 /* Other parts of Emacs pass large int values to allocator functions
789 expecting ptrdiff_t. This is portable in practice, but check it to
791 verify (INT_MAX
<= PTRDIFF_MAX
);
794 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
795 Signal an error on memory exhaustion, and block interrupt input. */
798 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
800 eassert (0 <= nitems
&& 0 < item_size
);
801 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
802 memory_full (SIZE_MAX
);
803 return xmalloc (nitems
* item_size
);
807 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
808 Signal an error on memory exhaustion, and block interrupt input. */
811 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
813 eassert (0 <= nitems
&& 0 < item_size
);
814 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
815 memory_full (SIZE_MAX
);
816 return xrealloc (pa
, nitems
* item_size
);
820 /* Grow PA, which points to an array of *NITEMS items, and return the
821 location of the reallocated array, updating *NITEMS to reflect its
822 new size. The new array will contain at least NITEMS_INCR_MIN more
823 items, but will not contain more than NITEMS_MAX items total.
824 ITEM_SIZE is the size of each item, in bytes.
826 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
827 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
830 If PA is null, then allocate a new array instead of reallocating
831 the old one. Thus, to grow an array A without saving its old
832 contents, invoke xfree (A) immediately followed by xgrowalloc (0,
835 Block interrupt input as needed. If memory exhaustion occurs, set
836 *NITEMS to zero if PA is null, and signal an error (i.e., do not
840 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
841 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
843 /* The approximate size to use for initial small allocation
844 requests. This is the largest "small" request for the GNU C
846 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
848 /* If the array is tiny, grow it to about (but no greater than)
849 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
850 ptrdiff_t n
= *nitems
;
851 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
852 ptrdiff_t half_again
= n
>> 1;
853 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
855 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
856 NITEMS_MAX, and what the C language can represent safely. */
857 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
858 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
859 ? nitems_max
: C_language_max
);
860 ptrdiff_t nitems_incr_max
= n_max
- n
;
861 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
863 eassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
866 if (nitems_incr_max
< incr
)
867 memory_full (SIZE_MAX
);
869 pa
= xrealloc (pa
, n
* item_size
);
875 /* Like strdup, but uses xmalloc. */
878 xstrdup (const char *s
)
880 size_t len
= strlen (s
) + 1;
881 char *p
= xmalloc (len
);
887 /* Unwind for SAFE_ALLOCA */
890 safe_alloca_unwind (Lisp_Object arg
)
892 register struct Lisp_Save_Value
*p
= XSAVE_VALUE (arg
);
902 /* Like malloc but used for allocating Lisp data. NBYTES is the
903 number of bytes to allocate, TYPE describes the intended use of the
904 allocated memory block (for strings, for conses, ...). */
907 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
911 lisp_malloc (size_t nbytes
, enum mem_type type
)
917 #ifdef GC_MALLOC_CHECK
918 allocated_mem_type
= type
;
921 val
= malloc (nbytes
);
924 /* If the memory just allocated cannot be addressed thru a Lisp
925 object's pointer, and it needs to be,
926 that's equivalent to running out of memory. */
927 if (val
&& type
!= MEM_TYPE_NON_LISP
)
930 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
931 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
933 lisp_malloc_loser
= val
;
940 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
941 if (val
&& type
!= MEM_TYPE_NON_LISP
)
942 mem_insert (val
, (char *) val
+ nbytes
, type
);
945 MALLOC_UNBLOCK_INPUT
;
947 memory_full (nbytes
);
951 /* Free BLOCK. This must be called to free memory allocated with a
952 call to lisp_malloc. */
955 lisp_free (void *block
)
959 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
960 mem_delete (mem_find (block
));
962 MALLOC_UNBLOCK_INPUT
;
965 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
967 /* The entry point is lisp_align_malloc which returns blocks of at most
968 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
970 #if defined (HAVE_POSIX_MEMALIGN) && defined (SYSTEM_MALLOC)
971 #define USE_POSIX_MEMALIGN 1
974 /* BLOCK_ALIGN has to be a power of 2. */
975 #define BLOCK_ALIGN (1 << 10)
977 /* Padding to leave at the end of a malloc'd block. This is to give
978 malloc a chance to minimize the amount of memory wasted to alignment.
979 It should be tuned to the particular malloc library used.
980 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
981 posix_memalign on the other hand would ideally prefer a value of 4
982 because otherwise, there's 1020 bytes wasted between each ablocks.
983 In Emacs, testing shows that those 1020 can most of the time be
984 efficiently used by malloc to place other objects, so a value of 0 can
985 still preferable unless you have a lot of aligned blocks and virtually
987 #define BLOCK_PADDING 0
988 #define BLOCK_BYTES \
989 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
991 /* Internal data structures and constants. */
993 #define ABLOCKS_SIZE 16
995 /* An aligned block of memory. */
1000 char payload
[BLOCK_BYTES
];
1001 struct ablock
*next_free
;
1003 /* `abase' is the aligned base of the ablocks. */
1004 /* It is overloaded to hold the virtual `busy' field that counts
1005 the number of used ablock in the parent ablocks.
1006 The first ablock has the `busy' field, the others have the `abase'
1007 field. To tell the difference, we assume that pointers will have
1008 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1009 is used to tell whether the real base of the parent ablocks is `abase'
1010 (if not, the word before the first ablock holds a pointer to the
1012 struct ablocks
*abase
;
1013 /* The padding of all but the last ablock is unused. The padding of
1014 the last ablock in an ablocks is not allocated. */
1016 char padding
[BLOCK_PADDING
];
1020 /* A bunch of consecutive aligned blocks. */
1023 struct ablock blocks
[ABLOCKS_SIZE
];
1026 /* Size of the block requested from malloc or posix_memalign. */
1027 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1029 #define ABLOCK_ABASE(block) \
1030 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1031 ? (struct ablocks *)(block) \
1034 /* Virtual `busy' field. */
1035 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1037 /* Pointer to the (not necessarily aligned) malloc block. */
1038 #ifdef USE_POSIX_MEMALIGN
1039 #define ABLOCKS_BASE(abase) (abase)
1041 #define ABLOCKS_BASE(abase) \
1042 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void**)abase)[-1])
1045 /* The list of free ablock. */
1046 static struct ablock
*free_ablock
;
1048 /* Allocate an aligned block of nbytes.
1049 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1050 smaller or equal to BLOCK_BYTES. */
1052 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1055 struct ablocks
*abase
;
1057 eassert (nbytes
<= BLOCK_BYTES
);
1061 #ifdef GC_MALLOC_CHECK
1062 allocated_mem_type
= type
;
1068 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1070 #ifdef DOUG_LEA_MALLOC
1071 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1072 because mapped region contents are not preserved in
1074 mallopt (M_MMAP_MAX
, 0);
1077 #ifdef USE_POSIX_MEMALIGN
1079 int err
= posix_memalign (&base
, BLOCK_ALIGN
, ABLOCKS_BYTES
);
1085 base
= malloc (ABLOCKS_BYTES
);
1086 abase
= ALIGN (base
, BLOCK_ALIGN
);
1091 MALLOC_UNBLOCK_INPUT
;
1092 memory_full (ABLOCKS_BYTES
);
1095 aligned
= (base
== abase
);
1097 ((void**)abase
)[-1] = base
;
1099 #ifdef DOUG_LEA_MALLOC
1100 /* Back to a reasonable maximum of mmap'ed areas. */
1101 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1105 /* If the memory just allocated cannot be addressed thru a Lisp
1106 object's pointer, and it needs to be, that's equivalent to
1107 running out of memory. */
1108 if (type
!= MEM_TYPE_NON_LISP
)
1111 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1112 XSETCONS (tem
, end
);
1113 if ((char *) XCONS (tem
) != end
)
1115 lisp_malloc_loser
= base
;
1117 MALLOC_UNBLOCK_INPUT
;
1118 memory_full (SIZE_MAX
);
1123 /* Initialize the blocks and put them on the free list.
1124 If `base' was not properly aligned, we can't use the last block. */
1125 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1127 abase
->blocks
[i
].abase
= abase
;
1128 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1129 free_ablock
= &abase
->blocks
[i
];
1131 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1133 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1134 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1135 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1136 eassert (ABLOCKS_BASE (abase
) == base
);
1137 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1140 abase
= ABLOCK_ABASE (free_ablock
);
1141 ABLOCKS_BUSY (abase
) =
1142 (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1144 free_ablock
= free_ablock
->x
.next_free
;
1146 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1147 if (type
!= MEM_TYPE_NON_LISP
)
1148 mem_insert (val
, (char *) val
+ nbytes
, type
);
1151 MALLOC_UNBLOCK_INPUT
;
1153 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1158 lisp_align_free (void *block
)
1160 struct ablock
*ablock
= block
;
1161 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1164 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1165 mem_delete (mem_find (block
));
1167 /* Put on free list. */
1168 ablock
->x
.next_free
= free_ablock
;
1169 free_ablock
= ablock
;
1170 /* Update busy count. */
1171 ABLOCKS_BUSY (abase
)
1172 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1174 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1175 { /* All the blocks are free. */
1176 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1177 struct ablock
**tem
= &free_ablock
;
1178 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1182 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1185 *tem
= (*tem
)->x
.next_free
;
1188 tem
= &(*tem
)->x
.next_free
;
1190 eassert ((aligned
& 1) == aligned
);
1191 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1192 #ifdef USE_POSIX_MEMALIGN
1193 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1195 free (ABLOCKS_BASE (abase
));
1197 MALLOC_UNBLOCK_INPUT
;
1201 #ifndef SYSTEM_MALLOC
1203 /* Arranging to disable input signals while we're in malloc.
1205 This only works with GNU malloc. To help out systems which can't
1206 use GNU malloc, all the calls to malloc, realloc, and free
1207 elsewhere in the code should be inside a BLOCK_INPUT/UNBLOCK_INPUT
1208 pair; unfortunately, we have no idea what C library functions
1209 might call malloc, so we can't really protect them unless you're
1210 using GNU malloc. Fortunately, most of the major operating systems
1211 can use GNU malloc. */
1214 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
1215 there's no need to block input around malloc. */
1217 #ifndef DOUG_LEA_MALLOC
1218 extern void * (*__malloc_hook
) (size_t, const void *);
1219 extern void * (*__realloc_hook
) (void *, size_t, const void *);
1220 extern void (*__free_hook
) (void *, const void *);
1221 /* Else declared in malloc.h, perhaps with an extra arg. */
1222 #endif /* DOUG_LEA_MALLOC */
1223 static void * (*old_malloc_hook
) (size_t, const void *);
1224 static void * (*old_realloc_hook
) (void *, size_t, const void*);
1225 static void (*old_free_hook
) (void*, const void*);
1227 #ifdef DOUG_LEA_MALLOC
1228 # define BYTES_USED (mallinfo ().uordblks)
1230 # define BYTES_USED _bytes_used
1233 #ifdef GC_MALLOC_CHECK
1234 static int dont_register_blocks
;
1237 static size_t bytes_used_when_reconsidered
;
1239 /* Value of _bytes_used, when spare_memory was freed. */
1241 static size_t bytes_used_when_full
;
1243 /* This function is used as the hook for free to call. */
1246 emacs_blocked_free (void *ptr
, const void *ptr2
)
1250 #ifdef GC_MALLOC_CHECK
1256 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1259 "Freeing `%p' which wasn't allocated with malloc\n", ptr
);
1264 /* fprintf (stderr, "free %p...%p (%p)\n", m->start, m->end, ptr); */
1268 #endif /* GC_MALLOC_CHECK */
1270 __free_hook
= old_free_hook
;
1273 /* If we released our reserve (due to running out of memory),
1274 and we have a fair amount free once again,
1275 try to set aside another reserve in case we run out once more. */
1276 if (! NILP (Vmemory_full
)
1277 /* Verify there is enough space that even with the malloc
1278 hysteresis this call won't run out again.
1279 The code here is correct as long as SPARE_MEMORY
1280 is substantially larger than the block size malloc uses. */
1281 && (bytes_used_when_full
1282 > ((bytes_used_when_reconsidered
= BYTES_USED
)
1283 + max (malloc_hysteresis
, 4) * SPARE_MEMORY
)))
1284 refill_memory_reserve ();
1286 __free_hook
= emacs_blocked_free
;
1287 UNBLOCK_INPUT_ALLOC
;
1291 /* This function is the malloc hook that Emacs uses. */
1294 emacs_blocked_malloc (size_t size
, const void *ptr
)
1299 __malloc_hook
= old_malloc_hook
;
1300 #ifdef DOUG_LEA_MALLOC
1301 /* Segfaults on my system. --lorentey */
1302 /* mallopt (M_TOP_PAD, malloc_hysteresis * 4096); */
1304 __malloc_extra_blocks
= malloc_hysteresis
;
1307 value
= malloc (size
);
1309 #ifdef GC_MALLOC_CHECK
1311 struct mem_node
*m
= mem_find (value
);
1314 fprintf (stderr
, "Malloc returned %p which is already in use\n",
1316 fprintf (stderr
, "Region in use is %p...%p, %td bytes, type %d\n",
1317 m
->start
, m
->end
, (char *) m
->end
- (char *) m
->start
,
1322 if (!dont_register_blocks
)
1324 mem_insert (value
, (char *) value
+ max (1, size
), allocated_mem_type
);
1325 allocated_mem_type
= MEM_TYPE_NON_LISP
;
1328 #endif /* GC_MALLOC_CHECK */
1330 __malloc_hook
= emacs_blocked_malloc
;
1331 UNBLOCK_INPUT_ALLOC
;
1333 /* fprintf (stderr, "%p malloc\n", value); */
1338 /* This function is the realloc hook that Emacs uses. */
1341 emacs_blocked_realloc (void *ptr
, size_t size
, const void *ptr2
)
1346 __realloc_hook
= old_realloc_hook
;
1348 #ifdef GC_MALLOC_CHECK
1351 struct mem_node
*m
= mem_find (ptr
);
1352 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1355 "Realloc of %p which wasn't allocated with malloc\n",
1363 /* fprintf (stderr, "%p -> realloc\n", ptr); */
1365 /* Prevent malloc from registering blocks. */
1366 dont_register_blocks
= 1;
1367 #endif /* GC_MALLOC_CHECK */
1369 value
= realloc (ptr
, size
);
1371 #ifdef GC_MALLOC_CHECK
1372 dont_register_blocks
= 0;
1375 struct mem_node
*m
= mem_find (value
);
1378 fprintf (stderr
, "Realloc returns memory that is already in use\n");
1382 /* Can't handle zero size regions in the red-black tree. */
1383 mem_insert (value
, (char *) value
+ max (size
, 1), MEM_TYPE_NON_LISP
);
1386 /* fprintf (stderr, "%p <- realloc\n", value); */
1387 #endif /* GC_MALLOC_CHECK */
1389 __realloc_hook
= emacs_blocked_realloc
;
1390 UNBLOCK_INPUT_ALLOC
;
1397 /* Called from Fdump_emacs so that when the dumped Emacs starts, it has a
1398 normal malloc. Some thread implementations need this as they call
1399 malloc before main. The pthread_self call in BLOCK_INPUT_ALLOC then
1400 calls malloc because it is the first call, and we have an endless loop. */
1403 reset_malloc_hooks (void)
1405 __free_hook
= old_free_hook
;
1406 __malloc_hook
= old_malloc_hook
;
1407 __realloc_hook
= old_realloc_hook
;
1409 #endif /* HAVE_PTHREAD */
1412 /* Called from main to set up malloc to use our hooks. */
1415 uninterrupt_malloc (void)
1418 #ifdef DOUG_LEA_MALLOC
1419 pthread_mutexattr_t attr
;
1421 /* GLIBC has a faster way to do this, but let's keep it portable.
1422 This is according to the Single UNIX Specification. */
1423 pthread_mutexattr_init (&attr
);
1424 pthread_mutexattr_settype (&attr
, PTHREAD_MUTEX_RECURSIVE
);
1425 pthread_mutex_init (&alloc_mutex
, &attr
);
1426 #else /* !DOUG_LEA_MALLOC */
1427 /* Some systems such as Solaris 2.6 don't have a recursive mutex,
1428 and the bundled gmalloc.c doesn't require it. */
1429 pthread_mutex_init (&alloc_mutex
, NULL
);
1430 #endif /* !DOUG_LEA_MALLOC */
1431 #endif /* HAVE_PTHREAD */
1433 if (__free_hook
!= emacs_blocked_free
)
1434 old_free_hook
= __free_hook
;
1435 __free_hook
= emacs_blocked_free
;
1437 if (__malloc_hook
!= emacs_blocked_malloc
)
1438 old_malloc_hook
= __malloc_hook
;
1439 __malloc_hook
= emacs_blocked_malloc
;
1441 if (__realloc_hook
!= emacs_blocked_realloc
)
1442 old_realloc_hook
= __realloc_hook
;
1443 __realloc_hook
= emacs_blocked_realloc
;
1446 #endif /* not SYNC_INPUT */
1447 #endif /* not SYSTEM_MALLOC */
1451 /***********************************************************************
1453 ***********************************************************************/
1455 /* Number of intervals allocated in an interval_block structure.
1456 The 1020 is 1024 minus malloc overhead. */
1458 #define INTERVAL_BLOCK_SIZE \
1459 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1461 /* Intervals are allocated in chunks in form of an interval_block
1464 struct interval_block
1466 /* Place `intervals' first, to preserve alignment. */
1467 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1468 struct interval_block
*next
;
1471 /* Current interval block. Its `next' pointer points to older
1474 static struct interval_block
*interval_block
;
1476 /* Index in interval_block above of the next unused interval
1479 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1481 /* Number of free and live intervals. */
1483 static EMACS_INT total_free_intervals
, total_intervals
;
1485 /* List of free intervals. */
1487 static INTERVAL interval_free_list
;
1489 /* Return a new interval. */
1492 make_interval (void)
1496 /* eassert (!handling_signal); */
1500 if (interval_free_list
)
1502 val
= interval_free_list
;
1503 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1507 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1509 struct interval_block
*newi
1510 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1512 newi
->next
= interval_block
;
1513 interval_block
= newi
;
1514 interval_block_index
= 0;
1515 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1517 val
= &interval_block
->intervals
[interval_block_index
++];
1520 MALLOC_UNBLOCK_INPUT
;
1522 consing_since_gc
+= sizeof (struct interval
);
1524 total_free_intervals
--;
1525 RESET_INTERVAL (val
);
1531 /* Mark Lisp objects in interval I. */
1534 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1536 /* Intervals should never be shared. So, if extra internal checking is
1537 enabled, GC aborts if it seems to have visited an interval twice. */
1538 eassert (!i
->gcmarkbit
);
1540 mark_object (i
->plist
);
1544 /* Mark the interval tree rooted in TREE. Don't call this directly;
1545 use the macro MARK_INTERVAL_TREE instead. */
1548 mark_interval_tree (register INTERVAL tree
)
1550 /* No need to test if this tree has been marked already; this
1551 function is always called through the MARK_INTERVAL_TREE macro,
1552 which takes care of that. */
1554 traverse_intervals_noorder (tree
, mark_interval
, Qnil
);
1558 /* Mark the interval tree rooted in I. */
1560 #define MARK_INTERVAL_TREE(i) \
1562 if (!NULL_INTERVAL_P (i) && !i->gcmarkbit) \
1563 mark_interval_tree (i); \
1567 #define UNMARK_BALANCE_INTERVALS(i) \
1569 if (! NULL_INTERVAL_P (i)) \
1570 (i) = balance_intervals (i); \
1573 /***********************************************************************
1575 ***********************************************************************/
1577 /* Lisp_Strings are allocated in string_block structures. When a new
1578 string_block is allocated, all the Lisp_Strings it contains are
1579 added to a free-list string_free_list. When a new Lisp_String is
1580 needed, it is taken from that list. During the sweep phase of GC,
1581 string_blocks that are entirely free are freed, except two which
1584 String data is allocated from sblock structures. Strings larger
1585 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1586 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1588 Sblocks consist internally of sdata structures, one for each
1589 Lisp_String. The sdata structure points to the Lisp_String it
1590 belongs to. The Lisp_String points back to the `u.data' member of
1591 its sdata structure.
1593 When a Lisp_String is freed during GC, it is put back on
1594 string_free_list, and its `data' member and its sdata's `string'
1595 pointer is set to null. The size of the string is recorded in the
1596 `u.nbytes' member of the sdata. So, sdata structures that are no
1597 longer used, can be easily recognized, and it's easy to compact the
1598 sblocks of small strings which we do in compact_small_strings. */
1600 /* Size in bytes of an sblock structure used for small strings. This
1601 is 8192 minus malloc overhead. */
1603 #define SBLOCK_SIZE 8188
1605 /* Strings larger than this are considered large strings. String data
1606 for large strings is allocated from individual sblocks. */
1608 #define LARGE_STRING_BYTES 1024
1610 /* Structure describing string memory sub-allocated from an sblock.
1611 This is where the contents of Lisp strings are stored. */
1615 /* Back-pointer to the string this sdata belongs to. If null, this
1616 structure is free, and the NBYTES member of the union below
1617 contains the string's byte size (the same value that STRING_BYTES
1618 would return if STRING were non-null). If non-null, STRING_BYTES
1619 (STRING) is the size of the data, and DATA contains the string's
1621 struct Lisp_String
*string
;
1623 #ifdef GC_CHECK_STRING_BYTES
1626 unsigned char data
[1];
1628 #define SDATA_NBYTES(S) (S)->nbytes
1629 #define SDATA_DATA(S) (S)->data
1630 #define SDATA_SELECTOR(member) member
1632 #else /* not GC_CHECK_STRING_BYTES */
1636 /* When STRING is non-null. */
1637 unsigned char data
[1];
1639 /* When STRING is null. */
1643 #define SDATA_NBYTES(S) (S)->u.nbytes
1644 #define SDATA_DATA(S) (S)->u.data
1645 #define SDATA_SELECTOR(member) u.member
1647 #endif /* not GC_CHECK_STRING_BYTES */
1649 #define SDATA_DATA_OFFSET offsetof (struct sdata, SDATA_SELECTOR (data))
1653 /* Structure describing a block of memory which is sub-allocated to
1654 obtain string data memory for strings. Blocks for small strings
1655 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1656 as large as needed. */
1661 struct sblock
*next
;
1663 /* Pointer to the next free sdata block. This points past the end
1664 of the sblock if there isn't any space left in this block. */
1665 struct sdata
*next_free
;
1667 /* Start of data. */
1668 struct sdata first_data
;
1671 /* Number of Lisp strings in a string_block structure. The 1020 is
1672 1024 minus malloc overhead. */
1674 #define STRING_BLOCK_SIZE \
1675 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1677 /* Structure describing a block from which Lisp_String structures
1682 /* Place `strings' first, to preserve alignment. */
1683 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1684 struct string_block
*next
;
1687 /* Head and tail of the list of sblock structures holding Lisp string
1688 data. We always allocate from current_sblock. The NEXT pointers
1689 in the sblock structures go from oldest_sblock to current_sblock. */
1691 static struct sblock
*oldest_sblock
, *current_sblock
;
1693 /* List of sblocks for large strings. */
1695 static struct sblock
*large_sblocks
;
1697 /* List of string_block structures. */
1699 static struct string_block
*string_blocks
;
1701 /* Free-list of Lisp_Strings. */
1703 static struct Lisp_String
*string_free_list
;
1705 /* Number of live and free Lisp_Strings. */
1707 static EMACS_INT total_strings
, total_free_strings
;
1709 /* Number of bytes used by live strings. */
1711 static EMACS_INT total_string_size
;
1713 /* Given a pointer to a Lisp_String S which is on the free-list
1714 string_free_list, return a pointer to its successor in the
1717 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1719 /* Return a pointer to the sdata structure belonging to Lisp string S.
1720 S must be live, i.e. S->data must not be null. S->data is actually
1721 a pointer to the `u.data' member of its sdata structure; the
1722 structure starts at a constant offset in front of that. */
1724 #define SDATA_OF_STRING(S) ((struct sdata *) ((S)->data - SDATA_DATA_OFFSET))
1727 #ifdef GC_CHECK_STRING_OVERRUN
1729 /* We check for overrun in string data blocks by appending a small
1730 "cookie" after each allocated string data block, and check for the
1731 presence of this cookie during GC. */
1733 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1734 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1735 { '\xde', '\xad', '\xbe', '\xef' };
1738 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1741 /* Value is the size of an sdata structure large enough to hold NBYTES
1742 bytes of string data. The value returned includes a terminating
1743 NUL byte, the size of the sdata structure, and padding. */
1745 #ifdef GC_CHECK_STRING_BYTES
1747 #define SDATA_SIZE(NBYTES) \
1748 ((SDATA_DATA_OFFSET \
1750 + sizeof (ptrdiff_t) - 1) \
1751 & ~(sizeof (ptrdiff_t) - 1))
1753 #else /* not GC_CHECK_STRING_BYTES */
1755 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1756 less than the size of that member. The 'max' is not needed when
1757 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1758 alignment code reserves enough space. */
1760 #define SDATA_SIZE(NBYTES) \
1761 ((SDATA_DATA_OFFSET \
1762 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1764 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1766 + sizeof (ptrdiff_t) - 1) \
1767 & ~(sizeof (ptrdiff_t) - 1))
1769 #endif /* not GC_CHECK_STRING_BYTES */
1771 /* Extra bytes to allocate for each string. */
1773 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1775 /* Exact bound on the number of bytes in a string, not counting the
1776 terminating null. A string cannot contain more bytes than
1777 STRING_BYTES_BOUND, nor can it be so long that the size_t
1778 arithmetic in allocate_string_data would overflow while it is
1779 calculating a value to be passed to malloc. */
1780 #define STRING_BYTES_MAX \
1781 min (STRING_BYTES_BOUND, \
1782 ((SIZE_MAX - XMALLOC_OVERRUN_CHECK_OVERHEAD \
1784 - offsetof (struct sblock, first_data) \
1785 - SDATA_DATA_OFFSET) \
1786 & ~(sizeof (EMACS_INT) - 1)))
1788 /* Initialize string allocation. Called from init_alloc_once. */
1793 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1794 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1798 #ifdef GC_CHECK_STRING_BYTES
1800 static int check_string_bytes_count
;
1802 #define CHECK_STRING_BYTES(S) STRING_BYTES (S)
1805 /* Like GC_STRING_BYTES, but with debugging check. */
1808 string_bytes (struct Lisp_String
*s
)
1811 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1813 if (!PURE_POINTER_P (s
)
1815 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1820 /* Check validity of Lisp strings' string_bytes member in B. */
1823 check_sblock (struct sblock
*b
)
1825 struct sdata
*from
, *end
, *from_end
;
1829 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1831 /* Compute the next FROM here because copying below may
1832 overwrite data we need to compute it. */
1835 /* Check that the string size recorded in the string is the
1836 same as the one recorded in the sdata structure. */
1838 CHECK_STRING_BYTES (from
->string
);
1841 nbytes
= GC_STRING_BYTES (from
->string
);
1843 nbytes
= SDATA_NBYTES (from
);
1845 nbytes
= SDATA_SIZE (nbytes
);
1846 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1851 /* Check validity of Lisp strings' string_bytes member. ALL_P
1852 non-zero means check all strings, otherwise check only most
1853 recently allocated strings. Used for hunting a bug. */
1856 check_string_bytes (int all_p
)
1862 for (b
= large_sblocks
; b
; b
= b
->next
)
1864 struct Lisp_String
*s
= b
->first_data
.string
;
1866 CHECK_STRING_BYTES (s
);
1869 for (b
= oldest_sblock
; b
; b
= b
->next
)
1872 else if (current_sblock
)
1873 check_sblock (current_sblock
);
1876 #endif /* GC_CHECK_STRING_BYTES */
1878 #ifdef GC_CHECK_STRING_FREE_LIST
1880 /* Walk through the string free list looking for bogus next pointers.
1881 This may catch buffer overrun from a previous string. */
1884 check_string_free_list (void)
1886 struct Lisp_String
*s
;
1888 /* Pop a Lisp_String off the free-list. */
1889 s
= string_free_list
;
1892 if ((uintptr_t) s
< 1024)
1894 s
= NEXT_FREE_LISP_STRING (s
);
1898 #define check_string_free_list()
1901 /* Return a new Lisp_String. */
1903 static struct Lisp_String
*
1904 allocate_string (void)
1906 struct Lisp_String
*s
;
1908 /* eassert (!handling_signal); */
1912 /* If the free-list is empty, allocate a new string_block, and
1913 add all the Lisp_Strings in it to the free-list. */
1914 if (string_free_list
== NULL
)
1916 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1919 b
->next
= string_blocks
;
1922 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1925 /* Every string on a free list should have NULL data pointer. */
1927 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1928 string_free_list
= s
;
1931 total_free_strings
+= STRING_BLOCK_SIZE
;
1934 check_string_free_list ();
1936 /* Pop a Lisp_String off the free-list. */
1937 s
= string_free_list
;
1938 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1940 MALLOC_UNBLOCK_INPUT
;
1942 --total_free_strings
;
1945 consing_since_gc
+= sizeof *s
;
1947 #ifdef GC_CHECK_STRING_BYTES
1948 if (!noninteractive
)
1950 if (++check_string_bytes_count
== 200)
1952 check_string_bytes_count
= 0;
1953 check_string_bytes (1);
1956 check_string_bytes (0);
1958 #endif /* GC_CHECK_STRING_BYTES */
1964 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1965 plus a NUL byte at the end. Allocate an sdata structure for S, and
1966 set S->data to its `u.data' member. Store a NUL byte at the end of
1967 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1968 S->data if it was initially non-null. */
1971 allocate_string_data (struct Lisp_String
*s
,
1972 EMACS_INT nchars
, EMACS_INT nbytes
)
1974 struct sdata
*data
, *old_data
;
1976 ptrdiff_t needed
, old_nbytes
;
1978 if (STRING_BYTES_MAX
< nbytes
)
1981 /* Determine the number of bytes needed to store NBYTES bytes
1983 needed
= SDATA_SIZE (nbytes
);
1986 old_data
= SDATA_OF_STRING (s
);
1987 old_nbytes
= GC_STRING_BYTES (s
);
1994 if (nbytes
> LARGE_STRING_BYTES
)
1996 size_t size
= offsetof (struct sblock
, first_data
) + needed
;
1998 #ifdef DOUG_LEA_MALLOC
1999 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
2000 because mapped region contents are not preserved in
2003 In case you think of allowing it in a dumped Emacs at the
2004 cost of not being able to re-dump, there's another reason:
2005 mmap'ed data typically have an address towards the top of the
2006 address space, which won't fit into an EMACS_INT (at least on
2007 32-bit systems with the current tagging scheme). --fx */
2008 mallopt (M_MMAP_MAX
, 0);
2011 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
2013 #ifdef DOUG_LEA_MALLOC
2014 /* Back to a reasonable maximum of mmap'ed areas. */
2015 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2018 b
->next_free
= &b
->first_data
;
2019 b
->first_data
.string
= NULL
;
2020 b
->next
= large_sblocks
;
2023 else if (current_sblock
== NULL
2024 || (((char *) current_sblock
+ SBLOCK_SIZE
2025 - (char *) current_sblock
->next_free
)
2026 < (needed
+ GC_STRING_EXTRA
)))
2028 /* Not enough room in the current sblock. */
2029 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
2030 b
->next_free
= &b
->first_data
;
2031 b
->first_data
.string
= NULL
;
2035 current_sblock
->next
= b
;
2043 data
= b
->next_free
;
2044 b
->next_free
= (struct sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
2046 MALLOC_UNBLOCK_INPUT
;
2049 s
->data
= SDATA_DATA (data
);
2050 #ifdef GC_CHECK_STRING_BYTES
2051 SDATA_NBYTES (data
) = nbytes
;
2054 s
->size_byte
= nbytes
;
2055 s
->data
[nbytes
] = '\0';
2056 #ifdef GC_CHECK_STRING_OVERRUN
2057 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
2058 GC_STRING_OVERRUN_COOKIE_SIZE
);
2061 /* Note that Faset may call to this function when S has already data
2062 assigned. In this case, mark data as free by setting it's string
2063 back-pointer to null, and record the size of the data in it. */
2066 SDATA_NBYTES (old_data
) = old_nbytes
;
2067 old_data
->string
= NULL
;
2070 consing_since_gc
+= needed
;
2074 /* Sweep and compact strings. */
2077 sweep_strings (void)
2079 struct string_block
*b
, *next
;
2080 struct string_block
*live_blocks
= NULL
;
2082 string_free_list
= NULL
;
2083 total_strings
= total_free_strings
= 0;
2084 total_string_size
= 0;
2086 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
2087 for (b
= string_blocks
; b
; b
= next
)
2090 struct Lisp_String
*free_list_before
= string_free_list
;
2094 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
2096 struct Lisp_String
*s
= b
->strings
+ i
;
2100 /* String was not on free-list before. */
2101 if (STRING_MARKED_P (s
))
2103 /* String is live; unmark it and its intervals. */
2106 if (!NULL_INTERVAL_P (s
->intervals
))
2107 UNMARK_BALANCE_INTERVALS (s
->intervals
);
2110 total_string_size
+= STRING_BYTES (s
);
2114 /* String is dead. Put it on the free-list. */
2115 struct sdata
*data
= SDATA_OF_STRING (s
);
2117 /* Save the size of S in its sdata so that we know
2118 how large that is. Reset the sdata's string
2119 back-pointer so that we know it's free. */
2120 #ifdef GC_CHECK_STRING_BYTES
2121 if (GC_STRING_BYTES (s
) != SDATA_NBYTES (data
))
2124 data
->u
.nbytes
= GC_STRING_BYTES (s
);
2126 data
->string
= NULL
;
2128 /* Reset the strings's `data' member so that we
2132 /* Put the string on the free-list. */
2133 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2134 string_free_list
= s
;
2140 /* S was on the free-list before. Put it there again. */
2141 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2142 string_free_list
= s
;
2147 /* Free blocks that contain free Lisp_Strings only, except
2148 the first two of them. */
2149 if (nfree
== STRING_BLOCK_SIZE
2150 && total_free_strings
> STRING_BLOCK_SIZE
)
2153 string_free_list
= free_list_before
;
2157 total_free_strings
+= nfree
;
2158 b
->next
= live_blocks
;
2163 check_string_free_list ();
2165 string_blocks
= live_blocks
;
2166 free_large_strings ();
2167 compact_small_strings ();
2169 check_string_free_list ();
2173 /* Free dead large strings. */
2176 free_large_strings (void)
2178 struct sblock
*b
, *next
;
2179 struct sblock
*live_blocks
= NULL
;
2181 for (b
= large_sblocks
; b
; b
= next
)
2185 if (b
->first_data
.string
== NULL
)
2189 b
->next
= live_blocks
;
2194 large_sblocks
= live_blocks
;
2198 /* Compact data of small strings. Free sblocks that don't contain
2199 data of live strings after compaction. */
2202 compact_small_strings (void)
2204 struct sblock
*b
, *tb
, *next
;
2205 struct sdata
*from
, *to
, *end
, *tb_end
;
2206 struct sdata
*to_end
, *from_end
;
2208 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2209 to, and TB_END is the end of TB. */
2211 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2212 to
= &tb
->first_data
;
2214 /* Step through the blocks from the oldest to the youngest. We
2215 expect that old blocks will stabilize over time, so that less
2216 copying will happen this way. */
2217 for (b
= oldest_sblock
; b
; b
= b
->next
)
2220 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2222 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
2224 /* Compute the next FROM here because copying below may
2225 overwrite data we need to compute it. */
2228 #ifdef GC_CHECK_STRING_BYTES
2229 /* Check that the string size recorded in the string is the
2230 same as the one recorded in the sdata structure. */
2232 && GC_STRING_BYTES (from
->string
) != SDATA_NBYTES (from
))
2234 #endif /* GC_CHECK_STRING_BYTES */
2237 nbytes
= GC_STRING_BYTES (from
->string
);
2239 nbytes
= SDATA_NBYTES (from
);
2241 if (nbytes
> LARGE_STRING_BYTES
)
2244 nbytes
= SDATA_SIZE (nbytes
);
2245 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2247 #ifdef GC_CHECK_STRING_OVERRUN
2248 if (memcmp (string_overrun_cookie
,
2249 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2250 GC_STRING_OVERRUN_COOKIE_SIZE
))
2254 /* FROM->string non-null means it's alive. Copy its data. */
2257 /* If TB is full, proceed with the next sblock. */
2258 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2259 if (to_end
> tb_end
)
2263 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2264 to
= &tb
->first_data
;
2265 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2268 /* Copy, and update the string's `data' pointer. */
2271 eassert (tb
!= b
|| to
< from
);
2272 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2273 to
->string
->data
= SDATA_DATA (to
);
2276 /* Advance past the sdata we copied to. */
2282 /* The rest of the sblocks following TB don't contain live data, so
2283 we can free them. */
2284 for (b
= tb
->next
; b
; b
= next
)
2292 current_sblock
= tb
;
2296 string_overflow (void)
2298 error ("Maximum string size exceeded");
2301 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2302 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2303 LENGTH must be an integer.
2304 INIT must be an integer that represents a character. */)
2305 (Lisp_Object length
, Lisp_Object init
)
2307 register Lisp_Object val
;
2308 register unsigned char *p
, *end
;
2312 CHECK_NATNUM (length
);
2313 CHECK_CHARACTER (init
);
2315 c
= XFASTINT (init
);
2316 if (ASCII_CHAR_P (c
))
2318 nbytes
= XINT (length
);
2319 val
= make_uninit_string (nbytes
);
2321 end
= p
+ SCHARS (val
);
2327 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2328 int len
= CHAR_STRING (c
, str
);
2329 EMACS_INT string_len
= XINT (length
);
2331 if (string_len
> STRING_BYTES_MAX
/ len
)
2333 nbytes
= len
* string_len
;
2334 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2339 memcpy (p
, str
, len
);
2349 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2350 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2351 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2352 (Lisp_Object length
, Lisp_Object init
)
2354 register Lisp_Object val
;
2355 struct Lisp_Bool_Vector
*p
;
2356 ptrdiff_t length_in_chars
;
2357 EMACS_INT length_in_elts
;
2360 CHECK_NATNUM (length
);
2362 bits_per_value
= sizeof (EMACS_INT
) * BOOL_VECTOR_BITS_PER_CHAR
;
2364 length_in_elts
= (XFASTINT (length
) + bits_per_value
- 1) / bits_per_value
;
2366 /* We must allocate one more elements than LENGTH_IN_ELTS for the
2367 slot `size' of the struct Lisp_Bool_Vector. */
2368 val
= Fmake_vector (make_number (length_in_elts
+ 1), Qnil
);
2370 /* No Lisp_Object to trace in there. */
2371 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0);
2373 p
= XBOOL_VECTOR (val
);
2374 p
->size
= XFASTINT (length
);
2376 length_in_chars
= ((XFASTINT (length
) + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2377 / BOOL_VECTOR_BITS_PER_CHAR
);
2378 if (length_in_chars
)
2380 memset (p
->data
, ! NILP (init
) ? -1 : 0, length_in_chars
);
2382 /* Clear any extraneous bits in the last byte. */
2383 p
->data
[length_in_chars
- 1]
2384 &= (1 << (XINT (length
) % BOOL_VECTOR_BITS_PER_CHAR
)) - 1;
2391 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2392 of characters from the contents. This string may be unibyte or
2393 multibyte, depending on the contents. */
2396 make_string (const char *contents
, ptrdiff_t nbytes
)
2398 register Lisp_Object val
;
2399 ptrdiff_t nchars
, multibyte_nbytes
;
2401 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2402 &nchars
, &multibyte_nbytes
);
2403 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2404 /* CONTENTS contains no multibyte sequences or contains an invalid
2405 multibyte sequence. We must make unibyte string. */
2406 val
= make_unibyte_string (contents
, nbytes
);
2408 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2413 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2416 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2418 register Lisp_Object val
;
2419 val
= make_uninit_string (length
);
2420 memcpy (SDATA (val
), contents
, length
);
2425 /* Make a multibyte string from NCHARS characters occupying NBYTES
2426 bytes at CONTENTS. */
2429 make_multibyte_string (const char *contents
,
2430 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2432 register Lisp_Object val
;
2433 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2434 memcpy (SDATA (val
), contents
, nbytes
);
2439 /* Make a string from NCHARS characters occupying NBYTES bytes at
2440 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2443 make_string_from_bytes (const char *contents
,
2444 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2446 register Lisp_Object val
;
2447 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2448 memcpy (SDATA (val
), contents
, nbytes
);
2449 if (SBYTES (val
) == SCHARS (val
))
2450 STRING_SET_UNIBYTE (val
);
2455 /* Make a string from NCHARS characters occupying NBYTES bytes at
2456 CONTENTS. The argument MULTIBYTE controls whether to label the
2457 string as multibyte. If NCHARS is negative, it counts the number of
2458 characters by itself. */
2461 make_specified_string (const char *contents
,
2462 ptrdiff_t nchars
, ptrdiff_t nbytes
, int multibyte
)
2464 register Lisp_Object val
;
2469 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2474 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2475 memcpy (SDATA (val
), contents
, nbytes
);
2477 STRING_SET_UNIBYTE (val
);
2482 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2483 occupying LENGTH bytes. */
2486 make_uninit_string (EMACS_INT length
)
2491 return empty_unibyte_string
;
2492 val
= make_uninit_multibyte_string (length
, length
);
2493 STRING_SET_UNIBYTE (val
);
2498 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2499 which occupy NBYTES bytes. */
2502 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2505 struct Lisp_String
*s
;
2510 return empty_multibyte_string
;
2512 s
= allocate_string ();
2513 s
->intervals
= NULL_INTERVAL
;
2514 allocate_string_data (s
, nchars
, nbytes
);
2515 XSETSTRING (string
, s
);
2516 string_chars_consed
+= nbytes
;
2520 /* Print arguments to BUF according to a FORMAT, then return
2521 a Lisp_String initialized with the data from BUF. */
2524 make_formatted_string (char *buf
, const char *format
, ...)
2529 va_start (ap
, format
);
2530 length
= vsprintf (buf
, format
, ap
);
2532 return make_string (buf
, length
);
2536 /***********************************************************************
2538 ***********************************************************************/
2540 /* We store float cells inside of float_blocks, allocating a new
2541 float_block with malloc whenever necessary. Float cells reclaimed
2542 by GC are put on a free list to be reallocated before allocating
2543 any new float cells from the latest float_block. */
2545 #define FLOAT_BLOCK_SIZE \
2546 (((BLOCK_BYTES - sizeof (struct float_block *) \
2547 /* The compiler might add padding at the end. */ \
2548 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2549 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2551 #define GETMARKBIT(block,n) \
2552 (((block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2553 >> ((n) % (sizeof (int) * CHAR_BIT))) \
2556 #define SETMARKBIT(block,n) \
2557 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2558 |= 1 << ((n) % (sizeof (int) * CHAR_BIT))
2560 #define UNSETMARKBIT(block,n) \
2561 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2562 &= ~(1 << ((n) % (sizeof (int) * CHAR_BIT)))
2564 #define FLOAT_BLOCK(fptr) \
2565 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2567 #define FLOAT_INDEX(fptr) \
2568 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2572 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2573 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2574 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2575 struct float_block
*next
;
2578 #define FLOAT_MARKED_P(fptr) \
2579 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2581 #define FLOAT_MARK(fptr) \
2582 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2584 #define FLOAT_UNMARK(fptr) \
2585 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2587 /* Current float_block. */
2589 static struct float_block
*float_block
;
2591 /* Index of first unused Lisp_Float in the current float_block. */
2593 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2595 /* Free-list of Lisp_Floats. */
2597 static struct Lisp_Float
*float_free_list
;
2599 /* Return a new float object with value FLOAT_VALUE. */
2602 make_float (double float_value
)
2604 register Lisp_Object val
;
2606 /* eassert (!handling_signal); */
2610 if (float_free_list
)
2612 /* We use the data field for chaining the free list
2613 so that we won't use the same field that has the mark bit. */
2614 XSETFLOAT (val
, float_free_list
);
2615 float_free_list
= float_free_list
->u
.chain
;
2619 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2621 struct float_block
*new
2622 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2623 new->next
= float_block
;
2624 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2626 float_block_index
= 0;
2627 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2629 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2630 float_block_index
++;
2633 MALLOC_UNBLOCK_INPUT
;
2635 XFLOAT_INIT (val
, float_value
);
2636 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2637 consing_since_gc
+= sizeof (struct Lisp_Float
);
2639 total_free_floats
--;
2645 /***********************************************************************
2647 ***********************************************************************/
2649 /* We store cons cells inside of cons_blocks, allocating a new
2650 cons_block with malloc whenever necessary. Cons cells reclaimed by
2651 GC are put on a free list to be reallocated before allocating
2652 any new cons cells from the latest cons_block. */
2654 #define CONS_BLOCK_SIZE \
2655 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2656 /* The compiler might add padding at the end. */ \
2657 - (sizeof (struct Lisp_Cons) - sizeof (int))) * CHAR_BIT) \
2658 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2660 #define CONS_BLOCK(fptr) \
2661 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2663 #define CONS_INDEX(fptr) \
2664 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2668 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2669 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2670 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2671 struct cons_block
*next
;
2674 #define CONS_MARKED_P(fptr) \
2675 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2677 #define CONS_MARK(fptr) \
2678 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2680 #define CONS_UNMARK(fptr) \
2681 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2683 /* Current cons_block. */
2685 static struct cons_block
*cons_block
;
2687 /* Index of first unused Lisp_Cons in the current block. */
2689 static int cons_block_index
= CONS_BLOCK_SIZE
;
2691 /* Free-list of Lisp_Cons structures. */
2693 static struct Lisp_Cons
*cons_free_list
;
2695 /* Explicitly free a cons cell by putting it on the free-list. */
2698 free_cons (struct Lisp_Cons
*ptr
)
2700 ptr
->u
.chain
= cons_free_list
;
2704 cons_free_list
= ptr
;
2705 total_free_conses
++;
2708 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2709 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2710 (Lisp_Object car
, Lisp_Object cdr
)
2712 register Lisp_Object val
;
2714 /* eassert (!handling_signal); */
2720 /* We use the cdr for chaining the free list
2721 so that we won't use the same field that has the mark bit. */
2722 XSETCONS (val
, cons_free_list
);
2723 cons_free_list
= cons_free_list
->u
.chain
;
2727 if (cons_block_index
== CONS_BLOCK_SIZE
)
2729 struct cons_block
*new
2730 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2731 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2732 new->next
= cons_block
;
2734 cons_block_index
= 0;
2735 total_free_conses
+= CONS_BLOCK_SIZE
;
2737 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2741 MALLOC_UNBLOCK_INPUT
;
2745 eassert (!CONS_MARKED_P (XCONS (val
)));
2746 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2747 total_free_conses
--;
2748 cons_cells_consed
++;
2752 #ifdef GC_CHECK_CONS_LIST
2753 /* Get an error now if there's any junk in the cons free list. */
2755 check_cons_list (void)
2757 struct Lisp_Cons
*tail
= cons_free_list
;
2760 tail
= tail
->u
.chain
;
2764 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2767 list1 (Lisp_Object arg1
)
2769 return Fcons (arg1
, Qnil
);
2773 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2775 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2780 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2782 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2787 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2789 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2794 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2796 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2797 Fcons (arg5
, Qnil
)))));
2801 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2802 doc
: /* Return a newly created list with specified arguments as elements.
2803 Any number of arguments, even zero arguments, are allowed.
2804 usage: (list &rest OBJECTS) */)
2805 (ptrdiff_t nargs
, Lisp_Object
*args
)
2807 register Lisp_Object val
;
2813 val
= Fcons (args
[nargs
], val
);
2819 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2820 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2821 (register Lisp_Object length
, Lisp_Object init
)
2823 register Lisp_Object val
;
2824 register EMACS_INT size
;
2826 CHECK_NATNUM (length
);
2827 size
= XFASTINT (length
);
2832 val
= Fcons (init
, val
);
2837 val
= Fcons (init
, val
);
2842 val
= Fcons (init
, val
);
2847 val
= Fcons (init
, val
);
2852 val
= Fcons (init
, val
);
2867 /***********************************************************************
2869 ***********************************************************************/
2871 /* This value is balanced well enough to avoid too much internal overhead
2872 for the most common cases; it's not required to be a power of two, but
2873 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2875 #define VECTOR_BLOCK_SIZE 4096
2877 /* Handy constants for vectorlike objects. */
2880 header_size
= offsetof (struct Lisp_Vector
, contents
),
2881 word_size
= sizeof (Lisp_Object
),
2882 roundup_size
= COMMON_MULTIPLE (sizeof (Lisp_Object
),
2883 USE_LSB_TAG
? 1 << GCTYPEBITS
: 1)
2886 /* ROUNDUP_SIZE must be a power of 2. */
2887 verify ((roundup_size
& (roundup_size
- 1)) == 0);
2889 /* Verify assumptions described above. */
2890 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2891 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2893 /* Round up X to nearest mult-of-ROUNDUP_SIZE. */
2895 #define vroundup(x) (((x) + (roundup_size - 1)) & ~(roundup_size - 1))
2897 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2899 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup (sizeof (void *)))
2901 /* Size of the minimal vector allocated from block. */
2903 #define VBLOCK_BYTES_MIN vroundup (sizeof (struct Lisp_Vector))
2905 /* Size of the largest vector allocated from block. */
2907 #define VBLOCK_BYTES_MAX \
2908 vroundup ((VECTOR_BLOCK_BYTES / 2) - sizeof (Lisp_Object))
2910 /* We maintain one free list for each possible block-allocated
2911 vector size, and this is the number of free lists we have. */
2913 #define VECTOR_MAX_FREE_LIST_INDEX \
2914 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2916 /* Common shortcut to advance vector pointer over a block data. */
2918 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2920 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2922 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2924 /* Common shortcut to setup vector on a free list. */
2926 #define SETUP_ON_FREE_LIST(v, nbytes, index) \
2928 XSETPVECTYPESIZE (v, PVEC_FREE, nbytes); \
2929 eassert ((nbytes) % roundup_size == 0); \
2930 (index) = VINDEX (nbytes); \
2931 eassert ((index) < VECTOR_MAX_FREE_LIST_INDEX); \
2932 (v)->header.next.vector = vector_free_lists[index]; \
2933 vector_free_lists[index] = (v); \
2934 total_free_vector_bytes += (nbytes); \
2939 char data
[VECTOR_BLOCK_BYTES
];
2940 struct vector_block
*next
;
2943 /* Chain of vector blocks. */
2945 static struct vector_block
*vector_blocks
;
2947 /* Vector free lists, where NTH item points to a chain of free
2948 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2950 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2952 /* Singly-linked list of large vectors. */
2954 static struct Lisp_Vector
*large_vectors
;
2956 /* The only vector with 0 slots, allocated from pure space. */
2958 Lisp_Object zero_vector
;
2960 /* Get a new vector block. */
2962 static struct vector_block
*
2963 allocate_vector_block (void)
2965 struct vector_block
*block
= xmalloc (sizeof *block
);
2967 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
2968 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
2969 MEM_TYPE_VECTOR_BLOCK
);
2972 block
->next
= vector_blocks
;
2973 vector_blocks
= block
;
2977 /* Called once to initialize vector allocation. */
2982 zero_vector
= make_pure_vector (0);
2985 /* Allocate vector from a vector block. */
2987 static struct Lisp_Vector
*
2988 allocate_vector_from_block (size_t nbytes
)
2990 struct Lisp_Vector
*vector
, *rest
;
2991 struct vector_block
*block
;
2992 size_t index
, restbytes
;
2994 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
2995 eassert (nbytes
% roundup_size
== 0);
2997 /* First, try to allocate from a free list
2998 containing vectors of the requested size. */
2999 index
= VINDEX (nbytes
);
3000 if (vector_free_lists
[index
])
3002 vector
= vector_free_lists
[index
];
3003 vector_free_lists
[index
] = vector
->header
.next
.vector
;
3004 vector
->header
.next
.nbytes
= nbytes
;
3005 total_free_vector_bytes
-= nbytes
;
3009 /* Next, check free lists containing larger vectors. Since
3010 we will split the result, we should have remaining space
3011 large enough to use for one-slot vector at least. */
3012 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
3013 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
3014 if (vector_free_lists
[index
])
3016 /* This vector is larger than requested. */
3017 vector
= vector_free_lists
[index
];
3018 vector_free_lists
[index
] = vector
->header
.next
.vector
;
3019 vector
->header
.next
.nbytes
= nbytes
;
3020 total_free_vector_bytes
-= nbytes
;
3022 /* Excess bytes are used for the smaller vector,
3023 which should be set on an appropriate free list. */
3024 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
3025 eassert (restbytes
% roundup_size
== 0);
3026 rest
= ADVANCE (vector
, nbytes
);
3027 SETUP_ON_FREE_LIST (rest
, restbytes
, index
);
3031 /* Finally, need a new vector block. */
3032 block
= allocate_vector_block ();
3034 /* New vector will be at the beginning of this block. */
3035 vector
= (struct Lisp_Vector
*) block
->data
;
3036 vector
->header
.next
.nbytes
= nbytes
;
3038 /* If the rest of space from this block is large enough
3039 for one-slot vector at least, set up it on a free list. */
3040 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
3041 if (restbytes
>= VBLOCK_BYTES_MIN
)
3043 eassert (restbytes
% roundup_size
== 0);
3044 rest
= ADVANCE (vector
, nbytes
);
3045 SETUP_ON_FREE_LIST (rest
, restbytes
, index
);
3050 /* Return how many Lisp_Objects can be stored in V. */
3052 #define VECTOR_SIZE(v) ((v)->header.size & PSEUDOVECTOR_FLAG ? \
3053 (PSEUDOVECTOR_SIZE_MASK & (v)->header.size) : \
3056 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
3058 #define VECTOR_IN_BLOCK(vector, block) \
3059 ((char *) (vector) <= (block)->data \
3060 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
3062 /* Number of bytes used by vector-block-allocated object. This is the only
3063 place where we actually use the `nbytes' field of the vector-header.
3064 I.e. we could get rid of the `nbytes' field by computing it based on the
3067 #define PSEUDOVECTOR_NBYTES(vector) \
3068 (PSEUDOVECTOR_TYPEP (&vector->header, PVEC_FREE) \
3069 ? vector->header.size & PSEUDOVECTOR_SIZE_MASK \
3070 : vector->header.next.nbytes)
3072 /* Reclaim space used by unmarked vectors. */
3075 sweep_vectors (void)
3077 struct vector_block
*block
= vector_blocks
, **bprev
= &vector_blocks
;
3078 struct Lisp_Vector
*vector
, *next
, **vprev
= &large_vectors
;
3080 total_free_vector_bytes
= total_vector_size
= 0;
3081 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
3083 /* Looking through vector blocks. */
3085 for (block
= vector_blocks
; block
; block
= *bprev
)
3087 int free_this_block
= 0;
3089 for (vector
= (struct Lisp_Vector
*) block
->data
;
3090 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
3092 if (VECTOR_MARKED_P (vector
))
3094 VECTOR_UNMARK (vector
);
3095 total_vector_size
+= VECTOR_SIZE (vector
);
3096 next
= ADVANCE (vector
, vector
->header
.next
.nbytes
);
3100 ptrdiff_t nbytes
= PSEUDOVECTOR_NBYTES (vector
);
3101 ptrdiff_t total_bytes
= nbytes
;
3103 next
= ADVANCE (vector
, nbytes
);
3105 /* While NEXT is not marked, try to coalesce with VECTOR,
3106 thus making VECTOR of the largest possible size. */
3108 while (VECTOR_IN_BLOCK (next
, block
))
3110 if (VECTOR_MARKED_P (next
))
3112 nbytes
= PSEUDOVECTOR_NBYTES (next
);
3113 total_bytes
+= nbytes
;
3114 next
= ADVANCE (next
, nbytes
);
3117 eassert (total_bytes
% roundup_size
== 0);
3119 if (vector
== (struct Lisp_Vector
*) block
->data
3120 && !VECTOR_IN_BLOCK (next
, block
))
3121 /* This block should be freed because all of it's
3122 space was coalesced into the only free vector. */
3123 free_this_block
= 1;
3127 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
3132 if (free_this_block
)
3134 *bprev
= block
->next
;
3135 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
3136 mem_delete (mem_find (block
->data
));
3141 bprev
= &block
->next
;
3144 /* Sweep large vectors. */
3146 for (vector
= large_vectors
; vector
; vector
= *vprev
)
3148 if (VECTOR_MARKED_P (vector
))
3150 VECTOR_UNMARK (vector
);
3151 total_vector_size
+= VECTOR_SIZE (vector
);
3152 vprev
= &vector
->header
.next
.vector
;
3156 *vprev
= vector
->header
.next
.vector
;
3162 /* Value is a pointer to a newly allocated Lisp_Vector structure
3163 with room for LEN Lisp_Objects. */
3165 static struct Lisp_Vector
*
3166 allocate_vectorlike (ptrdiff_t len
)
3168 struct Lisp_Vector
*p
;
3172 /* This gets triggered by code which I haven't bothered to fix. --Stef */
3173 /* eassert (!handling_signal); */
3176 p
= XVECTOR (zero_vector
);
3179 size_t nbytes
= header_size
+ len
* word_size
;
3181 #ifdef DOUG_LEA_MALLOC
3182 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
3183 because mapped region contents are not preserved in
3185 mallopt (M_MMAP_MAX
, 0);
3188 if (nbytes
<= VBLOCK_BYTES_MAX
)
3189 p
= allocate_vector_from_block (vroundup (nbytes
));
3192 p
= lisp_malloc (nbytes
, MEM_TYPE_VECTORLIKE
);
3193 p
->header
.next
.vector
= large_vectors
;
3197 #ifdef DOUG_LEA_MALLOC
3198 /* Back to a reasonable maximum of mmap'ed areas. */
3199 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3202 consing_since_gc
+= nbytes
;
3203 vector_cells_consed
+= len
;
3206 MALLOC_UNBLOCK_INPUT
;
3212 /* Allocate a vector with LEN slots. */
3214 struct Lisp_Vector
*
3215 allocate_vector (EMACS_INT len
)
3217 struct Lisp_Vector
*v
;
3218 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3220 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3221 memory_full (SIZE_MAX
);
3222 v
= allocate_vectorlike (len
);
3223 v
->header
.size
= len
;
3228 /* Allocate other vector-like structures. */
3230 struct Lisp_Vector
*
3231 allocate_pseudovector (int memlen
, int lisplen
, int tag
)
3233 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3236 /* Only the first lisplen slots will be traced normally by the GC. */
3237 for (i
= 0; i
< lisplen
; ++i
)
3238 v
->contents
[i
] = Qnil
;
3240 XSETPVECTYPESIZE (v
, tag
, lisplen
);
3245 allocate_buffer (void)
3247 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3249 XSETPVECTYPESIZE (b
, PVEC_BUFFER
, (offsetof (struct buffer
, own_text
)
3250 - header_size
) / word_size
);
3251 /* Note that the fields of B are not initialized. */
3255 struct Lisp_Hash_Table
*
3256 allocate_hash_table (void)
3258 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
3262 allocate_window (void)
3266 w
= ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
3267 /* Users assumes that non-Lisp data is zeroed. */
3268 memset (&w
->current_matrix
, 0,
3269 sizeof (*w
) - offsetof (struct window
, current_matrix
));
3274 allocate_terminal (void)
3278 t
= ALLOCATE_PSEUDOVECTOR (struct terminal
, next_terminal
, PVEC_TERMINAL
);
3279 /* Users assumes that non-Lisp data is zeroed. */
3280 memset (&t
->next_terminal
, 0,
3281 sizeof (*t
) - offsetof (struct terminal
, next_terminal
));
3286 allocate_frame (void)
3290 f
= ALLOCATE_PSEUDOVECTOR (struct frame
, face_cache
, PVEC_FRAME
);
3291 /* Users assumes that non-Lisp data is zeroed. */
3292 memset (&f
->face_cache
, 0,
3293 sizeof (*f
) - offsetof (struct frame
, face_cache
));
3297 struct Lisp_Process
*
3298 allocate_process (void)
3300 struct Lisp_Process
*p
;
3302 p
= ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3303 /* Users assumes that non-Lisp data is zeroed. */
3305 sizeof (*p
) - offsetof (struct Lisp_Process
, pid
));
3309 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3310 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3311 See also the function `vector'. */)
3312 (register Lisp_Object length
, Lisp_Object init
)
3315 register ptrdiff_t sizei
;
3316 register ptrdiff_t i
;
3317 register struct Lisp_Vector
*p
;
3319 CHECK_NATNUM (length
);
3321 p
= allocate_vector (XFASTINT (length
));
3322 sizei
= XFASTINT (length
);
3323 for (i
= 0; i
< sizei
; i
++)
3324 p
->contents
[i
] = init
;
3326 XSETVECTOR (vector
, p
);
3331 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3332 doc
: /* Return a newly created vector with specified arguments as elements.
3333 Any number of arguments, even zero arguments, are allowed.
3334 usage: (vector &rest OBJECTS) */)
3335 (ptrdiff_t nargs
, Lisp_Object
*args
)
3337 register Lisp_Object len
, val
;
3339 register struct Lisp_Vector
*p
;
3341 XSETFASTINT (len
, nargs
);
3342 val
= Fmake_vector (len
, Qnil
);
3344 for (i
= 0; i
< nargs
; i
++)
3345 p
->contents
[i
] = args
[i
];
3350 make_byte_code (struct Lisp_Vector
*v
)
3352 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3353 && STRING_MULTIBYTE (v
->contents
[1]))
3354 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3355 earlier because they produced a raw 8-bit string for byte-code
3356 and now such a byte-code string is loaded as multibyte while
3357 raw 8-bit characters converted to multibyte form. Thus, now we
3358 must convert them back to the original unibyte form. */
3359 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3360 XSETPVECTYPE (v
, PVEC_COMPILED
);
3363 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3364 doc
: /* Create a byte-code object with specified arguments as elements.
3365 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3366 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3367 and (optional) INTERACTIVE-SPEC.
3368 The first four arguments are required; at most six have any
3370 The ARGLIST can be either like the one of `lambda', in which case the arguments
3371 will be dynamically bound before executing the byte code, or it can be an
3372 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3373 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3374 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3375 argument to catch the left-over arguments. If such an integer is used, the
3376 arguments will not be dynamically bound but will be instead pushed on the
3377 stack before executing the byte-code.
3378 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3379 (ptrdiff_t nargs
, Lisp_Object
*args
)
3381 register Lisp_Object len
, val
;
3383 register struct Lisp_Vector
*p
;
3385 /* We used to purecopy everything here, if purify-flga was set. This worked
3386 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3387 dangerous, since make-byte-code is used during execution to build
3388 closures, so any closure built during the preload phase would end up
3389 copied into pure space, including its free variables, which is sometimes
3390 just wasteful and other times plainly wrong (e.g. those free vars may want
3393 XSETFASTINT (len
, nargs
);
3394 val
= Fmake_vector (len
, Qnil
);
3397 for (i
= 0; i
< nargs
; i
++)
3398 p
->contents
[i
] = args
[i
];
3400 XSETCOMPILED (val
, p
);
3406 /***********************************************************************
3408 ***********************************************************************/
3410 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3411 of the required alignment if LSB tags are used. */
3413 union aligned_Lisp_Symbol
3415 struct Lisp_Symbol s
;
3417 unsigned char c
[(sizeof (struct Lisp_Symbol
) + (1 << GCTYPEBITS
) - 1)
3418 & -(1 << GCTYPEBITS
)];
3422 /* Each symbol_block is just under 1020 bytes long, since malloc
3423 really allocates in units of powers of two and uses 4 bytes for its
3426 #define SYMBOL_BLOCK_SIZE \
3427 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3431 /* Place `symbols' first, to preserve alignment. */
3432 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3433 struct symbol_block
*next
;
3436 /* Current symbol block and index of first unused Lisp_Symbol
3439 static struct symbol_block
*symbol_block
;
3440 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3442 /* List of free symbols. */
3444 static struct Lisp_Symbol
*symbol_free_list
;
3446 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3447 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3448 Its value and function definition are void, and its property list is nil. */)
3451 register Lisp_Object val
;
3452 register struct Lisp_Symbol
*p
;
3454 CHECK_STRING (name
);
3456 /* eassert (!handling_signal); */
3460 if (symbol_free_list
)
3462 XSETSYMBOL (val
, symbol_free_list
);
3463 symbol_free_list
= symbol_free_list
->next
;
3467 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3469 struct symbol_block
*new
3470 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3471 new->next
= symbol_block
;
3473 symbol_block_index
= 0;
3474 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3476 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3477 symbol_block_index
++;
3480 MALLOC_UNBLOCK_INPUT
;
3485 p
->redirect
= SYMBOL_PLAINVAL
;
3486 SET_SYMBOL_VAL (p
, Qunbound
);
3487 p
->function
= Qunbound
;
3490 p
->interned
= SYMBOL_UNINTERNED
;
3492 p
->declared_special
= 0;
3493 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3495 total_free_symbols
--;
3501 /***********************************************************************
3502 Marker (Misc) Allocation
3503 ***********************************************************************/
3505 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3506 the required alignment when LSB tags are used. */
3508 union aligned_Lisp_Misc
3512 unsigned char c
[(sizeof (union Lisp_Misc
) + (1 << GCTYPEBITS
) - 1)
3513 & -(1 << GCTYPEBITS
)];
3517 /* Allocation of markers and other objects that share that structure.
3518 Works like allocation of conses. */
3520 #define MARKER_BLOCK_SIZE \
3521 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3525 /* Place `markers' first, to preserve alignment. */
3526 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3527 struct marker_block
*next
;
3530 static struct marker_block
*marker_block
;
3531 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3533 static union Lisp_Misc
*marker_free_list
;
3535 /* Return a newly allocated Lisp_Misc object, with no substructure. */
3538 allocate_misc (void)
3542 /* eassert (!handling_signal); */
3546 if (marker_free_list
)
3548 XSETMISC (val
, marker_free_list
);
3549 marker_free_list
= marker_free_list
->u_free
.chain
;
3553 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3555 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3556 new->next
= marker_block
;
3558 marker_block_index
= 0;
3559 total_free_markers
+= MARKER_BLOCK_SIZE
;
3561 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3562 marker_block_index
++;
3565 MALLOC_UNBLOCK_INPUT
;
3567 --total_free_markers
;
3568 consing_since_gc
+= sizeof (union Lisp_Misc
);
3569 misc_objects_consed
++;
3570 XMISCANY (val
)->gcmarkbit
= 0;
3574 /* Free a Lisp_Misc object */
3577 free_misc (Lisp_Object misc
)
3579 XMISCTYPE (misc
) = Lisp_Misc_Free
;
3580 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3581 marker_free_list
= XMISC (misc
);
3583 total_free_markers
++;
3586 /* Return a Lisp_Misc_Save_Value object containing POINTER and
3587 INTEGER. This is used to package C values to call record_unwind_protect.
3588 The unwind function can get the C values back using XSAVE_VALUE. */
3591 make_save_value (void *pointer
, ptrdiff_t integer
)
3593 register Lisp_Object val
;
3594 register struct Lisp_Save_Value
*p
;
3596 val
= allocate_misc ();
3597 XMISCTYPE (val
) = Lisp_Misc_Save_Value
;
3598 p
= XSAVE_VALUE (val
);
3599 p
->pointer
= pointer
;
3600 p
->integer
= integer
;
3605 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3606 doc
: /* Return a newly allocated marker which does not point at any place. */)
3609 register Lisp_Object val
;
3610 register struct Lisp_Marker
*p
;
3612 val
= allocate_misc ();
3613 XMISCTYPE (val
) = Lisp_Misc_Marker
;
3619 p
->insertion_type
= 0;
3623 /* Return a newly allocated marker which points into BUF
3624 at character position CHARPOS and byte position BYTEPOS. */
3627 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3630 struct Lisp_Marker
*m
;
3632 /* No dead buffers here. */
3633 eassert (!NILP (BVAR (buf
, name
)));
3635 /* Every character is at least one byte. */
3636 eassert (charpos
<= bytepos
);
3638 obj
= allocate_misc ();
3639 XMISCTYPE (obj
) = Lisp_Misc_Marker
;
3642 m
->charpos
= charpos
;
3643 m
->bytepos
= bytepos
;
3644 m
->insertion_type
= 0;
3645 m
->next
= BUF_MARKERS (buf
);
3646 BUF_MARKERS (buf
) = m
;
3650 /* Put MARKER back on the free list after using it temporarily. */
3653 free_marker (Lisp_Object marker
)
3655 unchain_marker (XMARKER (marker
));
3660 /* Return a newly created vector or string with specified arguments as
3661 elements. If all the arguments are characters that can fit
3662 in a string of events, make a string; otherwise, make a vector.
3664 Any number of arguments, even zero arguments, are allowed. */
3667 make_event_array (register int nargs
, Lisp_Object
*args
)
3671 for (i
= 0; i
< nargs
; i
++)
3672 /* The things that fit in a string
3673 are characters that are in 0...127,
3674 after discarding the meta bit and all the bits above it. */
3675 if (!INTEGERP (args
[i
])
3676 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3677 return Fvector (nargs
, args
);
3679 /* Since the loop exited, we know that all the things in it are
3680 characters, so we can make a string. */
3684 result
= Fmake_string (make_number (nargs
), make_number (0));
3685 for (i
= 0; i
< nargs
; i
++)
3687 SSET (result
, i
, XINT (args
[i
]));
3688 /* Move the meta bit to the right place for a string char. */
3689 if (XINT (args
[i
]) & CHAR_META
)
3690 SSET (result
, i
, SREF (result
, i
) | 0x80);
3699 /************************************************************************
3700 Memory Full Handling
3701 ************************************************************************/
3704 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3705 there may have been size_t overflow so that malloc was never
3706 called, or perhaps malloc was invoked successfully but the
3707 resulting pointer had problems fitting into a tagged EMACS_INT. In
3708 either case this counts as memory being full even though malloc did
3712 memory_full (size_t nbytes
)
3714 /* Do not go into hysterics merely because a large request failed. */
3715 int enough_free_memory
= 0;
3716 if (SPARE_MEMORY
< nbytes
)
3721 p
= malloc (SPARE_MEMORY
);
3725 enough_free_memory
= 1;
3727 MALLOC_UNBLOCK_INPUT
;
3730 if (! enough_free_memory
)
3736 memory_full_cons_threshold
= sizeof (struct cons_block
);
3738 /* The first time we get here, free the spare memory. */
3739 for (i
= 0; i
< sizeof (spare_memory
) / sizeof (char *); i
++)
3740 if (spare_memory
[i
])
3743 free (spare_memory
[i
]);
3744 else if (i
>= 1 && i
<= 4)
3745 lisp_align_free (spare_memory
[i
]);
3747 lisp_free (spare_memory
[i
]);
3748 spare_memory
[i
] = 0;
3751 /* Record the space now used. When it decreases substantially,
3752 we can refill the memory reserve. */
3753 #if !defined SYSTEM_MALLOC && !defined SYNC_INPUT
3754 bytes_used_when_full
= BYTES_USED
;
3758 /* This used to call error, but if we've run out of memory, we could
3759 get infinite recursion trying to build the string. */
3760 xsignal (Qnil
, Vmemory_signal_data
);
3763 /* If we released our reserve (due to running out of memory),
3764 and we have a fair amount free once again,
3765 try to set aside another reserve in case we run out once more.
3767 This is called when a relocatable block is freed in ralloc.c,
3768 and also directly from this file, in case we're not using ralloc.c. */
3771 refill_memory_reserve (void)
3773 #ifndef SYSTEM_MALLOC
3774 if (spare_memory
[0] == 0)
3775 spare_memory
[0] = malloc (SPARE_MEMORY
);
3776 if (spare_memory
[1] == 0)
3777 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
3779 if (spare_memory
[2] == 0)
3780 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
3782 if (spare_memory
[3] == 0)
3783 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
3785 if (spare_memory
[4] == 0)
3786 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
3788 if (spare_memory
[5] == 0)
3789 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
3791 if (spare_memory
[6] == 0)
3792 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
3794 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3795 Vmemory_full
= Qnil
;
3799 /************************************************************************
3801 ************************************************************************/
3803 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3805 /* Conservative C stack marking requires a method to identify possibly
3806 live Lisp objects given a pointer value. We do this by keeping
3807 track of blocks of Lisp data that are allocated in a red-black tree
3808 (see also the comment of mem_node which is the type of nodes in
3809 that tree). Function lisp_malloc adds information for an allocated
3810 block to the red-black tree with calls to mem_insert, and function
3811 lisp_free removes it with mem_delete. Functions live_string_p etc
3812 call mem_find to lookup information about a given pointer in the
3813 tree, and use that to determine if the pointer points to a Lisp
3816 /* Initialize this part of alloc.c. */
3821 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3822 mem_z
.parent
= NULL
;
3823 mem_z
.color
= MEM_BLACK
;
3824 mem_z
.start
= mem_z
.end
= NULL
;
3829 /* Value is a pointer to the mem_node containing START. Value is
3830 MEM_NIL if there is no node in the tree containing START. */
3832 static inline struct mem_node
*
3833 mem_find (void *start
)
3837 if (start
< min_heap_address
|| start
> max_heap_address
)
3840 /* Make the search always successful to speed up the loop below. */
3841 mem_z
.start
= start
;
3842 mem_z
.end
= (char *) start
+ 1;
3845 while (start
< p
->start
|| start
>= p
->end
)
3846 p
= start
< p
->start
? p
->left
: p
->right
;
3851 /* Insert a new node into the tree for a block of memory with start
3852 address START, end address END, and type TYPE. Value is a
3853 pointer to the node that was inserted. */
3855 static struct mem_node
*
3856 mem_insert (void *start
, void *end
, enum mem_type type
)
3858 struct mem_node
*c
, *parent
, *x
;
3860 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3861 min_heap_address
= start
;
3862 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3863 max_heap_address
= end
;
3865 /* See where in the tree a node for START belongs. In this
3866 particular application, it shouldn't happen that a node is already
3867 present. For debugging purposes, let's check that. */
3871 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3873 while (c
!= MEM_NIL
)
3875 if (start
>= c
->start
&& start
< c
->end
)
3878 c
= start
< c
->start
? c
->left
: c
->right
;
3881 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3883 while (c
!= MEM_NIL
)
3886 c
= start
< c
->start
? c
->left
: c
->right
;
3889 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3891 /* Create a new node. */
3892 #ifdef GC_MALLOC_CHECK
3893 x
= _malloc_internal (sizeof *x
);
3897 x
= xmalloc (sizeof *x
);
3903 x
->left
= x
->right
= MEM_NIL
;
3906 /* Insert it as child of PARENT or install it as root. */
3909 if (start
< parent
->start
)
3917 /* Re-establish red-black tree properties. */
3918 mem_insert_fixup (x
);
3924 /* Re-establish the red-black properties of the tree, and thereby
3925 balance the tree, after node X has been inserted; X is always red. */
3928 mem_insert_fixup (struct mem_node
*x
)
3930 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3932 /* X is red and its parent is red. This is a violation of
3933 red-black tree property #3. */
3935 if (x
->parent
== x
->parent
->parent
->left
)
3937 /* We're on the left side of our grandparent, and Y is our
3939 struct mem_node
*y
= x
->parent
->parent
->right
;
3941 if (y
->color
== MEM_RED
)
3943 /* Uncle and parent are red but should be black because
3944 X is red. Change the colors accordingly and proceed
3945 with the grandparent. */
3946 x
->parent
->color
= MEM_BLACK
;
3947 y
->color
= MEM_BLACK
;
3948 x
->parent
->parent
->color
= MEM_RED
;
3949 x
= x
->parent
->parent
;
3953 /* Parent and uncle have different colors; parent is
3954 red, uncle is black. */
3955 if (x
== x
->parent
->right
)
3958 mem_rotate_left (x
);
3961 x
->parent
->color
= MEM_BLACK
;
3962 x
->parent
->parent
->color
= MEM_RED
;
3963 mem_rotate_right (x
->parent
->parent
);
3968 /* This is the symmetrical case of above. */
3969 struct mem_node
*y
= x
->parent
->parent
->left
;
3971 if (y
->color
== MEM_RED
)
3973 x
->parent
->color
= MEM_BLACK
;
3974 y
->color
= MEM_BLACK
;
3975 x
->parent
->parent
->color
= MEM_RED
;
3976 x
= x
->parent
->parent
;
3980 if (x
== x
->parent
->left
)
3983 mem_rotate_right (x
);
3986 x
->parent
->color
= MEM_BLACK
;
3987 x
->parent
->parent
->color
= MEM_RED
;
3988 mem_rotate_left (x
->parent
->parent
);
3993 /* The root may have been changed to red due to the algorithm. Set
3994 it to black so that property #5 is satisfied. */
3995 mem_root
->color
= MEM_BLACK
;
4006 mem_rotate_left (struct mem_node
*x
)
4010 /* Turn y's left sub-tree into x's right sub-tree. */
4013 if (y
->left
!= MEM_NIL
)
4014 y
->left
->parent
= x
;
4016 /* Y's parent was x's parent. */
4018 y
->parent
= x
->parent
;
4020 /* Get the parent to point to y instead of x. */
4023 if (x
== x
->parent
->left
)
4024 x
->parent
->left
= y
;
4026 x
->parent
->right
= y
;
4031 /* Put x on y's left. */
4045 mem_rotate_right (struct mem_node
*x
)
4047 struct mem_node
*y
= x
->left
;
4050 if (y
->right
!= MEM_NIL
)
4051 y
->right
->parent
= x
;
4054 y
->parent
= x
->parent
;
4057 if (x
== x
->parent
->right
)
4058 x
->parent
->right
= y
;
4060 x
->parent
->left
= y
;
4071 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4074 mem_delete (struct mem_node
*z
)
4076 struct mem_node
*x
, *y
;
4078 if (!z
|| z
== MEM_NIL
)
4081 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4086 while (y
->left
!= MEM_NIL
)
4090 if (y
->left
!= MEM_NIL
)
4095 x
->parent
= y
->parent
;
4098 if (y
== y
->parent
->left
)
4099 y
->parent
->left
= x
;
4101 y
->parent
->right
= x
;
4108 z
->start
= y
->start
;
4113 if (y
->color
== MEM_BLACK
)
4114 mem_delete_fixup (x
);
4116 #ifdef GC_MALLOC_CHECK
4124 /* Re-establish the red-black properties of the tree, after a
4128 mem_delete_fixup (struct mem_node
*x
)
4130 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4132 if (x
== x
->parent
->left
)
4134 struct mem_node
*w
= x
->parent
->right
;
4136 if (w
->color
== MEM_RED
)
4138 w
->color
= MEM_BLACK
;
4139 x
->parent
->color
= MEM_RED
;
4140 mem_rotate_left (x
->parent
);
4141 w
= x
->parent
->right
;
4144 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4151 if (w
->right
->color
== MEM_BLACK
)
4153 w
->left
->color
= MEM_BLACK
;
4155 mem_rotate_right (w
);
4156 w
= x
->parent
->right
;
4158 w
->color
= x
->parent
->color
;
4159 x
->parent
->color
= MEM_BLACK
;
4160 w
->right
->color
= MEM_BLACK
;
4161 mem_rotate_left (x
->parent
);
4167 struct mem_node
*w
= x
->parent
->left
;
4169 if (w
->color
== MEM_RED
)
4171 w
->color
= MEM_BLACK
;
4172 x
->parent
->color
= MEM_RED
;
4173 mem_rotate_right (x
->parent
);
4174 w
= x
->parent
->left
;
4177 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4184 if (w
->left
->color
== MEM_BLACK
)
4186 w
->right
->color
= MEM_BLACK
;
4188 mem_rotate_left (w
);
4189 w
= x
->parent
->left
;
4192 w
->color
= x
->parent
->color
;
4193 x
->parent
->color
= MEM_BLACK
;
4194 w
->left
->color
= MEM_BLACK
;
4195 mem_rotate_right (x
->parent
);
4201 x
->color
= MEM_BLACK
;
4205 /* Value is non-zero if P is a pointer to a live Lisp string on
4206 the heap. M is a pointer to the mem_block for P. */
4209 live_string_p (struct mem_node
*m
, void *p
)
4211 if (m
->type
== MEM_TYPE_STRING
)
4213 struct string_block
*b
= (struct string_block
*) m
->start
;
4214 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4216 /* P must point to the start of a Lisp_String structure, and it
4217 must not be on the free-list. */
4219 && offset
% sizeof b
->strings
[0] == 0
4220 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4221 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4228 /* Value is non-zero if P is a pointer to a live Lisp cons on
4229 the heap. M is a pointer to the mem_block for P. */
4232 live_cons_p (struct mem_node
*m
, void *p
)
4234 if (m
->type
== MEM_TYPE_CONS
)
4236 struct cons_block
*b
= (struct cons_block
*) m
->start
;
4237 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4239 /* P must point to the start of a Lisp_Cons, not be
4240 one of the unused cells in the current cons block,
4241 and not be on the free-list. */
4243 && offset
% sizeof b
->conses
[0] == 0
4244 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4246 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4247 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
4254 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4255 the heap. M is a pointer to the mem_block for P. */
4258 live_symbol_p (struct mem_node
*m
, void *p
)
4260 if (m
->type
== MEM_TYPE_SYMBOL
)
4262 struct symbol_block
*b
= (struct symbol_block
*) m
->start
;
4263 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4265 /* P must point to the start of a Lisp_Symbol, not be
4266 one of the unused cells in the current symbol block,
4267 and not be on the free-list. */
4269 && offset
% sizeof b
->symbols
[0] == 0
4270 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4271 && (b
!= symbol_block
4272 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4273 && !EQ (((struct Lisp_Symbol
*) p
)->function
, Vdead
));
4280 /* Value is non-zero if P is a pointer to a live Lisp float on
4281 the heap. M is a pointer to the mem_block for P. */
4284 live_float_p (struct mem_node
*m
, void *p
)
4286 if (m
->type
== MEM_TYPE_FLOAT
)
4288 struct float_block
*b
= (struct float_block
*) m
->start
;
4289 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4291 /* P must point to the start of a Lisp_Float and not be
4292 one of the unused cells in the current float block. */
4294 && offset
% sizeof b
->floats
[0] == 0
4295 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4296 && (b
!= float_block
4297 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4304 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4305 the heap. M is a pointer to the mem_block for P. */
4308 live_misc_p (struct mem_node
*m
, void *p
)
4310 if (m
->type
== MEM_TYPE_MISC
)
4312 struct marker_block
*b
= (struct marker_block
*) m
->start
;
4313 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4315 /* P must point to the start of a Lisp_Misc, not be
4316 one of the unused cells in the current misc block,
4317 and not be on the free-list. */
4319 && offset
% sizeof b
->markers
[0] == 0
4320 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4321 && (b
!= marker_block
4322 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4323 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4330 /* Value is non-zero if P is a pointer to a live vector-like object.
4331 M is a pointer to the mem_block for P. */
4334 live_vector_p (struct mem_node
*m
, void *p
)
4336 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4338 /* This memory node corresponds to a vector block. */
4339 struct vector_block
*block
= (struct vector_block
*) m
->start
;
4340 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4342 /* P is in the block's allocation range. Scan the block
4343 up to P and see whether P points to the start of some
4344 vector which is not on a free list. FIXME: check whether
4345 some allocation patterns (probably a lot of short vectors)
4346 may cause a substantial overhead of this loop. */
4347 while (VECTOR_IN_BLOCK (vector
, block
)
4348 && vector
<= (struct Lisp_Vector
*) p
)
4350 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
))
4351 vector
= ADVANCE (vector
, (vector
->header
.size
4352 & PSEUDOVECTOR_SIZE_MASK
));
4353 else if (vector
== p
)
4356 vector
= ADVANCE (vector
, vector
->header
.next
.nbytes
);
4359 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== m
->start
)
4360 /* This memory node corresponds to a large vector. */
4366 /* Value is non-zero if P is a pointer to a live buffer. M is a
4367 pointer to the mem_block for P. */
4370 live_buffer_p (struct mem_node
*m
, void *p
)
4372 /* P must point to the start of the block, and the buffer
4373 must not have been killed. */
4374 return (m
->type
== MEM_TYPE_BUFFER
4376 && !NILP (((struct buffer
*) p
)->BUFFER_INTERNAL_FIELD (name
)));
4379 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4383 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4385 /* Array of objects that are kept alive because the C stack contains
4386 a pattern that looks like a reference to them . */
4388 #define MAX_ZOMBIES 10
4389 static Lisp_Object zombies
[MAX_ZOMBIES
];
4391 /* Number of zombie objects. */
4393 static EMACS_INT nzombies
;
4395 /* Number of garbage collections. */
4397 static EMACS_INT ngcs
;
4399 /* Average percentage of zombies per collection. */
4401 static double avg_zombies
;
4403 /* Max. number of live and zombie objects. */
4405 static EMACS_INT max_live
, max_zombies
;
4407 /* Average number of live objects per GC. */
4409 static double avg_live
;
4411 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4412 doc
: /* Show information about live and zombie objects. */)
4415 Lisp_Object args
[8], zombie_list
= Qnil
;
4417 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); i
++)
4418 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4419 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4420 args
[1] = make_number (ngcs
);
4421 args
[2] = make_float (avg_live
);
4422 args
[3] = make_float (avg_zombies
);
4423 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4424 args
[5] = make_number (max_live
);
4425 args
[6] = make_number (max_zombies
);
4426 args
[7] = zombie_list
;
4427 return Fmessage (8, args
);
4430 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4433 /* Mark OBJ if we can prove it's a Lisp_Object. */
4436 mark_maybe_object (Lisp_Object obj
)
4444 po
= (void *) XPNTR (obj
);
4451 switch (XTYPE (obj
))
4454 mark_p
= (live_string_p (m
, po
)
4455 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4459 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4463 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4467 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4470 case Lisp_Vectorlike
:
4471 /* Note: can't check BUFFERP before we know it's a
4472 buffer because checking that dereferences the pointer
4473 PO which might point anywhere. */
4474 if (live_vector_p (m
, po
))
4475 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4476 else if (live_buffer_p (m
, po
))
4477 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4481 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4490 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4491 if (nzombies
< MAX_ZOMBIES
)
4492 zombies
[nzombies
] = obj
;
4501 /* If P points to Lisp data, mark that as live if it isn't already
4505 mark_maybe_pointer (void *p
)
4509 /* Quickly rule out some values which can't point to Lisp data.
4510 USE_LSB_TAG needs Lisp data to be aligned on multiples of 1 << GCTYPEBITS.
4511 Otherwise, assume that Lisp data is aligned on even addresses. */
4512 if ((intptr_t) p
% (USE_LSB_TAG
? 1 << GCTYPEBITS
: 2))
4518 Lisp_Object obj
= Qnil
;
4522 case MEM_TYPE_NON_LISP
:
4523 /* Nothing to do; not a pointer to Lisp memory. */
4526 case MEM_TYPE_BUFFER
:
4527 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4528 XSETVECTOR (obj
, p
);
4532 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4536 case MEM_TYPE_STRING
:
4537 if (live_string_p (m
, p
)
4538 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4539 XSETSTRING (obj
, p
);
4543 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4547 case MEM_TYPE_SYMBOL
:
4548 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4549 XSETSYMBOL (obj
, p
);
4552 case MEM_TYPE_FLOAT
:
4553 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4557 case MEM_TYPE_VECTORLIKE
:
4558 case MEM_TYPE_VECTOR_BLOCK
:
4559 if (live_vector_p (m
, p
))
4562 XSETVECTOR (tem
, p
);
4563 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4578 /* Alignment of pointer values. Use offsetof, as it sometimes returns
4579 a smaller alignment than GCC's __alignof__ and mark_memory might
4580 miss objects if __alignof__ were used. */
4581 #define GC_POINTER_ALIGNMENT offsetof (struct {char a; void *b;}, b)
4583 /* Define POINTERS_MIGHT_HIDE_IN_OBJECTS to 1 if marking via C pointers does
4584 not suffice, which is the typical case. A host where a Lisp_Object is
4585 wider than a pointer might allocate a Lisp_Object in non-adjacent halves.
4586 If USE_LSB_TAG, the bottom half is not a valid pointer, but it should
4587 suffice to widen it to to a Lisp_Object and check it that way. */
4588 #if USE_LSB_TAG || VAL_MAX < UINTPTR_MAX
4589 # if !USE_LSB_TAG && VAL_MAX < UINTPTR_MAX >> GCTYPEBITS
4590 /* If tag bits straddle pointer-word boundaries, neither mark_maybe_pointer
4591 nor mark_maybe_object can follow the pointers. This should not occur on
4592 any practical porting target. */
4593 # error "MSB type bits straddle pointer-word boundaries"
4595 /* Marking via C pointers does not suffice, because Lisp_Objects contain
4596 pointer words that hold pointers ORed with type bits. */
4597 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 1
4599 /* Marking via C pointers suffices, because Lisp_Objects contain pointer
4600 words that hold unmodified pointers. */
4601 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 0
4604 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4605 or END+OFFSET..START. */
4608 mark_memory (void *start
, void *end
)
4609 #if defined (__clang__) && defined (__has_feature)
4610 #if __has_feature(address_sanitizer)
4611 /* Do not allow -faddress-sanitizer to check this function, since it
4612 crosses the function stack boundary, and thus would yield many
4614 __attribute__((no_address_safety_analysis
))
4621 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4625 /* Make START the pointer to the start of the memory region,
4626 if it isn't already. */
4634 /* Mark Lisp data pointed to. This is necessary because, in some
4635 situations, the C compiler optimizes Lisp objects away, so that
4636 only a pointer to them remains. Example:
4638 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4641 Lisp_Object obj = build_string ("test");
4642 struct Lisp_String *s = XSTRING (obj);
4643 Fgarbage_collect ();
4644 fprintf (stderr, "test `%s'\n", s->data);
4648 Here, `obj' isn't really used, and the compiler optimizes it
4649 away. The only reference to the life string is through the
4652 for (pp
= start
; (void *) pp
< end
; pp
++)
4653 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4655 void *p
= *(void **) ((char *) pp
+ i
);
4656 mark_maybe_pointer (p
);
4657 if (POINTERS_MIGHT_HIDE_IN_OBJECTS
)
4658 mark_maybe_object (XIL ((intptr_t) p
));
4662 /* setjmp will work with GCC unless NON_SAVING_SETJMP is defined in
4663 the GCC system configuration. In gcc 3.2, the only systems for
4664 which this is so are i386-sco5 non-ELF, i386-sysv3 (maybe included
4665 by others?) and ns32k-pc532-min. */
4667 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4669 static int setjmp_tested_p
, longjmps_done
;
4671 #define SETJMP_WILL_LIKELY_WORK "\
4673 Emacs garbage collector has been changed to use conservative stack\n\
4674 marking. Emacs has determined that the method it uses to do the\n\
4675 marking will likely work on your system, but this isn't sure.\n\
4677 If you are a system-programmer, or can get the help of a local wizard\n\
4678 who is, please take a look at the function mark_stack in alloc.c, and\n\
4679 verify that the methods used are appropriate for your system.\n\
4681 Please mail the result to <emacs-devel@gnu.org>.\n\
4684 #define SETJMP_WILL_NOT_WORK "\
4686 Emacs garbage collector has been changed to use conservative stack\n\
4687 marking. Emacs has determined that the default method it uses to do the\n\
4688 marking will not work on your system. We will need a system-dependent\n\
4689 solution for your system.\n\
4691 Please take a look at the function mark_stack in alloc.c, and\n\
4692 try to find a way to make it work on your system.\n\
4694 Note that you may get false negatives, depending on the compiler.\n\
4695 In particular, you need to use -O with GCC for this test.\n\
4697 Please mail the result to <emacs-devel@gnu.org>.\n\
4701 /* Perform a quick check if it looks like setjmp saves registers in a
4702 jmp_buf. Print a message to stderr saying so. When this test
4703 succeeds, this is _not_ a proof that setjmp is sufficient for
4704 conservative stack marking. Only the sources or a disassembly
4715 /* Arrange for X to be put in a register. */
4721 if (longjmps_done
== 1)
4723 /* Came here after the longjmp at the end of the function.
4725 If x == 1, the longjmp has restored the register to its
4726 value before the setjmp, and we can hope that setjmp
4727 saves all such registers in the jmp_buf, although that
4730 For other values of X, either something really strange is
4731 taking place, or the setjmp just didn't save the register. */
4734 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4737 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4744 if (longjmps_done
== 1)
4748 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4751 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4753 /* Abort if anything GCPRO'd doesn't survive the GC. */
4761 for (p
= gcprolist
; p
; p
= p
->next
)
4762 for (i
= 0; i
< p
->nvars
; ++i
)
4763 if (!survives_gc_p (p
->var
[i
]))
4764 /* FIXME: It's not necessarily a bug. It might just be that the
4765 GCPRO is unnecessary or should release the object sooner. */
4769 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4776 fprintf (stderr
, "\nZombies kept alive = %"pI
"d:\n", nzombies
);
4777 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4779 fprintf (stderr
, " %d = ", i
);
4780 debug_print (zombies
[i
]);
4784 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4787 /* Mark live Lisp objects on the C stack.
4789 There are several system-dependent problems to consider when
4790 porting this to new architectures:
4794 We have to mark Lisp objects in CPU registers that can hold local
4795 variables or are used to pass parameters.
4797 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4798 something that either saves relevant registers on the stack, or
4799 calls mark_maybe_object passing it each register's contents.
4801 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4802 implementation assumes that calling setjmp saves registers we need
4803 to see in a jmp_buf which itself lies on the stack. This doesn't
4804 have to be true! It must be verified for each system, possibly
4805 by taking a look at the source code of setjmp.
4807 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4808 can use it as a machine independent method to store all registers
4809 to the stack. In this case the macros described in the previous
4810 two paragraphs are not used.
4814 Architectures differ in the way their processor stack is organized.
4815 For example, the stack might look like this
4818 | Lisp_Object | size = 4
4820 | something else | size = 2
4822 | Lisp_Object | size = 4
4826 In such a case, not every Lisp_Object will be aligned equally. To
4827 find all Lisp_Object on the stack it won't be sufficient to walk
4828 the stack in steps of 4 bytes. Instead, two passes will be
4829 necessary, one starting at the start of the stack, and a second
4830 pass starting at the start of the stack + 2. Likewise, if the
4831 minimal alignment of Lisp_Objects on the stack is 1, four passes
4832 would be necessary, each one starting with one byte more offset
4833 from the stack start. */
4840 #ifdef HAVE___BUILTIN_UNWIND_INIT
4841 /* Force callee-saved registers and register windows onto the stack.
4842 This is the preferred method if available, obviating the need for
4843 machine dependent methods. */
4844 __builtin_unwind_init ();
4846 #else /* not HAVE___BUILTIN_UNWIND_INIT */
4847 #ifndef GC_SAVE_REGISTERS_ON_STACK
4848 /* jmp_buf may not be aligned enough on darwin-ppc64 */
4849 union aligned_jmpbuf
{
4853 volatile int stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4855 /* This trick flushes the register windows so that all the state of
4856 the process is contained in the stack. */
4857 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4858 needed on ia64 too. See mach_dep.c, where it also says inline
4859 assembler doesn't work with relevant proprietary compilers. */
4861 #if defined (__sparc64__) && defined (__FreeBSD__)
4862 /* FreeBSD does not have a ta 3 handler. */
4869 /* Save registers that we need to see on the stack. We need to see
4870 registers used to hold register variables and registers used to
4872 #ifdef GC_SAVE_REGISTERS_ON_STACK
4873 GC_SAVE_REGISTERS_ON_STACK (end
);
4874 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4876 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4877 setjmp will definitely work, test it
4878 and print a message with the result
4880 if (!setjmp_tested_p
)
4882 setjmp_tested_p
= 1;
4885 #endif /* GC_SETJMP_WORKS */
4888 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4889 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4890 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
4892 /* This assumes that the stack is a contiguous region in memory. If
4893 that's not the case, something has to be done here to iterate
4894 over the stack segments. */
4895 mark_memory (stack_base
, end
);
4897 /* Allow for marking a secondary stack, like the register stack on the
4899 #ifdef GC_MARK_SECONDARY_STACK
4900 GC_MARK_SECONDARY_STACK ();
4903 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4908 #endif /* GC_MARK_STACK != 0 */
4911 /* Determine whether it is safe to access memory at address P. */
4913 valid_pointer_p (void *p
)
4916 return w32_valid_pointer_p (p
, 16);
4920 /* Obviously, we cannot just access it (we would SEGV trying), so we
4921 trick the o/s to tell us whether p is a valid pointer.
4922 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4923 not validate p in that case. */
4927 int valid
= (emacs_write (fd
[1], (char *) p
, 16) == 16);
4928 emacs_close (fd
[1]);
4929 emacs_close (fd
[0]);
4937 /* Return 1 if OBJ is a valid lisp object.
4938 Return 0 if OBJ is NOT a valid lisp object.
4939 Return -1 if we cannot validate OBJ.
4940 This function can be quite slow,
4941 so it should only be used in code for manual debugging. */
4944 valid_lisp_object_p (Lisp_Object obj
)
4954 p
= (void *) XPNTR (obj
);
4955 if (PURE_POINTER_P (p
))
4959 return valid_pointer_p (p
);
4966 int valid
= valid_pointer_p (p
);
4978 case MEM_TYPE_NON_LISP
:
4981 case MEM_TYPE_BUFFER
:
4982 return live_buffer_p (m
, p
);
4985 return live_cons_p (m
, p
);
4987 case MEM_TYPE_STRING
:
4988 return live_string_p (m
, p
);
4991 return live_misc_p (m
, p
);
4993 case MEM_TYPE_SYMBOL
:
4994 return live_symbol_p (m
, p
);
4996 case MEM_TYPE_FLOAT
:
4997 return live_float_p (m
, p
);
4999 case MEM_TYPE_VECTORLIKE
:
5000 case MEM_TYPE_VECTOR_BLOCK
:
5001 return live_vector_p (m
, p
);
5014 /***********************************************************************
5015 Pure Storage Management
5016 ***********************************************************************/
5018 /* Allocate room for SIZE bytes from pure Lisp storage and return a
5019 pointer to it. TYPE is the Lisp type for which the memory is
5020 allocated. TYPE < 0 means it's not used for a Lisp object. */
5023 pure_alloc (size_t size
, int type
)
5027 size_t alignment
= (1 << GCTYPEBITS
);
5029 size_t alignment
= sizeof (EMACS_INT
);
5031 /* Give Lisp_Floats an extra alignment. */
5032 if (type
== Lisp_Float
)
5034 #if defined __GNUC__ && __GNUC__ >= 2
5035 alignment
= __alignof (struct Lisp_Float
);
5037 alignment
= sizeof (struct Lisp_Float
);
5045 /* Allocate space for a Lisp object from the beginning of the free
5046 space with taking account of alignment. */
5047 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
5048 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
5052 /* Allocate space for a non-Lisp object from the end of the free
5054 pure_bytes_used_non_lisp
+= size
;
5055 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5057 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
5059 if (pure_bytes_used
<= pure_size
)
5062 /* Don't allocate a large amount here,
5063 because it might get mmap'd and then its address
5064 might not be usable. */
5065 purebeg
= xmalloc (10000);
5067 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
5068 pure_bytes_used
= 0;
5069 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
5074 /* Print a warning if PURESIZE is too small. */
5077 check_pure_size (void)
5079 if (pure_bytes_used_before_overflow
)
5080 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
5082 pure_bytes_used
+ pure_bytes_used_before_overflow
);
5086 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
5087 the non-Lisp data pool of the pure storage, and return its start
5088 address. Return NULL if not found. */
5091 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5094 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5095 const unsigned char *p
;
5098 if (pure_bytes_used_non_lisp
<= nbytes
)
5101 /* Set up the Boyer-Moore table. */
5103 for (i
= 0; i
< 256; i
++)
5106 p
= (const unsigned char *) data
;
5108 bm_skip
[*p
++] = skip
;
5110 last_char_skip
= bm_skip
['\0'];
5112 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5113 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5115 /* See the comments in the function `boyer_moore' (search.c) for the
5116 use of `infinity'. */
5117 infinity
= pure_bytes_used_non_lisp
+ 1;
5118 bm_skip
['\0'] = infinity
;
5120 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5124 /* Check the last character (== '\0'). */
5127 start
+= bm_skip
[*(p
+ start
)];
5129 while (start
<= start_max
);
5131 if (start
< infinity
)
5132 /* Couldn't find the last character. */
5135 /* No less than `infinity' means we could find the last
5136 character at `p[start - infinity]'. */
5139 /* Check the remaining characters. */
5140 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5142 return non_lisp_beg
+ start
;
5144 start
+= last_char_skip
;
5146 while (start
<= start_max
);
5152 /* Return a string allocated in pure space. DATA is a buffer holding
5153 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5154 non-zero means make the result string multibyte.
5156 Must get an error if pure storage is full, since if it cannot hold
5157 a large string it may be able to hold conses that point to that
5158 string; then the string is not protected from gc. */
5161 make_pure_string (const char *data
,
5162 ptrdiff_t nchars
, ptrdiff_t nbytes
, int multibyte
)
5165 struct Lisp_String
*s
;
5167 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
5168 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5169 if (s
->data
== NULL
)
5171 s
->data
= (unsigned char *) pure_alloc (nbytes
+ 1, -1);
5172 memcpy (s
->data
, data
, nbytes
);
5173 s
->data
[nbytes
] = '\0';
5176 s
->size_byte
= multibyte
? nbytes
: -1;
5177 s
->intervals
= NULL_INTERVAL
;
5178 XSETSTRING (string
, s
);
5182 /* Return a string allocated in pure space. Do not
5183 allocate the string data, just point to DATA. */
5186 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5189 struct Lisp_String
*s
;
5191 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
5194 s
->data
= (unsigned char *) data
;
5195 s
->intervals
= NULL_INTERVAL
;
5196 XSETSTRING (string
, s
);
5200 /* Return a cons allocated from pure space. Give it pure copies
5201 of CAR as car and CDR as cdr. */
5204 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5206 register Lisp_Object
new;
5207 struct Lisp_Cons
*p
;
5209 p
= (struct Lisp_Cons
*) pure_alloc (sizeof *p
, Lisp_Cons
);
5211 XSETCAR (new, Fpurecopy (car
));
5212 XSETCDR (new, Fpurecopy (cdr
));
5217 /* Value is a float object with value NUM allocated from pure space. */
5220 make_pure_float (double num
)
5222 register Lisp_Object
new;
5223 struct Lisp_Float
*p
;
5225 p
= (struct Lisp_Float
*) pure_alloc (sizeof *p
, Lisp_Float
);
5227 XFLOAT_INIT (new, num
);
5232 /* Return a vector with room for LEN Lisp_Objects allocated from
5236 make_pure_vector (ptrdiff_t len
)
5239 struct Lisp_Vector
*p
;
5240 size_t size
= (offsetof (struct Lisp_Vector
, contents
)
5241 + len
* sizeof (Lisp_Object
));
5243 p
= (struct Lisp_Vector
*) pure_alloc (size
, Lisp_Vectorlike
);
5244 XSETVECTOR (new, p
);
5245 XVECTOR (new)->header
.size
= len
;
5250 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5251 doc
: /* Make a copy of object OBJ in pure storage.
5252 Recursively copies contents of vectors and cons cells.
5253 Does not copy symbols. Copies strings without text properties. */)
5254 (register Lisp_Object obj
)
5256 if (NILP (Vpurify_flag
))
5259 if (PURE_POINTER_P (XPNTR (obj
)))
5262 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5264 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5270 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5271 else if (FLOATP (obj
))
5272 obj
= make_pure_float (XFLOAT_DATA (obj
));
5273 else if (STRINGP (obj
))
5274 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5276 STRING_MULTIBYTE (obj
));
5277 else if (COMPILEDP (obj
) || VECTORP (obj
))
5279 register struct Lisp_Vector
*vec
;
5280 register ptrdiff_t i
;
5284 if (size
& PSEUDOVECTOR_FLAG
)
5285 size
&= PSEUDOVECTOR_SIZE_MASK
;
5286 vec
= XVECTOR (make_pure_vector (size
));
5287 for (i
= 0; i
< size
; i
++)
5288 vec
->contents
[i
] = Fpurecopy (AREF (obj
, i
));
5289 if (COMPILEDP (obj
))
5291 XSETPVECTYPE (vec
, PVEC_COMPILED
);
5292 XSETCOMPILED (obj
, vec
);
5295 XSETVECTOR (obj
, vec
);
5297 else if (MARKERP (obj
))
5298 error ("Attempt to copy a marker to pure storage");
5300 /* Not purified, don't hash-cons. */
5303 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5304 Fputhash (obj
, obj
, Vpurify_flag
);
5311 /***********************************************************************
5313 ***********************************************************************/
5315 /* Put an entry in staticvec, pointing at the variable with address
5319 staticpro (Lisp_Object
*varaddress
)
5321 staticvec
[staticidx
++] = varaddress
;
5322 if (staticidx
>= NSTATICS
)
5327 /***********************************************************************
5329 ***********************************************************************/
5331 /* Temporarily prevent garbage collection. */
5334 inhibit_garbage_collection (void)
5336 ptrdiff_t count
= SPECPDL_INDEX ();
5338 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5343 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5344 doc
: /* Reclaim storage for Lisp objects no longer needed.
5345 Garbage collection happens automatically if you cons more than
5346 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5347 `garbage-collect' normally returns a list with info on amount of space in use:
5348 ((USED-CONSES . FREE-CONSES) (USED-SYMS . FREE-SYMS)
5349 (USED-MISCS . FREE-MISCS) USED-STRING-CHARS USED-VECTOR-SLOTS
5350 (USED-FLOATS . FREE-FLOATS) (USED-INTERVALS . FREE-INTERVALS)
5351 (USED-STRINGS . FREE-STRINGS))
5352 However, if there was overflow in pure space, `garbage-collect'
5353 returns nil, because real GC can't be done.
5354 See Info node `(elisp)Garbage Collection'. */)
5357 register struct specbinding
*bind
;
5358 char stack_top_variable
;
5361 Lisp_Object total
[8];
5362 ptrdiff_t count
= SPECPDL_INDEX ();
5368 /* Can't GC if pure storage overflowed because we can't determine
5369 if something is a pure object or not. */
5370 if (pure_bytes_used_before_overflow
)
5375 /* Don't keep undo information around forever.
5376 Do this early on, so it is no problem if the user quits. */
5378 register struct buffer
*nextb
= all_buffers
;
5382 /* If a buffer's undo list is Qt, that means that undo is
5383 turned off in that buffer. Calling truncate_undo_list on
5384 Qt tends to return NULL, which effectively turns undo back on.
5385 So don't call truncate_undo_list if undo_list is Qt. */
5386 if (! NILP (nextb
->BUFFER_INTERNAL_FIELD (name
))
5387 && ! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
5388 truncate_undo_list (nextb
);
5390 /* Shrink buffer gaps, but skip indirect and dead buffers. */
5391 if (nextb
->base_buffer
== 0 && !NILP (nextb
->BUFFER_INTERNAL_FIELD (name
))
5392 && ! nextb
->text
->inhibit_shrinking
)
5394 /* If a buffer's gap size is more than 10% of the buffer
5395 size, or larger than 2000 bytes, then shrink it
5396 accordingly. Keep a minimum size of 20 bytes. */
5397 int size
= min (2000, max (20, (nextb
->text
->z_byte
/ 10)));
5399 if (nextb
->text
->gap_size
> size
)
5401 struct buffer
*save_current
= current_buffer
;
5402 current_buffer
= nextb
;
5403 make_gap (-(nextb
->text
->gap_size
- size
));
5404 current_buffer
= save_current
;
5408 nextb
= nextb
->header
.next
.buffer
;
5412 t1
= current_emacs_time ();
5414 /* In case user calls debug_print during GC,
5415 don't let that cause a recursive GC. */
5416 consing_since_gc
= 0;
5418 /* Save what's currently displayed in the echo area. */
5419 message_p
= push_message ();
5420 record_unwind_protect (pop_message_unwind
, Qnil
);
5422 /* Save a copy of the contents of the stack, for debugging. */
5423 #if MAX_SAVE_STACK > 0
5424 if (NILP (Vpurify_flag
))
5427 ptrdiff_t stack_size
;
5428 if (&stack_top_variable
< stack_bottom
)
5430 stack
= &stack_top_variable
;
5431 stack_size
= stack_bottom
- &stack_top_variable
;
5435 stack
= stack_bottom
;
5436 stack_size
= &stack_top_variable
- stack_bottom
;
5438 if (stack_size
<= MAX_SAVE_STACK
)
5440 if (stack_copy_size
< stack_size
)
5442 stack_copy
= xrealloc (stack_copy
, stack_size
);
5443 stack_copy_size
= stack_size
;
5445 memcpy (stack_copy
, stack
, stack_size
);
5448 #endif /* MAX_SAVE_STACK > 0 */
5450 if (garbage_collection_messages
)
5451 message1_nolog ("Garbage collecting...");
5455 shrink_regexp_cache ();
5459 /* clear_marks (); */
5461 /* Mark all the special slots that serve as the roots of accessibility. */
5463 for (i
= 0; i
< staticidx
; i
++)
5464 mark_object (*staticvec
[i
]);
5466 for (bind
= specpdl
; bind
!= specpdl_ptr
; bind
++)
5468 mark_object (bind
->symbol
);
5469 mark_object (bind
->old_value
);
5477 extern void xg_mark_data (void);
5482 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5483 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5487 register struct gcpro
*tail
;
5488 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5489 for (i
= 0; i
< tail
->nvars
; i
++)
5490 mark_object (tail
->var
[i
]);
5494 struct catchtag
*catch;
5495 struct handler
*handler
;
5497 for (catch = catchlist
; catch; catch = catch->next
)
5499 mark_object (catch->tag
);
5500 mark_object (catch->val
);
5502 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5504 mark_object (handler
->handler
);
5505 mark_object (handler
->var
);
5511 #ifdef HAVE_WINDOW_SYSTEM
5512 mark_fringe_data ();
5515 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5519 /* Everything is now marked, except for the things that require special
5520 finalization, i.e. the undo_list.
5521 Look thru every buffer's undo list
5522 for elements that update markers that were not marked,
5525 register struct buffer
*nextb
= all_buffers
;
5529 /* If a buffer's undo list is Qt, that means that undo is
5530 turned off in that buffer. Calling truncate_undo_list on
5531 Qt tends to return NULL, which effectively turns undo back on.
5532 So don't call truncate_undo_list if undo_list is Qt. */
5533 if (! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
5535 Lisp_Object tail
, prev
;
5536 tail
= nextb
->BUFFER_INTERNAL_FIELD (undo_list
);
5538 while (CONSP (tail
))
5540 if (CONSP (XCAR (tail
))
5541 && MARKERP (XCAR (XCAR (tail
)))
5542 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5545 nextb
->BUFFER_INTERNAL_FIELD (undo_list
) = tail
= XCDR (tail
);
5549 XSETCDR (prev
, tail
);
5559 /* Now that we have stripped the elements that need not be in the
5560 undo_list any more, we can finally mark the list. */
5561 mark_object (nextb
->BUFFER_INTERNAL_FIELD (undo_list
));
5563 nextb
= nextb
->header
.next
.buffer
;
5569 /* Clear the mark bits that we set in certain root slots. */
5571 unmark_byte_stack ();
5572 VECTOR_UNMARK (&buffer_defaults
);
5573 VECTOR_UNMARK (&buffer_local_symbols
);
5575 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5583 /* clear_marks (); */
5586 consing_since_gc
= 0;
5587 if (gc_cons_threshold
< 10000)
5588 gc_cons_threshold
= 10000;
5590 gc_relative_threshold
= 0;
5591 if (FLOATP (Vgc_cons_percentage
))
5592 { /* Set gc_cons_combined_threshold. */
5595 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5596 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5597 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5598 tot
+= total_string_size
;
5599 tot
+= total_vector_size
* sizeof (Lisp_Object
);
5600 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5601 tot
+= total_intervals
* sizeof (struct interval
);
5602 tot
+= total_strings
* sizeof (struct Lisp_String
);
5604 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5607 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5608 gc_relative_threshold
= tot
;
5610 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5614 if (garbage_collection_messages
)
5616 if (message_p
|| minibuf_level
> 0)
5619 message1_nolog ("Garbage collecting...done");
5622 unbind_to (count
, Qnil
);
5624 total
[0] = Fcons (make_number (total_conses
),
5625 make_number (total_free_conses
));
5626 total
[1] = Fcons (make_number (total_symbols
),
5627 make_number (total_free_symbols
));
5628 total
[2] = Fcons (make_number (total_markers
),
5629 make_number (total_free_markers
));
5630 total
[3] = make_number (total_string_size
);
5631 total
[4] = make_number (total_vector_size
);
5632 total
[5] = Fcons (make_number (total_floats
),
5633 make_number (total_free_floats
));
5634 total
[6] = Fcons (make_number (total_intervals
),
5635 make_number (total_free_intervals
));
5636 total
[7] = Fcons (make_number (total_strings
),
5637 make_number (total_free_strings
));
5639 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5641 /* Compute average percentage of zombies. */
5644 for (i
= 0; i
< 7; ++i
)
5645 if (CONSP (total
[i
]))
5646 nlive
+= XFASTINT (XCAR (total
[i
]));
5648 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5649 max_live
= max (nlive
, max_live
);
5650 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5651 max_zombies
= max (nzombies
, max_zombies
);
5656 if (!NILP (Vpost_gc_hook
))
5658 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5659 safe_run_hooks (Qpost_gc_hook
);
5660 unbind_to (gc_count
, Qnil
);
5663 /* Accumulate statistics. */
5664 if (FLOATP (Vgc_elapsed
))
5666 EMACS_TIME t2
= current_emacs_time ();
5667 EMACS_TIME t3
= sub_emacs_time (t2
, t1
);
5668 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5669 + EMACS_TIME_TO_DOUBLE (t3
));
5674 return Flist (sizeof total
/ sizeof *total
, total
);
5678 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5679 only interesting objects referenced from glyphs are strings. */
5682 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5684 struct glyph_row
*row
= matrix
->rows
;
5685 struct glyph_row
*end
= row
+ matrix
->nrows
;
5687 for (; row
< end
; ++row
)
5691 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5693 struct glyph
*glyph
= row
->glyphs
[area
];
5694 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5696 for (; glyph
< end_glyph
; ++glyph
)
5697 if (STRINGP (glyph
->object
)
5698 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5699 mark_object (glyph
->object
);
5705 /* Mark Lisp faces in the face cache C. */
5708 mark_face_cache (struct face_cache
*c
)
5713 for (i
= 0; i
< c
->used
; ++i
)
5715 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5719 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5720 mark_object (face
->lface
[j
]);
5728 /* Mark reference to a Lisp_Object.
5729 If the object referred to has not been seen yet, recursively mark
5730 all the references contained in it. */
5732 #define LAST_MARKED_SIZE 500
5733 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5734 static int last_marked_index
;
5736 /* For debugging--call abort when we cdr down this many
5737 links of a list, in mark_object. In debugging,
5738 the call to abort will hit a breakpoint.
5739 Normally this is zero and the check never goes off. */
5740 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5743 mark_vectorlike (struct Lisp_Vector
*ptr
)
5745 ptrdiff_t size
= ptr
->header
.size
;
5748 eassert (!VECTOR_MARKED_P (ptr
));
5749 VECTOR_MARK (ptr
); /* Else mark it. */
5750 if (size
& PSEUDOVECTOR_FLAG
)
5751 size
&= PSEUDOVECTOR_SIZE_MASK
;
5753 /* Note that this size is not the memory-footprint size, but only
5754 the number of Lisp_Object fields that we should trace.
5755 The distinction is used e.g. by Lisp_Process which places extra
5756 non-Lisp_Object fields at the end of the structure... */
5757 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
5758 mark_object (ptr
->contents
[i
]);
5761 /* Like mark_vectorlike but optimized for char-tables (and
5762 sub-char-tables) assuming that the contents are mostly integers or
5766 mark_char_table (struct Lisp_Vector
*ptr
)
5768 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5771 eassert (!VECTOR_MARKED_P (ptr
));
5773 for (i
= 0; i
< size
; i
++)
5775 Lisp_Object val
= ptr
->contents
[i
];
5777 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5779 if (SUB_CHAR_TABLE_P (val
))
5781 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5782 mark_char_table (XVECTOR (val
));
5789 /* Mark the chain of overlays starting at PTR. */
5792 mark_overlay (struct Lisp_Overlay
*ptr
)
5794 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
5797 mark_object (ptr
->start
);
5798 mark_object (ptr
->end
);
5799 mark_object (ptr
->plist
);
5803 /* Mark Lisp_Objects and special pointers in BUFFER. */
5806 mark_buffer (struct buffer
*buffer
)
5808 /* This is handled much like other pseudovectors... */
5809 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
5811 /* ...but there are some buffer-specific things. */
5813 MARK_INTERVAL_TREE (BUF_INTERVALS (buffer
));
5815 /* For now, we just don't mark the undo_list. It's done later in
5816 a special way just before the sweep phase, and after stripping
5817 some of its elements that are not needed any more. */
5819 mark_overlay (buffer
->overlays_before
);
5820 mark_overlay (buffer
->overlays_after
);
5822 /* If this is an indirect buffer, mark its base buffer. */
5823 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5824 mark_buffer (buffer
->base_buffer
);
5827 /* Determine type of generic Lisp_Object and mark it accordingly. */
5830 mark_object (Lisp_Object arg
)
5832 register Lisp_Object obj
= arg
;
5833 #ifdef GC_CHECK_MARKED_OBJECTS
5837 ptrdiff_t cdr_count
= 0;
5841 if (PURE_POINTER_P (XPNTR (obj
)))
5844 last_marked
[last_marked_index
++] = obj
;
5845 if (last_marked_index
== LAST_MARKED_SIZE
)
5846 last_marked_index
= 0;
5848 /* Perform some sanity checks on the objects marked here. Abort if
5849 we encounter an object we know is bogus. This increases GC time
5850 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5851 #ifdef GC_CHECK_MARKED_OBJECTS
5853 po
= (void *) XPNTR (obj
);
5855 /* Check that the object pointed to by PO is known to be a Lisp
5856 structure allocated from the heap. */
5857 #define CHECK_ALLOCATED() \
5859 m = mem_find (po); \
5864 /* Check that the object pointed to by PO is live, using predicate
5866 #define CHECK_LIVE(LIVEP) \
5868 if (!LIVEP (m, po)) \
5872 /* Check both of the above conditions. */
5873 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5875 CHECK_ALLOCATED (); \
5876 CHECK_LIVE (LIVEP); \
5879 #else /* not GC_CHECK_MARKED_OBJECTS */
5881 #define CHECK_LIVE(LIVEP) (void) 0
5882 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5884 #endif /* not GC_CHECK_MARKED_OBJECTS */
5886 switch (SWITCH_ENUM_CAST (XTYPE (obj
)))
5890 register struct Lisp_String
*ptr
= XSTRING (obj
);
5891 if (STRING_MARKED_P (ptr
))
5893 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
5895 MARK_INTERVAL_TREE (ptr
->intervals
);
5896 #ifdef GC_CHECK_STRING_BYTES
5897 /* Check that the string size recorded in the string is the
5898 same as the one recorded in the sdata structure. */
5899 CHECK_STRING_BYTES (ptr
);
5900 #endif /* GC_CHECK_STRING_BYTES */
5904 case Lisp_Vectorlike
:
5906 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5907 register ptrdiff_t pvectype
;
5909 if (VECTOR_MARKED_P (ptr
))
5912 #ifdef GC_CHECK_MARKED_OBJECTS
5914 if (m
== MEM_NIL
&& !SUBRP (obj
)
5915 && po
!= &buffer_defaults
5916 && po
!= &buffer_local_symbols
)
5918 #endif /* GC_CHECK_MARKED_OBJECTS */
5920 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
5921 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
5922 >> PSEUDOVECTOR_SIZE_BITS
);
5926 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
5927 CHECK_LIVE (live_vector_p
);
5932 #ifdef GC_CHECK_MARKED_OBJECTS
5933 if (po
!= &buffer_defaults
&& po
!= &buffer_local_symbols
)
5935 struct buffer
*b
= all_buffers
;
5936 for (; b
&& b
!= po
; b
= b
->header
.next
.buffer
)
5941 #endif /* GC_CHECK_MARKED_OBJECTS */
5942 mark_buffer ((struct buffer
*) ptr
);
5946 { /* We could treat this just like a vector, but it is better
5947 to save the COMPILED_CONSTANTS element for last and avoid
5949 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5953 for (i
= 0; i
< size
; i
++)
5954 if (i
!= COMPILED_CONSTANTS
)
5955 mark_object (ptr
->contents
[i
]);
5956 if (size
> COMPILED_CONSTANTS
)
5958 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
5966 mark_vectorlike (ptr
);
5967 mark_face_cache (((struct frame
*) ptr
)->face_cache
);
5973 struct window
*w
= (struct window
*) ptr
;
5975 mark_vectorlike (ptr
);
5976 /* Mark glyphs for leaf windows. Marking window
5977 matrices is sufficient because frame matrices
5978 use the same glyph memory. */
5979 if (NILP (w
->hchild
) && NILP (w
->vchild
) && w
->current_matrix
)
5981 mark_glyph_matrix (w
->current_matrix
);
5982 mark_glyph_matrix (w
->desired_matrix
);
5987 case PVEC_HASH_TABLE
:
5989 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
5991 mark_vectorlike (ptr
);
5992 /* If hash table is not weak, mark all keys and values.
5993 For weak tables, mark only the vector. */
5995 mark_object (h
->key_and_value
);
5997 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6001 case PVEC_CHAR_TABLE
:
6002 mark_char_table (ptr
);
6005 case PVEC_BOOL_VECTOR
:
6006 /* No Lisp_Objects to mark in a bool vector. */
6017 mark_vectorlike (ptr
);
6024 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6025 struct Lisp_Symbol
*ptrx
;
6029 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
6031 mark_object (ptr
->function
);
6032 mark_object (ptr
->plist
);
6033 switch (ptr
->redirect
)
6035 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6036 case SYMBOL_VARALIAS
:
6039 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6043 case SYMBOL_LOCALIZED
:
6045 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
6046 /* If the value is forwarded to a buffer or keyboard field,
6047 these are marked when we see the corresponding object.
6048 And if it's forwarded to a C variable, either it's not
6049 a Lisp_Object var, or it's staticpro'd already. */
6050 mark_object (blv
->where
);
6051 mark_object (blv
->valcell
);
6052 mark_object (blv
->defcell
);
6055 case SYMBOL_FORWARDED
:
6056 /* If the value is forwarded to a buffer or keyboard field,
6057 these are marked when we see the corresponding object.
6058 And if it's forwarded to a C variable, either it's not
6059 a Lisp_Object var, or it's staticpro'd already. */
6063 if (!PURE_POINTER_P (XSTRING (ptr
->xname
)))
6064 MARK_STRING (XSTRING (ptr
->xname
));
6065 MARK_INTERVAL_TREE (STRING_INTERVALS (ptr
->xname
));
6070 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun. */
6071 XSETSYMBOL (obj
, ptrx
);
6078 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6080 if (XMISCANY (obj
)->gcmarkbit
)
6083 switch (XMISCTYPE (obj
))
6085 case Lisp_Misc_Marker
:
6086 /* DO NOT mark thru the marker's chain.
6087 The buffer's markers chain does not preserve markers from gc;
6088 instead, markers are removed from the chain when freed by gc. */
6089 XMISCANY (obj
)->gcmarkbit
= 1;
6092 case Lisp_Misc_Save_Value
:
6093 XMISCANY (obj
)->gcmarkbit
= 1;
6096 register struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
6097 /* If DOGC is set, POINTER is the address of a memory
6098 area containing INTEGER potential Lisp_Objects. */
6101 Lisp_Object
*p
= (Lisp_Object
*) ptr
->pointer
;
6103 for (nelt
= ptr
->integer
; nelt
> 0; nelt
--, p
++)
6104 mark_maybe_object (*p
);
6110 case Lisp_Misc_Overlay
:
6111 mark_overlay (XOVERLAY (obj
));
6121 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6122 if (CONS_MARKED_P (ptr
))
6124 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6126 /* If the cdr is nil, avoid recursion for the car. */
6127 if (EQ (ptr
->u
.cdr
, Qnil
))
6133 mark_object (ptr
->car
);
6136 if (cdr_count
== mark_object_loop_halt
)
6142 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6143 FLOAT_MARK (XFLOAT (obj
));
6154 #undef CHECK_ALLOCATED
6155 #undef CHECK_ALLOCATED_AND_LIVE
6157 /* Mark the Lisp pointers in the terminal objects.
6158 Called by Fgarbage_collect. */
6161 mark_terminals (void)
6164 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6166 eassert (t
->name
!= NULL
);
6167 #ifdef HAVE_WINDOW_SYSTEM
6168 /* If a terminal object is reachable from a stacpro'ed object,
6169 it might have been marked already. Make sure the image cache
6171 mark_image_cache (t
->image_cache
);
6172 #endif /* HAVE_WINDOW_SYSTEM */
6173 if (!VECTOR_MARKED_P (t
))
6174 mark_vectorlike ((struct Lisp_Vector
*)t
);
6180 /* Value is non-zero if OBJ will survive the current GC because it's
6181 either marked or does not need to be marked to survive. */
6184 survives_gc_p (Lisp_Object obj
)
6188 switch (XTYPE (obj
))
6195 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6199 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6203 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6206 case Lisp_Vectorlike
:
6207 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6211 survives_p
= CONS_MARKED_P (XCONS (obj
));
6215 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6222 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
6227 /* Sweep: find all structures not marked, and free them. */
6232 /* Remove or mark entries in weak hash tables.
6233 This must be done before any object is unmarked. */
6234 sweep_weak_hash_tables ();
6237 #ifdef GC_CHECK_STRING_BYTES
6238 if (!noninteractive
)
6239 check_string_bytes (1);
6242 /* Put all unmarked conses on free list */
6244 register struct cons_block
*cblk
;
6245 struct cons_block
**cprev
= &cons_block
;
6246 register int lim
= cons_block_index
;
6247 EMACS_INT num_free
= 0, num_used
= 0;
6251 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6255 int ilim
= (lim
+ BITS_PER_INT
- 1) / BITS_PER_INT
;
6257 /* Scan the mark bits an int at a time. */
6258 for (i
= 0; i
< ilim
; i
++)
6260 if (cblk
->gcmarkbits
[i
] == -1)
6262 /* Fast path - all cons cells for this int are marked. */
6263 cblk
->gcmarkbits
[i
] = 0;
6264 num_used
+= BITS_PER_INT
;
6268 /* Some cons cells for this int are not marked.
6269 Find which ones, and free them. */
6270 int start
, pos
, stop
;
6272 start
= i
* BITS_PER_INT
;
6274 if (stop
> BITS_PER_INT
)
6275 stop
= BITS_PER_INT
;
6278 for (pos
= start
; pos
< stop
; pos
++)
6280 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6283 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6284 cons_free_list
= &cblk
->conses
[pos
];
6286 cons_free_list
->car
= Vdead
;
6292 CONS_UNMARK (&cblk
->conses
[pos
]);
6298 lim
= CONS_BLOCK_SIZE
;
6299 /* If this block contains only free conses and we have already
6300 seen more than two blocks worth of free conses then deallocate
6302 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6304 *cprev
= cblk
->next
;
6305 /* Unhook from the free list. */
6306 cons_free_list
= cblk
->conses
[0].u
.chain
;
6307 lisp_align_free (cblk
);
6311 num_free
+= this_free
;
6312 cprev
= &cblk
->next
;
6315 total_conses
= num_used
;
6316 total_free_conses
= num_free
;
6319 /* Put all unmarked floats on free list */
6321 register struct float_block
*fblk
;
6322 struct float_block
**fprev
= &float_block
;
6323 register int lim
= float_block_index
;
6324 EMACS_INT num_free
= 0, num_used
= 0;
6326 float_free_list
= 0;
6328 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6332 for (i
= 0; i
< lim
; i
++)
6333 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6336 fblk
->floats
[i
].u
.chain
= float_free_list
;
6337 float_free_list
= &fblk
->floats
[i
];
6342 FLOAT_UNMARK (&fblk
->floats
[i
]);
6344 lim
= FLOAT_BLOCK_SIZE
;
6345 /* If this block contains only free floats and we have already
6346 seen more than two blocks worth of free floats then deallocate
6348 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6350 *fprev
= fblk
->next
;
6351 /* Unhook from the free list. */
6352 float_free_list
= fblk
->floats
[0].u
.chain
;
6353 lisp_align_free (fblk
);
6357 num_free
+= this_free
;
6358 fprev
= &fblk
->next
;
6361 total_floats
= num_used
;
6362 total_free_floats
= num_free
;
6365 /* Put all unmarked intervals on free list */
6367 register struct interval_block
*iblk
;
6368 struct interval_block
**iprev
= &interval_block
;
6369 register int lim
= interval_block_index
;
6370 EMACS_INT num_free
= 0, num_used
= 0;
6372 interval_free_list
= 0;
6374 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6379 for (i
= 0; i
< lim
; i
++)
6381 if (!iblk
->intervals
[i
].gcmarkbit
)
6383 SET_INTERVAL_PARENT (&iblk
->intervals
[i
], interval_free_list
);
6384 interval_free_list
= &iblk
->intervals
[i
];
6390 iblk
->intervals
[i
].gcmarkbit
= 0;
6393 lim
= INTERVAL_BLOCK_SIZE
;
6394 /* If this block contains only free intervals and we have already
6395 seen more than two blocks worth of free intervals then
6396 deallocate this block. */
6397 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6399 *iprev
= iblk
->next
;
6400 /* Unhook from the free list. */
6401 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6406 num_free
+= this_free
;
6407 iprev
= &iblk
->next
;
6410 total_intervals
= num_used
;
6411 total_free_intervals
= num_free
;
6414 /* Put all unmarked symbols on free list */
6416 register struct symbol_block
*sblk
;
6417 struct symbol_block
**sprev
= &symbol_block
;
6418 register int lim
= symbol_block_index
;
6419 EMACS_INT num_free
= 0, num_used
= 0;
6421 symbol_free_list
= NULL
;
6423 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6426 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6427 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6429 for (; sym
< end
; ++sym
)
6431 /* Check if the symbol was created during loadup. In such a case
6432 it might be pointed to by pure bytecode which we don't trace,
6433 so we conservatively assume that it is live. */
6434 int pure_p
= PURE_POINTER_P (XSTRING (sym
->s
.xname
));
6436 if (!sym
->s
.gcmarkbit
&& !pure_p
)
6438 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6439 xfree (SYMBOL_BLV (&sym
->s
));
6440 sym
->s
.next
= symbol_free_list
;
6441 symbol_free_list
= &sym
->s
;
6443 symbol_free_list
->function
= Vdead
;
6451 UNMARK_STRING (XSTRING (sym
->s
.xname
));
6452 sym
->s
.gcmarkbit
= 0;
6456 lim
= SYMBOL_BLOCK_SIZE
;
6457 /* If this block contains only free symbols and we have already
6458 seen more than two blocks worth of free symbols then deallocate
6460 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6462 *sprev
= sblk
->next
;
6463 /* Unhook from the free list. */
6464 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6469 num_free
+= this_free
;
6470 sprev
= &sblk
->next
;
6473 total_symbols
= num_used
;
6474 total_free_symbols
= num_free
;
6477 /* Put all unmarked misc's on free list.
6478 For a marker, first unchain it from the buffer it points into. */
6480 register struct marker_block
*mblk
;
6481 struct marker_block
**mprev
= &marker_block
;
6482 register int lim
= marker_block_index
;
6483 EMACS_INT num_free
= 0, num_used
= 0;
6485 marker_free_list
= 0;
6487 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6492 for (i
= 0; i
< lim
; i
++)
6494 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6496 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6497 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6498 /* Set the type of the freed object to Lisp_Misc_Free.
6499 We could leave the type alone, since nobody checks it,
6500 but this might catch bugs faster. */
6501 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6502 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6503 marker_free_list
= &mblk
->markers
[i
].m
;
6509 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6512 lim
= MARKER_BLOCK_SIZE
;
6513 /* If this block contains only free markers and we have already
6514 seen more than two blocks worth of free markers then deallocate
6516 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6518 *mprev
= mblk
->next
;
6519 /* Unhook from the free list. */
6520 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6525 num_free
+= this_free
;
6526 mprev
= &mblk
->next
;
6530 total_markers
= num_used
;
6531 total_free_markers
= num_free
;
6534 /* Free all unmarked buffers */
6536 register struct buffer
*buffer
= all_buffers
, *prev
= 0, *next
;
6539 if (!VECTOR_MARKED_P (buffer
))
6542 prev
->header
.next
= buffer
->header
.next
;
6544 all_buffers
= buffer
->header
.next
.buffer
;
6545 next
= buffer
->header
.next
.buffer
;
6551 VECTOR_UNMARK (buffer
);
6552 UNMARK_BALANCE_INTERVALS (BUF_INTERVALS (buffer
));
6553 prev
= buffer
, buffer
= buffer
->header
.next
.buffer
;
6559 #ifdef GC_CHECK_STRING_BYTES
6560 if (!noninteractive
)
6561 check_string_bytes (1);
6568 /* Debugging aids. */
6570 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6571 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6572 This may be helpful in debugging Emacs's memory usage.
6573 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6578 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6583 DEFUN ("memory-free", Fmemory_free
, Smemory_free
, 0, 0, 0,
6584 doc
: /* Return a list of two counters that measure how much free memory
6585 is hold by the Emacs process. Both counters are in KBytes. First
6586 counter shows how much memory holds in a free lists maintained by
6587 the Emacs itself. Second counter shows how much free memory is in
6588 the heap (freed by Emacs but not released back to the operating
6589 system). If the second counter is zero, heap statistics is not
6593 Lisp_Object data
[2];
6595 data
[0] = make_number
6596 (min (MOST_POSITIVE_FIXNUM
,
6597 (total_free_conses
* sizeof (struct Lisp_Cons
)
6598 + total_free_markers
* sizeof (union Lisp_Misc
)
6599 + total_free_symbols
* sizeof (struct Lisp_Symbol
)
6600 + total_free_floats
* sizeof (struct Lisp_Float
)
6601 + total_free_intervals
* sizeof (struct interval
)
6602 + total_free_strings
* sizeof (struct Lisp_String
)
6603 + total_free_vector_bytes
) / 1024));
6604 #ifdef DOUG_LEA_MALLOC
6605 data
[1] = make_number
6606 (min (MOST_POSITIVE_FIXNUM
, mallinfo ().fordblks
/ 1024));
6608 data
[1] = make_number (0);
6610 return Flist (2, data
);
6613 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6614 doc
: /* Return a list of counters that measure how much consing there has been.
6615 Each of these counters increments for a certain kind of object.
6616 The counters wrap around from the largest positive integer to zero.
6617 Garbage collection does not decrease them.
6618 The elements of the value are as follows:
6619 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6620 All are in units of 1 = one object consed
6621 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6623 MISCS include overlays, markers, and some internal types.
6624 Frames, windows, buffers, and subprocesses count as vectors
6625 (but the contents of a buffer's text do not count here). */)
6628 Lisp_Object consed
[8];
6630 consed
[0] = make_number (min (MOST_POSITIVE_FIXNUM
, cons_cells_consed
));
6631 consed
[1] = make_number (min (MOST_POSITIVE_FIXNUM
, floats_consed
));
6632 consed
[2] = make_number (min (MOST_POSITIVE_FIXNUM
, vector_cells_consed
));
6633 consed
[3] = make_number (min (MOST_POSITIVE_FIXNUM
, symbols_consed
));
6634 consed
[4] = make_number (min (MOST_POSITIVE_FIXNUM
, string_chars_consed
));
6635 consed
[5] = make_number (min (MOST_POSITIVE_FIXNUM
, misc_objects_consed
));
6636 consed
[6] = make_number (min (MOST_POSITIVE_FIXNUM
, intervals_consed
));
6637 consed
[7] = make_number (min (MOST_POSITIVE_FIXNUM
, strings_consed
));
6639 return Flist (8, consed
);
6642 /* Find at most FIND_MAX symbols which have OBJ as their value or
6643 function. This is used in gdbinit's `xwhichsymbols' command. */
6646 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6648 struct symbol_block
*sblk
;
6649 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6650 Lisp_Object found
= Qnil
;
6654 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6656 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
6659 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
6661 struct Lisp_Symbol
*sym
= &aligned_sym
->s
;
6665 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6668 XSETSYMBOL (tem
, sym
);
6669 val
= find_symbol_value (tem
);
6671 || EQ (sym
->function
, obj
)
6672 || (!NILP (sym
->function
)
6673 && COMPILEDP (sym
->function
)
6674 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
6677 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)))
6679 found
= Fcons (tem
, found
);
6680 if (--find_max
== 0)
6688 unbind_to (gc_count
, Qnil
);
6692 #ifdef ENABLE_CHECKING
6693 int suppress_checking
;
6696 die (const char *msg
, const char *file
, int line
)
6698 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: %s\r\n",
6704 /* Initialization */
6707 init_alloc_once (void)
6709 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6711 pure_size
= PURESIZE
;
6713 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6715 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6718 #ifdef DOUG_LEA_MALLOC
6719 mallopt (M_TRIM_THRESHOLD
, 128*1024); /* trim threshold */
6720 mallopt (M_MMAP_THRESHOLD
, 64*1024); /* mmap threshold */
6721 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* max. number of mmap'ed areas */
6727 malloc_hysteresis
= 32;
6729 malloc_hysteresis
= 0;
6732 refill_memory_reserve ();
6733 gc_cons_threshold
= 100000 * sizeof (Lisp_Object
);
6740 byte_stack_list
= 0;
6742 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6743 setjmp_tested_p
= longjmps_done
= 0;
6746 Vgc_elapsed
= make_float (0.0);
6751 syms_of_alloc (void)
6753 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6754 doc
: /* Number of bytes of consing between garbage collections.
6755 Garbage collection can happen automatically once this many bytes have been
6756 allocated since the last garbage collection. All data types count.
6758 Garbage collection happens automatically only when `eval' is called.
6760 By binding this temporarily to a large number, you can effectively
6761 prevent garbage collection during a part of the program.
6762 See also `gc-cons-percentage'. */);
6764 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6765 doc
: /* Portion of the heap used for allocation.
6766 Garbage collection can happen automatically once this portion of the heap
6767 has been allocated since the last garbage collection.
6768 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6769 Vgc_cons_percentage
= make_float (0.1);
6771 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6772 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
6774 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6775 doc
: /* Number of cons cells that have been consed so far. */);
6777 DEFVAR_INT ("floats-consed", floats_consed
,
6778 doc
: /* Number of floats that have been consed so far. */);
6780 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
6781 doc
: /* Number of vector cells that have been consed so far. */);
6783 DEFVAR_INT ("symbols-consed", symbols_consed
,
6784 doc
: /* Number of symbols that have been consed so far. */);
6786 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
6787 doc
: /* Number of string characters that have been consed so far. */);
6789 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
6790 doc
: /* Number of miscellaneous objects that have been consed so far.
6791 These include markers and overlays, plus certain objects not visible
6794 DEFVAR_INT ("intervals-consed", intervals_consed
,
6795 doc
: /* Number of intervals that have been consed so far. */);
6797 DEFVAR_INT ("strings-consed", strings_consed
,
6798 doc
: /* Number of strings that have been consed so far. */);
6800 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
6801 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
6802 This means that certain objects should be allocated in shared (pure) space.
6803 It can also be set to a hash-table, in which case this table is used to
6804 do hash-consing of the objects allocated to pure space. */);
6806 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
6807 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
6808 garbage_collection_messages
= 0;
6810 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
6811 doc
: /* Hook run after garbage collection has finished. */);
6812 Vpost_gc_hook
= Qnil
;
6813 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
6815 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
6816 doc
: /* Precomputed `signal' argument for memory-full error. */);
6817 /* We build this in advance because if we wait until we need it, we might
6818 not be able to allocate the memory to hold it. */
6820 = pure_cons (Qerror
,
6821 pure_cons (build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"), Qnil
));
6823 DEFVAR_LISP ("memory-full", Vmemory_full
,
6824 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
6825 Vmemory_full
= Qnil
;
6827 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
6828 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
6830 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
6831 doc
: /* Accumulated time elapsed in garbage collections.
6832 The time is in seconds as a floating point value. */);
6833 DEFVAR_INT ("gcs-done", gcs_done
,
6834 doc
: /* Accumulated number of garbage collections done. */);
6839 defsubr (&Smake_byte_code
);
6840 defsubr (&Smake_list
);
6841 defsubr (&Smake_vector
);
6842 defsubr (&Smake_string
);
6843 defsubr (&Smake_bool_vector
);
6844 defsubr (&Smake_symbol
);
6845 defsubr (&Smake_marker
);
6846 defsubr (&Spurecopy
);
6847 defsubr (&Sgarbage_collect
);
6848 defsubr (&Smemory_limit
);
6849 defsubr (&Smemory_free
);
6850 defsubr (&Smemory_use_counts
);
6852 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
6853 defsubr (&Sgc_status
);