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
;
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 /* Non-zero means ignore malloc warnings. Set during initialization.
262 Currently not used. */
264 static int ignore_warnings
;
266 static Lisp_Object Qgc_cons_threshold
;
267 Lisp_Object Qchar_table_extra_slots
;
269 /* Hook run after GC has finished. */
271 static Lisp_Object Qpost_gc_hook
;
273 static void mark_terminals (void);
274 static void gc_sweep (void);
275 static Lisp_Object
make_pure_vector (ptrdiff_t);
276 static void mark_glyph_matrix (struct glyph_matrix
*);
277 static void mark_face_cache (struct face_cache
*);
279 #if !defined REL_ALLOC || defined SYSTEM_MALLOC
280 static void refill_memory_reserve (void);
282 static struct Lisp_String
*allocate_string (void);
283 static void compact_small_strings (void);
284 static void free_large_strings (void);
285 static void sweep_strings (void);
286 static void free_misc (Lisp_Object
);
287 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
289 /* When scanning the C stack for live Lisp objects, Emacs keeps track
290 of what memory allocated via lisp_malloc is intended for what
291 purpose. This enumeration specifies the type of memory. */
302 /* We used to keep separate mem_types for subtypes of vectors such as
303 process, hash_table, frame, terminal, and window, but we never made
304 use of the distinction, so it only caused source-code complexity
305 and runtime slowdown. Minor but pointless. */
307 /* Special type to denote vector blocks. */
308 MEM_TYPE_VECTOR_BLOCK
311 static void *lisp_malloc (size_t, enum mem_type
);
314 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
316 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
317 #include <stdio.h> /* For fprintf. */
320 /* A unique object in pure space used to make some Lisp objects
321 on free lists recognizable in O(1). */
323 static Lisp_Object Vdead
;
324 #define DEADP(x) EQ (x, Vdead)
326 #ifdef GC_MALLOC_CHECK
328 enum mem_type allocated_mem_type
;
330 #endif /* GC_MALLOC_CHECK */
332 /* A node in the red-black tree describing allocated memory containing
333 Lisp data. Each such block is recorded with its start and end
334 address when it is allocated, and removed from the tree when it
337 A red-black tree is a balanced binary tree with the following
340 1. Every node is either red or black.
341 2. Every leaf is black.
342 3. If a node is red, then both of its children are black.
343 4. Every simple path from a node to a descendant leaf contains
344 the same number of black nodes.
345 5. The root is always black.
347 When nodes are inserted into the tree, or deleted from the tree,
348 the tree is "fixed" so that these properties are always true.
350 A red-black tree with N internal nodes has height at most 2
351 log(N+1). Searches, insertions and deletions are done in O(log N).
352 Please see a text book about data structures for a detailed
353 description of red-black trees. Any book worth its salt should
358 /* Children of this node. These pointers are never NULL. When there
359 is no child, the value is MEM_NIL, which points to a dummy node. */
360 struct mem_node
*left
, *right
;
362 /* The parent of this node. In the root node, this is NULL. */
363 struct mem_node
*parent
;
365 /* Start and end of allocated region. */
369 enum {MEM_BLACK
, MEM_RED
} color
;
375 /* Base address of stack. Set in main. */
377 Lisp_Object
*stack_base
;
379 /* Root of the tree describing allocated Lisp memory. */
381 static struct mem_node
*mem_root
;
383 /* Lowest and highest known address in the heap. */
385 static void *min_heap_address
, *max_heap_address
;
387 /* Sentinel node of the tree. */
389 static struct mem_node mem_z
;
390 #define MEM_NIL &mem_z
392 static struct Lisp_Vector
*allocate_vectorlike (ptrdiff_t);
393 static void lisp_free (void *);
394 static void mark_stack (void);
395 static int live_vector_p (struct mem_node
*, void *);
396 static int live_buffer_p (struct mem_node
*, void *);
397 static int live_string_p (struct mem_node
*, void *);
398 static int live_cons_p (struct mem_node
*, void *);
399 static int live_symbol_p (struct mem_node
*, void *);
400 static int live_float_p (struct mem_node
*, void *);
401 static int live_misc_p (struct mem_node
*, void *);
402 static void mark_maybe_object (Lisp_Object
);
403 static void mark_memory (void *, void *);
404 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
405 static void mem_init (void);
406 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
407 static void mem_insert_fixup (struct mem_node
*);
409 static void mem_rotate_left (struct mem_node
*);
410 static void mem_rotate_right (struct mem_node
*);
411 static void mem_delete (struct mem_node
*);
412 static void mem_delete_fixup (struct mem_node
*);
413 static inline struct mem_node
*mem_find (void *);
416 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
417 static void check_gcpros (void);
420 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
426 /* Recording what needs to be marked for gc. */
428 struct gcpro
*gcprolist
;
430 /* Addresses of staticpro'd variables. Initialize it to a nonzero
431 value; otherwise some compilers put it into BSS. */
433 #define NSTATICS 0x650
434 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
436 /* Index of next unused slot in staticvec. */
438 static int staticidx
= 0;
440 static void *pure_alloc (size_t, int);
443 /* Value is SZ rounded up to the next multiple of ALIGNMENT.
444 ALIGNMENT must be a power of 2. */
446 #define ALIGN(ptr, ALIGNMENT) \
447 ((void *) (((uintptr_t) (ptr) + (ALIGNMENT) - 1) \
448 & ~ ((ALIGNMENT) - 1)))
452 /************************************************************************
454 ************************************************************************/
456 /* Function malloc calls this if it finds we are near exhausting storage. */
459 malloc_warning (const char *str
)
461 pending_malloc_warning
= str
;
465 /* Display an already-pending malloc warning. */
468 display_malloc_warning (void)
470 call3 (intern ("display-warning"),
472 build_string (pending_malloc_warning
),
473 intern ("emergency"));
474 pending_malloc_warning
= 0;
477 /* Called if we can't allocate relocatable space for a buffer. */
480 buffer_memory_full (ptrdiff_t nbytes
)
482 /* If buffers use the relocating allocator, no need to free
483 spare_memory, because we may have plenty of malloc space left
484 that we could get, and if we don't, the malloc that fails will
485 itself cause spare_memory to be freed. If buffers don't use the
486 relocating allocator, treat this like any other failing
490 memory_full (nbytes
);
493 /* This used to call error, but if we've run out of memory, we could
494 get infinite recursion trying to build the string. */
495 xsignal (Qnil
, Vmemory_signal_data
);
498 /* A common multiple of the positive integers A and B. Ideally this
499 would be the least common multiple, but there's no way to do that
500 as a constant expression in C, so do the best that we can easily do. */
501 #define COMMON_MULTIPLE(a, b) \
502 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
504 #ifndef XMALLOC_OVERRUN_CHECK
505 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
508 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
511 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
512 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
513 block size in little-endian order. The trailer consists of
514 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
516 The header is used to detect whether this block has been allocated
517 through these functions, as some low-level libc functions may
518 bypass the malloc hooks. */
520 #define XMALLOC_OVERRUN_CHECK_SIZE 16
521 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
522 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
524 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
525 hold a size_t value and (2) the header size is a multiple of the
526 alignment that Emacs needs for C types and for USE_LSB_TAG. */
527 #define XMALLOC_BASE_ALIGNMENT \
530 union { long double d; intmax_t i; void *p; } u; \
536 # define XMALLOC_HEADER_ALIGNMENT \
537 COMMON_MULTIPLE (1 << GCTYPEBITS, XMALLOC_BASE_ALIGNMENT)
539 # define XMALLOC_HEADER_ALIGNMENT XMALLOC_BASE_ALIGNMENT
541 #define XMALLOC_OVERRUN_SIZE_SIZE \
542 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
543 + XMALLOC_HEADER_ALIGNMENT - 1) \
544 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
545 - XMALLOC_OVERRUN_CHECK_SIZE)
547 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
548 { '\x9a', '\x9b', '\xae', '\xaf',
549 '\xbf', '\xbe', '\xce', '\xcf',
550 '\xea', '\xeb', '\xec', '\xed',
551 '\xdf', '\xde', '\x9c', '\x9d' };
553 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
554 { '\xaa', '\xab', '\xac', '\xad',
555 '\xba', '\xbb', '\xbc', '\xbd',
556 '\xca', '\xcb', '\xcc', '\xcd',
557 '\xda', '\xdb', '\xdc', '\xdd' };
559 /* Insert and extract the block size in the header. */
562 xmalloc_put_size (unsigned char *ptr
, size_t size
)
565 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
567 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
573 xmalloc_get_size (unsigned char *ptr
)
577 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
578 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
587 /* The call depth in overrun_check functions. For example, this might happen:
589 overrun_check_malloc()
590 -> malloc -> (via hook)_-> emacs_blocked_malloc
591 -> overrun_check_malloc
592 call malloc (hooks are NULL, so real malloc is called).
593 malloc returns 10000.
594 add overhead, return 10016.
595 <- (back in overrun_check_malloc)
596 add overhead again, return 10032
597 xmalloc returns 10032.
602 overrun_check_free(10032)
604 free(10016) <- crash, because 10000 is the original pointer. */
606 static ptrdiff_t check_depth
;
608 /* Like malloc, but wraps allocated block with header and trailer. */
611 overrun_check_malloc (size_t size
)
613 register unsigned char *val
;
614 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
615 if (SIZE_MAX
- overhead
< size
)
618 val
= malloc (size
+ overhead
);
619 if (val
&& check_depth
== 1)
621 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
622 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
623 xmalloc_put_size (val
, size
);
624 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
625 XMALLOC_OVERRUN_CHECK_SIZE
);
632 /* Like realloc, but checks old block for overrun, and wraps new block
633 with header and trailer. */
636 overrun_check_realloc (void *block
, size_t size
)
638 register unsigned char *val
= (unsigned char *) block
;
639 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
640 if (SIZE_MAX
- overhead
< size
)
645 && memcmp (xmalloc_overrun_check_header
,
646 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
647 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
649 size_t osize
= xmalloc_get_size (val
);
650 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
651 XMALLOC_OVERRUN_CHECK_SIZE
))
653 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
654 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
655 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
658 val
= realloc (val
, size
+ overhead
);
660 if (val
&& check_depth
== 1)
662 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
663 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
664 xmalloc_put_size (val
, size
);
665 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
666 XMALLOC_OVERRUN_CHECK_SIZE
);
672 /* Like free, but checks block for overrun. */
675 overrun_check_free (void *block
)
677 unsigned char *val
= (unsigned char *) block
;
682 && memcmp (xmalloc_overrun_check_header
,
683 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
684 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
686 size_t osize
= xmalloc_get_size (val
);
687 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
688 XMALLOC_OVERRUN_CHECK_SIZE
))
690 #ifdef XMALLOC_CLEAR_FREE_MEMORY
691 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
692 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
694 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
695 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
696 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
707 #define malloc overrun_check_malloc
708 #define realloc overrun_check_realloc
709 #define free overrun_check_free
713 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
714 there's no need to block input around malloc. */
715 #define MALLOC_BLOCK_INPUT ((void)0)
716 #define MALLOC_UNBLOCK_INPUT ((void)0)
718 #define MALLOC_BLOCK_INPUT BLOCK_INPUT
719 #define MALLOC_UNBLOCK_INPUT UNBLOCK_INPUT
722 /* Like malloc but check for no memory and block interrupt input.. */
725 xmalloc (size_t size
)
731 MALLOC_UNBLOCK_INPUT
;
738 /* Like the above, but zeroes out the memory just allocated. */
741 xzalloc (size_t size
)
747 MALLOC_UNBLOCK_INPUT
;
751 memset (val
, 0, size
);
755 /* Like realloc but check for no memory and block interrupt input.. */
758 xrealloc (void *block
, size_t size
)
763 /* We must call malloc explicitly when BLOCK is 0, since some
764 reallocs don't do this. */
768 val
= realloc (block
, size
);
769 MALLOC_UNBLOCK_INPUT
;
777 /* Like free but block interrupt input. */
786 MALLOC_UNBLOCK_INPUT
;
787 /* We don't call refill_memory_reserve here
788 because that duplicates doing so in emacs_blocked_free
789 and the criterion should go there. */
793 /* Other parts of Emacs pass large int values to allocator functions
794 expecting ptrdiff_t. This is portable in practice, but check it to
796 verify (INT_MAX
<= PTRDIFF_MAX
);
799 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
800 Signal an error on memory exhaustion, and block interrupt input. */
803 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
805 eassert (0 <= nitems
&& 0 < item_size
);
806 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
807 memory_full (SIZE_MAX
);
808 return xmalloc (nitems
* item_size
);
812 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
813 Signal an error on memory exhaustion, and block interrupt input. */
816 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
818 eassert (0 <= nitems
&& 0 < item_size
);
819 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
820 memory_full (SIZE_MAX
);
821 return xrealloc (pa
, nitems
* item_size
);
825 /* Grow PA, which points to an array of *NITEMS items, and return the
826 location of the reallocated array, updating *NITEMS to reflect its
827 new size. The new array will contain at least NITEMS_INCR_MIN more
828 items, but will not contain more than NITEMS_MAX items total.
829 ITEM_SIZE is the size of each item, in bytes.
831 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
832 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
835 If PA is null, then allocate a new array instead of reallocating
836 the old one. Thus, to grow an array A without saving its old
837 contents, invoke xfree (A) immediately followed by xgrowalloc (0,
840 Block interrupt input as needed. If memory exhaustion occurs, set
841 *NITEMS to zero if PA is null, and signal an error (i.e., do not
845 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
846 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
848 /* The approximate size to use for initial small allocation
849 requests. This is the largest "small" request for the GNU C
851 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
853 /* If the array is tiny, grow it to about (but no greater than)
854 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
855 ptrdiff_t n
= *nitems
;
856 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
857 ptrdiff_t half_again
= n
>> 1;
858 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
860 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
861 NITEMS_MAX, and what the C language can represent safely. */
862 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
863 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
864 ? nitems_max
: C_language_max
);
865 ptrdiff_t nitems_incr_max
= n_max
- n
;
866 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
868 eassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
871 if (nitems_incr_max
< incr
)
872 memory_full (SIZE_MAX
);
874 pa
= xrealloc (pa
, n
* item_size
);
880 /* Like strdup, but uses xmalloc. */
883 xstrdup (const char *s
)
885 size_t len
= strlen (s
) + 1;
886 char *p
= xmalloc (len
);
892 /* Unwind for SAFE_ALLOCA */
895 safe_alloca_unwind (Lisp_Object arg
)
897 register struct Lisp_Save_Value
*p
= XSAVE_VALUE (arg
);
907 /* Like malloc but used for allocating Lisp data. NBYTES is the
908 number of bytes to allocate, TYPE describes the intended use of the
909 allocated memory block (for strings, for conses, ...). */
912 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
916 lisp_malloc (size_t nbytes
, enum mem_type type
)
922 #ifdef GC_MALLOC_CHECK
923 allocated_mem_type
= type
;
926 val
= malloc (nbytes
);
929 /* If the memory just allocated cannot be addressed thru a Lisp
930 object's pointer, and it needs to be,
931 that's equivalent to running out of memory. */
932 if (val
&& type
!= MEM_TYPE_NON_LISP
)
935 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
936 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
938 lisp_malloc_loser
= val
;
945 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
946 if (val
&& type
!= MEM_TYPE_NON_LISP
)
947 mem_insert (val
, (char *) val
+ nbytes
, type
);
950 MALLOC_UNBLOCK_INPUT
;
952 memory_full (nbytes
);
956 /* Free BLOCK. This must be called to free memory allocated with a
957 call to lisp_malloc. */
960 lisp_free (void *block
)
964 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
965 mem_delete (mem_find (block
));
967 MALLOC_UNBLOCK_INPUT
;
970 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
972 /* The entry point is lisp_align_malloc which returns blocks of at most
973 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
975 #if defined (HAVE_POSIX_MEMALIGN) && defined (SYSTEM_MALLOC)
976 #define USE_POSIX_MEMALIGN 1
979 /* BLOCK_ALIGN has to be a power of 2. */
980 #define BLOCK_ALIGN (1 << 10)
982 /* Padding to leave at the end of a malloc'd block. This is to give
983 malloc a chance to minimize the amount of memory wasted to alignment.
984 It should be tuned to the particular malloc library used.
985 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
986 posix_memalign on the other hand would ideally prefer a value of 4
987 because otherwise, there's 1020 bytes wasted between each ablocks.
988 In Emacs, testing shows that those 1020 can most of the time be
989 efficiently used by malloc to place other objects, so a value of 0 can
990 still preferable unless you have a lot of aligned blocks and virtually
992 #define BLOCK_PADDING 0
993 #define BLOCK_BYTES \
994 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
996 /* Internal data structures and constants. */
998 #define ABLOCKS_SIZE 16
1000 /* An aligned block of memory. */
1005 char payload
[BLOCK_BYTES
];
1006 struct ablock
*next_free
;
1008 /* `abase' is the aligned base of the ablocks. */
1009 /* It is overloaded to hold the virtual `busy' field that counts
1010 the number of used ablock in the parent ablocks.
1011 The first ablock has the `busy' field, the others have the `abase'
1012 field. To tell the difference, we assume that pointers will have
1013 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1014 is used to tell whether the real base of the parent ablocks is `abase'
1015 (if not, the word before the first ablock holds a pointer to the
1017 struct ablocks
*abase
;
1018 /* The padding of all but the last ablock is unused. The padding of
1019 the last ablock in an ablocks is not allocated. */
1021 char padding
[BLOCK_PADDING
];
1025 /* A bunch of consecutive aligned blocks. */
1028 struct ablock blocks
[ABLOCKS_SIZE
];
1031 /* Size of the block requested from malloc or posix_memalign. */
1032 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1034 #define ABLOCK_ABASE(block) \
1035 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1036 ? (struct ablocks *)(block) \
1039 /* Virtual `busy' field. */
1040 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1042 /* Pointer to the (not necessarily aligned) malloc block. */
1043 #ifdef USE_POSIX_MEMALIGN
1044 #define ABLOCKS_BASE(abase) (abase)
1046 #define ABLOCKS_BASE(abase) \
1047 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void**)abase)[-1])
1050 /* The list of free ablock. */
1051 static struct ablock
*free_ablock
;
1053 /* Allocate an aligned block of nbytes.
1054 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1055 smaller or equal to BLOCK_BYTES. */
1057 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1060 struct ablocks
*abase
;
1062 eassert (nbytes
<= BLOCK_BYTES
);
1066 #ifdef GC_MALLOC_CHECK
1067 allocated_mem_type
= type
;
1073 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1075 #ifdef DOUG_LEA_MALLOC
1076 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1077 because mapped region contents are not preserved in
1079 mallopt (M_MMAP_MAX
, 0);
1082 #ifdef USE_POSIX_MEMALIGN
1084 int err
= posix_memalign (&base
, BLOCK_ALIGN
, ABLOCKS_BYTES
);
1090 base
= malloc (ABLOCKS_BYTES
);
1091 abase
= ALIGN (base
, BLOCK_ALIGN
);
1096 MALLOC_UNBLOCK_INPUT
;
1097 memory_full (ABLOCKS_BYTES
);
1100 aligned
= (base
== abase
);
1102 ((void**)abase
)[-1] = base
;
1104 #ifdef DOUG_LEA_MALLOC
1105 /* Back to a reasonable maximum of mmap'ed areas. */
1106 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1110 /* If the memory just allocated cannot be addressed thru a Lisp
1111 object's pointer, and it needs to be, that's equivalent to
1112 running out of memory. */
1113 if (type
!= MEM_TYPE_NON_LISP
)
1116 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1117 XSETCONS (tem
, end
);
1118 if ((char *) XCONS (tem
) != end
)
1120 lisp_malloc_loser
= base
;
1122 MALLOC_UNBLOCK_INPUT
;
1123 memory_full (SIZE_MAX
);
1128 /* Initialize the blocks and put them on the free list.
1129 If `base' was not properly aligned, we can't use the last block. */
1130 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1132 abase
->blocks
[i
].abase
= abase
;
1133 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1134 free_ablock
= &abase
->blocks
[i
];
1136 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1138 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1139 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1140 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1141 eassert (ABLOCKS_BASE (abase
) == base
);
1142 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1145 abase
= ABLOCK_ABASE (free_ablock
);
1146 ABLOCKS_BUSY (abase
) =
1147 (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1149 free_ablock
= free_ablock
->x
.next_free
;
1151 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1152 if (type
!= MEM_TYPE_NON_LISP
)
1153 mem_insert (val
, (char *) val
+ nbytes
, type
);
1156 MALLOC_UNBLOCK_INPUT
;
1158 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1163 lisp_align_free (void *block
)
1165 struct ablock
*ablock
= block
;
1166 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1169 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1170 mem_delete (mem_find (block
));
1172 /* Put on free list. */
1173 ablock
->x
.next_free
= free_ablock
;
1174 free_ablock
= ablock
;
1175 /* Update busy count. */
1176 ABLOCKS_BUSY (abase
)
1177 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1179 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1180 { /* All the blocks are free. */
1181 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1182 struct ablock
**tem
= &free_ablock
;
1183 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1187 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1190 *tem
= (*tem
)->x
.next_free
;
1193 tem
= &(*tem
)->x
.next_free
;
1195 eassert ((aligned
& 1) == aligned
);
1196 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1197 #ifdef USE_POSIX_MEMALIGN
1198 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1200 free (ABLOCKS_BASE (abase
));
1202 MALLOC_UNBLOCK_INPUT
;
1206 #ifndef SYSTEM_MALLOC
1208 /* Arranging to disable input signals while we're in malloc.
1210 This only works with GNU malloc. To help out systems which can't
1211 use GNU malloc, all the calls to malloc, realloc, and free
1212 elsewhere in the code should be inside a BLOCK_INPUT/UNBLOCK_INPUT
1213 pair; unfortunately, we have no idea what C library functions
1214 might call malloc, so we can't really protect them unless you're
1215 using GNU malloc. Fortunately, most of the major operating systems
1216 can use GNU malloc. */
1219 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
1220 there's no need to block input around malloc. */
1222 #ifndef DOUG_LEA_MALLOC
1223 extern void * (*__malloc_hook
) (size_t, const void *);
1224 extern void * (*__realloc_hook
) (void *, size_t, const void *);
1225 extern void (*__free_hook
) (void *, const void *);
1226 /* Else declared in malloc.h, perhaps with an extra arg. */
1227 #endif /* DOUG_LEA_MALLOC */
1228 static void * (*old_malloc_hook
) (size_t, const void *);
1229 static void * (*old_realloc_hook
) (void *, size_t, const void*);
1230 static void (*old_free_hook
) (void*, const void*);
1232 #ifdef DOUG_LEA_MALLOC
1233 # define BYTES_USED (mallinfo ().uordblks)
1235 # define BYTES_USED _bytes_used
1238 #ifdef GC_MALLOC_CHECK
1239 static int dont_register_blocks
;
1242 static size_t bytes_used_when_reconsidered
;
1244 /* Value of _bytes_used, when spare_memory was freed. */
1246 static size_t bytes_used_when_full
;
1248 /* This function is used as the hook for free to call. */
1251 emacs_blocked_free (void *ptr
, const void *ptr2
)
1255 #ifdef GC_MALLOC_CHECK
1261 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1264 "Freeing `%p' which wasn't allocated with malloc\n", ptr
);
1269 /* fprintf (stderr, "free %p...%p (%p)\n", m->start, m->end, ptr); */
1273 #endif /* GC_MALLOC_CHECK */
1275 __free_hook
= old_free_hook
;
1278 /* If we released our reserve (due to running out of memory),
1279 and we have a fair amount free once again,
1280 try to set aside another reserve in case we run out once more. */
1281 if (! NILP (Vmemory_full
)
1282 /* Verify there is enough space that even with the malloc
1283 hysteresis this call won't run out again.
1284 The code here is correct as long as SPARE_MEMORY
1285 is substantially larger than the block size malloc uses. */
1286 && (bytes_used_when_full
1287 > ((bytes_used_when_reconsidered
= BYTES_USED
)
1288 + max (malloc_hysteresis
, 4) * SPARE_MEMORY
)))
1289 refill_memory_reserve ();
1291 __free_hook
= emacs_blocked_free
;
1292 UNBLOCK_INPUT_ALLOC
;
1296 /* This function is the malloc hook that Emacs uses. */
1299 emacs_blocked_malloc (size_t size
, const void *ptr
)
1304 __malloc_hook
= old_malloc_hook
;
1305 #ifdef DOUG_LEA_MALLOC
1306 /* Segfaults on my system. --lorentey */
1307 /* mallopt (M_TOP_PAD, malloc_hysteresis * 4096); */
1309 __malloc_extra_blocks
= malloc_hysteresis
;
1312 value
= malloc (size
);
1314 #ifdef GC_MALLOC_CHECK
1316 struct mem_node
*m
= mem_find (value
);
1319 fprintf (stderr
, "Malloc returned %p which is already in use\n",
1321 fprintf (stderr
, "Region in use is %p...%p, %td bytes, type %d\n",
1322 m
->start
, m
->end
, (char *) m
->end
- (char *) m
->start
,
1327 if (!dont_register_blocks
)
1329 mem_insert (value
, (char *) value
+ max (1, size
), allocated_mem_type
);
1330 allocated_mem_type
= MEM_TYPE_NON_LISP
;
1333 #endif /* GC_MALLOC_CHECK */
1335 __malloc_hook
= emacs_blocked_malloc
;
1336 UNBLOCK_INPUT_ALLOC
;
1338 /* fprintf (stderr, "%p malloc\n", value); */
1343 /* This function is the realloc hook that Emacs uses. */
1346 emacs_blocked_realloc (void *ptr
, size_t size
, const void *ptr2
)
1351 __realloc_hook
= old_realloc_hook
;
1353 #ifdef GC_MALLOC_CHECK
1356 struct mem_node
*m
= mem_find (ptr
);
1357 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1360 "Realloc of %p which wasn't allocated with malloc\n",
1368 /* fprintf (stderr, "%p -> realloc\n", ptr); */
1370 /* Prevent malloc from registering blocks. */
1371 dont_register_blocks
= 1;
1372 #endif /* GC_MALLOC_CHECK */
1374 value
= realloc (ptr
, size
);
1376 #ifdef GC_MALLOC_CHECK
1377 dont_register_blocks
= 0;
1380 struct mem_node
*m
= mem_find (value
);
1383 fprintf (stderr
, "Realloc returns memory that is already in use\n");
1387 /* Can't handle zero size regions in the red-black tree. */
1388 mem_insert (value
, (char *) value
+ max (size
, 1), MEM_TYPE_NON_LISP
);
1391 /* fprintf (stderr, "%p <- realloc\n", value); */
1392 #endif /* GC_MALLOC_CHECK */
1394 __realloc_hook
= emacs_blocked_realloc
;
1395 UNBLOCK_INPUT_ALLOC
;
1402 /* Called from Fdump_emacs so that when the dumped Emacs starts, it has a
1403 normal malloc. Some thread implementations need this as they call
1404 malloc before main. The pthread_self call in BLOCK_INPUT_ALLOC then
1405 calls malloc because it is the first call, and we have an endless loop. */
1408 reset_malloc_hooks (void)
1410 __free_hook
= old_free_hook
;
1411 __malloc_hook
= old_malloc_hook
;
1412 __realloc_hook
= old_realloc_hook
;
1414 #endif /* HAVE_PTHREAD */
1417 /* Called from main to set up malloc to use our hooks. */
1420 uninterrupt_malloc (void)
1423 #ifdef DOUG_LEA_MALLOC
1424 pthread_mutexattr_t attr
;
1426 /* GLIBC has a faster way to do this, but let's keep it portable.
1427 This is according to the Single UNIX Specification. */
1428 pthread_mutexattr_init (&attr
);
1429 pthread_mutexattr_settype (&attr
, PTHREAD_MUTEX_RECURSIVE
);
1430 pthread_mutex_init (&alloc_mutex
, &attr
);
1431 #else /* !DOUG_LEA_MALLOC */
1432 /* Some systems such as Solaris 2.6 don't have a recursive mutex,
1433 and the bundled gmalloc.c doesn't require it. */
1434 pthread_mutex_init (&alloc_mutex
, NULL
);
1435 #endif /* !DOUG_LEA_MALLOC */
1436 #endif /* HAVE_PTHREAD */
1438 if (__free_hook
!= emacs_blocked_free
)
1439 old_free_hook
= __free_hook
;
1440 __free_hook
= emacs_blocked_free
;
1442 if (__malloc_hook
!= emacs_blocked_malloc
)
1443 old_malloc_hook
= __malloc_hook
;
1444 __malloc_hook
= emacs_blocked_malloc
;
1446 if (__realloc_hook
!= emacs_blocked_realloc
)
1447 old_realloc_hook
= __realloc_hook
;
1448 __realloc_hook
= emacs_blocked_realloc
;
1451 #endif /* not SYNC_INPUT */
1452 #endif /* not SYSTEM_MALLOC */
1456 /***********************************************************************
1458 ***********************************************************************/
1460 /* Number of intervals allocated in an interval_block structure.
1461 The 1020 is 1024 minus malloc overhead. */
1463 #define INTERVAL_BLOCK_SIZE \
1464 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1466 /* Intervals are allocated in chunks in form of an interval_block
1469 struct interval_block
1471 /* Place `intervals' first, to preserve alignment. */
1472 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1473 struct interval_block
*next
;
1476 /* Current interval block. Its `next' pointer points to older
1479 static struct interval_block
*interval_block
;
1481 /* Index in interval_block above of the next unused interval
1484 static int interval_block_index
;
1486 /* Number of free and live intervals. */
1488 static EMACS_INT total_free_intervals
, total_intervals
;
1490 /* List of free intervals. */
1492 static INTERVAL interval_free_list
;
1495 /* Initialize interval allocation. */
1498 init_intervals (void)
1500 interval_block
= NULL
;
1501 interval_block_index
= INTERVAL_BLOCK_SIZE
;
1502 interval_free_list
= 0;
1506 /* Return a new interval. */
1509 make_interval (void)
1513 /* eassert (!handling_signal); */
1517 if (interval_free_list
)
1519 val
= interval_free_list
;
1520 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1524 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1526 struct interval_block
*newi
1527 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1529 newi
->next
= interval_block
;
1530 interval_block
= newi
;
1531 interval_block_index
= 0;
1533 val
= &interval_block
->intervals
[interval_block_index
++];
1536 MALLOC_UNBLOCK_INPUT
;
1538 consing_since_gc
+= sizeof (struct interval
);
1540 RESET_INTERVAL (val
);
1546 /* Mark Lisp objects in interval I. */
1549 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1551 eassert (!i
->gcmarkbit
); /* Intervals are never shared. */
1553 mark_object (i
->plist
);
1557 /* Mark the interval tree rooted in TREE. Don't call this directly;
1558 use the macro MARK_INTERVAL_TREE instead. */
1561 mark_interval_tree (register INTERVAL tree
)
1563 /* No need to test if this tree has been marked already; this
1564 function is always called through the MARK_INTERVAL_TREE macro,
1565 which takes care of that. */
1567 traverse_intervals_noorder (tree
, mark_interval
, Qnil
);
1571 /* Mark the interval tree rooted in I. */
1573 #define MARK_INTERVAL_TREE(i) \
1575 if (!NULL_INTERVAL_P (i) && !i->gcmarkbit) \
1576 mark_interval_tree (i); \
1580 #define UNMARK_BALANCE_INTERVALS(i) \
1582 if (! NULL_INTERVAL_P (i)) \
1583 (i) = balance_intervals (i); \
1586 /***********************************************************************
1588 ***********************************************************************/
1590 /* Lisp_Strings are allocated in string_block structures. When a new
1591 string_block is allocated, all the Lisp_Strings it contains are
1592 added to a free-list string_free_list. When a new Lisp_String is
1593 needed, it is taken from that list. During the sweep phase of GC,
1594 string_blocks that are entirely free are freed, except two which
1597 String data is allocated from sblock structures. Strings larger
1598 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1599 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1601 Sblocks consist internally of sdata structures, one for each
1602 Lisp_String. The sdata structure points to the Lisp_String it
1603 belongs to. The Lisp_String points back to the `u.data' member of
1604 its sdata structure.
1606 When a Lisp_String is freed during GC, it is put back on
1607 string_free_list, and its `data' member and its sdata's `string'
1608 pointer is set to null. The size of the string is recorded in the
1609 `u.nbytes' member of the sdata. So, sdata structures that are no
1610 longer used, can be easily recognized, and it's easy to compact the
1611 sblocks of small strings which we do in compact_small_strings. */
1613 /* Size in bytes of an sblock structure used for small strings. This
1614 is 8192 minus malloc overhead. */
1616 #define SBLOCK_SIZE 8188
1618 /* Strings larger than this are considered large strings. String data
1619 for large strings is allocated from individual sblocks. */
1621 #define LARGE_STRING_BYTES 1024
1623 /* Structure describing string memory sub-allocated from an sblock.
1624 This is where the contents of Lisp strings are stored. */
1628 /* Back-pointer to the string this sdata belongs to. If null, this
1629 structure is free, and the NBYTES member of the union below
1630 contains the string's byte size (the same value that STRING_BYTES
1631 would return if STRING were non-null). If non-null, STRING_BYTES
1632 (STRING) is the size of the data, and DATA contains the string's
1634 struct Lisp_String
*string
;
1636 #ifdef GC_CHECK_STRING_BYTES
1639 unsigned char data
[1];
1641 #define SDATA_NBYTES(S) (S)->nbytes
1642 #define SDATA_DATA(S) (S)->data
1643 #define SDATA_SELECTOR(member) member
1645 #else /* not GC_CHECK_STRING_BYTES */
1649 /* When STRING is non-null. */
1650 unsigned char data
[1];
1652 /* When STRING is null. */
1656 #define SDATA_NBYTES(S) (S)->u.nbytes
1657 #define SDATA_DATA(S) (S)->u.data
1658 #define SDATA_SELECTOR(member) u.member
1660 #endif /* not GC_CHECK_STRING_BYTES */
1662 #define SDATA_DATA_OFFSET offsetof (struct sdata, SDATA_SELECTOR (data))
1666 /* Structure describing a block of memory which is sub-allocated to
1667 obtain string data memory for strings. Blocks for small strings
1668 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1669 as large as needed. */
1674 struct sblock
*next
;
1676 /* Pointer to the next free sdata block. This points past the end
1677 of the sblock if there isn't any space left in this block. */
1678 struct sdata
*next_free
;
1680 /* Start of data. */
1681 struct sdata first_data
;
1684 /* Number of Lisp strings in a string_block structure. The 1020 is
1685 1024 minus malloc overhead. */
1687 #define STRING_BLOCK_SIZE \
1688 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1690 /* Structure describing a block from which Lisp_String structures
1695 /* Place `strings' first, to preserve alignment. */
1696 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1697 struct string_block
*next
;
1700 /* Head and tail of the list of sblock structures holding Lisp string
1701 data. We always allocate from current_sblock. The NEXT pointers
1702 in the sblock structures go from oldest_sblock to current_sblock. */
1704 static struct sblock
*oldest_sblock
, *current_sblock
;
1706 /* List of sblocks for large strings. */
1708 static struct sblock
*large_sblocks
;
1710 /* List of string_block structures. */
1712 static struct string_block
*string_blocks
;
1714 /* Free-list of Lisp_Strings. */
1716 static struct Lisp_String
*string_free_list
;
1718 /* Number of live and free Lisp_Strings. */
1720 static EMACS_INT total_strings
, total_free_strings
;
1722 /* Number of bytes used by live strings. */
1724 static EMACS_INT total_string_size
;
1726 /* Given a pointer to a Lisp_String S which is on the free-list
1727 string_free_list, return a pointer to its successor in the
1730 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1732 /* Return a pointer to the sdata structure belonging to Lisp string S.
1733 S must be live, i.e. S->data must not be null. S->data is actually
1734 a pointer to the `u.data' member of its sdata structure; the
1735 structure starts at a constant offset in front of that. */
1737 #define SDATA_OF_STRING(S) ((struct sdata *) ((S)->data - SDATA_DATA_OFFSET))
1740 #ifdef GC_CHECK_STRING_OVERRUN
1742 /* We check for overrun in string data blocks by appending a small
1743 "cookie" after each allocated string data block, and check for the
1744 presence of this cookie during GC. */
1746 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1747 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1748 { '\xde', '\xad', '\xbe', '\xef' };
1751 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1754 /* Value is the size of an sdata structure large enough to hold NBYTES
1755 bytes of string data. The value returned includes a terminating
1756 NUL byte, the size of the sdata structure, and padding. */
1758 #ifdef GC_CHECK_STRING_BYTES
1760 #define SDATA_SIZE(NBYTES) \
1761 ((SDATA_DATA_OFFSET \
1763 + sizeof (ptrdiff_t) - 1) \
1764 & ~(sizeof (ptrdiff_t) - 1))
1766 #else /* not GC_CHECK_STRING_BYTES */
1768 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1769 less than the size of that member. The 'max' is not needed when
1770 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1771 alignment code reserves enough space. */
1773 #define SDATA_SIZE(NBYTES) \
1774 ((SDATA_DATA_OFFSET \
1775 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1777 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1779 + sizeof (ptrdiff_t) - 1) \
1780 & ~(sizeof (ptrdiff_t) - 1))
1782 #endif /* not GC_CHECK_STRING_BYTES */
1784 /* Extra bytes to allocate for each string. */
1786 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1788 /* Exact bound on the number of bytes in a string, not counting the
1789 terminating null. A string cannot contain more bytes than
1790 STRING_BYTES_BOUND, nor can it be so long that the size_t
1791 arithmetic in allocate_string_data would overflow while it is
1792 calculating a value to be passed to malloc. */
1793 #define STRING_BYTES_MAX \
1794 min (STRING_BYTES_BOUND, \
1795 ((SIZE_MAX - XMALLOC_OVERRUN_CHECK_OVERHEAD \
1797 - offsetof (struct sblock, first_data) \
1798 - SDATA_DATA_OFFSET) \
1799 & ~(sizeof (EMACS_INT) - 1)))
1801 /* Initialize string allocation. Called from init_alloc_once. */
1806 total_strings
= total_free_strings
= total_string_size
= 0;
1807 oldest_sblock
= current_sblock
= large_sblocks
= NULL
;
1808 string_blocks
= NULL
;
1809 string_free_list
= NULL
;
1810 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1811 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1815 #ifdef GC_CHECK_STRING_BYTES
1817 static int check_string_bytes_count
;
1819 #define CHECK_STRING_BYTES(S) STRING_BYTES (S)
1822 /* Like GC_STRING_BYTES, but with debugging check. */
1825 string_bytes (struct Lisp_String
*s
)
1828 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1830 if (!PURE_POINTER_P (s
)
1832 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1837 /* Check validity of Lisp strings' string_bytes member in B. */
1840 check_sblock (struct sblock
*b
)
1842 struct sdata
*from
, *end
, *from_end
;
1846 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1848 /* Compute the next FROM here because copying below may
1849 overwrite data we need to compute it. */
1852 /* Check that the string size recorded in the string is the
1853 same as the one recorded in the sdata structure. */
1855 CHECK_STRING_BYTES (from
->string
);
1858 nbytes
= GC_STRING_BYTES (from
->string
);
1860 nbytes
= SDATA_NBYTES (from
);
1862 nbytes
= SDATA_SIZE (nbytes
);
1863 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1868 /* Check validity of Lisp strings' string_bytes member. ALL_P
1869 non-zero means check all strings, otherwise check only most
1870 recently allocated strings. Used for hunting a bug. */
1873 check_string_bytes (int all_p
)
1879 for (b
= large_sblocks
; b
; b
= b
->next
)
1881 struct Lisp_String
*s
= b
->first_data
.string
;
1883 CHECK_STRING_BYTES (s
);
1886 for (b
= oldest_sblock
; b
; b
= b
->next
)
1889 else if (current_sblock
)
1890 check_sblock (current_sblock
);
1893 #endif /* GC_CHECK_STRING_BYTES */
1895 #ifdef GC_CHECK_STRING_FREE_LIST
1897 /* Walk through the string free list looking for bogus next pointers.
1898 This may catch buffer overrun from a previous string. */
1901 check_string_free_list (void)
1903 struct Lisp_String
*s
;
1905 /* Pop a Lisp_String off the free-list. */
1906 s
= string_free_list
;
1909 if ((uintptr_t) s
< 1024)
1911 s
= NEXT_FREE_LISP_STRING (s
);
1915 #define check_string_free_list()
1918 /* Return a new Lisp_String. */
1920 static struct Lisp_String
*
1921 allocate_string (void)
1923 struct Lisp_String
*s
;
1925 /* eassert (!handling_signal); */
1929 /* If the free-list is empty, allocate a new string_block, and
1930 add all the Lisp_Strings in it to the free-list. */
1931 if (string_free_list
== NULL
)
1933 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1936 b
->next
= string_blocks
;
1939 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1942 /* Every string on a free list should have NULL data pointer. */
1944 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1945 string_free_list
= s
;
1948 total_free_strings
+= STRING_BLOCK_SIZE
;
1951 check_string_free_list ();
1953 /* Pop a Lisp_String off the free-list. */
1954 s
= string_free_list
;
1955 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1957 MALLOC_UNBLOCK_INPUT
;
1959 --total_free_strings
;
1962 consing_since_gc
+= sizeof *s
;
1964 #ifdef GC_CHECK_STRING_BYTES
1965 if (!noninteractive
)
1967 if (++check_string_bytes_count
== 200)
1969 check_string_bytes_count
= 0;
1970 check_string_bytes (1);
1973 check_string_bytes (0);
1975 #endif /* GC_CHECK_STRING_BYTES */
1981 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1982 plus a NUL byte at the end. Allocate an sdata structure for S, and
1983 set S->data to its `u.data' member. Store a NUL byte at the end of
1984 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1985 S->data if it was initially non-null. */
1988 allocate_string_data (struct Lisp_String
*s
,
1989 EMACS_INT nchars
, EMACS_INT nbytes
)
1995 if (STRING_BYTES_MAX
< nbytes
)
1998 /* Determine the number of bytes needed to store NBYTES bytes
2000 needed
= SDATA_SIZE (nbytes
);
2004 if (nbytes
> LARGE_STRING_BYTES
)
2006 size_t size
= offsetof (struct sblock
, first_data
) + needed
;
2008 #ifdef DOUG_LEA_MALLOC
2009 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
2010 because mapped region contents are not preserved in
2013 In case you think of allowing it in a dumped Emacs at the
2014 cost of not being able to re-dump, there's another reason:
2015 mmap'ed data typically have an address towards the top of the
2016 address space, which won't fit into an EMACS_INT (at least on
2017 32-bit systems with the current tagging scheme). --fx */
2018 mallopt (M_MMAP_MAX
, 0);
2021 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
2023 #ifdef DOUG_LEA_MALLOC
2024 /* Back to a reasonable maximum of mmap'ed areas. */
2025 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2028 b
->next_free
= &b
->first_data
;
2029 b
->first_data
.string
= NULL
;
2030 b
->next
= large_sblocks
;
2033 else if (current_sblock
== NULL
2034 || (((char *) current_sblock
+ SBLOCK_SIZE
2035 - (char *) current_sblock
->next_free
)
2036 < (needed
+ GC_STRING_EXTRA
)))
2038 /* Not enough room in the current sblock. */
2039 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
2040 b
->next_free
= &b
->first_data
;
2041 b
->first_data
.string
= NULL
;
2045 current_sblock
->next
= b
;
2053 data
= b
->next_free
;
2054 b
->next_free
= (struct sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
2056 MALLOC_UNBLOCK_INPUT
;
2059 s
->data
= SDATA_DATA (data
);
2060 #ifdef GC_CHECK_STRING_BYTES
2061 SDATA_NBYTES (data
) = nbytes
;
2064 s
->size_byte
= nbytes
;
2065 s
->data
[nbytes
] = '\0';
2066 #ifdef GC_CHECK_STRING_OVERRUN
2067 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
2068 GC_STRING_OVERRUN_COOKIE_SIZE
);
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
;
2522 /***********************************************************************
2524 ***********************************************************************/
2526 /* We store float cells inside of float_blocks, allocating a new
2527 float_block with malloc whenever necessary. Float cells reclaimed
2528 by GC are put on a free list to be reallocated before allocating
2529 any new float cells from the latest float_block. */
2531 #define FLOAT_BLOCK_SIZE \
2532 (((BLOCK_BYTES - sizeof (struct float_block *) \
2533 /* The compiler might add padding at the end. */ \
2534 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2535 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2537 #define GETMARKBIT(block,n) \
2538 (((block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2539 >> ((n) % (sizeof (int) * CHAR_BIT))) \
2542 #define SETMARKBIT(block,n) \
2543 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2544 |= 1 << ((n) % (sizeof (int) * CHAR_BIT))
2546 #define UNSETMARKBIT(block,n) \
2547 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2548 &= ~(1 << ((n) % (sizeof (int) * CHAR_BIT)))
2550 #define FLOAT_BLOCK(fptr) \
2551 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2553 #define FLOAT_INDEX(fptr) \
2554 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2558 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2559 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2560 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2561 struct float_block
*next
;
2564 #define FLOAT_MARKED_P(fptr) \
2565 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2567 #define FLOAT_MARK(fptr) \
2568 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2570 #define FLOAT_UNMARK(fptr) \
2571 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2573 /* Current float_block. */
2575 static struct float_block
*float_block
;
2577 /* Index of first unused Lisp_Float in the current float_block. */
2579 static int float_block_index
;
2581 /* Free-list of Lisp_Floats. */
2583 static struct Lisp_Float
*float_free_list
;
2586 /* Initialize float allocation. */
2592 float_block_index
= FLOAT_BLOCK_SIZE
; /* Force alloc of new float_block. */
2593 float_free_list
= 0;
2597 /* Return a new float object with value FLOAT_VALUE. */
2600 make_float (double float_value
)
2602 register Lisp_Object val
;
2604 /* eassert (!handling_signal); */
2608 if (float_free_list
)
2610 /* We use the data field for chaining the free list
2611 so that we won't use the same field that has the mark bit. */
2612 XSETFLOAT (val
, float_free_list
);
2613 float_free_list
= float_free_list
->u
.chain
;
2617 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2619 struct float_block
*new
2620 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2621 new->next
= float_block
;
2622 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2624 float_block_index
= 0;
2626 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2627 float_block_index
++;
2630 MALLOC_UNBLOCK_INPUT
;
2632 XFLOAT_INIT (val
, float_value
);
2633 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2634 consing_since_gc
+= sizeof (struct Lisp_Float
);
2641 /***********************************************************************
2643 ***********************************************************************/
2645 /* We store cons cells inside of cons_blocks, allocating a new
2646 cons_block with malloc whenever necessary. Cons cells reclaimed by
2647 GC are put on a free list to be reallocated before allocating
2648 any new cons cells from the latest cons_block. */
2650 #define CONS_BLOCK_SIZE \
2651 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2652 /* The compiler might add padding at the end. */ \
2653 - (sizeof (struct Lisp_Cons) - sizeof (int))) * CHAR_BIT) \
2654 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2656 #define CONS_BLOCK(fptr) \
2657 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2659 #define CONS_INDEX(fptr) \
2660 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2664 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2665 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2666 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2667 struct cons_block
*next
;
2670 #define CONS_MARKED_P(fptr) \
2671 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2673 #define CONS_MARK(fptr) \
2674 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2676 #define CONS_UNMARK(fptr) \
2677 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2679 /* Current cons_block. */
2681 static struct cons_block
*cons_block
;
2683 /* Index of first unused Lisp_Cons in the current block. */
2685 static int cons_block_index
;
2687 /* Free-list of Lisp_Cons structures. */
2689 static struct Lisp_Cons
*cons_free_list
;
2692 /* Initialize cons allocation. */
2698 cons_block_index
= CONS_BLOCK_SIZE
; /* Force alloc of new cons_block. */
2703 /* Explicitly free a cons cell by putting it on the free-list. */
2706 free_cons (struct Lisp_Cons
*ptr
)
2708 ptr
->u
.chain
= cons_free_list
;
2712 cons_free_list
= ptr
;
2715 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2716 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2717 (Lisp_Object car
, Lisp_Object cdr
)
2719 register Lisp_Object val
;
2721 /* eassert (!handling_signal); */
2727 /* We use the cdr for chaining the free list
2728 so that we won't use the same field that has the mark bit. */
2729 XSETCONS (val
, cons_free_list
);
2730 cons_free_list
= cons_free_list
->u
.chain
;
2734 if (cons_block_index
== CONS_BLOCK_SIZE
)
2736 struct cons_block
*new
2737 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2738 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2739 new->next
= cons_block
;
2741 cons_block_index
= 0;
2743 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2747 MALLOC_UNBLOCK_INPUT
;
2751 eassert (!CONS_MARKED_P (XCONS (val
)));
2752 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2753 cons_cells_consed
++;
2757 #ifdef GC_CHECK_CONS_LIST
2758 /* Get an error now if there's any junk in the cons free list. */
2760 check_cons_list (void)
2762 struct Lisp_Cons
*tail
= cons_free_list
;
2765 tail
= tail
->u
.chain
;
2769 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2772 list1 (Lisp_Object arg1
)
2774 return Fcons (arg1
, Qnil
);
2778 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2780 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2785 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2787 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2792 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2794 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2799 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2801 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2802 Fcons (arg5
, Qnil
)))));
2806 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2807 doc
: /* Return a newly created list with specified arguments as elements.
2808 Any number of arguments, even zero arguments, are allowed.
2809 usage: (list &rest OBJECTS) */)
2810 (ptrdiff_t nargs
, Lisp_Object
*args
)
2812 register Lisp_Object val
;
2818 val
= Fcons (args
[nargs
], val
);
2824 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2825 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2826 (register Lisp_Object length
, Lisp_Object init
)
2828 register Lisp_Object val
;
2829 register EMACS_INT size
;
2831 CHECK_NATNUM (length
);
2832 size
= XFASTINT (length
);
2837 val
= Fcons (init
, val
);
2842 val
= Fcons (init
, val
);
2847 val
= Fcons (init
, val
);
2852 val
= Fcons (init
, val
);
2857 val
= Fcons (init
, val
);
2872 /***********************************************************************
2874 ***********************************************************************/
2876 /* This value is balanced well enough to avoid too much internal overhead
2877 for the most common cases; it's not required to be a power of two, but
2878 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2880 #define VECTOR_BLOCK_SIZE 4096
2882 /* Handy constants for vectorlike objects. */
2885 header_size
= offsetof (struct Lisp_Vector
, contents
),
2886 word_size
= sizeof (Lisp_Object
),
2887 roundup_size
= COMMON_MULTIPLE (sizeof (Lisp_Object
),
2888 USE_LSB_TAG
? 1 << GCTYPEBITS
: 1)
2891 /* ROUNDUP_SIZE must be a power of 2. */
2892 verify ((roundup_size
& (roundup_size
- 1)) == 0);
2894 /* Verify assumptions described above. */
2895 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2896 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2898 /* Round up X to nearest mult-of-ROUNDUP_SIZE. */
2900 #define vroundup(x) (((x) + (roundup_size - 1)) & ~(roundup_size - 1))
2902 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2904 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup (sizeof (void *)))
2906 /* Size of the minimal vector allocated from block. */
2908 #define VBLOCK_BYTES_MIN vroundup (sizeof (struct Lisp_Vector))
2910 /* Size of the largest vector allocated from block. */
2912 #define VBLOCK_BYTES_MAX \
2913 vroundup ((VECTOR_BLOCK_BYTES / 2) - sizeof (Lisp_Object))
2915 /* We maintain one free list for each possible block-allocated
2916 vector size, and this is the number of free lists we have. */
2918 #define VECTOR_MAX_FREE_LIST_INDEX \
2919 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2921 /* Common shortcut to advance vector pointer over a block data. */
2923 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2925 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2927 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2929 /* Common shortcut to setup vector on a free list. */
2931 #define SETUP_ON_FREE_LIST(v, nbytes, index) \
2933 XSETPVECTYPESIZE (v, PVEC_FREE, nbytes); \
2934 eassert ((nbytes) % roundup_size == 0); \
2935 (index) = VINDEX (nbytes); \
2936 eassert ((index) < VECTOR_MAX_FREE_LIST_INDEX); \
2937 (v)->header.next.vector = vector_free_lists[index]; \
2938 vector_free_lists[index] = (v); \
2943 char data
[VECTOR_BLOCK_BYTES
];
2944 struct vector_block
*next
;
2947 /* Chain of vector blocks. */
2949 static struct vector_block
*vector_blocks
;
2951 /* Vector free lists, where NTH item points to a chain of free
2952 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2954 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2956 /* Singly-linked list of large vectors. */
2958 static struct Lisp_Vector
*large_vectors
;
2960 /* The only vector with 0 slots, allocated from pure space. */
2962 static struct Lisp_Vector
*zero_vector
;
2964 /* Get a new vector block. */
2966 static struct vector_block
*
2967 allocate_vector_block (void)
2969 struct vector_block
*block
= xmalloc (sizeof *block
);
2971 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
2972 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
2973 MEM_TYPE_VECTOR_BLOCK
);
2976 block
->next
= vector_blocks
;
2977 vector_blocks
= block
;
2981 /* Called once to initialize vector allocation. */
2986 zero_vector
= pure_alloc (header_size
, Lisp_Vectorlike
);
2987 zero_vector
->header
.size
= 0;
2990 /* Allocate vector from a vector block. */
2992 static struct Lisp_Vector
*
2993 allocate_vector_from_block (size_t nbytes
)
2995 struct Lisp_Vector
*vector
, *rest
;
2996 struct vector_block
*block
;
2997 size_t index
, restbytes
;
2999 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
3000 eassert (nbytes
% roundup_size
== 0);
3002 /* First, try to allocate from a free list
3003 containing vectors of the requested size. */
3004 index
= VINDEX (nbytes
);
3005 if (vector_free_lists
[index
])
3007 vector
= vector_free_lists
[index
];
3008 vector_free_lists
[index
] = vector
->header
.next
.vector
;
3009 vector
->header
.next
.nbytes
= nbytes
;
3013 /* Next, check free lists containing larger vectors. Since
3014 we will split the result, we should have remaining space
3015 large enough to use for one-slot vector at least. */
3016 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
3017 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
3018 if (vector_free_lists
[index
])
3020 /* This vector is larger than requested. */
3021 vector
= vector_free_lists
[index
];
3022 vector_free_lists
[index
] = vector
->header
.next
.vector
;
3023 vector
->header
.next
.nbytes
= nbytes
;
3025 /* Excess bytes are used for the smaller vector,
3026 which should be set on an appropriate free list. */
3027 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
3028 eassert (restbytes
% roundup_size
== 0);
3029 rest
= ADVANCE (vector
, nbytes
);
3030 SETUP_ON_FREE_LIST (rest
, restbytes
, index
);
3034 /* Finally, need a new vector block. */
3035 block
= allocate_vector_block ();
3037 /* New vector will be at the beginning of this block. */
3038 vector
= (struct Lisp_Vector
*) block
->data
;
3039 vector
->header
.next
.nbytes
= nbytes
;
3041 /* If the rest of space from this block is large enough
3042 for one-slot vector at least, set up it on a free list. */
3043 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
3044 if (restbytes
>= VBLOCK_BYTES_MIN
)
3046 eassert (restbytes
% roundup_size
== 0);
3047 rest
= ADVANCE (vector
, nbytes
);
3048 SETUP_ON_FREE_LIST (rest
, restbytes
, index
);
3053 /* Return how many Lisp_Objects can be stored in V. */
3055 #define VECTOR_SIZE(v) ((v)->header.size & PSEUDOVECTOR_FLAG ? \
3056 (PSEUDOVECTOR_SIZE_MASK & (v)->header.size) : \
3059 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
3061 #define VECTOR_IN_BLOCK(vector, block) \
3062 ((char *) (vector) <= (block)->data \
3063 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
3065 /* Number of bytes used by vector-block-allocated object. This is the only
3066 place where we actually use the `nbytes' field of the vector-header.
3067 I.e. we could get rid of the `nbytes' field by computing it based on the
3070 #define PSEUDOVECTOR_NBYTES(vector) \
3071 (PSEUDOVECTOR_TYPEP (&vector->header, PVEC_FREE) \
3072 ? vector->header.size & PSEUDOVECTOR_SIZE_MASK \
3073 : vector->header.next.nbytes)
3075 /* Reclaim space used by unmarked vectors. */
3078 sweep_vectors (void)
3080 struct vector_block
*block
= vector_blocks
, **bprev
= &vector_blocks
;
3081 struct Lisp_Vector
*vector
, *next
, **vprev
= &large_vectors
;
3083 total_vector_size
= 0;
3084 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
3086 /* Looking through vector blocks. */
3088 for (block
= vector_blocks
; block
; block
= *bprev
)
3090 int free_this_block
= 0;
3092 for (vector
= (struct Lisp_Vector
*) block
->data
;
3093 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
3095 if (VECTOR_MARKED_P (vector
))
3097 VECTOR_UNMARK (vector
);
3098 total_vector_size
+= VECTOR_SIZE (vector
);
3099 next
= ADVANCE (vector
, vector
->header
.next
.nbytes
);
3103 ptrdiff_t nbytes
= PSEUDOVECTOR_NBYTES (vector
);
3104 ptrdiff_t total_bytes
= nbytes
;
3106 next
= ADVANCE (vector
, nbytes
);
3108 /* While NEXT is not marked, try to coalesce with VECTOR,
3109 thus making VECTOR of the largest possible size. */
3111 while (VECTOR_IN_BLOCK (next
, block
))
3113 if (VECTOR_MARKED_P (next
))
3115 nbytes
= PSEUDOVECTOR_NBYTES (next
);
3116 total_bytes
+= nbytes
;
3117 next
= ADVANCE (next
, nbytes
);
3120 eassert (total_bytes
% roundup_size
== 0);
3122 if (vector
== (struct Lisp_Vector
*) block
->data
3123 && !VECTOR_IN_BLOCK (next
, block
))
3124 /* This block should be freed because all of it's
3125 space was coalesced into the only free vector. */
3126 free_this_block
= 1;
3130 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
3135 if (free_this_block
)
3137 *bprev
= block
->next
;
3138 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
3139 mem_delete (mem_find (block
->data
));
3144 bprev
= &block
->next
;
3147 /* Sweep large vectors. */
3149 for (vector
= large_vectors
; vector
; vector
= *vprev
)
3151 if (VECTOR_MARKED_P (vector
))
3153 VECTOR_UNMARK (vector
);
3154 total_vector_size
+= VECTOR_SIZE (vector
);
3155 vprev
= &vector
->header
.next
.vector
;
3159 *vprev
= vector
->header
.next
.vector
;
3165 /* Value is a pointer to a newly allocated Lisp_Vector structure
3166 with room for LEN Lisp_Objects. */
3168 static struct Lisp_Vector
*
3169 allocate_vectorlike (ptrdiff_t len
)
3171 struct Lisp_Vector
*p
;
3175 /* This gets triggered by code which I haven't bothered to fix. --Stef */
3176 /* eassert (!handling_signal); */
3182 size_t nbytes
= header_size
+ len
* word_size
;
3184 #ifdef DOUG_LEA_MALLOC
3185 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
3186 because mapped region contents are not preserved in
3188 mallopt (M_MMAP_MAX
, 0);
3191 if (nbytes
<= VBLOCK_BYTES_MAX
)
3192 p
= allocate_vector_from_block (vroundup (nbytes
));
3195 p
= lisp_malloc (nbytes
, MEM_TYPE_VECTORLIKE
);
3196 p
->header
.next
.vector
= large_vectors
;
3200 #ifdef DOUG_LEA_MALLOC
3201 /* Back to a reasonable maximum of mmap'ed areas. */
3202 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3205 consing_since_gc
+= nbytes
;
3206 vector_cells_consed
+= len
;
3209 MALLOC_UNBLOCK_INPUT
;
3215 /* Allocate a vector with LEN slots. */
3217 struct Lisp_Vector
*
3218 allocate_vector (EMACS_INT len
)
3220 struct Lisp_Vector
*v
;
3221 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3223 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3224 memory_full (SIZE_MAX
);
3225 v
= allocate_vectorlike (len
);
3226 v
->header
.size
= len
;
3231 /* Allocate other vector-like structures. */
3233 struct Lisp_Vector
*
3234 allocate_pseudovector (int memlen
, int lisplen
, int tag
)
3236 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3239 /* Only the first lisplen slots will be traced normally by the GC. */
3240 for (i
= 0; i
< lisplen
; ++i
)
3241 v
->contents
[i
] = Qnil
;
3243 XSETPVECTYPESIZE (v
, tag
, lisplen
);
3248 allocate_buffer (void)
3250 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3252 XSETPVECTYPESIZE (b
, PVEC_BUFFER
, (offsetof (struct buffer
, own_text
)
3253 - header_size
) / word_size
);
3254 /* Note that the fields of B are not initialized. */
3258 struct Lisp_Hash_Table
*
3259 allocate_hash_table (void)
3261 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
3265 allocate_window (void)
3269 w
= ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
3270 /* Users assumes that non-Lisp data is zeroed. */
3271 memset (&w
->current_matrix
, 0,
3272 sizeof (*w
) - offsetof (struct window
, current_matrix
));
3277 allocate_terminal (void)
3281 t
= ALLOCATE_PSEUDOVECTOR (struct terminal
, next_terminal
, PVEC_TERMINAL
);
3282 /* Users assumes that non-Lisp data is zeroed. */
3283 memset (&t
->next_terminal
, 0,
3284 sizeof (*t
) - offsetof (struct terminal
, next_terminal
));
3289 allocate_frame (void)
3293 f
= ALLOCATE_PSEUDOVECTOR (struct frame
, face_cache
, PVEC_FRAME
);
3294 /* Users assumes that non-Lisp data is zeroed. */
3295 memset (&f
->face_cache
, 0,
3296 sizeof (*f
) - offsetof (struct frame
, face_cache
));
3300 struct Lisp_Process
*
3301 allocate_process (void)
3303 struct Lisp_Process
*p
;
3305 p
= ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3306 /* Users assumes that non-Lisp data is zeroed. */
3308 sizeof (*p
) - offsetof (struct Lisp_Process
, pid
));
3312 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3313 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3314 See also the function `vector'. */)
3315 (register Lisp_Object length
, Lisp_Object init
)
3318 register ptrdiff_t sizei
;
3319 register ptrdiff_t i
;
3320 register struct Lisp_Vector
*p
;
3322 CHECK_NATNUM (length
);
3324 p
= allocate_vector (XFASTINT (length
));
3325 sizei
= XFASTINT (length
);
3326 for (i
= 0; i
< sizei
; i
++)
3327 p
->contents
[i
] = init
;
3329 XSETVECTOR (vector
, p
);
3334 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3335 doc
: /* Return a newly created vector with specified arguments as elements.
3336 Any number of arguments, even zero arguments, are allowed.
3337 usage: (vector &rest OBJECTS) */)
3338 (ptrdiff_t nargs
, Lisp_Object
*args
)
3340 register Lisp_Object len
, val
;
3342 register struct Lisp_Vector
*p
;
3344 XSETFASTINT (len
, nargs
);
3345 val
= Fmake_vector (len
, Qnil
);
3347 for (i
= 0; i
< nargs
; i
++)
3348 p
->contents
[i
] = args
[i
];
3353 make_byte_code (struct Lisp_Vector
*v
)
3355 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3356 && STRING_MULTIBYTE (v
->contents
[1]))
3357 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3358 earlier because they produced a raw 8-bit string for byte-code
3359 and now such a byte-code string is loaded as multibyte while
3360 raw 8-bit characters converted to multibyte form. Thus, now we
3361 must convert them back to the original unibyte form. */
3362 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3363 XSETPVECTYPE (v
, PVEC_COMPILED
);
3366 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3367 doc
: /* Create a byte-code object with specified arguments as elements.
3368 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3369 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3370 and (optional) INTERACTIVE-SPEC.
3371 The first four arguments are required; at most six have any
3373 The ARGLIST can be either like the one of `lambda', in which case the arguments
3374 will be dynamically bound before executing the byte code, or it can be an
3375 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3376 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3377 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3378 argument to catch the left-over arguments. If such an integer is used, the
3379 arguments will not be dynamically bound but will be instead pushed on the
3380 stack before executing the byte-code.
3381 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3382 (ptrdiff_t nargs
, Lisp_Object
*args
)
3384 register Lisp_Object len
, val
;
3386 register struct Lisp_Vector
*p
;
3388 /* We used to purecopy everything here, if purify-flga was set. This worked
3389 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3390 dangerous, since make-byte-code is used during execution to build
3391 closures, so any closure built during the preload phase would end up
3392 copied into pure space, including its free variables, which is sometimes
3393 just wasteful and other times plainly wrong (e.g. those free vars may want
3396 XSETFASTINT (len
, nargs
);
3397 val
= Fmake_vector (len
, Qnil
);
3400 for (i
= 0; i
< nargs
; i
++)
3401 p
->contents
[i
] = args
[i
];
3403 XSETCOMPILED (val
, p
);
3409 /***********************************************************************
3411 ***********************************************************************/
3413 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3414 of the required alignment if LSB tags are used. */
3416 union aligned_Lisp_Symbol
3418 struct Lisp_Symbol s
;
3420 unsigned char c
[(sizeof (struct Lisp_Symbol
) + (1 << GCTYPEBITS
) - 1)
3421 & -(1 << GCTYPEBITS
)];
3425 /* Each symbol_block is just under 1020 bytes long, since malloc
3426 really allocates in units of powers of two and uses 4 bytes for its
3429 #define SYMBOL_BLOCK_SIZE \
3430 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3434 /* Place `symbols' first, to preserve alignment. */
3435 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3436 struct symbol_block
*next
;
3439 /* Current symbol block and index of first unused Lisp_Symbol
3442 static struct symbol_block
*symbol_block
;
3443 static int symbol_block_index
;
3445 /* List of free symbols. */
3447 static struct Lisp_Symbol
*symbol_free_list
;
3450 /* Initialize symbol allocation. */
3455 symbol_block
= NULL
;
3456 symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3457 symbol_free_list
= 0;
3461 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3462 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3463 Its value and function definition are void, and its property list is nil. */)
3466 register Lisp_Object val
;
3467 register struct Lisp_Symbol
*p
;
3469 CHECK_STRING (name
);
3471 /* eassert (!handling_signal); */
3475 if (symbol_free_list
)
3477 XSETSYMBOL (val
, symbol_free_list
);
3478 symbol_free_list
= symbol_free_list
->next
;
3482 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3484 struct symbol_block
*new
3485 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3486 new->next
= symbol_block
;
3488 symbol_block_index
= 0;
3490 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3491 symbol_block_index
++;
3494 MALLOC_UNBLOCK_INPUT
;
3499 p
->redirect
= SYMBOL_PLAINVAL
;
3500 SET_SYMBOL_VAL (p
, Qunbound
);
3501 p
->function
= Qunbound
;
3504 p
->interned
= SYMBOL_UNINTERNED
;
3506 p
->declared_special
= 0;
3507 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3514 /***********************************************************************
3515 Marker (Misc) Allocation
3516 ***********************************************************************/
3518 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3519 the required alignment when LSB tags are used. */
3521 union aligned_Lisp_Misc
3525 unsigned char c
[(sizeof (union Lisp_Misc
) + (1 << GCTYPEBITS
) - 1)
3526 & -(1 << GCTYPEBITS
)];
3530 /* Allocation of markers and other objects that share that structure.
3531 Works like allocation of conses. */
3533 #define MARKER_BLOCK_SIZE \
3534 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3538 /* Place `markers' first, to preserve alignment. */
3539 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3540 struct marker_block
*next
;
3543 static struct marker_block
*marker_block
;
3544 static int marker_block_index
;
3546 static union Lisp_Misc
*marker_free_list
;
3551 marker_block
= NULL
;
3552 marker_block_index
= MARKER_BLOCK_SIZE
;
3553 marker_free_list
= 0;
3556 /* Return a newly allocated Lisp_Misc object, with no substructure. */
3559 allocate_misc (void)
3563 /* eassert (!handling_signal); */
3567 if (marker_free_list
)
3569 XSETMISC (val
, marker_free_list
);
3570 marker_free_list
= marker_free_list
->u_free
.chain
;
3574 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3576 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3577 new->next
= marker_block
;
3579 marker_block_index
= 0;
3580 total_free_markers
+= MARKER_BLOCK_SIZE
;
3582 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3583 marker_block_index
++;
3586 MALLOC_UNBLOCK_INPUT
;
3588 --total_free_markers
;
3589 consing_since_gc
+= sizeof (union Lisp_Misc
);
3590 misc_objects_consed
++;
3591 XMISCANY (val
)->gcmarkbit
= 0;
3595 /* Free a Lisp_Misc object */
3598 free_misc (Lisp_Object misc
)
3600 XMISCTYPE (misc
) = Lisp_Misc_Free
;
3601 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3602 marker_free_list
= XMISC (misc
);
3604 total_free_markers
++;
3607 /* Return a Lisp_Misc_Save_Value object containing POINTER and
3608 INTEGER. This is used to package C values to call record_unwind_protect.
3609 The unwind function can get the C values back using XSAVE_VALUE. */
3612 make_save_value (void *pointer
, ptrdiff_t integer
)
3614 register Lisp_Object val
;
3615 register struct Lisp_Save_Value
*p
;
3617 val
= allocate_misc ();
3618 XMISCTYPE (val
) = Lisp_Misc_Save_Value
;
3619 p
= XSAVE_VALUE (val
);
3620 p
->pointer
= pointer
;
3621 p
->integer
= integer
;
3626 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3627 doc
: /* Return a newly allocated marker which does not point at any place. */)
3630 register Lisp_Object val
;
3631 register struct Lisp_Marker
*p
;
3633 val
= allocate_misc ();
3634 XMISCTYPE (val
) = Lisp_Misc_Marker
;
3640 p
->insertion_type
= 0;
3644 /* Return a newly allocated marker which points into BUF
3645 at character position CHARPOS and byte position BYTEPOS. */
3648 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3651 struct Lisp_Marker
*m
;
3653 /* No dead buffers here. */
3654 eassert (!NILP (BVAR (buf
, name
)));
3656 /* Every character is at least one byte. */
3657 eassert (charpos
<= bytepos
);
3659 obj
= allocate_misc ();
3660 XMISCTYPE (obj
) = Lisp_Misc_Marker
;
3663 m
->charpos
= charpos
;
3664 m
->bytepos
= bytepos
;
3665 m
->insertion_type
= 0;
3666 m
->next
= BUF_MARKERS (buf
);
3667 BUF_MARKERS (buf
) = m
;
3671 /* Put MARKER back on the free list after using it temporarily. */
3674 free_marker (Lisp_Object marker
)
3676 unchain_marker (XMARKER (marker
));
3681 /* Return a newly created vector or string with specified arguments as
3682 elements. If all the arguments are characters that can fit
3683 in a string of events, make a string; otherwise, make a vector.
3685 Any number of arguments, even zero arguments, are allowed. */
3688 make_event_array (register int nargs
, Lisp_Object
*args
)
3692 for (i
= 0; i
< nargs
; i
++)
3693 /* The things that fit in a string
3694 are characters that are in 0...127,
3695 after discarding the meta bit and all the bits above it. */
3696 if (!INTEGERP (args
[i
])
3697 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3698 return Fvector (nargs
, args
);
3700 /* Since the loop exited, we know that all the things in it are
3701 characters, so we can make a string. */
3705 result
= Fmake_string (make_number (nargs
), make_number (0));
3706 for (i
= 0; i
< nargs
; i
++)
3708 SSET (result
, i
, XINT (args
[i
]));
3709 /* Move the meta bit to the right place for a string char. */
3710 if (XINT (args
[i
]) & CHAR_META
)
3711 SSET (result
, i
, SREF (result
, i
) | 0x80);
3720 /************************************************************************
3721 Memory Full Handling
3722 ************************************************************************/
3725 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3726 there may have been size_t overflow so that malloc was never
3727 called, or perhaps malloc was invoked successfully but the
3728 resulting pointer had problems fitting into a tagged EMACS_INT. In
3729 either case this counts as memory being full even though malloc did
3733 memory_full (size_t nbytes
)
3735 /* Do not go into hysterics merely because a large request failed. */
3736 int enough_free_memory
= 0;
3737 if (SPARE_MEMORY
< nbytes
)
3742 p
= malloc (SPARE_MEMORY
);
3746 enough_free_memory
= 1;
3748 MALLOC_UNBLOCK_INPUT
;
3751 if (! enough_free_memory
)
3757 memory_full_cons_threshold
= sizeof (struct cons_block
);
3759 /* The first time we get here, free the spare memory. */
3760 for (i
= 0; i
< sizeof (spare_memory
) / sizeof (char *); i
++)
3761 if (spare_memory
[i
])
3764 free (spare_memory
[i
]);
3765 else if (i
>= 1 && i
<= 4)
3766 lisp_align_free (spare_memory
[i
]);
3768 lisp_free (spare_memory
[i
]);
3769 spare_memory
[i
] = 0;
3772 /* Record the space now used. When it decreases substantially,
3773 we can refill the memory reserve. */
3774 #if !defined SYSTEM_MALLOC && !defined SYNC_INPUT
3775 bytes_used_when_full
= BYTES_USED
;
3779 /* This used to call error, but if we've run out of memory, we could
3780 get infinite recursion trying to build the string. */
3781 xsignal (Qnil
, Vmemory_signal_data
);
3784 /* If we released our reserve (due to running out of memory),
3785 and we have a fair amount free once again,
3786 try to set aside another reserve in case we run out once more.
3788 This is called when a relocatable block is freed in ralloc.c,
3789 and also directly from this file, in case we're not using ralloc.c. */
3792 refill_memory_reserve (void)
3794 #ifndef SYSTEM_MALLOC
3795 if (spare_memory
[0] == 0)
3796 spare_memory
[0] = malloc (SPARE_MEMORY
);
3797 if (spare_memory
[1] == 0)
3798 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
3800 if (spare_memory
[2] == 0)
3801 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
3803 if (spare_memory
[3] == 0)
3804 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
3806 if (spare_memory
[4] == 0)
3807 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
3809 if (spare_memory
[5] == 0)
3810 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
3812 if (spare_memory
[6] == 0)
3813 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
3815 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3816 Vmemory_full
= Qnil
;
3820 /************************************************************************
3822 ************************************************************************/
3824 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3826 /* Conservative C stack marking requires a method to identify possibly
3827 live Lisp objects given a pointer value. We do this by keeping
3828 track of blocks of Lisp data that are allocated in a red-black tree
3829 (see also the comment of mem_node which is the type of nodes in
3830 that tree). Function lisp_malloc adds information for an allocated
3831 block to the red-black tree with calls to mem_insert, and function
3832 lisp_free removes it with mem_delete. Functions live_string_p etc
3833 call mem_find to lookup information about a given pointer in the
3834 tree, and use that to determine if the pointer points to a Lisp
3837 /* Initialize this part of alloc.c. */
3842 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3843 mem_z
.parent
= NULL
;
3844 mem_z
.color
= MEM_BLACK
;
3845 mem_z
.start
= mem_z
.end
= NULL
;
3850 /* Value is a pointer to the mem_node containing START. Value is
3851 MEM_NIL if there is no node in the tree containing START. */
3853 static inline struct mem_node
*
3854 mem_find (void *start
)
3858 if (start
< min_heap_address
|| start
> max_heap_address
)
3861 /* Make the search always successful to speed up the loop below. */
3862 mem_z
.start
= start
;
3863 mem_z
.end
= (char *) start
+ 1;
3866 while (start
< p
->start
|| start
>= p
->end
)
3867 p
= start
< p
->start
? p
->left
: p
->right
;
3872 /* Insert a new node into the tree for a block of memory with start
3873 address START, end address END, and type TYPE. Value is a
3874 pointer to the node that was inserted. */
3876 static struct mem_node
*
3877 mem_insert (void *start
, void *end
, enum mem_type type
)
3879 struct mem_node
*c
, *parent
, *x
;
3881 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3882 min_heap_address
= start
;
3883 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3884 max_heap_address
= end
;
3886 /* See where in the tree a node for START belongs. In this
3887 particular application, it shouldn't happen that a node is already
3888 present. For debugging purposes, let's check that. */
3892 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3894 while (c
!= MEM_NIL
)
3896 if (start
>= c
->start
&& start
< c
->end
)
3899 c
= start
< c
->start
? c
->left
: c
->right
;
3902 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3904 while (c
!= MEM_NIL
)
3907 c
= start
< c
->start
? c
->left
: c
->right
;
3910 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3912 /* Create a new node. */
3913 #ifdef GC_MALLOC_CHECK
3914 x
= _malloc_internal (sizeof *x
);
3918 x
= xmalloc (sizeof *x
);
3924 x
->left
= x
->right
= MEM_NIL
;
3927 /* Insert it as child of PARENT or install it as root. */
3930 if (start
< parent
->start
)
3938 /* Re-establish red-black tree properties. */
3939 mem_insert_fixup (x
);
3945 /* Re-establish the red-black properties of the tree, and thereby
3946 balance the tree, after node X has been inserted; X is always red. */
3949 mem_insert_fixup (struct mem_node
*x
)
3951 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3953 /* X is red and its parent is red. This is a violation of
3954 red-black tree property #3. */
3956 if (x
->parent
== x
->parent
->parent
->left
)
3958 /* We're on the left side of our grandparent, and Y is our
3960 struct mem_node
*y
= x
->parent
->parent
->right
;
3962 if (y
->color
== MEM_RED
)
3964 /* Uncle and parent are red but should be black because
3965 X is red. Change the colors accordingly and proceed
3966 with the grandparent. */
3967 x
->parent
->color
= MEM_BLACK
;
3968 y
->color
= MEM_BLACK
;
3969 x
->parent
->parent
->color
= MEM_RED
;
3970 x
= x
->parent
->parent
;
3974 /* Parent and uncle have different colors; parent is
3975 red, uncle is black. */
3976 if (x
== x
->parent
->right
)
3979 mem_rotate_left (x
);
3982 x
->parent
->color
= MEM_BLACK
;
3983 x
->parent
->parent
->color
= MEM_RED
;
3984 mem_rotate_right (x
->parent
->parent
);
3989 /* This is the symmetrical case of above. */
3990 struct mem_node
*y
= x
->parent
->parent
->left
;
3992 if (y
->color
== MEM_RED
)
3994 x
->parent
->color
= MEM_BLACK
;
3995 y
->color
= MEM_BLACK
;
3996 x
->parent
->parent
->color
= MEM_RED
;
3997 x
= x
->parent
->parent
;
4001 if (x
== x
->parent
->left
)
4004 mem_rotate_right (x
);
4007 x
->parent
->color
= MEM_BLACK
;
4008 x
->parent
->parent
->color
= MEM_RED
;
4009 mem_rotate_left (x
->parent
->parent
);
4014 /* The root may have been changed to red due to the algorithm. Set
4015 it to black so that property #5 is satisfied. */
4016 mem_root
->color
= MEM_BLACK
;
4027 mem_rotate_left (struct mem_node
*x
)
4031 /* Turn y's left sub-tree into x's right sub-tree. */
4034 if (y
->left
!= MEM_NIL
)
4035 y
->left
->parent
= x
;
4037 /* Y's parent was x's parent. */
4039 y
->parent
= x
->parent
;
4041 /* Get the parent to point to y instead of x. */
4044 if (x
== x
->parent
->left
)
4045 x
->parent
->left
= y
;
4047 x
->parent
->right
= y
;
4052 /* Put x on y's left. */
4066 mem_rotate_right (struct mem_node
*x
)
4068 struct mem_node
*y
= x
->left
;
4071 if (y
->right
!= MEM_NIL
)
4072 y
->right
->parent
= x
;
4075 y
->parent
= x
->parent
;
4078 if (x
== x
->parent
->right
)
4079 x
->parent
->right
= y
;
4081 x
->parent
->left
= y
;
4092 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4095 mem_delete (struct mem_node
*z
)
4097 struct mem_node
*x
, *y
;
4099 if (!z
|| z
== MEM_NIL
)
4102 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4107 while (y
->left
!= MEM_NIL
)
4111 if (y
->left
!= MEM_NIL
)
4116 x
->parent
= y
->parent
;
4119 if (y
== y
->parent
->left
)
4120 y
->parent
->left
= x
;
4122 y
->parent
->right
= x
;
4129 z
->start
= y
->start
;
4134 if (y
->color
== MEM_BLACK
)
4135 mem_delete_fixup (x
);
4137 #ifdef GC_MALLOC_CHECK
4145 /* Re-establish the red-black properties of the tree, after a
4149 mem_delete_fixup (struct mem_node
*x
)
4151 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4153 if (x
== x
->parent
->left
)
4155 struct mem_node
*w
= x
->parent
->right
;
4157 if (w
->color
== MEM_RED
)
4159 w
->color
= MEM_BLACK
;
4160 x
->parent
->color
= MEM_RED
;
4161 mem_rotate_left (x
->parent
);
4162 w
= x
->parent
->right
;
4165 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4172 if (w
->right
->color
== MEM_BLACK
)
4174 w
->left
->color
= MEM_BLACK
;
4176 mem_rotate_right (w
);
4177 w
= x
->parent
->right
;
4179 w
->color
= x
->parent
->color
;
4180 x
->parent
->color
= MEM_BLACK
;
4181 w
->right
->color
= MEM_BLACK
;
4182 mem_rotate_left (x
->parent
);
4188 struct mem_node
*w
= x
->parent
->left
;
4190 if (w
->color
== MEM_RED
)
4192 w
->color
= MEM_BLACK
;
4193 x
->parent
->color
= MEM_RED
;
4194 mem_rotate_right (x
->parent
);
4195 w
= x
->parent
->left
;
4198 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4205 if (w
->left
->color
== MEM_BLACK
)
4207 w
->right
->color
= MEM_BLACK
;
4209 mem_rotate_left (w
);
4210 w
= x
->parent
->left
;
4213 w
->color
= x
->parent
->color
;
4214 x
->parent
->color
= MEM_BLACK
;
4215 w
->left
->color
= MEM_BLACK
;
4216 mem_rotate_right (x
->parent
);
4222 x
->color
= MEM_BLACK
;
4226 /* Value is non-zero if P is a pointer to a live Lisp string on
4227 the heap. M is a pointer to the mem_block for P. */
4230 live_string_p (struct mem_node
*m
, void *p
)
4232 if (m
->type
== MEM_TYPE_STRING
)
4234 struct string_block
*b
= (struct string_block
*) m
->start
;
4235 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4237 /* P must point to the start of a Lisp_String structure, and it
4238 must not be on the free-list. */
4240 && offset
% sizeof b
->strings
[0] == 0
4241 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4242 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4249 /* Value is non-zero if P is a pointer to a live Lisp cons on
4250 the heap. M is a pointer to the mem_block for P. */
4253 live_cons_p (struct mem_node
*m
, void *p
)
4255 if (m
->type
== MEM_TYPE_CONS
)
4257 struct cons_block
*b
= (struct cons_block
*) m
->start
;
4258 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4260 /* P must point to the start of a Lisp_Cons, not be
4261 one of the unused cells in the current cons block,
4262 and not be on the free-list. */
4264 && offset
% sizeof b
->conses
[0] == 0
4265 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4267 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4268 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
4275 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4276 the heap. M is a pointer to the mem_block for P. */
4279 live_symbol_p (struct mem_node
*m
, void *p
)
4281 if (m
->type
== MEM_TYPE_SYMBOL
)
4283 struct symbol_block
*b
= (struct symbol_block
*) m
->start
;
4284 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4286 /* P must point to the start of a Lisp_Symbol, not be
4287 one of the unused cells in the current symbol block,
4288 and not be on the free-list. */
4290 && offset
% sizeof b
->symbols
[0] == 0
4291 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4292 && (b
!= symbol_block
4293 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4294 && !EQ (((struct Lisp_Symbol
*) p
)->function
, Vdead
));
4301 /* Value is non-zero if P is a pointer to a live Lisp float on
4302 the heap. M is a pointer to the mem_block for P. */
4305 live_float_p (struct mem_node
*m
, void *p
)
4307 if (m
->type
== MEM_TYPE_FLOAT
)
4309 struct float_block
*b
= (struct float_block
*) m
->start
;
4310 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4312 /* P must point to the start of a Lisp_Float and not be
4313 one of the unused cells in the current float block. */
4315 && offset
% sizeof b
->floats
[0] == 0
4316 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4317 && (b
!= float_block
4318 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4325 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4326 the heap. M is a pointer to the mem_block for P. */
4329 live_misc_p (struct mem_node
*m
, void *p
)
4331 if (m
->type
== MEM_TYPE_MISC
)
4333 struct marker_block
*b
= (struct marker_block
*) m
->start
;
4334 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4336 /* P must point to the start of a Lisp_Misc, not be
4337 one of the unused cells in the current misc block,
4338 and not be on the free-list. */
4340 && offset
% sizeof b
->markers
[0] == 0
4341 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4342 && (b
!= marker_block
4343 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4344 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4351 /* Value is non-zero if P is a pointer to a live vector-like object.
4352 M is a pointer to the mem_block for P. */
4355 live_vector_p (struct mem_node
*m
, void *p
)
4357 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4359 /* This memory node corresponds to a vector block. */
4360 struct vector_block
*block
= (struct vector_block
*) m
->start
;
4361 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4363 /* P is in the block's allocation range. Scan the block
4364 up to P and see whether P points to the start of some
4365 vector which is not on a free list. FIXME: check whether
4366 some allocation patterns (probably a lot of short vectors)
4367 may cause a substantial overhead of this loop. */
4368 while (VECTOR_IN_BLOCK (vector
, block
)
4369 && vector
<= (struct Lisp_Vector
*) p
)
4371 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
))
4372 vector
= ADVANCE (vector
, (vector
->header
.size
4373 & PSEUDOVECTOR_SIZE_MASK
));
4374 else if (vector
== p
)
4377 vector
= ADVANCE (vector
, vector
->header
.next
.nbytes
);
4380 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== m
->start
)
4381 /* This memory node corresponds to a large vector. */
4387 /* Value is non-zero if P is a pointer to a live buffer. M is a
4388 pointer to the mem_block for P. */
4391 live_buffer_p (struct mem_node
*m
, void *p
)
4393 /* P must point to the start of the block, and the buffer
4394 must not have been killed. */
4395 return (m
->type
== MEM_TYPE_BUFFER
4397 && !NILP (((struct buffer
*) p
)->BUFFER_INTERNAL_FIELD (name
)));
4400 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4404 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4406 /* Array of objects that are kept alive because the C stack contains
4407 a pattern that looks like a reference to them . */
4409 #define MAX_ZOMBIES 10
4410 static Lisp_Object zombies
[MAX_ZOMBIES
];
4412 /* Number of zombie objects. */
4414 static EMACS_INT nzombies
;
4416 /* Number of garbage collections. */
4418 static EMACS_INT ngcs
;
4420 /* Average percentage of zombies per collection. */
4422 static double avg_zombies
;
4424 /* Max. number of live and zombie objects. */
4426 static EMACS_INT max_live
, max_zombies
;
4428 /* Average number of live objects per GC. */
4430 static double avg_live
;
4432 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4433 doc
: /* Show information about live and zombie objects. */)
4436 Lisp_Object args
[8], zombie_list
= Qnil
;
4438 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); i
++)
4439 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4440 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4441 args
[1] = make_number (ngcs
);
4442 args
[2] = make_float (avg_live
);
4443 args
[3] = make_float (avg_zombies
);
4444 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4445 args
[5] = make_number (max_live
);
4446 args
[6] = make_number (max_zombies
);
4447 args
[7] = zombie_list
;
4448 return Fmessage (8, args
);
4451 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4454 /* Mark OBJ if we can prove it's a Lisp_Object. */
4457 mark_maybe_object (Lisp_Object obj
)
4465 po
= (void *) XPNTR (obj
);
4472 switch (XTYPE (obj
))
4475 mark_p
= (live_string_p (m
, po
)
4476 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4480 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4484 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4488 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4491 case Lisp_Vectorlike
:
4492 /* Note: can't check BUFFERP before we know it's a
4493 buffer because checking that dereferences the pointer
4494 PO which might point anywhere. */
4495 if (live_vector_p (m
, po
))
4496 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4497 else if (live_buffer_p (m
, po
))
4498 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4502 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4511 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4512 if (nzombies
< MAX_ZOMBIES
)
4513 zombies
[nzombies
] = obj
;
4522 /* If P points to Lisp data, mark that as live if it isn't already
4526 mark_maybe_pointer (void *p
)
4530 /* Quickly rule out some values which can't point to Lisp data.
4531 USE_LSB_TAG needs Lisp data to be aligned on multiples of 1 << GCTYPEBITS.
4532 Otherwise, assume that Lisp data is aligned on even addresses. */
4533 if ((intptr_t) p
% (USE_LSB_TAG
? 1 << GCTYPEBITS
: 2))
4539 Lisp_Object obj
= Qnil
;
4543 case MEM_TYPE_NON_LISP
:
4544 /* Nothing to do; not a pointer to Lisp memory. */
4547 case MEM_TYPE_BUFFER
:
4548 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4549 XSETVECTOR (obj
, p
);
4553 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4557 case MEM_TYPE_STRING
:
4558 if (live_string_p (m
, p
)
4559 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4560 XSETSTRING (obj
, p
);
4564 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4568 case MEM_TYPE_SYMBOL
:
4569 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4570 XSETSYMBOL (obj
, p
);
4573 case MEM_TYPE_FLOAT
:
4574 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4578 case MEM_TYPE_VECTORLIKE
:
4579 case MEM_TYPE_VECTOR_BLOCK
:
4580 if (live_vector_p (m
, p
))
4583 XSETVECTOR (tem
, p
);
4584 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4599 /* Alignment of pointer values. Use offsetof, as it sometimes returns
4600 a smaller alignment than GCC's __alignof__ and mark_memory might
4601 miss objects if __alignof__ were used. */
4602 #define GC_POINTER_ALIGNMENT offsetof (struct {char a; void *b;}, b)
4604 /* Define POINTERS_MIGHT_HIDE_IN_OBJECTS to 1 if marking via C pointers does
4605 not suffice, which is the typical case. A host where a Lisp_Object is
4606 wider than a pointer might allocate a Lisp_Object in non-adjacent halves.
4607 If USE_LSB_TAG, the bottom half is not a valid pointer, but it should
4608 suffice to widen it to to a Lisp_Object and check it that way. */
4609 #if USE_LSB_TAG || VAL_MAX < UINTPTR_MAX
4610 # if !USE_LSB_TAG && VAL_MAX < UINTPTR_MAX >> GCTYPEBITS
4611 /* If tag bits straddle pointer-word boundaries, neither mark_maybe_pointer
4612 nor mark_maybe_object can follow the pointers. This should not occur on
4613 any practical porting target. */
4614 # error "MSB type bits straddle pointer-word boundaries"
4616 /* Marking via C pointers does not suffice, because Lisp_Objects contain
4617 pointer words that hold pointers ORed with type bits. */
4618 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 1
4620 /* Marking via C pointers suffices, because Lisp_Objects contain pointer
4621 words that hold unmodified pointers. */
4622 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 0
4625 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4626 or END+OFFSET..START. */
4629 mark_memory (void *start
, void *end
)
4631 /* Do not allow -faddress-sanitizer to check this function, since it
4632 crosses the function stack boundary, and thus would yield many
4634 __attribute__((no_address_safety_analysis
))
4640 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4644 /* Make START the pointer to the start of the memory region,
4645 if it isn't already. */
4653 /* Mark Lisp data pointed to. This is necessary because, in some
4654 situations, the C compiler optimizes Lisp objects away, so that
4655 only a pointer to them remains. Example:
4657 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4660 Lisp_Object obj = build_string ("test");
4661 struct Lisp_String *s = XSTRING (obj);
4662 Fgarbage_collect ();
4663 fprintf (stderr, "test `%s'\n", s->data);
4667 Here, `obj' isn't really used, and the compiler optimizes it
4668 away. The only reference to the life string is through the
4671 for (pp
= start
; (void *) pp
< end
; pp
++)
4672 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4674 void *p
= *(void **) ((char *) pp
+ i
);
4675 mark_maybe_pointer (p
);
4676 if (POINTERS_MIGHT_HIDE_IN_OBJECTS
)
4677 mark_maybe_object (XIL ((intptr_t) p
));
4681 /* setjmp will work with GCC unless NON_SAVING_SETJMP is defined in
4682 the GCC system configuration. In gcc 3.2, the only systems for
4683 which this is so are i386-sco5 non-ELF, i386-sysv3 (maybe included
4684 by others?) and ns32k-pc532-min. */
4686 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4688 static int setjmp_tested_p
, longjmps_done
;
4690 #define SETJMP_WILL_LIKELY_WORK "\
4692 Emacs garbage collector has been changed to use conservative stack\n\
4693 marking. Emacs has determined that the method it uses to do the\n\
4694 marking will likely work on your system, but this isn't sure.\n\
4696 If you are a system-programmer, or can get the help of a local wizard\n\
4697 who is, please take a look at the function mark_stack in alloc.c, and\n\
4698 verify that the methods used are appropriate for your system.\n\
4700 Please mail the result to <emacs-devel@gnu.org>.\n\
4703 #define SETJMP_WILL_NOT_WORK "\
4705 Emacs garbage collector has been changed to use conservative stack\n\
4706 marking. Emacs has determined that the default method it uses to do the\n\
4707 marking will not work on your system. We will need a system-dependent\n\
4708 solution for your system.\n\
4710 Please take a look at the function mark_stack in alloc.c, and\n\
4711 try to find a way to make it work on your system.\n\
4713 Note that you may get false negatives, depending on the compiler.\n\
4714 In particular, you need to use -O with GCC for this test.\n\
4716 Please mail the result to <emacs-devel@gnu.org>.\n\
4720 /* Perform a quick check if it looks like setjmp saves registers in a
4721 jmp_buf. Print a message to stderr saying so. When this test
4722 succeeds, this is _not_ a proof that setjmp is sufficient for
4723 conservative stack marking. Only the sources or a disassembly
4734 /* Arrange for X to be put in a register. */
4740 if (longjmps_done
== 1)
4742 /* Came here after the longjmp at the end of the function.
4744 If x == 1, the longjmp has restored the register to its
4745 value before the setjmp, and we can hope that setjmp
4746 saves all such registers in the jmp_buf, although that
4749 For other values of X, either something really strange is
4750 taking place, or the setjmp just didn't save the register. */
4753 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4756 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4763 if (longjmps_done
== 1)
4767 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4770 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4772 /* Abort if anything GCPRO'd doesn't survive the GC. */
4780 for (p
= gcprolist
; p
; p
= p
->next
)
4781 for (i
= 0; i
< p
->nvars
; ++i
)
4782 if (!survives_gc_p (p
->var
[i
]))
4783 /* FIXME: It's not necessarily a bug. It might just be that the
4784 GCPRO is unnecessary or should release the object sooner. */
4788 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4795 fprintf (stderr
, "\nZombies kept alive = %"pI
"d:\n", nzombies
);
4796 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4798 fprintf (stderr
, " %d = ", i
);
4799 debug_print (zombies
[i
]);
4803 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4806 /* Mark live Lisp objects on the C stack.
4808 There are several system-dependent problems to consider when
4809 porting this to new architectures:
4813 We have to mark Lisp objects in CPU registers that can hold local
4814 variables or are used to pass parameters.
4816 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4817 something that either saves relevant registers on the stack, or
4818 calls mark_maybe_object passing it each register's contents.
4820 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4821 implementation assumes that calling setjmp saves registers we need
4822 to see in a jmp_buf which itself lies on the stack. This doesn't
4823 have to be true! It must be verified for each system, possibly
4824 by taking a look at the source code of setjmp.
4826 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4827 can use it as a machine independent method to store all registers
4828 to the stack. In this case the macros described in the previous
4829 two paragraphs are not used.
4833 Architectures differ in the way their processor stack is organized.
4834 For example, the stack might look like this
4837 | Lisp_Object | size = 4
4839 | something else | size = 2
4841 | Lisp_Object | size = 4
4845 In such a case, not every Lisp_Object will be aligned equally. To
4846 find all Lisp_Object on the stack it won't be sufficient to walk
4847 the stack in steps of 4 bytes. Instead, two passes will be
4848 necessary, one starting at the start of the stack, and a second
4849 pass starting at the start of the stack + 2. Likewise, if the
4850 minimal alignment of Lisp_Objects on the stack is 1, four passes
4851 would be necessary, each one starting with one byte more offset
4852 from the stack start. */
4859 #ifdef HAVE___BUILTIN_UNWIND_INIT
4860 /* Force callee-saved registers and register windows onto the stack.
4861 This is the preferred method if available, obviating the need for
4862 machine dependent methods. */
4863 __builtin_unwind_init ();
4865 #else /* not HAVE___BUILTIN_UNWIND_INIT */
4866 #ifndef GC_SAVE_REGISTERS_ON_STACK
4867 /* jmp_buf may not be aligned enough on darwin-ppc64 */
4868 union aligned_jmpbuf
{
4872 volatile int stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4874 /* This trick flushes the register windows so that all the state of
4875 the process is contained in the stack. */
4876 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4877 needed on ia64 too. See mach_dep.c, where it also says inline
4878 assembler doesn't work with relevant proprietary compilers. */
4880 #if defined (__sparc64__) && defined (__FreeBSD__)
4881 /* FreeBSD does not have a ta 3 handler. */
4888 /* Save registers that we need to see on the stack. We need to see
4889 registers used to hold register variables and registers used to
4891 #ifdef GC_SAVE_REGISTERS_ON_STACK
4892 GC_SAVE_REGISTERS_ON_STACK (end
);
4893 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4895 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4896 setjmp will definitely work, test it
4897 and print a message with the result
4899 if (!setjmp_tested_p
)
4901 setjmp_tested_p
= 1;
4904 #endif /* GC_SETJMP_WORKS */
4907 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4908 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4909 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
4911 /* This assumes that the stack is a contiguous region in memory. If
4912 that's not the case, something has to be done here to iterate
4913 over the stack segments. */
4914 mark_memory (stack_base
, end
);
4916 /* Allow for marking a secondary stack, like the register stack on the
4918 #ifdef GC_MARK_SECONDARY_STACK
4919 GC_MARK_SECONDARY_STACK ();
4922 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4927 #endif /* GC_MARK_STACK != 0 */
4930 /* Determine whether it is safe to access memory at address P. */
4932 valid_pointer_p (void *p
)
4935 return w32_valid_pointer_p (p
, 16);
4939 /* Obviously, we cannot just access it (we would SEGV trying), so we
4940 trick the o/s to tell us whether p is a valid pointer.
4941 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4942 not validate p in that case. */
4946 int valid
= (emacs_write (fd
[1], (char *) p
, 16) == 16);
4947 emacs_close (fd
[1]);
4948 emacs_close (fd
[0]);
4956 /* Return 1 if OBJ is a valid lisp object.
4957 Return 0 if OBJ is NOT a valid lisp object.
4958 Return -1 if we cannot validate OBJ.
4959 This function can be quite slow,
4960 so it should only be used in code for manual debugging. */
4963 valid_lisp_object_p (Lisp_Object obj
)
4973 p
= (void *) XPNTR (obj
);
4974 if (PURE_POINTER_P (p
))
4978 return valid_pointer_p (p
);
4985 int valid
= valid_pointer_p (p
);
4997 case MEM_TYPE_NON_LISP
:
5000 case MEM_TYPE_BUFFER
:
5001 return live_buffer_p (m
, p
);
5004 return live_cons_p (m
, p
);
5006 case MEM_TYPE_STRING
:
5007 return live_string_p (m
, p
);
5010 return live_misc_p (m
, p
);
5012 case MEM_TYPE_SYMBOL
:
5013 return live_symbol_p (m
, p
);
5015 case MEM_TYPE_FLOAT
:
5016 return live_float_p (m
, p
);
5018 case MEM_TYPE_VECTORLIKE
:
5019 case MEM_TYPE_VECTOR_BLOCK
:
5020 return live_vector_p (m
, p
);
5033 /***********************************************************************
5034 Pure Storage Management
5035 ***********************************************************************/
5037 /* Allocate room for SIZE bytes from pure Lisp storage and return a
5038 pointer to it. TYPE is the Lisp type for which the memory is
5039 allocated. TYPE < 0 means it's not used for a Lisp object. */
5042 pure_alloc (size_t size
, int type
)
5046 size_t alignment
= (1 << GCTYPEBITS
);
5048 size_t alignment
= sizeof (EMACS_INT
);
5050 /* Give Lisp_Floats an extra alignment. */
5051 if (type
== Lisp_Float
)
5053 #if defined __GNUC__ && __GNUC__ >= 2
5054 alignment
= __alignof (struct Lisp_Float
);
5056 alignment
= sizeof (struct Lisp_Float
);
5064 /* Allocate space for a Lisp object from the beginning of the free
5065 space with taking account of alignment. */
5066 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
5067 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
5071 /* Allocate space for a non-Lisp object from the end of the free
5073 pure_bytes_used_non_lisp
+= size
;
5074 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5076 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
5078 if (pure_bytes_used
<= pure_size
)
5081 /* Don't allocate a large amount here,
5082 because it might get mmap'd and then its address
5083 might not be usable. */
5084 purebeg
= xmalloc (10000);
5086 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
5087 pure_bytes_used
= 0;
5088 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
5093 /* Print a warning if PURESIZE is too small. */
5096 check_pure_size (void)
5098 if (pure_bytes_used_before_overflow
)
5099 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
5101 pure_bytes_used
+ pure_bytes_used_before_overflow
);
5105 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
5106 the non-Lisp data pool of the pure storage, and return its start
5107 address. Return NULL if not found. */
5110 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5113 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5114 const unsigned char *p
;
5117 if (pure_bytes_used_non_lisp
<= nbytes
)
5120 /* Set up the Boyer-Moore table. */
5122 for (i
= 0; i
< 256; i
++)
5125 p
= (const unsigned char *) data
;
5127 bm_skip
[*p
++] = skip
;
5129 last_char_skip
= bm_skip
['\0'];
5131 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5132 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5134 /* See the comments in the function `boyer_moore' (search.c) for the
5135 use of `infinity'. */
5136 infinity
= pure_bytes_used_non_lisp
+ 1;
5137 bm_skip
['\0'] = infinity
;
5139 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5143 /* Check the last character (== '\0'). */
5146 start
+= bm_skip
[*(p
+ start
)];
5148 while (start
<= start_max
);
5150 if (start
< infinity
)
5151 /* Couldn't find the last character. */
5154 /* No less than `infinity' means we could find the last
5155 character at `p[start - infinity]'. */
5158 /* Check the remaining characters. */
5159 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5161 return non_lisp_beg
+ start
;
5163 start
+= last_char_skip
;
5165 while (start
<= start_max
);
5171 /* Return a string allocated in pure space. DATA is a buffer holding
5172 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5173 non-zero means make the result string multibyte.
5175 Must get an error if pure storage is full, since if it cannot hold
5176 a large string it may be able to hold conses that point to that
5177 string; then the string is not protected from gc. */
5180 make_pure_string (const char *data
,
5181 ptrdiff_t nchars
, ptrdiff_t nbytes
, int multibyte
)
5184 struct Lisp_String
*s
;
5186 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
5187 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5188 if (s
->data
== NULL
)
5190 s
->data
= (unsigned char *) pure_alloc (nbytes
+ 1, -1);
5191 memcpy (s
->data
, data
, nbytes
);
5192 s
->data
[nbytes
] = '\0';
5195 s
->size_byte
= multibyte
? nbytes
: -1;
5196 s
->intervals
= NULL_INTERVAL
;
5197 XSETSTRING (string
, s
);
5201 /* Return a string a string allocated in pure space. Do not allocate
5202 the string data, just point to DATA. */
5205 make_pure_c_string (const char *data
)
5208 struct Lisp_String
*s
;
5209 ptrdiff_t nchars
= strlen (data
);
5211 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
5214 s
->data
= (unsigned char *) data
;
5215 s
->intervals
= NULL_INTERVAL
;
5216 XSETSTRING (string
, s
);
5220 /* Return a cons allocated from pure space. Give it pure copies
5221 of CAR as car and CDR as cdr. */
5224 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5226 register Lisp_Object
new;
5227 struct Lisp_Cons
*p
;
5229 p
= (struct Lisp_Cons
*) pure_alloc (sizeof *p
, Lisp_Cons
);
5231 XSETCAR (new, Fpurecopy (car
));
5232 XSETCDR (new, Fpurecopy (cdr
));
5237 /* Value is a float object with value NUM allocated from pure space. */
5240 make_pure_float (double num
)
5242 register Lisp_Object
new;
5243 struct Lisp_Float
*p
;
5245 p
= (struct Lisp_Float
*) pure_alloc (sizeof *p
, Lisp_Float
);
5247 XFLOAT_INIT (new, num
);
5252 /* Return a vector with room for LEN Lisp_Objects allocated from
5256 make_pure_vector (ptrdiff_t len
)
5259 struct Lisp_Vector
*p
;
5260 size_t size
= (offsetof (struct Lisp_Vector
, contents
)
5261 + len
* sizeof (Lisp_Object
));
5263 p
= (struct Lisp_Vector
*) pure_alloc (size
, Lisp_Vectorlike
);
5264 XSETVECTOR (new, p
);
5265 XVECTOR (new)->header
.size
= len
;
5270 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5271 doc
: /* Make a copy of object OBJ in pure storage.
5272 Recursively copies contents of vectors and cons cells.
5273 Does not copy symbols. Copies strings without text properties. */)
5274 (register Lisp_Object obj
)
5276 if (NILP (Vpurify_flag
))
5279 if (PURE_POINTER_P (XPNTR (obj
)))
5282 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5284 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5290 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5291 else if (FLOATP (obj
))
5292 obj
= make_pure_float (XFLOAT_DATA (obj
));
5293 else if (STRINGP (obj
))
5294 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5296 STRING_MULTIBYTE (obj
));
5297 else if (COMPILEDP (obj
) || VECTORP (obj
))
5299 register struct Lisp_Vector
*vec
;
5300 register ptrdiff_t i
;
5304 if (size
& PSEUDOVECTOR_FLAG
)
5305 size
&= PSEUDOVECTOR_SIZE_MASK
;
5306 vec
= XVECTOR (make_pure_vector (size
));
5307 for (i
= 0; i
< size
; i
++)
5308 vec
->contents
[i
] = Fpurecopy (AREF (obj
, i
));
5309 if (COMPILEDP (obj
))
5311 XSETPVECTYPE (vec
, PVEC_COMPILED
);
5312 XSETCOMPILED (obj
, vec
);
5315 XSETVECTOR (obj
, vec
);
5317 else if (MARKERP (obj
))
5318 error ("Attempt to copy a marker to pure storage");
5320 /* Not purified, don't hash-cons. */
5323 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5324 Fputhash (obj
, obj
, Vpurify_flag
);
5331 /***********************************************************************
5333 ***********************************************************************/
5335 /* Put an entry in staticvec, pointing at the variable with address
5339 staticpro (Lisp_Object
*varaddress
)
5341 staticvec
[staticidx
++] = varaddress
;
5342 if (staticidx
>= NSTATICS
)
5347 /***********************************************************************
5349 ***********************************************************************/
5351 /* Temporarily prevent garbage collection. */
5354 inhibit_garbage_collection (void)
5356 ptrdiff_t count
= SPECPDL_INDEX ();
5358 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5363 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5364 doc
: /* Reclaim storage for Lisp objects no longer needed.
5365 Garbage collection happens automatically if you cons more than
5366 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5367 `garbage-collect' normally returns a list with info on amount of space in use:
5368 ((USED-CONSES . FREE-CONSES) (USED-SYMS . FREE-SYMS)
5369 (USED-MISCS . FREE-MISCS) USED-STRING-CHARS USED-VECTOR-SLOTS
5370 (USED-FLOATS . FREE-FLOATS) (USED-INTERVALS . FREE-INTERVALS)
5371 (USED-STRINGS . FREE-STRINGS))
5372 However, if there was overflow in pure space, `garbage-collect'
5373 returns nil, because real GC can't be done.
5374 See Info node `(elisp)Garbage Collection'. */)
5377 register struct specbinding
*bind
;
5378 char stack_top_variable
;
5381 Lisp_Object total
[8];
5382 ptrdiff_t count
= SPECPDL_INDEX ();
5383 EMACS_TIME t1
, t2
, t3
;
5388 /* Can't GC if pure storage overflowed because we can't determine
5389 if something is a pure object or not. */
5390 if (pure_bytes_used_before_overflow
)
5395 /* Don't keep undo information around forever.
5396 Do this early on, so it is no problem if the user quits. */
5398 register struct buffer
*nextb
= all_buffers
;
5402 /* If a buffer's undo list is Qt, that means that undo is
5403 turned off in that buffer. Calling truncate_undo_list on
5404 Qt tends to return NULL, which effectively turns undo back on.
5405 So don't call truncate_undo_list if undo_list is Qt. */
5406 if (! NILP (nextb
->BUFFER_INTERNAL_FIELD (name
))
5407 && ! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
5408 truncate_undo_list (nextb
);
5410 /* Shrink buffer gaps, but skip indirect and dead buffers. */
5411 if (nextb
->base_buffer
== 0 && !NILP (nextb
->BUFFER_INTERNAL_FIELD (name
))
5412 && ! nextb
->text
->inhibit_shrinking
)
5414 /* If a buffer's gap size is more than 10% of the buffer
5415 size, or larger than 2000 bytes, then shrink it
5416 accordingly. Keep a minimum size of 20 bytes. */
5417 int size
= min (2000, max (20, (nextb
->text
->z_byte
/ 10)));
5419 if (nextb
->text
->gap_size
> size
)
5421 struct buffer
*save_current
= current_buffer
;
5422 current_buffer
= nextb
;
5423 make_gap (-(nextb
->text
->gap_size
- size
));
5424 current_buffer
= save_current
;
5428 nextb
= nextb
->header
.next
.buffer
;
5432 EMACS_GET_TIME (t1
);
5434 /* In case user calls debug_print during GC,
5435 don't let that cause a recursive GC. */
5436 consing_since_gc
= 0;
5438 /* Save what's currently displayed in the echo area. */
5439 message_p
= push_message ();
5440 record_unwind_protect (pop_message_unwind
, Qnil
);
5442 /* Save a copy of the contents of the stack, for debugging. */
5443 #if MAX_SAVE_STACK > 0
5444 if (NILP (Vpurify_flag
))
5447 ptrdiff_t stack_size
;
5448 if (&stack_top_variable
< stack_bottom
)
5450 stack
= &stack_top_variable
;
5451 stack_size
= stack_bottom
- &stack_top_variable
;
5455 stack
= stack_bottom
;
5456 stack_size
= &stack_top_variable
- stack_bottom
;
5458 if (stack_size
<= MAX_SAVE_STACK
)
5460 if (stack_copy_size
< stack_size
)
5462 stack_copy
= xrealloc (stack_copy
, stack_size
);
5463 stack_copy_size
= stack_size
;
5465 memcpy (stack_copy
, stack
, stack_size
);
5468 #endif /* MAX_SAVE_STACK > 0 */
5470 if (garbage_collection_messages
)
5471 message1_nolog ("Garbage collecting...");
5475 shrink_regexp_cache ();
5479 /* clear_marks (); */
5481 /* Mark all the special slots that serve as the roots of accessibility. */
5483 for (i
= 0; i
< staticidx
; i
++)
5484 mark_object (*staticvec
[i
]);
5486 for (bind
= specpdl
; bind
!= specpdl_ptr
; bind
++)
5488 mark_object (bind
->symbol
);
5489 mark_object (bind
->old_value
);
5497 extern void xg_mark_data (void);
5502 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5503 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5507 register struct gcpro
*tail
;
5508 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5509 for (i
= 0; i
< tail
->nvars
; i
++)
5510 mark_object (tail
->var
[i
]);
5514 struct catchtag
*catch;
5515 struct handler
*handler
;
5517 for (catch = catchlist
; catch; catch = catch->next
)
5519 mark_object (catch->tag
);
5520 mark_object (catch->val
);
5522 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5524 mark_object (handler
->handler
);
5525 mark_object (handler
->var
);
5531 #ifdef HAVE_WINDOW_SYSTEM
5532 mark_fringe_data ();
5535 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5539 /* Everything is now marked, except for the things that require special
5540 finalization, i.e. the undo_list.
5541 Look thru every buffer's undo list
5542 for elements that update markers that were not marked,
5545 register struct buffer
*nextb
= all_buffers
;
5549 /* If a buffer's undo list is Qt, that means that undo is
5550 turned off in that buffer. Calling truncate_undo_list on
5551 Qt tends to return NULL, which effectively turns undo back on.
5552 So don't call truncate_undo_list if undo_list is Qt. */
5553 if (! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
5555 Lisp_Object tail
, prev
;
5556 tail
= nextb
->BUFFER_INTERNAL_FIELD (undo_list
);
5558 while (CONSP (tail
))
5560 if (CONSP (XCAR (tail
))
5561 && MARKERP (XCAR (XCAR (tail
)))
5562 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5565 nextb
->BUFFER_INTERNAL_FIELD (undo_list
) = tail
= XCDR (tail
);
5569 XSETCDR (prev
, tail
);
5579 /* Now that we have stripped the elements that need not be in the
5580 undo_list any more, we can finally mark the list. */
5581 mark_object (nextb
->BUFFER_INTERNAL_FIELD (undo_list
));
5583 nextb
= nextb
->header
.next
.buffer
;
5589 /* Clear the mark bits that we set in certain root slots. */
5591 unmark_byte_stack ();
5592 VECTOR_UNMARK (&buffer_defaults
);
5593 VECTOR_UNMARK (&buffer_local_symbols
);
5595 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5603 /* clear_marks (); */
5606 consing_since_gc
= 0;
5607 if (gc_cons_threshold
< 10000)
5608 gc_cons_threshold
= 10000;
5610 gc_relative_threshold
= 0;
5611 if (FLOATP (Vgc_cons_percentage
))
5612 { /* Set gc_cons_combined_threshold. */
5615 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5616 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5617 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5618 tot
+= total_string_size
;
5619 tot
+= total_vector_size
* sizeof (Lisp_Object
);
5620 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5621 tot
+= total_intervals
* sizeof (struct interval
);
5622 tot
+= total_strings
* sizeof (struct Lisp_String
);
5624 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5627 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5628 gc_relative_threshold
= tot
;
5630 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5634 if (garbage_collection_messages
)
5636 if (message_p
|| minibuf_level
> 0)
5639 message1_nolog ("Garbage collecting...done");
5642 unbind_to (count
, Qnil
);
5644 total
[0] = Fcons (make_number (total_conses
),
5645 make_number (total_free_conses
));
5646 total
[1] = Fcons (make_number (total_symbols
),
5647 make_number (total_free_symbols
));
5648 total
[2] = Fcons (make_number (total_markers
),
5649 make_number (total_free_markers
));
5650 total
[3] = make_number (total_string_size
);
5651 total
[4] = make_number (total_vector_size
);
5652 total
[5] = Fcons (make_number (total_floats
),
5653 make_number (total_free_floats
));
5654 total
[6] = Fcons (make_number (total_intervals
),
5655 make_number (total_free_intervals
));
5656 total
[7] = Fcons (make_number (total_strings
),
5657 make_number (total_free_strings
));
5659 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5661 /* Compute average percentage of zombies. */
5664 for (i
= 0; i
< 7; ++i
)
5665 if (CONSP (total
[i
]))
5666 nlive
+= XFASTINT (XCAR (total
[i
]));
5668 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5669 max_live
= max (nlive
, max_live
);
5670 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5671 max_zombies
= max (nzombies
, max_zombies
);
5676 if (!NILP (Vpost_gc_hook
))
5678 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5679 safe_run_hooks (Qpost_gc_hook
);
5680 unbind_to (gc_count
, Qnil
);
5683 /* Accumulate statistics. */
5684 if (FLOATP (Vgc_elapsed
))
5686 EMACS_GET_TIME (t2
);
5687 EMACS_SUB_TIME (t3
, t2
, t1
);
5688 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5689 + EMACS_TIME_TO_DOUBLE (t3
));
5694 return Flist (sizeof total
/ sizeof *total
, total
);
5698 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5699 only interesting objects referenced from glyphs are strings. */
5702 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5704 struct glyph_row
*row
= matrix
->rows
;
5705 struct glyph_row
*end
= row
+ matrix
->nrows
;
5707 for (; row
< end
; ++row
)
5711 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5713 struct glyph
*glyph
= row
->glyphs
[area
];
5714 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5716 for (; glyph
< end_glyph
; ++glyph
)
5717 if (STRINGP (glyph
->object
)
5718 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5719 mark_object (glyph
->object
);
5725 /* Mark Lisp faces in the face cache C. */
5728 mark_face_cache (struct face_cache
*c
)
5733 for (i
= 0; i
< c
->used
; ++i
)
5735 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5739 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5740 mark_object (face
->lface
[j
]);
5748 /* Mark reference to a Lisp_Object.
5749 If the object referred to has not been seen yet, recursively mark
5750 all the references contained in it. */
5752 #define LAST_MARKED_SIZE 500
5753 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5754 static int last_marked_index
;
5756 /* For debugging--call abort when we cdr down this many
5757 links of a list, in mark_object. In debugging,
5758 the call to abort will hit a breakpoint.
5759 Normally this is zero and the check never goes off. */
5760 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5763 mark_vectorlike (struct Lisp_Vector
*ptr
)
5765 ptrdiff_t size
= ptr
->header
.size
;
5768 eassert (!VECTOR_MARKED_P (ptr
));
5769 VECTOR_MARK (ptr
); /* Else mark it. */
5770 if (size
& PSEUDOVECTOR_FLAG
)
5771 size
&= PSEUDOVECTOR_SIZE_MASK
;
5773 /* Note that this size is not the memory-footprint size, but only
5774 the number of Lisp_Object fields that we should trace.
5775 The distinction is used e.g. by Lisp_Process which places extra
5776 non-Lisp_Object fields at the end of the structure... */
5777 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
5778 mark_object (ptr
->contents
[i
]);
5781 /* Like mark_vectorlike but optimized for char-tables (and
5782 sub-char-tables) assuming that the contents are mostly integers or
5786 mark_char_table (struct Lisp_Vector
*ptr
)
5788 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5791 eassert (!VECTOR_MARKED_P (ptr
));
5793 for (i
= 0; i
< size
; i
++)
5795 Lisp_Object val
= ptr
->contents
[i
];
5797 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5799 if (SUB_CHAR_TABLE_P (val
))
5801 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5802 mark_char_table (XVECTOR (val
));
5809 /* Mark the chain of overlays starting at PTR. */
5812 mark_overlay (struct Lisp_Overlay
*ptr
)
5814 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
5817 mark_object (ptr
->start
);
5818 mark_object (ptr
->end
);
5819 mark_object (ptr
->plist
);
5823 /* Mark Lisp_Objects and special pointers in BUFFER. */
5826 mark_buffer (struct buffer
*buffer
)
5828 /* This is handled much like other pseudovectors... */
5829 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
5831 /* ...but there are some buffer-specific things. */
5833 MARK_INTERVAL_TREE (BUF_INTERVALS (buffer
));
5835 /* For now, we just don't mark the undo_list. It's done later in
5836 a special way just before the sweep phase, and after stripping
5837 some of its elements that are not needed any more. */
5839 mark_overlay (buffer
->overlays_before
);
5840 mark_overlay (buffer
->overlays_after
);
5842 /* If this is an indirect buffer, mark its base buffer. */
5843 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5844 mark_buffer (buffer
->base_buffer
);
5847 /* Determine type of generic Lisp_Object and mark it accordingly. */
5850 mark_object (Lisp_Object arg
)
5852 register Lisp_Object obj
= arg
;
5853 #ifdef GC_CHECK_MARKED_OBJECTS
5857 ptrdiff_t cdr_count
= 0;
5861 if (PURE_POINTER_P (XPNTR (obj
)))
5864 last_marked
[last_marked_index
++] = obj
;
5865 if (last_marked_index
== LAST_MARKED_SIZE
)
5866 last_marked_index
= 0;
5868 /* Perform some sanity checks on the objects marked here. Abort if
5869 we encounter an object we know is bogus. This increases GC time
5870 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5871 #ifdef GC_CHECK_MARKED_OBJECTS
5873 po
= (void *) XPNTR (obj
);
5875 /* Check that the object pointed to by PO is known to be a Lisp
5876 structure allocated from the heap. */
5877 #define CHECK_ALLOCATED() \
5879 m = mem_find (po); \
5884 /* Check that the object pointed to by PO is live, using predicate
5886 #define CHECK_LIVE(LIVEP) \
5888 if (!LIVEP (m, po)) \
5892 /* Check both of the above conditions. */
5893 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5895 CHECK_ALLOCATED (); \
5896 CHECK_LIVE (LIVEP); \
5899 #else /* not GC_CHECK_MARKED_OBJECTS */
5901 #define CHECK_LIVE(LIVEP) (void) 0
5902 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5904 #endif /* not GC_CHECK_MARKED_OBJECTS */
5906 switch (SWITCH_ENUM_CAST (XTYPE (obj
)))
5910 register struct Lisp_String
*ptr
= XSTRING (obj
);
5911 if (STRING_MARKED_P (ptr
))
5913 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
5915 MARK_INTERVAL_TREE (ptr
->intervals
);
5916 #ifdef GC_CHECK_STRING_BYTES
5917 /* Check that the string size recorded in the string is the
5918 same as the one recorded in the sdata structure. */
5919 CHECK_STRING_BYTES (ptr
);
5920 #endif /* GC_CHECK_STRING_BYTES */
5924 case Lisp_Vectorlike
:
5926 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5927 register ptrdiff_t pvectype
;
5929 if (VECTOR_MARKED_P (ptr
))
5932 #ifdef GC_CHECK_MARKED_OBJECTS
5934 if (m
== MEM_NIL
&& !SUBRP (obj
)
5935 && po
!= &buffer_defaults
5936 && po
!= &buffer_local_symbols
)
5938 #endif /* GC_CHECK_MARKED_OBJECTS */
5940 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
5941 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
5942 >> PSEUDOVECTOR_SIZE_BITS
);
5946 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
5947 CHECK_LIVE (live_vector_p
);
5952 #ifdef GC_CHECK_MARKED_OBJECTS
5953 if (po
!= &buffer_defaults
&& po
!= &buffer_local_symbols
)
5955 struct buffer
*b
= all_buffers
;
5956 for (; b
&& b
!= po
; b
= b
->header
.next
.buffer
)
5961 #endif /* GC_CHECK_MARKED_OBJECTS */
5962 mark_buffer ((struct buffer
*) ptr
);
5966 { /* We could treat this just like a vector, but it is better
5967 to save the COMPILED_CONSTANTS element for last and avoid
5969 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5973 for (i
= 0; i
< size
; i
++)
5974 if (i
!= COMPILED_CONSTANTS
)
5975 mark_object (ptr
->contents
[i
]);
5976 if (size
> COMPILED_CONSTANTS
)
5978 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
5986 mark_vectorlike (ptr
);
5987 mark_face_cache (((struct frame
*) ptr
)->face_cache
);
5993 struct window
*w
= (struct window
*) ptr
;
5995 mark_vectorlike (ptr
);
5996 /* Mark glyphs for leaf windows. Marking window
5997 matrices is sufficient because frame matrices
5998 use the same glyph memory. */
5999 if (NILP (w
->hchild
) && NILP (w
->vchild
) && w
->current_matrix
)
6001 mark_glyph_matrix (w
->current_matrix
);
6002 mark_glyph_matrix (w
->desired_matrix
);
6007 case PVEC_HASH_TABLE
:
6009 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6011 mark_vectorlike (ptr
);
6012 /* If hash table is not weak, mark all keys and values.
6013 For weak tables, mark only the vector. */
6015 mark_object (h
->key_and_value
);
6017 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6021 case PVEC_CHAR_TABLE
:
6022 mark_char_table (ptr
);
6025 case PVEC_BOOL_VECTOR
:
6026 /* No Lisp_Objects to mark in a bool vector. */
6037 mark_vectorlike (ptr
);
6044 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6045 struct Lisp_Symbol
*ptrx
;
6049 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
6051 mark_object (ptr
->function
);
6052 mark_object (ptr
->plist
);
6053 switch (ptr
->redirect
)
6055 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6056 case SYMBOL_VARALIAS
:
6059 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6063 case SYMBOL_LOCALIZED
:
6065 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
6066 /* If the value is forwarded to a buffer or keyboard field,
6067 these are marked when we see the corresponding object.
6068 And if it's forwarded to a C variable, either it's not
6069 a Lisp_Object var, or it's staticpro'd already. */
6070 mark_object (blv
->where
);
6071 mark_object (blv
->valcell
);
6072 mark_object (blv
->defcell
);
6075 case SYMBOL_FORWARDED
:
6076 /* If the value is forwarded to a buffer or keyboard field,
6077 these are marked when we see the corresponding object.
6078 And if it's forwarded to a C variable, either it's not
6079 a Lisp_Object var, or it's staticpro'd already. */
6083 if (!PURE_POINTER_P (XSTRING (ptr
->xname
)))
6084 MARK_STRING (XSTRING (ptr
->xname
));
6085 MARK_INTERVAL_TREE (STRING_INTERVALS (ptr
->xname
));
6090 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun. */
6091 XSETSYMBOL (obj
, ptrx
);
6098 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6100 if (XMISCANY (obj
)->gcmarkbit
)
6103 switch (XMISCTYPE (obj
))
6105 case Lisp_Misc_Marker
:
6106 /* DO NOT mark thru the marker's chain.
6107 The buffer's markers chain does not preserve markers from gc;
6108 instead, markers are removed from the chain when freed by gc. */
6109 XMISCANY (obj
)->gcmarkbit
= 1;
6112 case Lisp_Misc_Save_Value
:
6113 XMISCANY (obj
)->gcmarkbit
= 1;
6116 register struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
6117 /* If DOGC is set, POINTER is the address of a memory
6118 area containing INTEGER potential Lisp_Objects. */
6121 Lisp_Object
*p
= (Lisp_Object
*) ptr
->pointer
;
6123 for (nelt
= ptr
->integer
; nelt
> 0; nelt
--, p
++)
6124 mark_maybe_object (*p
);
6130 case Lisp_Misc_Overlay
:
6131 mark_overlay (XOVERLAY (obj
));
6141 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6142 if (CONS_MARKED_P (ptr
))
6144 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6146 /* If the cdr is nil, avoid recursion for the car. */
6147 if (EQ (ptr
->u
.cdr
, Qnil
))
6153 mark_object (ptr
->car
);
6156 if (cdr_count
== mark_object_loop_halt
)
6162 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6163 FLOAT_MARK (XFLOAT (obj
));
6174 #undef CHECK_ALLOCATED
6175 #undef CHECK_ALLOCATED_AND_LIVE
6177 /* Mark the Lisp pointers in the terminal objects.
6178 Called by Fgarbage_collect. */
6181 mark_terminals (void)
6184 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6186 eassert (t
->name
!= NULL
);
6187 #ifdef HAVE_WINDOW_SYSTEM
6188 /* If a terminal object is reachable from a stacpro'ed object,
6189 it might have been marked already. Make sure the image cache
6191 mark_image_cache (t
->image_cache
);
6192 #endif /* HAVE_WINDOW_SYSTEM */
6193 if (!VECTOR_MARKED_P (t
))
6194 mark_vectorlike ((struct Lisp_Vector
*)t
);
6200 /* Value is non-zero if OBJ will survive the current GC because it's
6201 either marked or does not need to be marked to survive. */
6204 survives_gc_p (Lisp_Object obj
)
6208 switch (XTYPE (obj
))
6215 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6219 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6223 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6226 case Lisp_Vectorlike
:
6227 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6231 survives_p
= CONS_MARKED_P (XCONS (obj
));
6235 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6242 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
6247 /* Sweep: find all structures not marked, and free them. */
6252 /* Remove or mark entries in weak hash tables.
6253 This must be done before any object is unmarked. */
6254 sweep_weak_hash_tables ();
6257 #ifdef GC_CHECK_STRING_BYTES
6258 if (!noninteractive
)
6259 check_string_bytes (1);
6262 /* Put all unmarked conses on free list */
6264 register struct cons_block
*cblk
;
6265 struct cons_block
**cprev
= &cons_block
;
6266 register int lim
= cons_block_index
;
6267 EMACS_INT num_free
= 0, num_used
= 0;
6271 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6275 int ilim
= (lim
+ BITS_PER_INT
- 1) / BITS_PER_INT
;
6277 /* Scan the mark bits an int at a time. */
6278 for (i
= 0; i
< ilim
; i
++)
6280 if (cblk
->gcmarkbits
[i
] == -1)
6282 /* Fast path - all cons cells for this int are marked. */
6283 cblk
->gcmarkbits
[i
] = 0;
6284 num_used
+= BITS_PER_INT
;
6288 /* Some cons cells for this int are not marked.
6289 Find which ones, and free them. */
6290 int start
, pos
, stop
;
6292 start
= i
* BITS_PER_INT
;
6294 if (stop
> BITS_PER_INT
)
6295 stop
= BITS_PER_INT
;
6298 for (pos
= start
; pos
< stop
; pos
++)
6300 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6303 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6304 cons_free_list
= &cblk
->conses
[pos
];
6306 cons_free_list
->car
= Vdead
;
6312 CONS_UNMARK (&cblk
->conses
[pos
]);
6318 lim
= CONS_BLOCK_SIZE
;
6319 /* If this block contains only free conses and we have already
6320 seen more than two blocks worth of free conses then deallocate
6322 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6324 *cprev
= cblk
->next
;
6325 /* Unhook from the free list. */
6326 cons_free_list
= cblk
->conses
[0].u
.chain
;
6327 lisp_align_free (cblk
);
6331 num_free
+= this_free
;
6332 cprev
= &cblk
->next
;
6335 total_conses
= num_used
;
6336 total_free_conses
= num_free
;
6339 /* Put all unmarked floats on free list */
6341 register struct float_block
*fblk
;
6342 struct float_block
**fprev
= &float_block
;
6343 register int lim
= float_block_index
;
6344 EMACS_INT num_free
= 0, num_used
= 0;
6346 float_free_list
= 0;
6348 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6352 for (i
= 0; i
< lim
; i
++)
6353 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6356 fblk
->floats
[i
].u
.chain
= float_free_list
;
6357 float_free_list
= &fblk
->floats
[i
];
6362 FLOAT_UNMARK (&fblk
->floats
[i
]);
6364 lim
= FLOAT_BLOCK_SIZE
;
6365 /* If this block contains only free floats and we have already
6366 seen more than two blocks worth of free floats then deallocate
6368 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6370 *fprev
= fblk
->next
;
6371 /* Unhook from the free list. */
6372 float_free_list
= fblk
->floats
[0].u
.chain
;
6373 lisp_align_free (fblk
);
6377 num_free
+= this_free
;
6378 fprev
= &fblk
->next
;
6381 total_floats
= num_used
;
6382 total_free_floats
= num_free
;
6385 /* Put all unmarked intervals on free list */
6387 register struct interval_block
*iblk
;
6388 struct interval_block
**iprev
= &interval_block
;
6389 register int lim
= interval_block_index
;
6390 EMACS_INT num_free
= 0, num_used
= 0;
6392 interval_free_list
= 0;
6394 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6399 for (i
= 0; i
< lim
; i
++)
6401 if (!iblk
->intervals
[i
].gcmarkbit
)
6403 SET_INTERVAL_PARENT (&iblk
->intervals
[i
], interval_free_list
);
6404 interval_free_list
= &iblk
->intervals
[i
];
6410 iblk
->intervals
[i
].gcmarkbit
= 0;
6413 lim
= INTERVAL_BLOCK_SIZE
;
6414 /* If this block contains only free intervals and we have already
6415 seen more than two blocks worth of free intervals then
6416 deallocate this block. */
6417 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6419 *iprev
= iblk
->next
;
6420 /* Unhook from the free list. */
6421 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6426 num_free
+= this_free
;
6427 iprev
= &iblk
->next
;
6430 total_intervals
= num_used
;
6431 total_free_intervals
= num_free
;
6434 /* Put all unmarked symbols on free list */
6436 register struct symbol_block
*sblk
;
6437 struct symbol_block
**sprev
= &symbol_block
;
6438 register int lim
= symbol_block_index
;
6439 EMACS_INT num_free
= 0, num_used
= 0;
6441 symbol_free_list
= NULL
;
6443 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6446 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6447 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6449 for (; sym
< end
; ++sym
)
6451 /* Check if the symbol was created during loadup. In such a case
6452 it might be pointed to by pure bytecode which we don't trace,
6453 so we conservatively assume that it is live. */
6454 int pure_p
= PURE_POINTER_P (XSTRING (sym
->s
.xname
));
6456 if (!sym
->s
.gcmarkbit
&& !pure_p
)
6458 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6459 xfree (SYMBOL_BLV (&sym
->s
));
6460 sym
->s
.next
= symbol_free_list
;
6461 symbol_free_list
= &sym
->s
;
6463 symbol_free_list
->function
= Vdead
;
6471 UNMARK_STRING (XSTRING (sym
->s
.xname
));
6472 sym
->s
.gcmarkbit
= 0;
6476 lim
= SYMBOL_BLOCK_SIZE
;
6477 /* If this block contains only free symbols and we have already
6478 seen more than two blocks worth of free symbols then deallocate
6480 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6482 *sprev
= sblk
->next
;
6483 /* Unhook from the free list. */
6484 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6489 num_free
+= this_free
;
6490 sprev
= &sblk
->next
;
6493 total_symbols
= num_used
;
6494 total_free_symbols
= num_free
;
6497 /* Put all unmarked misc's on free list.
6498 For a marker, first unchain it from the buffer it points into. */
6500 register struct marker_block
*mblk
;
6501 struct marker_block
**mprev
= &marker_block
;
6502 register int lim
= marker_block_index
;
6503 EMACS_INT num_free
= 0, num_used
= 0;
6505 marker_free_list
= 0;
6507 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6512 for (i
= 0; i
< lim
; i
++)
6514 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6516 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6517 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6518 /* Set the type of the freed object to Lisp_Misc_Free.
6519 We could leave the type alone, since nobody checks it,
6520 but this might catch bugs faster. */
6521 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6522 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6523 marker_free_list
= &mblk
->markers
[i
].m
;
6529 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6532 lim
= MARKER_BLOCK_SIZE
;
6533 /* If this block contains only free markers and we have already
6534 seen more than two blocks worth of free markers then deallocate
6536 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6538 *mprev
= mblk
->next
;
6539 /* Unhook from the free list. */
6540 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6545 num_free
+= this_free
;
6546 mprev
= &mblk
->next
;
6550 total_markers
= num_used
;
6551 total_free_markers
= num_free
;
6554 /* Free all unmarked buffers */
6556 register struct buffer
*buffer
= all_buffers
, *prev
= 0, *next
;
6559 if (!VECTOR_MARKED_P (buffer
))
6562 prev
->header
.next
= buffer
->header
.next
;
6564 all_buffers
= buffer
->header
.next
.buffer
;
6565 next
= buffer
->header
.next
.buffer
;
6571 VECTOR_UNMARK (buffer
);
6572 UNMARK_BALANCE_INTERVALS (BUF_INTERVALS (buffer
));
6573 prev
= buffer
, buffer
= buffer
->header
.next
.buffer
;
6579 #ifdef GC_CHECK_STRING_BYTES
6580 if (!noninteractive
)
6581 check_string_bytes (1);
6588 /* Debugging aids. */
6590 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6591 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6592 This may be helpful in debugging Emacs's memory usage.
6593 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6598 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6603 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6604 doc
: /* Return a list of counters that measure how much consing there has been.
6605 Each of these counters increments for a certain kind of object.
6606 The counters wrap around from the largest positive integer to zero.
6607 Garbage collection does not decrease them.
6608 The elements of the value are as follows:
6609 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6610 All are in units of 1 = one object consed
6611 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6613 MISCS include overlays, markers, and some internal types.
6614 Frames, windows, buffers, and subprocesses count as vectors
6615 (but the contents of a buffer's text do not count here). */)
6618 Lisp_Object consed
[8];
6620 consed
[0] = make_number (min (MOST_POSITIVE_FIXNUM
, cons_cells_consed
));
6621 consed
[1] = make_number (min (MOST_POSITIVE_FIXNUM
, floats_consed
));
6622 consed
[2] = make_number (min (MOST_POSITIVE_FIXNUM
, vector_cells_consed
));
6623 consed
[3] = make_number (min (MOST_POSITIVE_FIXNUM
, symbols_consed
));
6624 consed
[4] = make_number (min (MOST_POSITIVE_FIXNUM
, string_chars_consed
));
6625 consed
[5] = make_number (min (MOST_POSITIVE_FIXNUM
, misc_objects_consed
));
6626 consed
[6] = make_number (min (MOST_POSITIVE_FIXNUM
, intervals_consed
));
6627 consed
[7] = make_number (min (MOST_POSITIVE_FIXNUM
, strings_consed
));
6629 return Flist (8, consed
);
6632 /* Find at most FIND_MAX symbols which have OBJ as their value or
6633 function. This is used in gdbinit's `xwhichsymbols' command. */
6636 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6638 struct symbol_block
*sblk
;
6639 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6640 Lisp_Object found
= Qnil
;
6644 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6646 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
6649 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
6651 struct Lisp_Symbol
*sym
= &aligned_sym
->s
;
6655 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6658 XSETSYMBOL (tem
, sym
);
6659 val
= find_symbol_value (tem
);
6661 || EQ (sym
->function
, obj
)
6662 || (!NILP (sym
->function
)
6663 && COMPILEDP (sym
->function
)
6664 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
6667 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)))
6669 found
= Fcons (tem
, found
);
6670 if (--find_max
== 0)
6678 unbind_to (gc_count
, Qnil
);
6682 #ifdef ENABLE_CHECKING
6683 int suppress_checking
;
6686 die (const char *msg
, const char *file
, int line
)
6688 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: %s\r\n",
6694 /* Initialization */
6697 init_alloc_once (void)
6699 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6701 pure_size
= PURESIZE
;
6702 pure_bytes_used
= 0;
6703 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
6704 pure_bytes_used_before_overflow
= 0;
6706 /* Initialize the list of free aligned blocks. */
6709 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6711 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6714 ignore_warnings
= 1;
6715 #ifdef DOUG_LEA_MALLOC
6716 mallopt (M_TRIM_THRESHOLD
, 128*1024); /* trim threshold */
6717 mallopt (M_MMAP_THRESHOLD
, 64*1024); /* mmap threshold */
6718 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* max. number of mmap'ed areas */
6727 init_weak_hash_tables ();
6730 malloc_hysteresis
= 32;
6732 malloc_hysteresis
= 0;
6735 refill_memory_reserve ();
6737 ignore_warnings
= 0;
6739 byte_stack_list
= 0;
6741 consing_since_gc
= 0;
6742 gc_cons_threshold
= 100000 * sizeof (Lisp_Object
);
6743 gc_relative_threshold
= 0;
6750 byte_stack_list
= 0;
6752 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6753 setjmp_tested_p
= longjmps_done
= 0;
6756 Vgc_elapsed
= make_float (0.0);
6761 syms_of_alloc (void)
6763 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6764 doc
: /* Number of bytes of consing between garbage collections.
6765 Garbage collection can happen automatically once this many bytes have been
6766 allocated since the last garbage collection. All data types count.
6768 Garbage collection happens automatically only when `eval' is called.
6770 By binding this temporarily to a large number, you can effectively
6771 prevent garbage collection during a part of the program.
6772 See also `gc-cons-percentage'. */);
6774 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6775 doc
: /* Portion of the heap used for allocation.
6776 Garbage collection can happen automatically once this portion of the heap
6777 has been allocated since the last garbage collection.
6778 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6779 Vgc_cons_percentage
= make_float (0.1);
6781 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6782 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
6784 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6785 doc
: /* Number of cons cells that have been consed so far. */);
6787 DEFVAR_INT ("floats-consed", floats_consed
,
6788 doc
: /* Number of floats that have been consed so far. */);
6790 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
6791 doc
: /* Number of vector cells that have been consed so far. */);
6793 DEFVAR_INT ("symbols-consed", symbols_consed
,
6794 doc
: /* Number of symbols that have been consed so far. */);
6796 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
6797 doc
: /* Number of string characters that have been consed so far. */);
6799 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
6800 doc
: /* Number of miscellaneous objects that have been consed so far.
6801 These include markers and overlays, plus certain objects not visible
6804 DEFVAR_INT ("intervals-consed", intervals_consed
,
6805 doc
: /* Number of intervals that have been consed so far. */);
6807 DEFVAR_INT ("strings-consed", strings_consed
,
6808 doc
: /* Number of strings that have been consed so far. */);
6810 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
6811 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
6812 This means that certain objects should be allocated in shared (pure) space.
6813 It can also be set to a hash-table, in which case this table is used to
6814 do hash-consing of the objects allocated to pure space. */);
6816 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
6817 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
6818 garbage_collection_messages
= 0;
6820 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
6821 doc
: /* Hook run after garbage collection has finished. */);
6822 Vpost_gc_hook
= Qnil
;
6823 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
6825 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
6826 doc
: /* Precomputed `signal' argument for memory-full error. */);
6827 /* We build this in advance because if we wait until we need it, we might
6828 not be able to allocate the memory to hold it. */
6830 = pure_cons (Qerror
,
6831 pure_cons (make_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"), Qnil
));
6833 DEFVAR_LISP ("memory-full", Vmemory_full
,
6834 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
6835 Vmemory_full
= Qnil
;
6837 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
6838 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
6840 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
6841 doc
: /* Accumulated time elapsed in garbage collections.
6842 The time is in seconds as a floating point value. */);
6843 DEFVAR_INT ("gcs-done", gcs_done
,
6844 doc
: /* Accumulated number of garbage collections done. */);
6849 defsubr (&Smake_byte_code
);
6850 defsubr (&Smake_list
);
6851 defsubr (&Smake_vector
);
6852 defsubr (&Smake_string
);
6853 defsubr (&Smake_bool_vector
);
6854 defsubr (&Smake_symbol
);
6855 defsubr (&Smake_marker
);
6856 defsubr (&Spurecopy
);
6857 defsubr (&Sgarbage_collect
);
6858 defsubr (&Smemory_limit
);
6859 defsubr (&Smemory_use_counts
);
6861 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
6862 defsubr (&Sgc_status
);