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"
45 #include "blockinput.h"
46 #include "character.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_buffer (Lisp_Object
);
274 static void mark_terminals (void);
275 static void gc_sweep (void);
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. */
309 static void *lisp_malloc (size_t, enum mem_type
);
312 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
314 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
315 #include <stdio.h> /* For fprintf. */
318 /* A unique object in pure space used to make some Lisp objects
319 on free lists recognizable in O(1). */
321 static Lisp_Object Vdead
;
322 #define DEADP(x) EQ (x, Vdead)
324 #ifdef GC_MALLOC_CHECK
326 enum mem_type allocated_mem_type
;
328 #endif /* GC_MALLOC_CHECK */
330 /* A node in the red-black tree describing allocated memory containing
331 Lisp data. Each such block is recorded with its start and end
332 address when it is allocated, and removed from the tree when it
335 A red-black tree is a balanced binary tree with the following
338 1. Every node is either red or black.
339 2. Every leaf is black.
340 3. If a node is red, then both of its children are black.
341 4. Every simple path from a node to a descendant leaf contains
342 the same number of black nodes.
343 5. The root is always black.
345 When nodes are inserted into the tree, or deleted from the tree,
346 the tree is "fixed" so that these properties are always true.
348 A red-black tree with N internal nodes has height at most 2
349 log(N+1). Searches, insertions and deletions are done in O(log N).
350 Please see a text book about data structures for a detailed
351 description of red-black trees. Any book worth its salt should
356 /* Children of this node. These pointers are never NULL. When there
357 is no child, the value is MEM_NIL, which points to a dummy node. */
358 struct mem_node
*left
, *right
;
360 /* The parent of this node. In the root node, this is NULL. */
361 struct mem_node
*parent
;
363 /* Start and end of allocated region. */
367 enum {MEM_BLACK
, MEM_RED
} color
;
373 /* Base address of stack. Set in main. */
375 Lisp_Object
*stack_base
;
377 /* Root of the tree describing allocated Lisp memory. */
379 static struct mem_node
*mem_root
;
381 /* Lowest and highest known address in the heap. */
383 static void *min_heap_address
, *max_heap_address
;
385 /* Sentinel node of the tree. */
387 static struct mem_node mem_z
;
388 #define MEM_NIL &mem_z
390 static struct Lisp_Vector
*allocate_vectorlike (ptrdiff_t);
391 static void lisp_free (void *);
392 static void mark_stack (void);
393 static int live_vector_p (struct mem_node
*, void *);
394 static int live_buffer_p (struct mem_node
*, void *);
395 static int live_string_p (struct mem_node
*, void *);
396 static int live_cons_p (struct mem_node
*, void *);
397 static int live_symbol_p (struct mem_node
*, void *);
398 static int live_float_p (struct mem_node
*, void *);
399 static int live_misc_p (struct mem_node
*, void *);
400 static void mark_maybe_object (Lisp_Object
);
401 static void mark_memory (void *, void *);
402 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
403 static void mem_init (void);
404 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
405 static void mem_insert_fixup (struct mem_node
*);
407 static void mem_rotate_left (struct mem_node
*);
408 static void mem_rotate_right (struct mem_node
*);
409 static void mem_delete (struct mem_node
*);
410 static void mem_delete_fixup (struct mem_node
*);
411 static inline struct mem_node
*mem_find (void *);
414 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
415 static void check_gcpros (void);
418 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
424 /* Recording what needs to be marked for gc. */
426 struct gcpro
*gcprolist
;
428 /* Addresses of staticpro'd variables. Initialize it to a nonzero
429 value; otherwise some compilers put it into BSS. */
431 #define NSTATICS 0x640
432 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
434 /* Index of next unused slot in staticvec. */
436 static int staticidx
= 0;
438 static void *pure_alloc (size_t, int);
441 /* Value is SZ rounded up to the next multiple of ALIGNMENT.
442 ALIGNMENT must be a power of 2. */
444 #define ALIGN(ptr, ALIGNMENT) \
445 ((void *) (((uintptr_t) (ptr) + (ALIGNMENT) - 1) \
446 & ~ ((ALIGNMENT) - 1)))
450 /************************************************************************
452 ************************************************************************/
454 /* Function malloc calls this if it finds we are near exhausting storage. */
457 malloc_warning (const char *str
)
459 pending_malloc_warning
= str
;
463 /* Display an already-pending malloc warning. */
466 display_malloc_warning (void)
468 call3 (intern ("display-warning"),
470 build_string (pending_malloc_warning
),
471 intern ("emergency"));
472 pending_malloc_warning
= 0;
475 /* Called if we can't allocate relocatable space for a buffer. */
478 buffer_memory_full (ptrdiff_t nbytes
)
480 /* If buffers use the relocating allocator, no need to free
481 spare_memory, because we may have plenty of malloc space left
482 that we could get, and if we don't, the malloc that fails will
483 itself cause spare_memory to be freed. If buffers don't use the
484 relocating allocator, treat this like any other failing
488 memory_full (nbytes
);
491 /* This used to call error, but if we've run out of memory, we could
492 get infinite recursion trying to build the string. */
493 xsignal (Qnil
, Vmemory_signal_data
);
497 #ifndef XMALLOC_OVERRUN_CHECK
498 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
501 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
504 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
505 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
506 block size in little-endian order. The trailer consists of
507 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
509 The header is used to detect whether this block has been allocated
510 through these functions, as some low-level libc functions may
511 bypass the malloc hooks. */
513 #define XMALLOC_OVERRUN_CHECK_SIZE 16
514 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
515 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
517 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
518 hold a size_t value and (2) the header size is a multiple of the
519 alignment that Emacs needs for C types and for USE_LSB_TAG. */
520 #define XMALLOC_BASE_ALIGNMENT \
523 union { long double d; intmax_t i; void *p; } u; \
528 /* A common multiple of the positive integers A and B. Ideally this
529 would be the least common multiple, but there's no way to do that
530 as a constant expression in C, so do the best that we can easily do. */
531 # define COMMON_MULTIPLE(a, b) \
532 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
533 # define XMALLOC_HEADER_ALIGNMENT \
534 COMMON_MULTIPLE (1 << GCTYPEBITS, XMALLOC_BASE_ALIGNMENT)
536 # define XMALLOC_HEADER_ALIGNMENT XMALLOC_BASE_ALIGNMENT
538 #define XMALLOC_OVERRUN_SIZE_SIZE \
539 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
540 + XMALLOC_HEADER_ALIGNMENT - 1) \
541 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
542 - XMALLOC_OVERRUN_CHECK_SIZE)
544 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
545 { '\x9a', '\x9b', '\xae', '\xaf',
546 '\xbf', '\xbe', '\xce', '\xcf',
547 '\xea', '\xeb', '\xec', '\xed',
548 '\xdf', '\xde', '\x9c', '\x9d' };
550 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
551 { '\xaa', '\xab', '\xac', '\xad',
552 '\xba', '\xbb', '\xbc', '\xbd',
553 '\xca', '\xcb', '\xcc', '\xcd',
554 '\xda', '\xdb', '\xdc', '\xdd' };
556 /* Insert and extract the block size in the header. */
559 xmalloc_put_size (unsigned char *ptr
, size_t size
)
562 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
564 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
570 xmalloc_get_size (unsigned char *ptr
)
574 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
575 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
584 /* The call depth in overrun_check functions. For example, this might happen:
586 overrun_check_malloc()
587 -> malloc -> (via hook)_-> emacs_blocked_malloc
588 -> overrun_check_malloc
589 call malloc (hooks are NULL, so real malloc is called).
590 malloc returns 10000.
591 add overhead, return 10016.
592 <- (back in overrun_check_malloc)
593 add overhead again, return 10032
594 xmalloc returns 10032.
599 overrun_check_free(10032)
601 free(10016) <- crash, because 10000 is the original pointer. */
603 static ptrdiff_t check_depth
;
605 /* Like malloc, but wraps allocated block with header and trailer. */
608 overrun_check_malloc (size_t size
)
610 register unsigned char *val
;
611 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
612 if (SIZE_MAX
- overhead
< size
)
615 val
= (unsigned char *) malloc (size
+ overhead
);
616 if (val
&& check_depth
== 1)
618 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
619 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
620 xmalloc_put_size (val
, size
);
621 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
622 XMALLOC_OVERRUN_CHECK_SIZE
);
629 /* Like realloc, but checks old block for overrun, and wraps new block
630 with header and trailer. */
633 overrun_check_realloc (void *block
, size_t size
)
635 register unsigned char *val
= (unsigned char *) block
;
636 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
637 if (SIZE_MAX
- overhead
< size
)
642 && memcmp (xmalloc_overrun_check_header
,
643 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
644 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
646 size_t osize
= xmalloc_get_size (val
);
647 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
648 XMALLOC_OVERRUN_CHECK_SIZE
))
650 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
651 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
652 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
655 val
= realloc (val
, size
+ overhead
);
657 if (val
&& check_depth
== 1)
659 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
660 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
661 xmalloc_put_size (val
, size
);
662 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
663 XMALLOC_OVERRUN_CHECK_SIZE
);
669 /* Like free, but checks block for overrun. */
672 overrun_check_free (void *block
)
674 unsigned char *val
= (unsigned char *) block
;
679 && memcmp (xmalloc_overrun_check_header
,
680 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
681 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
683 size_t osize
= xmalloc_get_size (val
);
684 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
685 XMALLOC_OVERRUN_CHECK_SIZE
))
687 #ifdef XMALLOC_CLEAR_FREE_MEMORY
688 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
689 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
691 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
692 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
693 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
704 #define malloc overrun_check_malloc
705 #define realloc overrun_check_realloc
706 #define free overrun_check_free
710 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
711 there's no need to block input around malloc. */
712 #define MALLOC_BLOCK_INPUT ((void)0)
713 #define MALLOC_UNBLOCK_INPUT ((void)0)
715 #define MALLOC_BLOCK_INPUT BLOCK_INPUT
716 #define MALLOC_UNBLOCK_INPUT UNBLOCK_INPUT
719 /* Like malloc but check for no memory and block interrupt input.. */
722 xmalloc (size_t size
)
728 MALLOC_UNBLOCK_INPUT
;
736 /* Like realloc but check for no memory and block interrupt input.. */
739 xrealloc (void *block
, size_t size
)
744 /* We must call malloc explicitly when BLOCK is 0, since some
745 reallocs don't do this. */
749 val
= realloc (block
, size
);
750 MALLOC_UNBLOCK_INPUT
;
758 /* Like free but block interrupt input. */
767 MALLOC_UNBLOCK_INPUT
;
768 /* We don't call refill_memory_reserve here
769 because that duplicates doing so in emacs_blocked_free
770 and the criterion should go there. */
774 /* Other parts of Emacs pass large int values to allocator functions
775 expecting ptrdiff_t. This is portable in practice, but check it to
777 verify (INT_MAX
<= PTRDIFF_MAX
);
780 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
781 Signal an error on memory exhaustion, and block interrupt input. */
784 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
786 xassert (0 <= nitems
&& 0 < item_size
);
787 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
788 memory_full (SIZE_MAX
);
789 return xmalloc (nitems
* item_size
);
793 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
794 Signal an error on memory exhaustion, and block interrupt input. */
797 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
799 xassert (0 <= nitems
&& 0 < item_size
);
800 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
801 memory_full (SIZE_MAX
);
802 return xrealloc (pa
, nitems
* item_size
);
806 /* Grow PA, which points to an array of *NITEMS items, and return the
807 location of the reallocated array, updating *NITEMS to reflect its
808 new size. The new array will contain at least NITEMS_INCR_MIN more
809 items, but will not contain more than NITEMS_MAX items total.
810 ITEM_SIZE is the size of each item, in bytes.
812 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
813 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
816 If PA is null, then allocate a new array instead of reallocating
817 the old one. Thus, to grow an array A without saving its old
818 contents, invoke xfree (A) immediately followed by xgrowalloc (0,
821 Block interrupt input as needed. If memory exhaustion occurs, set
822 *NITEMS to zero if PA is null, and signal an error (i.e., do not
826 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
827 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
829 /* The approximate size to use for initial small allocation
830 requests. This is the largest "small" request for the GNU C
832 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
834 /* If the array is tiny, grow it to about (but no greater than)
835 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
836 ptrdiff_t n
= *nitems
;
837 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
838 ptrdiff_t half_again
= n
>> 1;
839 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
841 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
842 NITEMS_MAX, and what the C language can represent safely. */
843 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
844 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
845 ? nitems_max
: C_language_max
);
846 ptrdiff_t nitems_incr_max
= n_max
- n
;
847 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
849 xassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
852 if (nitems_incr_max
< incr
)
853 memory_full (SIZE_MAX
);
855 pa
= xrealloc (pa
, n
* item_size
);
861 /* Like strdup, but uses xmalloc. */
864 xstrdup (const char *s
)
866 size_t len
= strlen (s
) + 1;
867 char *p
= (char *) xmalloc (len
);
873 /* Unwind for SAFE_ALLOCA */
876 safe_alloca_unwind (Lisp_Object arg
)
878 register struct Lisp_Save_Value
*p
= XSAVE_VALUE (arg
);
888 /* Like malloc but used for allocating Lisp data. NBYTES is the
889 number of bytes to allocate, TYPE describes the intended use of the
890 allocated memory block (for strings, for conses, ...). */
893 static void *lisp_malloc_loser
;
897 lisp_malloc (size_t nbytes
, enum mem_type type
)
903 #ifdef GC_MALLOC_CHECK
904 allocated_mem_type
= type
;
907 val
= (void *) malloc (nbytes
);
910 /* If the memory just allocated cannot be addressed thru a Lisp
911 object's pointer, and it needs to be,
912 that's equivalent to running out of memory. */
913 if (val
&& type
!= MEM_TYPE_NON_LISP
)
916 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
917 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
919 lisp_malloc_loser
= val
;
926 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
927 if (val
&& type
!= MEM_TYPE_NON_LISP
)
928 mem_insert (val
, (char *) val
+ nbytes
, type
);
931 MALLOC_UNBLOCK_INPUT
;
933 memory_full (nbytes
);
937 /* Free BLOCK. This must be called to free memory allocated with a
938 call to lisp_malloc. */
941 lisp_free (void *block
)
945 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
946 mem_delete (mem_find (block
));
948 MALLOC_UNBLOCK_INPUT
;
951 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
953 /* The entry point is lisp_align_malloc which returns blocks of at most
954 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
956 #if defined (HAVE_POSIX_MEMALIGN) && defined (SYSTEM_MALLOC)
957 #define USE_POSIX_MEMALIGN 1
960 /* BLOCK_ALIGN has to be a power of 2. */
961 #define BLOCK_ALIGN (1 << 10)
963 /* Padding to leave at the end of a malloc'd block. This is to give
964 malloc a chance to minimize the amount of memory wasted to alignment.
965 It should be tuned to the particular malloc library used.
966 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
967 posix_memalign on the other hand would ideally prefer a value of 4
968 because otherwise, there's 1020 bytes wasted between each ablocks.
969 In Emacs, testing shows that those 1020 can most of the time be
970 efficiently used by malloc to place other objects, so a value of 0 can
971 still preferable unless you have a lot of aligned blocks and virtually
973 #define BLOCK_PADDING 0
974 #define BLOCK_BYTES \
975 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
977 /* Internal data structures and constants. */
979 #define ABLOCKS_SIZE 16
981 /* An aligned block of memory. */
986 char payload
[BLOCK_BYTES
];
987 struct ablock
*next_free
;
989 /* `abase' is the aligned base of the ablocks. */
990 /* It is overloaded to hold the virtual `busy' field that counts
991 the number of used ablock in the parent ablocks.
992 The first ablock has the `busy' field, the others have the `abase'
993 field. To tell the difference, we assume that pointers will have
994 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
995 is used to tell whether the real base of the parent ablocks is `abase'
996 (if not, the word before the first ablock holds a pointer to the
998 struct ablocks
*abase
;
999 /* The padding of all but the last ablock is unused. The padding of
1000 the last ablock in an ablocks is not allocated. */
1002 char padding
[BLOCK_PADDING
];
1006 /* A bunch of consecutive aligned blocks. */
1009 struct ablock blocks
[ABLOCKS_SIZE
];
1012 /* Size of the block requested from malloc or posix_memalign. */
1013 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1015 #define ABLOCK_ABASE(block) \
1016 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1017 ? (struct ablocks *)(block) \
1020 /* Virtual `busy' field. */
1021 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1023 /* Pointer to the (not necessarily aligned) malloc block. */
1024 #ifdef USE_POSIX_MEMALIGN
1025 #define ABLOCKS_BASE(abase) (abase)
1027 #define ABLOCKS_BASE(abase) \
1028 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void**)abase)[-1])
1031 /* The list of free ablock. */
1032 static struct ablock
*free_ablock
;
1034 /* Allocate an aligned block of nbytes.
1035 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1036 smaller or equal to BLOCK_BYTES. */
1038 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1041 struct ablocks
*abase
;
1043 eassert (nbytes
<= BLOCK_BYTES
);
1047 #ifdef GC_MALLOC_CHECK
1048 allocated_mem_type
= type
;
1054 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1056 #ifdef DOUG_LEA_MALLOC
1057 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1058 because mapped region contents are not preserved in
1060 mallopt (M_MMAP_MAX
, 0);
1063 #ifdef USE_POSIX_MEMALIGN
1065 int err
= posix_memalign (&base
, BLOCK_ALIGN
, ABLOCKS_BYTES
);
1071 base
= malloc (ABLOCKS_BYTES
);
1072 abase
= ALIGN (base
, BLOCK_ALIGN
);
1077 MALLOC_UNBLOCK_INPUT
;
1078 memory_full (ABLOCKS_BYTES
);
1081 aligned
= (base
== abase
);
1083 ((void**)abase
)[-1] = base
;
1085 #ifdef DOUG_LEA_MALLOC
1086 /* Back to a reasonable maximum of mmap'ed areas. */
1087 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1091 /* If the memory just allocated cannot be addressed thru a Lisp
1092 object's pointer, and it needs to be, that's equivalent to
1093 running out of memory. */
1094 if (type
!= MEM_TYPE_NON_LISP
)
1097 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1098 XSETCONS (tem
, end
);
1099 if ((char *) XCONS (tem
) != end
)
1101 lisp_malloc_loser
= base
;
1103 MALLOC_UNBLOCK_INPUT
;
1104 memory_full (SIZE_MAX
);
1109 /* Initialize the blocks and put them on the free list.
1110 If `base' was not properly aligned, we can't use the last block. */
1111 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1113 abase
->blocks
[i
].abase
= abase
;
1114 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1115 free_ablock
= &abase
->blocks
[i
];
1117 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1119 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1120 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1121 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1122 eassert (ABLOCKS_BASE (abase
) == base
);
1123 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1126 abase
= ABLOCK_ABASE (free_ablock
);
1127 ABLOCKS_BUSY (abase
) =
1128 (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1130 free_ablock
= free_ablock
->x
.next_free
;
1132 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1133 if (type
!= MEM_TYPE_NON_LISP
)
1134 mem_insert (val
, (char *) val
+ nbytes
, type
);
1137 MALLOC_UNBLOCK_INPUT
;
1139 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1144 lisp_align_free (void *block
)
1146 struct ablock
*ablock
= block
;
1147 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1150 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1151 mem_delete (mem_find (block
));
1153 /* Put on free list. */
1154 ablock
->x
.next_free
= free_ablock
;
1155 free_ablock
= ablock
;
1156 /* Update busy count. */
1157 ABLOCKS_BUSY (abase
)
1158 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1160 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1161 { /* All the blocks are free. */
1162 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1163 struct ablock
**tem
= &free_ablock
;
1164 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1168 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1171 *tem
= (*tem
)->x
.next_free
;
1174 tem
= &(*tem
)->x
.next_free
;
1176 eassert ((aligned
& 1) == aligned
);
1177 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1178 #ifdef USE_POSIX_MEMALIGN
1179 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1181 free (ABLOCKS_BASE (abase
));
1183 MALLOC_UNBLOCK_INPUT
;
1186 /* Return a new buffer structure allocated from the heap with
1187 a call to lisp_malloc. */
1190 allocate_buffer (void)
1193 = (struct buffer
*) lisp_malloc (sizeof (struct buffer
),
1195 XSETPVECTYPESIZE (b
, PVEC_BUFFER
,
1196 ((sizeof (struct buffer
) + sizeof (EMACS_INT
) - 1)
1197 / sizeof (EMACS_INT
)));
1202 #ifndef SYSTEM_MALLOC
1204 /* Arranging to disable input signals while we're in malloc.
1206 This only works with GNU malloc. To help out systems which can't
1207 use GNU malloc, all the calls to malloc, realloc, and free
1208 elsewhere in the code should be inside a BLOCK_INPUT/UNBLOCK_INPUT
1209 pair; unfortunately, we have no idea what C library functions
1210 might call malloc, so we can't really protect them unless you're
1211 using GNU malloc. Fortunately, most of the major operating systems
1212 can use GNU malloc. */
1215 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
1216 there's no need to block input around malloc. */
1218 #ifndef DOUG_LEA_MALLOC
1219 extern void * (*__malloc_hook
) (size_t, const void *);
1220 extern void * (*__realloc_hook
) (void *, size_t, const void *);
1221 extern void (*__free_hook
) (void *, const void *);
1222 /* Else declared in malloc.h, perhaps with an extra arg. */
1223 #endif /* DOUG_LEA_MALLOC */
1224 static void * (*old_malloc_hook
) (size_t, const void *);
1225 static void * (*old_realloc_hook
) (void *, size_t, const void*);
1226 static void (*old_free_hook
) (void*, const void*);
1228 #ifdef DOUG_LEA_MALLOC
1229 # define BYTES_USED (mallinfo ().uordblks)
1231 # define BYTES_USED _bytes_used
1234 #ifdef GC_MALLOC_CHECK
1235 static int dont_register_blocks
;
1238 static size_t bytes_used_when_reconsidered
;
1240 /* Value of _bytes_used, when spare_memory was freed. */
1242 static size_t bytes_used_when_full
;
1244 /* This function is used as the hook for free to call. */
1247 emacs_blocked_free (void *ptr
, const void *ptr2
)
1251 #ifdef GC_MALLOC_CHECK
1257 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1260 "Freeing `%p' which wasn't allocated with malloc\n", ptr
);
1265 /* fprintf (stderr, "free %p...%p (%p)\n", m->start, m->end, ptr); */
1269 #endif /* GC_MALLOC_CHECK */
1271 __free_hook
= old_free_hook
;
1274 /* If we released our reserve (due to running out of memory),
1275 and we have a fair amount free once again,
1276 try to set aside another reserve in case we run out once more. */
1277 if (! NILP (Vmemory_full
)
1278 /* Verify there is enough space that even with the malloc
1279 hysteresis this call won't run out again.
1280 The code here is correct as long as SPARE_MEMORY
1281 is substantially larger than the block size malloc uses. */
1282 && (bytes_used_when_full
1283 > ((bytes_used_when_reconsidered
= BYTES_USED
)
1284 + max (malloc_hysteresis
, 4) * SPARE_MEMORY
)))
1285 refill_memory_reserve ();
1287 __free_hook
= emacs_blocked_free
;
1288 UNBLOCK_INPUT_ALLOC
;
1292 /* This function is the malloc hook that Emacs uses. */
1295 emacs_blocked_malloc (size_t size
, const void *ptr
)
1300 __malloc_hook
= old_malloc_hook
;
1301 #ifdef DOUG_LEA_MALLOC
1302 /* Segfaults on my system. --lorentey */
1303 /* mallopt (M_TOP_PAD, malloc_hysteresis * 4096); */
1305 __malloc_extra_blocks
= malloc_hysteresis
;
1308 value
= (void *) malloc (size
);
1310 #ifdef GC_MALLOC_CHECK
1312 struct mem_node
*m
= mem_find (value
);
1315 fprintf (stderr
, "Malloc returned %p which is already in use\n",
1317 fprintf (stderr
, "Region in use is %p...%p, %td bytes, type %d\n",
1318 m
->start
, m
->end
, (char *) m
->end
- (char *) m
->start
,
1323 if (!dont_register_blocks
)
1325 mem_insert (value
, (char *) value
+ max (1, size
), allocated_mem_type
);
1326 allocated_mem_type
= MEM_TYPE_NON_LISP
;
1329 #endif /* GC_MALLOC_CHECK */
1331 __malloc_hook
= emacs_blocked_malloc
;
1332 UNBLOCK_INPUT_ALLOC
;
1334 /* fprintf (stderr, "%p malloc\n", value); */
1339 /* This function is the realloc hook that Emacs uses. */
1342 emacs_blocked_realloc (void *ptr
, size_t size
, const void *ptr2
)
1347 __realloc_hook
= old_realloc_hook
;
1349 #ifdef GC_MALLOC_CHECK
1352 struct mem_node
*m
= mem_find (ptr
);
1353 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1356 "Realloc of %p which wasn't allocated with malloc\n",
1364 /* fprintf (stderr, "%p -> realloc\n", ptr); */
1366 /* Prevent malloc from registering blocks. */
1367 dont_register_blocks
= 1;
1368 #endif /* GC_MALLOC_CHECK */
1370 value
= (void *) realloc (ptr
, size
);
1372 #ifdef GC_MALLOC_CHECK
1373 dont_register_blocks
= 0;
1376 struct mem_node
*m
= mem_find (value
);
1379 fprintf (stderr
, "Realloc returns memory that is already in use\n");
1383 /* Can't handle zero size regions in the red-black tree. */
1384 mem_insert (value
, (char *) value
+ max (size
, 1), MEM_TYPE_NON_LISP
);
1387 /* fprintf (stderr, "%p <- realloc\n", value); */
1388 #endif /* GC_MALLOC_CHECK */
1390 __realloc_hook
= emacs_blocked_realloc
;
1391 UNBLOCK_INPUT_ALLOC
;
1398 /* Called from Fdump_emacs so that when the dumped Emacs starts, it has a
1399 normal malloc. Some thread implementations need this as they call
1400 malloc before main. The pthread_self call in BLOCK_INPUT_ALLOC then
1401 calls malloc because it is the first call, and we have an endless loop. */
1404 reset_malloc_hooks (void)
1406 __free_hook
= old_free_hook
;
1407 __malloc_hook
= old_malloc_hook
;
1408 __realloc_hook
= old_realloc_hook
;
1410 #endif /* HAVE_PTHREAD */
1413 /* Called from main to set up malloc to use our hooks. */
1416 uninterrupt_malloc (void)
1419 #ifdef DOUG_LEA_MALLOC
1420 pthread_mutexattr_t attr
;
1422 /* GLIBC has a faster way to do this, but let's keep it portable.
1423 This is according to the Single UNIX Specification. */
1424 pthread_mutexattr_init (&attr
);
1425 pthread_mutexattr_settype (&attr
, PTHREAD_MUTEX_RECURSIVE
);
1426 pthread_mutex_init (&alloc_mutex
, &attr
);
1427 #else /* !DOUG_LEA_MALLOC */
1428 /* Some systems such as Solaris 2.6 don't have a recursive mutex,
1429 and the bundled gmalloc.c doesn't require it. */
1430 pthread_mutex_init (&alloc_mutex
, NULL
);
1431 #endif /* !DOUG_LEA_MALLOC */
1432 #endif /* HAVE_PTHREAD */
1434 if (__free_hook
!= emacs_blocked_free
)
1435 old_free_hook
= __free_hook
;
1436 __free_hook
= emacs_blocked_free
;
1438 if (__malloc_hook
!= emacs_blocked_malloc
)
1439 old_malloc_hook
= __malloc_hook
;
1440 __malloc_hook
= emacs_blocked_malloc
;
1442 if (__realloc_hook
!= emacs_blocked_realloc
)
1443 old_realloc_hook
= __realloc_hook
;
1444 __realloc_hook
= emacs_blocked_realloc
;
1447 #endif /* not SYNC_INPUT */
1448 #endif /* not SYSTEM_MALLOC */
1452 /***********************************************************************
1454 ***********************************************************************/
1456 /* Number of intervals allocated in an interval_block structure.
1457 The 1020 is 1024 minus malloc overhead. */
1459 #define INTERVAL_BLOCK_SIZE \
1460 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1462 /* Intervals are allocated in chunks in form of an interval_block
1465 struct interval_block
1467 /* Place `intervals' first, to preserve alignment. */
1468 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1469 struct interval_block
*next
;
1472 /* Current interval block. Its `next' pointer points to older
1475 static struct interval_block
*interval_block
;
1477 /* Index in interval_block above of the next unused interval
1480 static int interval_block_index
;
1482 /* Number of free and live intervals. */
1484 static EMACS_INT total_free_intervals
, total_intervals
;
1486 /* List of free intervals. */
1488 static INTERVAL interval_free_list
;
1491 /* Initialize interval allocation. */
1494 init_intervals (void)
1496 interval_block
= NULL
;
1497 interval_block_index
= INTERVAL_BLOCK_SIZE
;
1498 interval_free_list
= 0;
1502 /* Return a new interval. */
1505 make_interval (void)
1509 /* eassert (!handling_signal); */
1513 if (interval_free_list
)
1515 val
= interval_free_list
;
1516 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1520 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1522 register struct interval_block
*newi
;
1524 newi
= (struct interval_block
*) lisp_malloc (sizeof *newi
,
1527 newi
->next
= interval_block
;
1528 interval_block
= newi
;
1529 interval_block_index
= 0;
1531 val
= &interval_block
->intervals
[interval_block_index
++];
1534 MALLOC_UNBLOCK_INPUT
;
1536 consing_since_gc
+= sizeof (struct interval
);
1538 RESET_INTERVAL (val
);
1544 /* Mark Lisp objects in interval I. */
1547 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1549 eassert (!i
->gcmarkbit
); /* Intervals are never shared. */
1551 mark_object (i
->plist
);
1555 /* Mark the interval tree rooted in TREE. Don't call this directly;
1556 use the macro MARK_INTERVAL_TREE instead. */
1559 mark_interval_tree (register INTERVAL tree
)
1561 /* No need to test if this tree has been marked already; this
1562 function is always called through the MARK_INTERVAL_TREE macro,
1563 which takes care of that. */
1565 traverse_intervals_noorder (tree
, mark_interval
, Qnil
);
1569 /* Mark the interval tree rooted in I. */
1571 #define MARK_INTERVAL_TREE(i) \
1573 if (!NULL_INTERVAL_P (i) && !i->gcmarkbit) \
1574 mark_interval_tree (i); \
1578 #define UNMARK_BALANCE_INTERVALS(i) \
1580 if (! NULL_INTERVAL_P (i)) \
1581 (i) = balance_intervals (i); \
1585 /* Number support. If USE_LISP_UNION_TYPE is in effect, we
1586 can't create number objects in macros. */
1589 make_number (EMACS_INT n
)
1593 obj
.s
.type
= Lisp_Int
;
1598 /* Convert the pointer-sized word P to EMACS_INT while preserving its
1599 type and ptr fields. */
1601 widen_to_Lisp_Object (void *p
)
1603 intptr_t i
= (intptr_t) p
;
1604 #ifdef USE_LISP_UNION_TYPE
1613 /***********************************************************************
1615 ***********************************************************************/
1617 /* Lisp_Strings are allocated in string_block structures. When a new
1618 string_block is allocated, all the Lisp_Strings it contains are
1619 added to a free-list string_free_list. When a new Lisp_String is
1620 needed, it is taken from that list. During the sweep phase of GC,
1621 string_blocks that are entirely free are freed, except two which
1624 String data is allocated from sblock structures. Strings larger
1625 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1626 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1628 Sblocks consist internally of sdata structures, one for each
1629 Lisp_String. The sdata structure points to the Lisp_String it
1630 belongs to. The Lisp_String points back to the `u.data' member of
1631 its sdata structure.
1633 When a Lisp_String is freed during GC, it is put back on
1634 string_free_list, and its `data' member and its sdata's `string'
1635 pointer is set to null. The size of the string is recorded in the
1636 `u.nbytes' member of the sdata. So, sdata structures that are no
1637 longer used, can be easily recognized, and it's easy to compact the
1638 sblocks of small strings which we do in compact_small_strings. */
1640 /* Size in bytes of an sblock structure used for small strings. This
1641 is 8192 minus malloc overhead. */
1643 #define SBLOCK_SIZE 8188
1645 /* Strings larger than this are considered large strings. String data
1646 for large strings is allocated from individual sblocks. */
1648 #define LARGE_STRING_BYTES 1024
1650 /* Structure describing string memory sub-allocated from an sblock.
1651 This is where the contents of Lisp strings are stored. */
1655 /* Back-pointer to the string this sdata belongs to. If null, this
1656 structure is free, and the NBYTES member of the union below
1657 contains the string's byte size (the same value that STRING_BYTES
1658 would return if STRING were non-null). If non-null, STRING_BYTES
1659 (STRING) is the size of the data, and DATA contains the string's
1661 struct Lisp_String
*string
;
1663 #ifdef GC_CHECK_STRING_BYTES
1666 unsigned char data
[1];
1668 #define SDATA_NBYTES(S) (S)->nbytes
1669 #define SDATA_DATA(S) (S)->data
1670 #define SDATA_SELECTOR(member) member
1672 #else /* not GC_CHECK_STRING_BYTES */
1676 /* When STRING is non-null. */
1677 unsigned char data
[1];
1679 /* When STRING is null. */
1683 #define SDATA_NBYTES(S) (S)->u.nbytes
1684 #define SDATA_DATA(S) (S)->u.data
1685 #define SDATA_SELECTOR(member) u.member
1687 #endif /* not GC_CHECK_STRING_BYTES */
1689 #define SDATA_DATA_OFFSET offsetof (struct sdata, SDATA_SELECTOR (data))
1693 /* Structure describing a block of memory which is sub-allocated to
1694 obtain string data memory for strings. Blocks for small strings
1695 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1696 as large as needed. */
1701 struct sblock
*next
;
1703 /* Pointer to the next free sdata block. This points past the end
1704 of the sblock if there isn't any space left in this block. */
1705 struct sdata
*next_free
;
1707 /* Start of data. */
1708 struct sdata first_data
;
1711 /* Number of Lisp strings in a string_block structure. The 1020 is
1712 1024 minus malloc overhead. */
1714 #define STRING_BLOCK_SIZE \
1715 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1717 /* Structure describing a block from which Lisp_String structures
1722 /* Place `strings' first, to preserve alignment. */
1723 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1724 struct string_block
*next
;
1727 /* Head and tail of the list of sblock structures holding Lisp string
1728 data. We always allocate from current_sblock. The NEXT pointers
1729 in the sblock structures go from oldest_sblock to current_sblock. */
1731 static struct sblock
*oldest_sblock
, *current_sblock
;
1733 /* List of sblocks for large strings. */
1735 static struct sblock
*large_sblocks
;
1737 /* List of string_block structures. */
1739 static struct string_block
*string_blocks
;
1741 /* Free-list of Lisp_Strings. */
1743 static struct Lisp_String
*string_free_list
;
1745 /* Number of live and free Lisp_Strings. */
1747 static EMACS_INT total_strings
, total_free_strings
;
1749 /* Number of bytes used by live strings. */
1751 static EMACS_INT total_string_size
;
1753 /* Given a pointer to a Lisp_String S which is on the free-list
1754 string_free_list, return a pointer to its successor in the
1757 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1759 /* Return a pointer to the sdata structure belonging to Lisp string S.
1760 S must be live, i.e. S->data must not be null. S->data is actually
1761 a pointer to the `u.data' member of its sdata structure; the
1762 structure starts at a constant offset in front of that. */
1764 #define SDATA_OF_STRING(S) ((struct sdata *) ((S)->data - SDATA_DATA_OFFSET))
1767 #ifdef GC_CHECK_STRING_OVERRUN
1769 /* We check for overrun in string data blocks by appending a small
1770 "cookie" after each allocated string data block, and check for the
1771 presence of this cookie during GC. */
1773 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1774 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1775 { '\xde', '\xad', '\xbe', '\xef' };
1778 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1781 /* Value is the size of an sdata structure large enough to hold NBYTES
1782 bytes of string data. The value returned includes a terminating
1783 NUL byte, the size of the sdata structure, and padding. */
1785 #ifdef GC_CHECK_STRING_BYTES
1787 #define SDATA_SIZE(NBYTES) \
1788 ((SDATA_DATA_OFFSET \
1790 + sizeof (ptrdiff_t) - 1) \
1791 & ~(sizeof (ptrdiff_t) - 1))
1793 #else /* not GC_CHECK_STRING_BYTES */
1795 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1796 less than the size of that member. The 'max' is not needed when
1797 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1798 alignment code reserves enough space. */
1800 #define SDATA_SIZE(NBYTES) \
1801 ((SDATA_DATA_OFFSET \
1802 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1804 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1806 + sizeof (ptrdiff_t) - 1) \
1807 & ~(sizeof (ptrdiff_t) - 1))
1809 #endif /* not GC_CHECK_STRING_BYTES */
1811 /* Extra bytes to allocate for each string. */
1813 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1815 /* Exact bound on the number of bytes in a string, not counting the
1816 terminating null. A string cannot contain more bytes than
1817 STRING_BYTES_BOUND, nor can it be so long that the size_t
1818 arithmetic in allocate_string_data would overflow while it is
1819 calculating a value to be passed to malloc. */
1820 #define STRING_BYTES_MAX \
1821 min (STRING_BYTES_BOUND, \
1822 ((SIZE_MAX - XMALLOC_OVERRUN_CHECK_OVERHEAD \
1824 - offsetof (struct sblock, first_data) \
1825 - SDATA_DATA_OFFSET) \
1826 & ~(sizeof (EMACS_INT) - 1)))
1828 /* Initialize string allocation. Called from init_alloc_once. */
1833 total_strings
= total_free_strings
= total_string_size
= 0;
1834 oldest_sblock
= current_sblock
= large_sblocks
= NULL
;
1835 string_blocks
= NULL
;
1836 string_free_list
= NULL
;
1837 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1838 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1842 #ifdef GC_CHECK_STRING_BYTES
1844 static int check_string_bytes_count
;
1846 #define CHECK_STRING_BYTES(S) STRING_BYTES (S)
1849 /* Like GC_STRING_BYTES, but with debugging check. */
1852 string_bytes (struct Lisp_String
*s
)
1855 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1857 if (!PURE_POINTER_P (s
)
1859 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1864 /* Check validity of Lisp strings' string_bytes member in B. */
1867 check_sblock (struct sblock
*b
)
1869 struct sdata
*from
, *end
, *from_end
;
1873 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1875 /* Compute the next FROM here because copying below may
1876 overwrite data we need to compute it. */
1879 /* Check that the string size recorded in the string is the
1880 same as the one recorded in the sdata structure. */
1882 CHECK_STRING_BYTES (from
->string
);
1885 nbytes
= GC_STRING_BYTES (from
->string
);
1887 nbytes
= SDATA_NBYTES (from
);
1889 nbytes
= SDATA_SIZE (nbytes
);
1890 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1895 /* Check validity of Lisp strings' string_bytes member. ALL_P
1896 non-zero means check all strings, otherwise check only most
1897 recently allocated strings. Used for hunting a bug. */
1900 check_string_bytes (int all_p
)
1906 for (b
= large_sblocks
; b
; b
= b
->next
)
1908 struct Lisp_String
*s
= b
->first_data
.string
;
1910 CHECK_STRING_BYTES (s
);
1913 for (b
= oldest_sblock
; b
; b
= b
->next
)
1917 check_sblock (current_sblock
);
1920 #endif /* GC_CHECK_STRING_BYTES */
1922 #ifdef GC_CHECK_STRING_FREE_LIST
1924 /* Walk through the string free list looking for bogus next pointers.
1925 This may catch buffer overrun from a previous string. */
1928 check_string_free_list (void)
1930 struct Lisp_String
*s
;
1932 /* Pop a Lisp_String off the free-list. */
1933 s
= string_free_list
;
1936 if ((uintptr_t) s
< 1024)
1938 s
= NEXT_FREE_LISP_STRING (s
);
1942 #define check_string_free_list()
1945 /* Return a new Lisp_String. */
1947 static struct Lisp_String
*
1948 allocate_string (void)
1950 struct Lisp_String
*s
;
1952 /* eassert (!handling_signal); */
1956 /* If the free-list is empty, allocate a new string_block, and
1957 add all the Lisp_Strings in it to the free-list. */
1958 if (string_free_list
== NULL
)
1960 struct string_block
*b
;
1963 b
= (struct string_block
*) lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1964 memset (b
, 0, sizeof *b
);
1965 b
->next
= string_blocks
;
1968 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1971 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1972 string_free_list
= s
;
1975 total_free_strings
+= STRING_BLOCK_SIZE
;
1978 check_string_free_list ();
1980 /* Pop a Lisp_String off the free-list. */
1981 s
= string_free_list
;
1982 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1984 MALLOC_UNBLOCK_INPUT
;
1986 /* Probably not strictly necessary, but play it safe. */
1987 memset (s
, 0, sizeof *s
);
1989 --total_free_strings
;
1992 consing_since_gc
+= sizeof *s
;
1994 #ifdef GC_CHECK_STRING_BYTES
1995 if (!noninteractive
)
1997 if (++check_string_bytes_count
== 200)
1999 check_string_bytes_count
= 0;
2000 check_string_bytes (1);
2003 check_string_bytes (0);
2005 #endif /* GC_CHECK_STRING_BYTES */
2011 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
2012 plus a NUL byte at the end. Allocate an sdata structure for S, and
2013 set S->data to its `u.data' member. Store a NUL byte at the end of
2014 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
2015 S->data if it was initially non-null. */
2018 allocate_string_data (struct Lisp_String
*s
,
2019 EMACS_INT nchars
, EMACS_INT nbytes
)
2021 struct sdata
*data
, *old_data
;
2023 ptrdiff_t needed
, old_nbytes
;
2025 if (STRING_BYTES_MAX
< nbytes
)
2028 /* Determine the number of bytes needed to store NBYTES bytes
2030 needed
= SDATA_SIZE (nbytes
);
2031 old_data
= s
->data
? SDATA_OF_STRING (s
) : NULL
;
2032 old_nbytes
= GC_STRING_BYTES (s
);
2036 if (nbytes
> LARGE_STRING_BYTES
)
2038 size_t size
= offsetof (struct sblock
, first_data
) + needed
;
2040 #ifdef DOUG_LEA_MALLOC
2041 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
2042 because mapped region contents are not preserved in
2045 In case you think of allowing it in a dumped Emacs at the
2046 cost of not being able to re-dump, there's another reason:
2047 mmap'ed data typically have an address towards the top of the
2048 address space, which won't fit into an EMACS_INT (at least on
2049 32-bit systems with the current tagging scheme). --fx */
2050 mallopt (M_MMAP_MAX
, 0);
2053 b
= (struct sblock
*) lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
2055 #ifdef DOUG_LEA_MALLOC
2056 /* Back to a reasonable maximum of mmap'ed areas. */
2057 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2060 b
->next_free
= &b
->first_data
;
2061 b
->first_data
.string
= NULL
;
2062 b
->next
= large_sblocks
;
2065 else if (current_sblock
== NULL
2066 || (((char *) current_sblock
+ SBLOCK_SIZE
2067 - (char *) current_sblock
->next_free
)
2068 < (needed
+ GC_STRING_EXTRA
)))
2070 /* Not enough room in the current sblock. */
2071 b
= (struct sblock
*) lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
2072 b
->next_free
= &b
->first_data
;
2073 b
->first_data
.string
= NULL
;
2077 current_sblock
->next
= b
;
2085 data
= b
->next_free
;
2086 b
->next_free
= (struct sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
2088 MALLOC_UNBLOCK_INPUT
;
2091 s
->data
= SDATA_DATA (data
);
2092 #ifdef GC_CHECK_STRING_BYTES
2093 SDATA_NBYTES (data
) = nbytes
;
2096 s
->size_byte
= nbytes
;
2097 s
->data
[nbytes
] = '\0';
2098 #ifdef GC_CHECK_STRING_OVERRUN
2099 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
2100 GC_STRING_OVERRUN_COOKIE_SIZE
);
2103 /* If S had already data assigned, mark that as free by setting its
2104 string back-pointer to null, and recording the size of the data
2108 SDATA_NBYTES (old_data
) = old_nbytes
;
2109 old_data
->string
= NULL
;
2112 consing_since_gc
+= needed
;
2116 /* Sweep and compact strings. */
2119 sweep_strings (void)
2121 struct string_block
*b
, *next
;
2122 struct string_block
*live_blocks
= NULL
;
2124 string_free_list
= NULL
;
2125 total_strings
= total_free_strings
= 0;
2126 total_string_size
= 0;
2128 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
2129 for (b
= string_blocks
; b
; b
= next
)
2132 struct Lisp_String
*free_list_before
= string_free_list
;
2136 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
2138 struct Lisp_String
*s
= b
->strings
+ i
;
2142 /* String was not on free-list before. */
2143 if (STRING_MARKED_P (s
))
2145 /* String is live; unmark it and its intervals. */
2148 if (!NULL_INTERVAL_P (s
->intervals
))
2149 UNMARK_BALANCE_INTERVALS (s
->intervals
);
2152 total_string_size
+= STRING_BYTES (s
);
2156 /* String is dead. Put it on the free-list. */
2157 struct sdata
*data
= SDATA_OF_STRING (s
);
2159 /* Save the size of S in its sdata so that we know
2160 how large that is. Reset the sdata's string
2161 back-pointer so that we know it's free. */
2162 #ifdef GC_CHECK_STRING_BYTES
2163 if (GC_STRING_BYTES (s
) != SDATA_NBYTES (data
))
2166 data
->u
.nbytes
= GC_STRING_BYTES (s
);
2168 data
->string
= NULL
;
2170 /* Reset the strings's `data' member so that we
2174 /* Put the string on the free-list. */
2175 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2176 string_free_list
= s
;
2182 /* S was on the free-list before. Put it there again. */
2183 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2184 string_free_list
= s
;
2189 /* Free blocks that contain free Lisp_Strings only, except
2190 the first two of them. */
2191 if (nfree
== STRING_BLOCK_SIZE
2192 && total_free_strings
> STRING_BLOCK_SIZE
)
2195 string_free_list
= free_list_before
;
2199 total_free_strings
+= nfree
;
2200 b
->next
= live_blocks
;
2205 check_string_free_list ();
2207 string_blocks
= live_blocks
;
2208 free_large_strings ();
2209 compact_small_strings ();
2211 check_string_free_list ();
2215 /* Free dead large strings. */
2218 free_large_strings (void)
2220 struct sblock
*b
, *next
;
2221 struct sblock
*live_blocks
= NULL
;
2223 for (b
= large_sblocks
; b
; b
= next
)
2227 if (b
->first_data
.string
== NULL
)
2231 b
->next
= live_blocks
;
2236 large_sblocks
= live_blocks
;
2240 /* Compact data of small strings. Free sblocks that don't contain
2241 data of live strings after compaction. */
2244 compact_small_strings (void)
2246 struct sblock
*b
, *tb
, *next
;
2247 struct sdata
*from
, *to
, *end
, *tb_end
;
2248 struct sdata
*to_end
, *from_end
;
2250 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2251 to, and TB_END is the end of TB. */
2253 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2254 to
= &tb
->first_data
;
2256 /* Step through the blocks from the oldest to the youngest. We
2257 expect that old blocks will stabilize over time, so that less
2258 copying will happen this way. */
2259 for (b
= oldest_sblock
; b
; b
= b
->next
)
2262 xassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2264 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
2266 /* Compute the next FROM here because copying below may
2267 overwrite data we need to compute it. */
2270 #ifdef GC_CHECK_STRING_BYTES
2271 /* Check that the string size recorded in the string is the
2272 same as the one recorded in the sdata structure. */
2274 && GC_STRING_BYTES (from
->string
) != SDATA_NBYTES (from
))
2276 #endif /* GC_CHECK_STRING_BYTES */
2279 nbytes
= GC_STRING_BYTES (from
->string
);
2281 nbytes
= SDATA_NBYTES (from
);
2283 if (nbytes
> LARGE_STRING_BYTES
)
2286 nbytes
= SDATA_SIZE (nbytes
);
2287 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2289 #ifdef GC_CHECK_STRING_OVERRUN
2290 if (memcmp (string_overrun_cookie
,
2291 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2292 GC_STRING_OVERRUN_COOKIE_SIZE
))
2296 /* FROM->string non-null means it's alive. Copy its data. */
2299 /* If TB is full, proceed with the next sblock. */
2300 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2301 if (to_end
> tb_end
)
2305 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2306 to
= &tb
->first_data
;
2307 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2310 /* Copy, and update the string's `data' pointer. */
2313 xassert (tb
!= b
|| to
< from
);
2314 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2315 to
->string
->data
= SDATA_DATA (to
);
2318 /* Advance past the sdata we copied to. */
2324 /* The rest of the sblocks following TB don't contain live data, so
2325 we can free them. */
2326 for (b
= tb
->next
; b
; b
= next
)
2334 current_sblock
= tb
;
2338 string_overflow (void)
2340 error ("Maximum string size exceeded");
2343 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2344 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2345 LENGTH must be an integer.
2346 INIT must be an integer that represents a character. */)
2347 (Lisp_Object length
, Lisp_Object init
)
2349 register Lisp_Object val
;
2350 register unsigned char *p
, *end
;
2354 CHECK_NATNUM (length
);
2355 CHECK_CHARACTER (init
);
2357 c
= XFASTINT (init
);
2358 if (ASCII_CHAR_P (c
))
2360 nbytes
= XINT (length
);
2361 val
= make_uninit_string (nbytes
);
2363 end
= p
+ SCHARS (val
);
2369 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2370 int len
= CHAR_STRING (c
, str
);
2371 EMACS_INT string_len
= XINT (length
);
2373 if (string_len
> STRING_BYTES_MAX
/ len
)
2375 nbytes
= len
* string_len
;
2376 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2381 memcpy (p
, str
, len
);
2391 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2392 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2393 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2394 (Lisp_Object length
, Lisp_Object init
)
2396 register Lisp_Object val
;
2397 struct Lisp_Bool_Vector
*p
;
2398 ptrdiff_t length_in_chars
;
2399 EMACS_INT length_in_elts
;
2402 CHECK_NATNUM (length
);
2404 bits_per_value
= sizeof (EMACS_INT
) * BOOL_VECTOR_BITS_PER_CHAR
;
2406 length_in_elts
= (XFASTINT (length
) + bits_per_value
- 1) / bits_per_value
;
2408 /* We must allocate one more elements than LENGTH_IN_ELTS for the
2409 slot `size' of the struct Lisp_Bool_Vector. */
2410 val
= Fmake_vector (make_number (length_in_elts
+ 1), Qnil
);
2412 /* No Lisp_Object to trace in there. */
2413 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0);
2415 p
= XBOOL_VECTOR (val
);
2416 p
->size
= XFASTINT (length
);
2418 length_in_chars
= ((XFASTINT (length
) + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2419 / BOOL_VECTOR_BITS_PER_CHAR
);
2420 if (length_in_chars
)
2422 memset (p
->data
, ! NILP (init
) ? -1 : 0, length_in_chars
);
2424 /* Clear any extraneous bits in the last byte. */
2425 p
->data
[length_in_chars
- 1]
2426 &= (1 << (XINT (length
) % BOOL_VECTOR_BITS_PER_CHAR
)) - 1;
2433 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2434 of characters from the contents. This string may be unibyte or
2435 multibyte, depending on the contents. */
2438 make_string (const char *contents
, ptrdiff_t nbytes
)
2440 register Lisp_Object val
;
2441 ptrdiff_t nchars
, multibyte_nbytes
;
2443 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2444 &nchars
, &multibyte_nbytes
);
2445 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2446 /* CONTENTS contains no multibyte sequences or contains an invalid
2447 multibyte sequence. We must make unibyte string. */
2448 val
= make_unibyte_string (contents
, nbytes
);
2450 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2455 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2458 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2460 register Lisp_Object val
;
2461 val
= make_uninit_string (length
);
2462 memcpy (SDATA (val
), contents
, length
);
2467 /* Make a multibyte string from NCHARS characters occupying NBYTES
2468 bytes at CONTENTS. */
2471 make_multibyte_string (const char *contents
,
2472 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2474 register Lisp_Object val
;
2475 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2476 memcpy (SDATA (val
), contents
, nbytes
);
2481 /* Make a string from NCHARS characters occupying NBYTES bytes at
2482 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2485 make_string_from_bytes (const char *contents
,
2486 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2488 register Lisp_Object val
;
2489 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2490 memcpy (SDATA (val
), contents
, nbytes
);
2491 if (SBYTES (val
) == SCHARS (val
))
2492 STRING_SET_UNIBYTE (val
);
2497 /* Make a string from NCHARS characters occupying NBYTES bytes at
2498 CONTENTS. The argument MULTIBYTE controls whether to label the
2499 string as multibyte. If NCHARS is negative, it counts the number of
2500 characters by itself. */
2503 make_specified_string (const char *contents
,
2504 ptrdiff_t nchars
, ptrdiff_t nbytes
, int multibyte
)
2506 register Lisp_Object val
;
2511 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2516 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2517 memcpy (SDATA (val
), contents
, nbytes
);
2519 STRING_SET_UNIBYTE (val
);
2524 /* Make a string from the data at STR, treating it as multibyte if the
2528 build_string (const char *str
)
2530 return make_string (str
, strlen (str
));
2534 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2535 occupying LENGTH bytes. */
2538 make_uninit_string (EMACS_INT length
)
2543 return empty_unibyte_string
;
2544 val
= make_uninit_multibyte_string (length
, length
);
2545 STRING_SET_UNIBYTE (val
);
2550 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2551 which occupy NBYTES bytes. */
2554 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2557 struct Lisp_String
*s
;
2562 return empty_multibyte_string
;
2564 s
= allocate_string ();
2565 allocate_string_data (s
, nchars
, nbytes
);
2566 XSETSTRING (string
, s
);
2567 string_chars_consed
+= nbytes
;
2573 /***********************************************************************
2575 ***********************************************************************/
2577 /* We store float cells inside of float_blocks, allocating a new
2578 float_block with malloc whenever necessary. Float cells reclaimed
2579 by GC are put on a free list to be reallocated before allocating
2580 any new float cells from the latest float_block. */
2582 #define FLOAT_BLOCK_SIZE \
2583 (((BLOCK_BYTES - sizeof (struct float_block *) \
2584 /* The compiler might add padding at the end. */ \
2585 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2586 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2588 #define GETMARKBIT(block,n) \
2589 (((block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2590 >> ((n) % (sizeof (int) * CHAR_BIT))) \
2593 #define SETMARKBIT(block,n) \
2594 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2595 |= 1 << ((n) % (sizeof (int) * CHAR_BIT))
2597 #define UNSETMARKBIT(block,n) \
2598 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2599 &= ~(1 << ((n) % (sizeof (int) * CHAR_BIT)))
2601 #define FLOAT_BLOCK(fptr) \
2602 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2604 #define FLOAT_INDEX(fptr) \
2605 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2609 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2610 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2611 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2612 struct float_block
*next
;
2615 #define FLOAT_MARKED_P(fptr) \
2616 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2618 #define FLOAT_MARK(fptr) \
2619 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2621 #define FLOAT_UNMARK(fptr) \
2622 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2624 /* Current float_block. */
2626 static struct float_block
*float_block
;
2628 /* Index of first unused Lisp_Float in the current float_block. */
2630 static int float_block_index
;
2632 /* Free-list of Lisp_Floats. */
2634 static struct Lisp_Float
*float_free_list
;
2637 /* Initialize float allocation. */
2643 float_block_index
= FLOAT_BLOCK_SIZE
; /* Force alloc of new float_block. */
2644 float_free_list
= 0;
2648 /* Return a new float object with value FLOAT_VALUE. */
2651 make_float (double float_value
)
2653 register Lisp_Object val
;
2655 /* eassert (!handling_signal); */
2659 if (float_free_list
)
2661 /* We use the data field for chaining the free list
2662 so that we won't use the same field that has the mark bit. */
2663 XSETFLOAT (val
, float_free_list
);
2664 float_free_list
= float_free_list
->u
.chain
;
2668 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2670 register struct float_block
*new;
2672 new = (struct float_block
*) lisp_align_malloc (sizeof *new,
2674 new->next
= float_block
;
2675 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2677 float_block_index
= 0;
2679 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2680 float_block_index
++;
2683 MALLOC_UNBLOCK_INPUT
;
2685 XFLOAT_INIT (val
, float_value
);
2686 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2687 consing_since_gc
+= sizeof (struct Lisp_Float
);
2694 /***********************************************************************
2696 ***********************************************************************/
2698 /* We store cons cells inside of cons_blocks, allocating a new
2699 cons_block with malloc whenever necessary. Cons cells reclaimed by
2700 GC are put on a free list to be reallocated before allocating
2701 any new cons cells from the latest cons_block. */
2703 #define CONS_BLOCK_SIZE \
2704 (((BLOCK_BYTES - sizeof (struct cons_block *)) * CHAR_BIT) \
2705 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2707 #define CONS_BLOCK(fptr) \
2708 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2710 #define CONS_INDEX(fptr) \
2711 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2715 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2716 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2717 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2718 struct cons_block
*next
;
2721 #define CONS_MARKED_P(fptr) \
2722 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2724 #define CONS_MARK(fptr) \
2725 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2727 #define CONS_UNMARK(fptr) \
2728 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2730 /* Current cons_block. */
2732 static struct cons_block
*cons_block
;
2734 /* Index of first unused Lisp_Cons in the current block. */
2736 static int cons_block_index
;
2738 /* Free-list of Lisp_Cons structures. */
2740 static struct Lisp_Cons
*cons_free_list
;
2743 /* Initialize cons allocation. */
2749 cons_block_index
= CONS_BLOCK_SIZE
; /* Force alloc of new cons_block. */
2754 /* Explicitly free a cons cell by putting it on the free-list. */
2757 free_cons (struct Lisp_Cons
*ptr
)
2759 ptr
->u
.chain
= cons_free_list
;
2763 cons_free_list
= ptr
;
2766 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2767 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2768 (Lisp_Object car
, Lisp_Object cdr
)
2770 register Lisp_Object val
;
2772 /* eassert (!handling_signal); */
2778 /* We use the cdr for chaining the free list
2779 so that we won't use the same field that has the mark bit. */
2780 XSETCONS (val
, cons_free_list
);
2781 cons_free_list
= cons_free_list
->u
.chain
;
2785 if (cons_block_index
== CONS_BLOCK_SIZE
)
2787 register struct cons_block
*new;
2788 new = (struct cons_block
*) lisp_align_malloc (sizeof *new,
2790 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2791 new->next
= cons_block
;
2793 cons_block_index
= 0;
2795 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2799 MALLOC_UNBLOCK_INPUT
;
2803 eassert (!CONS_MARKED_P (XCONS (val
)));
2804 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2805 cons_cells_consed
++;
2809 #ifdef GC_CHECK_CONS_LIST
2810 /* Get an error now if there's any junk in the cons free list. */
2812 check_cons_list (void)
2814 struct Lisp_Cons
*tail
= cons_free_list
;
2817 tail
= tail
->u
.chain
;
2821 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2824 list1 (Lisp_Object arg1
)
2826 return Fcons (arg1
, Qnil
);
2830 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2832 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2837 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2839 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2844 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2846 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2851 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2853 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2854 Fcons (arg5
, Qnil
)))));
2858 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2859 doc
: /* Return a newly created list with specified arguments as elements.
2860 Any number of arguments, even zero arguments, are allowed.
2861 usage: (list &rest OBJECTS) */)
2862 (ptrdiff_t nargs
, Lisp_Object
*args
)
2864 register Lisp_Object val
;
2870 val
= Fcons (args
[nargs
], val
);
2876 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2877 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2878 (register Lisp_Object length
, Lisp_Object init
)
2880 register Lisp_Object val
;
2881 register EMACS_INT size
;
2883 CHECK_NATNUM (length
);
2884 size
= XFASTINT (length
);
2889 val
= Fcons (init
, val
);
2894 val
= Fcons (init
, val
);
2899 val
= Fcons (init
, val
);
2904 val
= Fcons (init
, val
);
2909 val
= Fcons (init
, val
);
2924 /***********************************************************************
2926 ***********************************************************************/
2928 /* Singly-linked list of all vectors. */
2930 static struct Lisp_Vector
*all_vectors
;
2932 /* Handy constants for vectorlike objects. */
2935 header_size
= offsetof (struct Lisp_Vector
, contents
),
2936 word_size
= sizeof (Lisp_Object
)
2939 /* Value is a pointer to a newly allocated Lisp_Vector structure
2940 with room for LEN Lisp_Objects. */
2942 static struct Lisp_Vector
*
2943 allocate_vectorlike (ptrdiff_t len
)
2945 struct Lisp_Vector
*p
;
2950 #ifdef DOUG_LEA_MALLOC
2951 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
2952 because mapped region contents are not preserved in
2954 mallopt (M_MMAP_MAX
, 0);
2957 /* This gets triggered by code which I haven't bothered to fix. --Stef */
2958 /* eassert (!handling_signal); */
2960 nbytes
= header_size
+ len
* word_size
;
2961 p
= (struct Lisp_Vector
*) lisp_malloc (nbytes
, MEM_TYPE_VECTORLIKE
);
2963 #ifdef DOUG_LEA_MALLOC
2964 /* Back to a reasonable maximum of mmap'ed areas. */
2965 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2968 consing_since_gc
+= nbytes
;
2969 vector_cells_consed
+= len
;
2971 p
->header
.next
.vector
= all_vectors
;
2974 MALLOC_UNBLOCK_INPUT
;
2980 /* Allocate a vector with LEN slots. */
2982 struct Lisp_Vector
*
2983 allocate_vector (EMACS_INT len
)
2985 struct Lisp_Vector
*v
;
2986 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
2988 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
2989 memory_full (SIZE_MAX
);
2990 v
= allocate_vectorlike (len
);
2991 v
->header
.size
= len
;
2996 /* Allocate other vector-like structures. */
2998 struct Lisp_Vector
*
2999 allocate_pseudovector (int memlen
, int lisplen
, int tag
)
3001 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3004 /* Only the first lisplen slots will be traced normally by the GC. */
3005 for (i
= 0; i
< lisplen
; ++i
)
3006 v
->contents
[i
] = Qnil
;
3008 XSETPVECTYPESIZE (v
, tag
, lisplen
);
3012 struct Lisp_Hash_Table
*
3013 allocate_hash_table (void)
3015 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
3020 allocate_window (void)
3022 return ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
3027 allocate_terminal (void)
3029 struct terminal
*t
= ALLOCATE_PSEUDOVECTOR (struct terminal
,
3030 next_terminal
, PVEC_TERMINAL
);
3031 /* Zero out the non-GC'd fields. FIXME: This should be made unnecessary. */
3032 memset (&t
->next_terminal
, 0,
3033 (char*) (t
+ 1) - (char*) &t
->next_terminal
);
3039 allocate_frame (void)
3041 struct frame
*f
= ALLOCATE_PSEUDOVECTOR (struct frame
,
3042 face_cache
, PVEC_FRAME
);
3043 /* Zero out the non-GC'd fields. FIXME: This should be made unnecessary. */
3044 memset (&f
->face_cache
, 0,
3045 (char *) (f
+ 1) - (char *) &f
->face_cache
);
3050 struct Lisp_Process
*
3051 allocate_process (void)
3053 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3057 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3058 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3059 See also the function `vector'. */)
3060 (register Lisp_Object length
, Lisp_Object init
)
3063 register ptrdiff_t sizei
;
3064 register ptrdiff_t i
;
3065 register struct Lisp_Vector
*p
;
3067 CHECK_NATNUM (length
);
3069 p
= allocate_vector (XFASTINT (length
));
3070 sizei
= XFASTINT (length
);
3071 for (i
= 0; i
< sizei
; i
++)
3072 p
->contents
[i
] = init
;
3074 XSETVECTOR (vector
, p
);
3079 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3080 doc
: /* Return a newly created vector with specified arguments as elements.
3081 Any number of arguments, even zero arguments, are allowed.
3082 usage: (vector &rest OBJECTS) */)
3083 (ptrdiff_t nargs
, Lisp_Object
*args
)
3085 register Lisp_Object len
, val
;
3087 register struct Lisp_Vector
*p
;
3089 XSETFASTINT (len
, nargs
);
3090 val
= Fmake_vector (len
, Qnil
);
3092 for (i
= 0; i
< nargs
; i
++)
3093 p
->contents
[i
] = args
[i
];
3098 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3099 doc
: /* Create a byte-code object with specified arguments as elements.
3100 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3101 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3102 and (optional) INTERACTIVE-SPEC.
3103 The first four arguments are required; at most six have any
3105 The ARGLIST can be either like the one of `lambda', in which case the arguments
3106 will be dynamically bound before executing the byte code, or it can be an
3107 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3108 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3109 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3110 argument to catch the left-over arguments. If such an integer is used, the
3111 arguments will not be dynamically bound but will be instead pushed on the
3112 stack before executing the byte-code.
3113 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3114 (ptrdiff_t nargs
, Lisp_Object
*args
)
3116 register Lisp_Object len
, val
;
3118 register struct Lisp_Vector
*p
;
3120 XSETFASTINT (len
, nargs
);
3121 if (!NILP (Vpurify_flag
))
3122 val
= make_pure_vector (nargs
);
3124 val
= Fmake_vector (len
, Qnil
);
3126 if (nargs
> 1 && STRINGP (args
[1]) && STRING_MULTIBYTE (args
[1]))
3127 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3128 earlier because they produced a raw 8-bit string for byte-code
3129 and now such a byte-code string is loaded as multibyte while
3130 raw 8-bit characters converted to multibyte form. Thus, now we
3131 must convert them back to the original unibyte form. */
3132 args
[1] = Fstring_as_unibyte (args
[1]);
3135 for (i
= 0; i
< nargs
; i
++)
3137 if (!NILP (Vpurify_flag
))
3138 args
[i
] = Fpurecopy (args
[i
]);
3139 p
->contents
[i
] = args
[i
];
3141 XSETPVECTYPE (p
, PVEC_COMPILED
);
3142 XSETCOMPILED (val
, p
);
3148 /***********************************************************************
3150 ***********************************************************************/
3152 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3153 of the required alignment if LSB tags are used. */
3155 union aligned_Lisp_Symbol
3157 struct Lisp_Symbol s
;
3159 unsigned char c
[(sizeof (struct Lisp_Symbol
) + (1 << GCTYPEBITS
) - 1)
3160 & -(1 << GCTYPEBITS
)];
3164 /* Each symbol_block is just under 1020 bytes long, since malloc
3165 really allocates in units of powers of two and uses 4 bytes for its
3168 #define SYMBOL_BLOCK_SIZE \
3169 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3173 /* Place `symbols' first, to preserve alignment. */
3174 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3175 struct symbol_block
*next
;
3178 /* Current symbol block and index of first unused Lisp_Symbol
3181 static struct symbol_block
*symbol_block
;
3182 static int symbol_block_index
;
3184 /* List of free symbols. */
3186 static struct Lisp_Symbol
*symbol_free_list
;
3189 /* Initialize symbol allocation. */
3194 symbol_block
= NULL
;
3195 symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3196 symbol_free_list
= 0;
3200 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3201 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3202 Its value and function definition are void, and its property list is nil. */)
3205 register Lisp_Object val
;
3206 register struct Lisp_Symbol
*p
;
3208 CHECK_STRING (name
);
3210 /* eassert (!handling_signal); */
3214 if (symbol_free_list
)
3216 XSETSYMBOL (val
, symbol_free_list
);
3217 symbol_free_list
= symbol_free_list
->next
;
3221 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3223 struct symbol_block
*new;
3224 new = (struct symbol_block
*) lisp_malloc (sizeof *new,
3226 new->next
= symbol_block
;
3228 symbol_block_index
= 0;
3230 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3231 symbol_block_index
++;
3234 MALLOC_UNBLOCK_INPUT
;
3239 p
->redirect
= SYMBOL_PLAINVAL
;
3240 SET_SYMBOL_VAL (p
, Qunbound
);
3241 p
->function
= Qunbound
;
3244 p
->interned
= SYMBOL_UNINTERNED
;
3246 p
->declared_special
= 0;
3247 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3254 /***********************************************************************
3255 Marker (Misc) Allocation
3256 ***********************************************************************/
3258 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3259 the required alignment when LSB tags are used. */
3261 union aligned_Lisp_Misc
3265 unsigned char c
[(sizeof (union Lisp_Misc
) + (1 << GCTYPEBITS
) - 1)
3266 & -(1 << GCTYPEBITS
)];
3270 /* Allocation of markers and other objects that share that structure.
3271 Works like allocation of conses. */
3273 #define MARKER_BLOCK_SIZE \
3274 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3278 /* Place `markers' first, to preserve alignment. */
3279 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3280 struct marker_block
*next
;
3283 static struct marker_block
*marker_block
;
3284 static int marker_block_index
;
3286 static union Lisp_Misc
*marker_free_list
;
3291 marker_block
= NULL
;
3292 marker_block_index
= MARKER_BLOCK_SIZE
;
3293 marker_free_list
= 0;
3296 /* Return a newly allocated Lisp_Misc object, with no substructure. */
3299 allocate_misc (void)
3303 /* eassert (!handling_signal); */
3307 if (marker_free_list
)
3309 XSETMISC (val
, marker_free_list
);
3310 marker_free_list
= marker_free_list
->u_free
.chain
;
3314 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3316 struct marker_block
*new;
3317 new = (struct marker_block
*) lisp_malloc (sizeof *new,
3319 new->next
= marker_block
;
3321 marker_block_index
= 0;
3322 total_free_markers
+= MARKER_BLOCK_SIZE
;
3324 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3325 marker_block_index
++;
3328 MALLOC_UNBLOCK_INPUT
;
3330 --total_free_markers
;
3331 consing_since_gc
+= sizeof (union Lisp_Misc
);
3332 misc_objects_consed
++;
3333 XMISCANY (val
)->gcmarkbit
= 0;
3337 /* Free a Lisp_Misc object */
3340 free_misc (Lisp_Object misc
)
3342 XMISCTYPE (misc
) = Lisp_Misc_Free
;
3343 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3344 marker_free_list
= XMISC (misc
);
3346 total_free_markers
++;
3349 /* Return a Lisp_Misc_Save_Value object containing POINTER and
3350 INTEGER. This is used to package C values to call record_unwind_protect.
3351 The unwind function can get the C values back using XSAVE_VALUE. */
3354 make_save_value (void *pointer
, ptrdiff_t integer
)
3356 register Lisp_Object val
;
3357 register struct Lisp_Save_Value
*p
;
3359 val
= allocate_misc ();
3360 XMISCTYPE (val
) = Lisp_Misc_Save_Value
;
3361 p
= XSAVE_VALUE (val
);
3362 p
->pointer
= pointer
;
3363 p
->integer
= integer
;
3368 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3369 doc
: /* Return a newly allocated marker which does not point at any place. */)
3372 register Lisp_Object val
;
3373 register struct Lisp_Marker
*p
;
3375 val
= allocate_misc ();
3376 XMISCTYPE (val
) = Lisp_Misc_Marker
;
3382 p
->insertion_type
= 0;
3386 /* Put MARKER back on the free list after using it temporarily. */
3389 free_marker (Lisp_Object marker
)
3391 unchain_marker (XMARKER (marker
));
3396 /* Return a newly created vector or string with specified arguments as
3397 elements. If all the arguments are characters that can fit
3398 in a string of events, make a string; otherwise, make a vector.
3400 Any number of arguments, even zero arguments, are allowed. */
3403 make_event_array (register int nargs
, Lisp_Object
*args
)
3407 for (i
= 0; i
< nargs
; i
++)
3408 /* The things that fit in a string
3409 are characters that are in 0...127,
3410 after discarding the meta bit and all the bits above it. */
3411 if (!INTEGERP (args
[i
])
3412 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3413 return Fvector (nargs
, args
);
3415 /* Since the loop exited, we know that all the things in it are
3416 characters, so we can make a string. */
3420 result
= Fmake_string (make_number (nargs
), make_number (0));
3421 for (i
= 0; i
< nargs
; i
++)
3423 SSET (result
, i
, XINT (args
[i
]));
3424 /* Move the meta bit to the right place for a string char. */
3425 if (XINT (args
[i
]) & CHAR_META
)
3426 SSET (result
, i
, SREF (result
, i
) | 0x80);
3435 /************************************************************************
3436 Memory Full Handling
3437 ************************************************************************/
3440 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3441 there may have been size_t overflow so that malloc was never
3442 called, or perhaps malloc was invoked successfully but the
3443 resulting pointer had problems fitting into a tagged EMACS_INT. In
3444 either case this counts as memory being full even though malloc did
3448 memory_full (size_t nbytes
)
3450 /* Do not go into hysterics merely because a large request failed. */
3451 int enough_free_memory
= 0;
3452 if (SPARE_MEMORY
< nbytes
)
3457 p
= malloc (SPARE_MEMORY
);
3461 enough_free_memory
= 1;
3463 MALLOC_UNBLOCK_INPUT
;
3466 if (! enough_free_memory
)
3472 memory_full_cons_threshold
= sizeof (struct cons_block
);
3474 /* The first time we get here, free the spare memory. */
3475 for (i
= 0; i
< sizeof (spare_memory
) / sizeof (char *); i
++)
3476 if (spare_memory
[i
])
3479 free (spare_memory
[i
]);
3480 else if (i
>= 1 && i
<= 4)
3481 lisp_align_free (spare_memory
[i
]);
3483 lisp_free (spare_memory
[i
]);
3484 spare_memory
[i
] = 0;
3487 /* Record the space now used. When it decreases substantially,
3488 we can refill the memory reserve. */
3489 #if !defined SYSTEM_MALLOC && !defined SYNC_INPUT
3490 bytes_used_when_full
= BYTES_USED
;
3494 /* This used to call error, but if we've run out of memory, we could
3495 get infinite recursion trying to build the string. */
3496 xsignal (Qnil
, Vmemory_signal_data
);
3499 /* If we released our reserve (due to running out of memory),
3500 and we have a fair amount free once again,
3501 try to set aside another reserve in case we run out once more.
3503 This is called when a relocatable block is freed in ralloc.c,
3504 and also directly from this file, in case we're not using ralloc.c. */
3507 refill_memory_reserve (void)
3509 #ifndef SYSTEM_MALLOC
3510 if (spare_memory
[0] == 0)
3511 spare_memory
[0] = (char *) malloc (SPARE_MEMORY
);
3512 if (spare_memory
[1] == 0)
3513 spare_memory
[1] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3515 if (spare_memory
[2] == 0)
3516 spare_memory
[2] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3518 if (spare_memory
[3] == 0)
3519 spare_memory
[3] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3521 if (spare_memory
[4] == 0)
3522 spare_memory
[4] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3524 if (spare_memory
[5] == 0)
3525 spare_memory
[5] = (char *) lisp_malloc (sizeof (struct string_block
),
3527 if (spare_memory
[6] == 0)
3528 spare_memory
[6] = (char *) lisp_malloc (sizeof (struct string_block
),
3530 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3531 Vmemory_full
= Qnil
;
3535 /************************************************************************
3537 ************************************************************************/
3539 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3541 /* Conservative C stack marking requires a method to identify possibly
3542 live Lisp objects given a pointer value. We do this by keeping
3543 track of blocks of Lisp data that are allocated in a red-black tree
3544 (see also the comment of mem_node which is the type of nodes in
3545 that tree). Function lisp_malloc adds information for an allocated
3546 block to the red-black tree with calls to mem_insert, and function
3547 lisp_free removes it with mem_delete. Functions live_string_p etc
3548 call mem_find to lookup information about a given pointer in the
3549 tree, and use that to determine if the pointer points to a Lisp
3552 /* Initialize this part of alloc.c. */
3557 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3558 mem_z
.parent
= NULL
;
3559 mem_z
.color
= MEM_BLACK
;
3560 mem_z
.start
= mem_z
.end
= NULL
;
3565 /* Value is a pointer to the mem_node containing START. Value is
3566 MEM_NIL if there is no node in the tree containing START. */
3568 static inline struct mem_node
*
3569 mem_find (void *start
)
3573 if (start
< min_heap_address
|| start
> max_heap_address
)
3576 /* Make the search always successful to speed up the loop below. */
3577 mem_z
.start
= start
;
3578 mem_z
.end
= (char *) start
+ 1;
3581 while (start
< p
->start
|| start
>= p
->end
)
3582 p
= start
< p
->start
? p
->left
: p
->right
;
3587 /* Insert a new node into the tree for a block of memory with start
3588 address START, end address END, and type TYPE. Value is a
3589 pointer to the node that was inserted. */
3591 static struct mem_node
*
3592 mem_insert (void *start
, void *end
, enum mem_type type
)
3594 struct mem_node
*c
, *parent
, *x
;
3596 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3597 min_heap_address
= start
;
3598 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3599 max_heap_address
= end
;
3601 /* See where in the tree a node for START belongs. In this
3602 particular application, it shouldn't happen that a node is already
3603 present. For debugging purposes, let's check that. */
3607 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3609 while (c
!= MEM_NIL
)
3611 if (start
>= c
->start
&& start
< c
->end
)
3614 c
= start
< c
->start
? c
->left
: c
->right
;
3617 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3619 while (c
!= MEM_NIL
)
3622 c
= start
< c
->start
? c
->left
: c
->right
;
3625 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3627 /* Create a new node. */
3628 #ifdef GC_MALLOC_CHECK
3629 x
= (struct mem_node
*) _malloc_internal (sizeof *x
);
3633 x
= (struct mem_node
*) xmalloc (sizeof *x
);
3639 x
->left
= x
->right
= MEM_NIL
;
3642 /* Insert it as child of PARENT or install it as root. */
3645 if (start
< parent
->start
)
3653 /* Re-establish red-black tree properties. */
3654 mem_insert_fixup (x
);
3660 /* Re-establish the red-black properties of the tree, and thereby
3661 balance the tree, after node X has been inserted; X is always red. */
3664 mem_insert_fixup (struct mem_node
*x
)
3666 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3668 /* X is red and its parent is red. This is a violation of
3669 red-black tree property #3. */
3671 if (x
->parent
== x
->parent
->parent
->left
)
3673 /* We're on the left side of our grandparent, and Y is our
3675 struct mem_node
*y
= x
->parent
->parent
->right
;
3677 if (y
->color
== MEM_RED
)
3679 /* Uncle and parent are red but should be black because
3680 X is red. Change the colors accordingly and proceed
3681 with the grandparent. */
3682 x
->parent
->color
= MEM_BLACK
;
3683 y
->color
= MEM_BLACK
;
3684 x
->parent
->parent
->color
= MEM_RED
;
3685 x
= x
->parent
->parent
;
3689 /* Parent and uncle have different colors; parent is
3690 red, uncle is black. */
3691 if (x
== x
->parent
->right
)
3694 mem_rotate_left (x
);
3697 x
->parent
->color
= MEM_BLACK
;
3698 x
->parent
->parent
->color
= MEM_RED
;
3699 mem_rotate_right (x
->parent
->parent
);
3704 /* This is the symmetrical case of above. */
3705 struct mem_node
*y
= x
->parent
->parent
->left
;
3707 if (y
->color
== MEM_RED
)
3709 x
->parent
->color
= MEM_BLACK
;
3710 y
->color
= MEM_BLACK
;
3711 x
->parent
->parent
->color
= MEM_RED
;
3712 x
= x
->parent
->parent
;
3716 if (x
== x
->parent
->left
)
3719 mem_rotate_right (x
);
3722 x
->parent
->color
= MEM_BLACK
;
3723 x
->parent
->parent
->color
= MEM_RED
;
3724 mem_rotate_left (x
->parent
->parent
);
3729 /* The root may have been changed to red due to the algorithm. Set
3730 it to black so that property #5 is satisfied. */
3731 mem_root
->color
= MEM_BLACK
;
3742 mem_rotate_left (struct mem_node
*x
)
3746 /* Turn y's left sub-tree into x's right sub-tree. */
3749 if (y
->left
!= MEM_NIL
)
3750 y
->left
->parent
= x
;
3752 /* Y's parent was x's parent. */
3754 y
->parent
= x
->parent
;
3756 /* Get the parent to point to y instead of x. */
3759 if (x
== x
->parent
->left
)
3760 x
->parent
->left
= y
;
3762 x
->parent
->right
= y
;
3767 /* Put x on y's left. */
3781 mem_rotate_right (struct mem_node
*x
)
3783 struct mem_node
*y
= x
->left
;
3786 if (y
->right
!= MEM_NIL
)
3787 y
->right
->parent
= x
;
3790 y
->parent
= x
->parent
;
3793 if (x
== x
->parent
->right
)
3794 x
->parent
->right
= y
;
3796 x
->parent
->left
= y
;
3807 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
3810 mem_delete (struct mem_node
*z
)
3812 struct mem_node
*x
, *y
;
3814 if (!z
|| z
== MEM_NIL
)
3817 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
3822 while (y
->left
!= MEM_NIL
)
3826 if (y
->left
!= MEM_NIL
)
3831 x
->parent
= y
->parent
;
3834 if (y
== y
->parent
->left
)
3835 y
->parent
->left
= x
;
3837 y
->parent
->right
= x
;
3844 z
->start
= y
->start
;
3849 if (y
->color
== MEM_BLACK
)
3850 mem_delete_fixup (x
);
3852 #ifdef GC_MALLOC_CHECK
3860 /* Re-establish the red-black properties of the tree, after a
3864 mem_delete_fixup (struct mem_node
*x
)
3866 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
3868 if (x
== x
->parent
->left
)
3870 struct mem_node
*w
= x
->parent
->right
;
3872 if (w
->color
== MEM_RED
)
3874 w
->color
= MEM_BLACK
;
3875 x
->parent
->color
= MEM_RED
;
3876 mem_rotate_left (x
->parent
);
3877 w
= x
->parent
->right
;
3880 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
3887 if (w
->right
->color
== MEM_BLACK
)
3889 w
->left
->color
= MEM_BLACK
;
3891 mem_rotate_right (w
);
3892 w
= x
->parent
->right
;
3894 w
->color
= x
->parent
->color
;
3895 x
->parent
->color
= MEM_BLACK
;
3896 w
->right
->color
= MEM_BLACK
;
3897 mem_rotate_left (x
->parent
);
3903 struct mem_node
*w
= x
->parent
->left
;
3905 if (w
->color
== MEM_RED
)
3907 w
->color
= MEM_BLACK
;
3908 x
->parent
->color
= MEM_RED
;
3909 mem_rotate_right (x
->parent
);
3910 w
= x
->parent
->left
;
3913 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
3920 if (w
->left
->color
== MEM_BLACK
)
3922 w
->right
->color
= MEM_BLACK
;
3924 mem_rotate_left (w
);
3925 w
= x
->parent
->left
;
3928 w
->color
= x
->parent
->color
;
3929 x
->parent
->color
= MEM_BLACK
;
3930 w
->left
->color
= MEM_BLACK
;
3931 mem_rotate_right (x
->parent
);
3937 x
->color
= MEM_BLACK
;
3941 /* Value is non-zero if P is a pointer to a live Lisp string on
3942 the heap. M is a pointer to the mem_block for P. */
3945 live_string_p (struct mem_node
*m
, void *p
)
3947 if (m
->type
== MEM_TYPE_STRING
)
3949 struct string_block
*b
= (struct string_block
*) m
->start
;
3950 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
3952 /* P must point to the start of a Lisp_String structure, and it
3953 must not be on the free-list. */
3955 && offset
% sizeof b
->strings
[0] == 0
3956 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
3957 && ((struct Lisp_String
*) p
)->data
!= NULL
);
3964 /* Value is non-zero if P is a pointer to a live Lisp cons on
3965 the heap. M is a pointer to the mem_block for P. */
3968 live_cons_p (struct mem_node
*m
, void *p
)
3970 if (m
->type
== MEM_TYPE_CONS
)
3972 struct cons_block
*b
= (struct cons_block
*) m
->start
;
3973 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
3975 /* P must point to the start of a Lisp_Cons, not be
3976 one of the unused cells in the current cons block,
3977 and not be on the free-list. */
3979 && offset
% sizeof b
->conses
[0] == 0
3980 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
3982 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
3983 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
3990 /* Value is non-zero if P is a pointer to a live Lisp symbol on
3991 the heap. M is a pointer to the mem_block for P. */
3994 live_symbol_p (struct mem_node
*m
, void *p
)
3996 if (m
->type
== MEM_TYPE_SYMBOL
)
3998 struct symbol_block
*b
= (struct symbol_block
*) m
->start
;
3999 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4001 /* P must point to the start of a Lisp_Symbol, not be
4002 one of the unused cells in the current symbol block,
4003 and not be on the free-list. */
4005 && offset
% sizeof b
->symbols
[0] == 0
4006 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4007 && (b
!= symbol_block
4008 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4009 && !EQ (((struct Lisp_Symbol
*) p
)->function
, Vdead
));
4016 /* Value is non-zero if P is a pointer to a live Lisp float on
4017 the heap. M is a pointer to the mem_block for P. */
4020 live_float_p (struct mem_node
*m
, void *p
)
4022 if (m
->type
== MEM_TYPE_FLOAT
)
4024 struct float_block
*b
= (struct float_block
*) m
->start
;
4025 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4027 /* P must point to the start of a Lisp_Float and not be
4028 one of the unused cells in the current float block. */
4030 && offset
% sizeof b
->floats
[0] == 0
4031 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4032 && (b
!= float_block
4033 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4040 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4041 the heap. M is a pointer to the mem_block for P. */
4044 live_misc_p (struct mem_node
*m
, void *p
)
4046 if (m
->type
== MEM_TYPE_MISC
)
4048 struct marker_block
*b
= (struct marker_block
*) m
->start
;
4049 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4051 /* P must point to the start of a Lisp_Misc, not be
4052 one of the unused cells in the current misc block,
4053 and not be on the free-list. */
4055 && offset
% sizeof b
->markers
[0] == 0
4056 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4057 && (b
!= marker_block
4058 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4059 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4066 /* Value is non-zero if P is a pointer to a live vector-like object.
4067 M is a pointer to the mem_block for P. */
4070 live_vector_p (struct mem_node
*m
, void *p
)
4072 return (p
== m
->start
&& m
->type
== MEM_TYPE_VECTORLIKE
);
4076 /* Value is non-zero if P is a pointer to a live buffer. M is a
4077 pointer to the mem_block for P. */
4080 live_buffer_p (struct mem_node
*m
, void *p
)
4082 /* P must point to the start of the block, and the buffer
4083 must not have been killed. */
4084 return (m
->type
== MEM_TYPE_BUFFER
4086 && !NILP (((struct buffer
*) p
)->BUFFER_INTERNAL_FIELD (name
)));
4089 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4093 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4095 /* Array of objects that are kept alive because the C stack contains
4096 a pattern that looks like a reference to them . */
4098 #define MAX_ZOMBIES 10
4099 static Lisp_Object zombies
[MAX_ZOMBIES
];
4101 /* Number of zombie objects. */
4103 static EMACS_INT nzombies
;
4105 /* Number of garbage collections. */
4107 static EMACS_INT ngcs
;
4109 /* Average percentage of zombies per collection. */
4111 static double avg_zombies
;
4113 /* Max. number of live and zombie objects. */
4115 static EMACS_INT max_live
, max_zombies
;
4117 /* Average number of live objects per GC. */
4119 static double avg_live
;
4121 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4122 doc
: /* Show information about live and zombie objects. */)
4125 Lisp_Object args
[8], zombie_list
= Qnil
;
4127 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); i
++)
4128 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4129 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4130 args
[1] = make_number (ngcs
);
4131 args
[2] = make_float (avg_live
);
4132 args
[3] = make_float (avg_zombies
);
4133 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4134 args
[5] = make_number (max_live
);
4135 args
[6] = make_number (max_zombies
);
4136 args
[7] = zombie_list
;
4137 return Fmessage (8, args
);
4140 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4143 /* Mark OBJ if we can prove it's a Lisp_Object. */
4146 mark_maybe_object (Lisp_Object obj
)
4154 po
= (void *) XPNTR (obj
);
4161 switch (XTYPE (obj
))
4164 mark_p
= (live_string_p (m
, po
)
4165 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4169 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4173 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4177 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4180 case Lisp_Vectorlike
:
4181 /* Note: can't check BUFFERP before we know it's a
4182 buffer because checking that dereferences the pointer
4183 PO which might point anywhere. */
4184 if (live_vector_p (m
, po
))
4185 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4186 else if (live_buffer_p (m
, po
))
4187 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4191 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4200 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4201 if (nzombies
< MAX_ZOMBIES
)
4202 zombies
[nzombies
] = obj
;
4211 /* If P points to Lisp data, mark that as live if it isn't already
4215 mark_maybe_pointer (void *p
)
4219 /* Quickly rule out some values which can't point to Lisp data. */
4222 8 /* USE_LSB_TAG needs Lisp data to be aligned on multiples of 8. */
4224 2 /* We assume that Lisp data is aligned on even addresses. */
4232 Lisp_Object obj
= Qnil
;
4236 case MEM_TYPE_NON_LISP
:
4237 /* Nothing to do; not a pointer to Lisp memory. */
4240 case MEM_TYPE_BUFFER
:
4241 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4242 XSETVECTOR (obj
, p
);
4246 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4250 case MEM_TYPE_STRING
:
4251 if (live_string_p (m
, p
)
4252 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4253 XSETSTRING (obj
, p
);
4257 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4261 case MEM_TYPE_SYMBOL
:
4262 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4263 XSETSYMBOL (obj
, p
);
4266 case MEM_TYPE_FLOAT
:
4267 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4271 case MEM_TYPE_VECTORLIKE
:
4272 if (live_vector_p (m
, p
))
4275 XSETVECTOR (tem
, p
);
4276 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4291 /* Alignment of pointer values. Use offsetof, as it sometimes returns
4292 a smaller alignment than GCC's __alignof__ and mark_memory might
4293 miss objects if __alignof__ were used. */
4294 #define GC_POINTER_ALIGNMENT offsetof (struct {char a; void *b;}, b)
4296 /* Define POINTERS_MIGHT_HIDE_IN_OBJECTS to 1 if marking via C pointers does
4297 not suffice, which is the typical case. A host where a Lisp_Object is
4298 wider than a pointer might allocate a Lisp_Object in non-adjacent halves.
4299 If USE_LSB_TAG, the bottom half is not a valid pointer, but it should
4300 suffice to widen it to to a Lisp_Object and check it that way. */
4301 #if defined USE_LSB_TAG || VAL_MAX < UINTPTR_MAX
4302 # if !defined USE_LSB_TAG && VAL_MAX < UINTPTR_MAX >> GCTYPEBITS
4303 /* If tag bits straddle pointer-word boundaries, neither mark_maybe_pointer
4304 nor mark_maybe_object can follow the pointers. This should not occur on
4305 any practical porting target. */
4306 # error "MSB type bits straddle pointer-word boundaries"
4308 /* Marking via C pointers does not suffice, because Lisp_Objects contain
4309 pointer words that hold pointers ORed with type bits. */
4310 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 1
4312 /* Marking via C pointers suffices, because Lisp_Objects contain pointer
4313 words that hold unmodified pointers. */
4314 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 0
4317 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4318 or END+OFFSET..START. */
4321 mark_memory (void *start
, void *end
)
4326 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4330 /* Make START the pointer to the start of the memory region,
4331 if it isn't already. */
4339 /* Mark Lisp data pointed to. This is necessary because, in some
4340 situations, the C compiler optimizes Lisp objects away, so that
4341 only a pointer to them remains. Example:
4343 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4346 Lisp_Object obj = build_string ("test");
4347 struct Lisp_String *s = XSTRING (obj);
4348 Fgarbage_collect ();
4349 fprintf (stderr, "test `%s'\n", s->data);
4353 Here, `obj' isn't really used, and the compiler optimizes it
4354 away. The only reference to the life string is through the
4357 for (pp
= start
; (void *) pp
< end
; pp
++)
4358 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4360 void *p
= *(void **) ((char *) pp
+ i
);
4361 mark_maybe_pointer (p
);
4362 if (POINTERS_MIGHT_HIDE_IN_OBJECTS
)
4363 mark_maybe_object (widen_to_Lisp_Object (p
));
4367 /* setjmp will work with GCC unless NON_SAVING_SETJMP is defined in
4368 the GCC system configuration. In gcc 3.2, the only systems for
4369 which this is so are i386-sco5 non-ELF, i386-sysv3 (maybe included
4370 by others?) and ns32k-pc532-min. */
4372 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4374 static int setjmp_tested_p
, longjmps_done
;
4376 #define SETJMP_WILL_LIKELY_WORK "\
4378 Emacs garbage collector has been changed to use conservative stack\n\
4379 marking. Emacs has determined that the method it uses to do the\n\
4380 marking will likely work on your system, but this isn't sure.\n\
4382 If you are a system-programmer, or can get the help of a local wizard\n\
4383 who is, please take a look at the function mark_stack in alloc.c, and\n\
4384 verify that the methods used are appropriate for your system.\n\
4386 Please mail the result to <emacs-devel@gnu.org>.\n\
4389 #define SETJMP_WILL_NOT_WORK "\
4391 Emacs garbage collector has been changed to use conservative stack\n\
4392 marking. Emacs has determined that the default method it uses to do the\n\
4393 marking will not work on your system. We will need a system-dependent\n\
4394 solution for your system.\n\
4396 Please take a look at the function mark_stack in alloc.c, and\n\
4397 try to find a way to make it work on your system.\n\
4399 Note that you may get false negatives, depending on the compiler.\n\
4400 In particular, you need to use -O with GCC for this test.\n\
4402 Please mail the result to <emacs-devel@gnu.org>.\n\
4406 /* Perform a quick check if it looks like setjmp saves registers in a
4407 jmp_buf. Print a message to stderr saying so. When this test
4408 succeeds, this is _not_ a proof that setjmp is sufficient for
4409 conservative stack marking. Only the sources or a disassembly
4420 /* Arrange for X to be put in a register. */
4426 if (longjmps_done
== 1)
4428 /* Came here after the longjmp at the end of the function.
4430 If x == 1, the longjmp has restored the register to its
4431 value before the setjmp, and we can hope that setjmp
4432 saves all such registers in the jmp_buf, although that
4435 For other values of X, either something really strange is
4436 taking place, or the setjmp just didn't save the register. */
4439 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4442 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4449 if (longjmps_done
== 1)
4453 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4456 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4458 /* Abort if anything GCPRO'd doesn't survive the GC. */
4466 for (p
= gcprolist
; p
; p
= p
->next
)
4467 for (i
= 0; i
< p
->nvars
; ++i
)
4468 if (!survives_gc_p (p
->var
[i
]))
4469 /* FIXME: It's not necessarily a bug. It might just be that the
4470 GCPRO is unnecessary or should release the object sooner. */
4474 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4481 fprintf (stderr
, "\nZombies kept alive = %"pI
"d:\n", nzombies
);
4482 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4484 fprintf (stderr
, " %d = ", i
);
4485 debug_print (zombies
[i
]);
4489 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4492 /* Mark live Lisp objects on the C stack.
4494 There are several system-dependent problems to consider when
4495 porting this to new architectures:
4499 We have to mark Lisp objects in CPU registers that can hold local
4500 variables or are used to pass parameters.
4502 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4503 something that either saves relevant registers on the stack, or
4504 calls mark_maybe_object passing it each register's contents.
4506 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4507 implementation assumes that calling setjmp saves registers we need
4508 to see in a jmp_buf which itself lies on the stack. This doesn't
4509 have to be true! It must be verified for each system, possibly
4510 by taking a look at the source code of setjmp.
4512 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4513 can use it as a machine independent method to store all registers
4514 to the stack. In this case the macros described in the previous
4515 two paragraphs are not used.
4519 Architectures differ in the way their processor stack is organized.
4520 For example, the stack might look like this
4523 | Lisp_Object | size = 4
4525 | something else | size = 2
4527 | Lisp_Object | size = 4
4531 In such a case, not every Lisp_Object will be aligned equally. To
4532 find all Lisp_Object on the stack it won't be sufficient to walk
4533 the stack in steps of 4 bytes. Instead, two passes will be
4534 necessary, one starting at the start of the stack, and a second
4535 pass starting at the start of the stack + 2. Likewise, if the
4536 minimal alignment of Lisp_Objects on the stack is 1, four passes
4537 would be necessary, each one starting with one byte more offset
4538 from the stack start. */
4545 #ifdef HAVE___BUILTIN_UNWIND_INIT
4546 /* Force callee-saved registers and register windows onto the stack.
4547 This is the preferred method if available, obviating the need for
4548 machine dependent methods. */
4549 __builtin_unwind_init ();
4551 #else /* not HAVE___BUILTIN_UNWIND_INIT */
4552 #ifndef GC_SAVE_REGISTERS_ON_STACK
4553 /* jmp_buf may not be aligned enough on darwin-ppc64 */
4554 union aligned_jmpbuf
{
4558 volatile int stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4560 /* This trick flushes the register windows so that all the state of
4561 the process is contained in the stack. */
4562 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4563 needed on ia64 too. See mach_dep.c, where it also says inline
4564 assembler doesn't work with relevant proprietary compilers. */
4566 #if defined (__sparc64__) && defined (__FreeBSD__)
4567 /* FreeBSD does not have a ta 3 handler. */
4574 /* Save registers that we need to see on the stack. We need to see
4575 registers used to hold register variables and registers used to
4577 #ifdef GC_SAVE_REGISTERS_ON_STACK
4578 GC_SAVE_REGISTERS_ON_STACK (end
);
4579 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4581 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4582 setjmp will definitely work, test it
4583 and print a message with the result
4585 if (!setjmp_tested_p
)
4587 setjmp_tested_p
= 1;
4590 #endif /* GC_SETJMP_WORKS */
4593 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4594 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4595 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
4597 /* This assumes that the stack is a contiguous region in memory. If
4598 that's not the case, something has to be done here to iterate
4599 over the stack segments. */
4600 mark_memory (stack_base
, end
);
4602 /* Allow for marking a secondary stack, like the register stack on the
4604 #ifdef GC_MARK_SECONDARY_STACK
4605 GC_MARK_SECONDARY_STACK ();
4608 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4613 #endif /* GC_MARK_STACK != 0 */
4616 /* Determine whether it is safe to access memory at address P. */
4618 valid_pointer_p (void *p
)
4621 return w32_valid_pointer_p (p
, 16);
4625 /* Obviously, we cannot just access it (we would SEGV trying), so we
4626 trick the o/s to tell us whether p is a valid pointer.
4627 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4628 not validate p in that case. */
4632 int valid
= (emacs_write (fd
[1], (char *) p
, 16) == 16);
4633 emacs_close (fd
[1]);
4634 emacs_close (fd
[0]);
4642 /* Return 1 if OBJ is a valid lisp object.
4643 Return 0 if OBJ is NOT a valid lisp object.
4644 Return -1 if we cannot validate OBJ.
4645 This function can be quite slow,
4646 so it should only be used in code for manual debugging. */
4649 valid_lisp_object_p (Lisp_Object obj
)
4659 p
= (void *) XPNTR (obj
);
4660 if (PURE_POINTER_P (p
))
4664 return valid_pointer_p (p
);
4671 int valid
= valid_pointer_p (p
);
4683 case MEM_TYPE_NON_LISP
:
4686 case MEM_TYPE_BUFFER
:
4687 return live_buffer_p (m
, p
);
4690 return live_cons_p (m
, p
);
4692 case MEM_TYPE_STRING
:
4693 return live_string_p (m
, p
);
4696 return live_misc_p (m
, p
);
4698 case MEM_TYPE_SYMBOL
:
4699 return live_symbol_p (m
, p
);
4701 case MEM_TYPE_FLOAT
:
4702 return live_float_p (m
, p
);
4704 case MEM_TYPE_VECTORLIKE
:
4705 return live_vector_p (m
, p
);
4718 /***********************************************************************
4719 Pure Storage Management
4720 ***********************************************************************/
4722 /* Allocate room for SIZE bytes from pure Lisp storage and return a
4723 pointer to it. TYPE is the Lisp type for which the memory is
4724 allocated. TYPE < 0 means it's not used for a Lisp object. */
4727 pure_alloc (size_t size
, int type
)
4731 size_t alignment
= (1 << GCTYPEBITS
);
4733 size_t alignment
= sizeof (EMACS_INT
);
4735 /* Give Lisp_Floats an extra alignment. */
4736 if (type
== Lisp_Float
)
4738 #if defined __GNUC__ && __GNUC__ >= 2
4739 alignment
= __alignof (struct Lisp_Float
);
4741 alignment
= sizeof (struct Lisp_Float
);
4749 /* Allocate space for a Lisp object from the beginning of the free
4750 space with taking account of alignment. */
4751 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
4752 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
4756 /* Allocate space for a non-Lisp object from the end of the free
4758 pure_bytes_used_non_lisp
+= size
;
4759 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4761 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
4763 if (pure_bytes_used
<= pure_size
)
4766 /* Don't allocate a large amount here,
4767 because it might get mmap'd and then its address
4768 might not be usable. */
4769 purebeg
= (char *) xmalloc (10000);
4771 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
4772 pure_bytes_used
= 0;
4773 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
4778 /* Print a warning if PURESIZE is too small. */
4781 check_pure_size (void)
4783 if (pure_bytes_used_before_overflow
)
4784 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
4786 pure_bytes_used
+ pure_bytes_used_before_overflow
);
4790 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
4791 the non-Lisp data pool of the pure storage, and return its start
4792 address. Return NULL if not found. */
4795 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
4798 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
4799 const unsigned char *p
;
4802 if (pure_bytes_used_non_lisp
<= nbytes
)
4805 /* Set up the Boyer-Moore table. */
4807 for (i
= 0; i
< 256; i
++)
4810 p
= (const unsigned char *) data
;
4812 bm_skip
[*p
++] = skip
;
4814 last_char_skip
= bm_skip
['\0'];
4816 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4817 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
4819 /* See the comments in the function `boyer_moore' (search.c) for the
4820 use of `infinity'. */
4821 infinity
= pure_bytes_used_non_lisp
+ 1;
4822 bm_skip
['\0'] = infinity
;
4824 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
4828 /* Check the last character (== '\0'). */
4831 start
+= bm_skip
[*(p
+ start
)];
4833 while (start
<= start_max
);
4835 if (start
< infinity
)
4836 /* Couldn't find the last character. */
4839 /* No less than `infinity' means we could find the last
4840 character at `p[start - infinity]'. */
4843 /* Check the remaining characters. */
4844 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
4846 return non_lisp_beg
+ start
;
4848 start
+= last_char_skip
;
4850 while (start
<= start_max
);
4856 /* Return a string allocated in pure space. DATA is a buffer holding
4857 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
4858 non-zero means make the result string multibyte.
4860 Must get an error if pure storage is full, since if it cannot hold
4861 a large string it may be able to hold conses that point to that
4862 string; then the string is not protected from gc. */
4865 make_pure_string (const char *data
,
4866 ptrdiff_t nchars
, ptrdiff_t nbytes
, int multibyte
)
4869 struct Lisp_String
*s
;
4871 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
4872 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
4873 if (s
->data
== NULL
)
4875 s
->data
= (unsigned char *) pure_alloc (nbytes
+ 1, -1);
4876 memcpy (s
->data
, data
, nbytes
);
4877 s
->data
[nbytes
] = '\0';
4880 s
->size_byte
= multibyte
? nbytes
: -1;
4881 s
->intervals
= NULL_INTERVAL
;
4882 XSETSTRING (string
, s
);
4886 /* Return a string a string allocated in pure space. Do not allocate
4887 the string data, just point to DATA. */
4890 make_pure_c_string (const char *data
)
4893 struct Lisp_String
*s
;
4894 ptrdiff_t nchars
= strlen (data
);
4896 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
4899 s
->data
= (unsigned char *) data
;
4900 s
->intervals
= NULL_INTERVAL
;
4901 XSETSTRING (string
, s
);
4905 /* Return a cons allocated from pure space. Give it pure copies
4906 of CAR as car and CDR as cdr. */
4909 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
4911 register Lisp_Object
new;
4912 struct Lisp_Cons
*p
;
4914 p
= (struct Lisp_Cons
*) pure_alloc (sizeof *p
, Lisp_Cons
);
4916 XSETCAR (new, Fpurecopy (car
));
4917 XSETCDR (new, Fpurecopy (cdr
));
4922 /* Value is a float object with value NUM allocated from pure space. */
4925 make_pure_float (double num
)
4927 register Lisp_Object
new;
4928 struct Lisp_Float
*p
;
4930 p
= (struct Lisp_Float
*) pure_alloc (sizeof *p
, Lisp_Float
);
4932 XFLOAT_INIT (new, num
);
4937 /* Return a vector with room for LEN Lisp_Objects allocated from
4941 make_pure_vector (ptrdiff_t len
)
4944 struct Lisp_Vector
*p
;
4945 size_t size
= (offsetof (struct Lisp_Vector
, contents
)
4946 + len
* sizeof (Lisp_Object
));
4948 p
= (struct Lisp_Vector
*) pure_alloc (size
, Lisp_Vectorlike
);
4949 XSETVECTOR (new, p
);
4950 XVECTOR (new)->header
.size
= len
;
4955 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
4956 doc
: /* Make a copy of object OBJ in pure storage.
4957 Recursively copies contents of vectors and cons cells.
4958 Does not copy symbols. Copies strings without text properties. */)
4959 (register Lisp_Object obj
)
4961 if (NILP (Vpurify_flag
))
4964 if (PURE_POINTER_P (XPNTR (obj
)))
4967 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
4969 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
4975 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
4976 else if (FLOATP (obj
))
4977 obj
= make_pure_float (XFLOAT_DATA (obj
));
4978 else if (STRINGP (obj
))
4979 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
4981 STRING_MULTIBYTE (obj
));
4982 else if (COMPILEDP (obj
) || VECTORP (obj
))
4984 register struct Lisp_Vector
*vec
;
4985 register ptrdiff_t i
;
4989 if (size
& PSEUDOVECTOR_FLAG
)
4990 size
&= PSEUDOVECTOR_SIZE_MASK
;
4991 vec
= XVECTOR (make_pure_vector (size
));
4992 for (i
= 0; i
< size
; i
++)
4993 vec
->contents
[i
] = Fpurecopy (XVECTOR (obj
)->contents
[i
]);
4994 if (COMPILEDP (obj
))
4996 XSETPVECTYPE (vec
, PVEC_COMPILED
);
4997 XSETCOMPILED (obj
, vec
);
5000 XSETVECTOR (obj
, vec
);
5002 else if (MARKERP (obj
))
5003 error ("Attempt to copy a marker to pure storage");
5005 /* Not purified, don't hash-cons. */
5008 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5009 Fputhash (obj
, obj
, Vpurify_flag
);
5016 /***********************************************************************
5018 ***********************************************************************/
5020 /* Put an entry in staticvec, pointing at the variable with address
5024 staticpro (Lisp_Object
*varaddress
)
5026 staticvec
[staticidx
++] = varaddress
;
5027 if (staticidx
>= NSTATICS
)
5032 /***********************************************************************
5034 ***********************************************************************/
5036 /* Temporarily prevent garbage collection. */
5039 inhibit_garbage_collection (void)
5041 ptrdiff_t count
= SPECPDL_INDEX ();
5043 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5048 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5049 doc
: /* Reclaim storage for Lisp objects no longer needed.
5050 Garbage collection happens automatically if you cons more than
5051 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5052 `garbage-collect' normally returns a list with info on amount of space in use:
5053 ((USED-CONSES . FREE-CONSES) (USED-SYMS . FREE-SYMS)
5054 (USED-MISCS . FREE-MISCS) USED-STRING-CHARS USED-VECTOR-SLOTS
5055 (USED-FLOATS . FREE-FLOATS) (USED-INTERVALS . FREE-INTERVALS)
5056 (USED-STRINGS . FREE-STRINGS))
5057 However, if there was overflow in pure space, `garbage-collect'
5058 returns nil, because real GC can't be done.
5059 See Info node `(elisp)Garbage Collection'. */)
5062 register struct specbinding
*bind
;
5063 char stack_top_variable
;
5066 Lisp_Object total
[8];
5067 ptrdiff_t count
= SPECPDL_INDEX ();
5068 EMACS_TIME t1
, t2
, t3
;
5073 /* Can't GC if pure storage overflowed because we can't determine
5074 if something is a pure object or not. */
5075 if (pure_bytes_used_before_overflow
)
5080 /* Don't keep undo information around forever.
5081 Do this early on, so it is no problem if the user quits. */
5083 register struct buffer
*nextb
= all_buffers
;
5087 /* If a buffer's undo list is Qt, that means that undo is
5088 turned off in that buffer. Calling truncate_undo_list on
5089 Qt tends to return NULL, which effectively turns undo back on.
5090 So don't call truncate_undo_list if undo_list is Qt. */
5091 if (! NILP (nextb
->BUFFER_INTERNAL_FIELD (name
)) && ! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
5092 truncate_undo_list (nextb
);
5094 /* Shrink buffer gaps, but skip indirect and dead buffers. */
5095 if (nextb
->base_buffer
== 0 && !NILP (nextb
->BUFFER_INTERNAL_FIELD (name
))
5096 && ! nextb
->text
->inhibit_shrinking
)
5098 /* If a buffer's gap size is more than 10% of the buffer
5099 size, or larger than 2000 bytes, then shrink it
5100 accordingly. Keep a minimum size of 20 bytes. */
5101 int size
= min (2000, max (20, (nextb
->text
->z_byte
/ 10)));
5103 if (nextb
->text
->gap_size
> size
)
5105 struct buffer
*save_current
= current_buffer
;
5106 current_buffer
= nextb
;
5107 make_gap (-(nextb
->text
->gap_size
- size
));
5108 current_buffer
= save_current
;
5112 nextb
= nextb
->header
.next
.buffer
;
5116 EMACS_GET_TIME (t1
);
5118 /* In case user calls debug_print during GC,
5119 don't let that cause a recursive GC. */
5120 consing_since_gc
= 0;
5122 /* Save what's currently displayed in the echo area. */
5123 message_p
= push_message ();
5124 record_unwind_protect (pop_message_unwind
, Qnil
);
5126 /* Save a copy of the contents of the stack, for debugging. */
5127 #if MAX_SAVE_STACK > 0
5128 if (NILP (Vpurify_flag
))
5131 ptrdiff_t stack_size
;
5132 if (&stack_top_variable
< stack_bottom
)
5134 stack
= &stack_top_variable
;
5135 stack_size
= stack_bottom
- &stack_top_variable
;
5139 stack
= stack_bottom
;
5140 stack_size
= &stack_top_variable
- stack_bottom
;
5142 if (stack_size
<= MAX_SAVE_STACK
)
5144 if (stack_copy_size
< stack_size
)
5146 stack_copy
= (char *) xrealloc (stack_copy
, stack_size
);
5147 stack_copy_size
= stack_size
;
5149 memcpy (stack_copy
, stack
, stack_size
);
5152 #endif /* MAX_SAVE_STACK > 0 */
5154 if (garbage_collection_messages
)
5155 message1_nolog ("Garbage collecting...");
5159 shrink_regexp_cache ();
5163 /* clear_marks (); */
5165 /* Mark all the special slots that serve as the roots of accessibility. */
5167 for (i
= 0; i
< staticidx
; i
++)
5168 mark_object (*staticvec
[i
]);
5170 for (bind
= specpdl
; bind
!= specpdl_ptr
; bind
++)
5172 mark_object (bind
->symbol
);
5173 mark_object (bind
->old_value
);
5181 extern void xg_mark_data (void);
5186 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5187 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5191 register struct gcpro
*tail
;
5192 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5193 for (i
= 0; i
< tail
->nvars
; i
++)
5194 mark_object (tail
->var
[i
]);
5198 struct catchtag
*catch;
5199 struct handler
*handler
;
5201 for (catch = catchlist
; catch; catch = catch->next
)
5203 mark_object (catch->tag
);
5204 mark_object (catch->val
);
5206 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5208 mark_object (handler
->handler
);
5209 mark_object (handler
->var
);
5215 #ifdef HAVE_WINDOW_SYSTEM
5216 mark_fringe_data ();
5219 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5223 /* Everything is now marked, except for the things that require special
5224 finalization, i.e. the undo_list.
5225 Look thru every buffer's undo list
5226 for elements that update markers that were not marked,
5229 register struct buffer
*nextb
= all_buffers
;
5233 /* If a buffer's undo list is Qt, that means that undo is
5234 turned off in that buffer. Calling truncate_undo_list on
5235 Qt tends to return NULL, which effectively turns undo back on.
5236 So don't call truncate_undo_list if undo_list is Qt. */
5237 if (! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
5239 Lisp_Object tail
, prev
;
5240 tail
= nextb
->BUFFER_INTERNAL_FIELD (undo_list
);
5242 while (CONSP (tail
))
5244 if (CONSP (XCAR (tail
))
5245 && MARKERP (XCAR (XCAR (tail
)))
5246 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5249 nextb
->BUFFER_INTERNAL_FIELD (undo_list
) = tail
= XCDR (tail
);
5253 XSETCDR (prev
, tail
);
5263 /* Now that we have stripped the elements that need not be in the
5264 undo_list any more, we can finally mark the list. */
5265 mark_object (nextb
->BUFFER_INTERNAL_FIELD (undo_list
));
5267 nextb
= nextb
->header
.next
.buffer
;
5273 /* Clear the mark bits that we set in certain root slots. */
5275 unmark_byte_stack ();
5276 VECTOR_UNMARK (&buffer_defaults
);
5277 VECTOR_UNMARK (&buffer_local_symbols
);
5279 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5287 /* clear_marks (); */
5290 consing_since_gc
= 0;
5291 if (gc_cons_threshold
< 10000)
5292 gc_cons_threshold
= 10000;
5294 gc_relative_threshold
= 0;
5295 if (FLOATP (Vgc_cons_percentage
))
5296 { /* Set gc_cons_combined_threshold. */
5299 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5300 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5301 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5302 tot
+= total_string_size
;
5303 tot
+= total_vector_size
* sizeof (Lisp_Object
);
5304 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5305 tot
+= total_intervals
* sizeof (struct interval
);
5306 tot
+= total_strings
* sizeof (struct Lisp_String
);
5308 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5311 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5312 gc_relative_threshold
= tot
;
5314 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5318 if (garbage_collection_messages
)
5320 if (message_p
|| minibuf_level
> 0)
5323 message1_nolog ("Garbage collecting...done");
5326 unbind_to (count
, Qnil
);
5328 total
[0] = Fcons (make_number (total_conses
),
5329 make_number (total_free_conses
));
5330 total
[1] = Fcons (make_number (total_symbols
),
5331 make_number (total_free_symbols
));
5332 total
[2] = Fcons (make_number (total_markers
),
5333 make_number (total_free_markers
));
5334 total
[3] = make_number (total_string_size
);
5335 total
[4] = make_number (total_vector_size
);
5336 total
[5] = Fcons (make_number (total_floats
),
5337 make_number (total_free_floats
));
5338 total
[6] = Fcons (make_number (total_intervals
),
5339 make_number (total_free_intervals
));
5340 total
[7] = Fcons (make_number (total_strings
),
5341 make_number (total_free_strings
));
5343 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5345 /* Compute average percentage of zombies. */
5348 for (i
= 0; i
< 7; ++i
)
5349 if (CONSP (total
[i
]))
5350 nlive
+= XFASTINT (XCAR (total
[i
]));
5352 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5353 max_live
= max (nlive
, max_live
);
5354 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5355 max_zombies
= max (nzombies
, max_zombies
);
5360 if (!NILP (Vpost_gc_hook
))
5362 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5363 safe_run_hooks (Qpost_gc_hook
);
5364 unbind_to (gc_count
, Qnil
);
5367 /* Accumulate statistics. */
5368 EMACS_GET_TIME (t2
);
5369 EMACS_SUB_TIME (t3
, t2
, t1
);
5370 if (FLOATP (Vgc_elapsed
))
5371 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
) +
5373 EMACS_USECS (t3
) * 1.0e-6);
5376 return Flist (sizeof total
/ sizeof *total
, total
);
5380 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5381 only interesting objects referenced from glyphs are strings. */
5384 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5386 struct glyph_row
*row
= matrix
->rows
;
5387 struct glyph_row
*end
= row
+ matrix
->nrows
;
5389 for (; row
< end
; ++row
)
5393 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5395 struct glyph
*glyph
= row
->glyphs
[area
];
5396 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5398 for (; glyph
< end_glyph
; ++glyph
)
5399 if (STRINGP (glyph
->object
)
5400 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5401 mark_object (glyph
->object
);
5407 /* Mark Lisp faces in the face cache C. */
5410 mark_face_cache (struct face_cache
*c
)
5415 for (i
= 0; i
< c
->used
; ++i
)
5417 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5421 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5422 mark_object (face
->lface
[j
]);
5430 /* Mark reference to a Lisp_Object.
5431 If the object referred to has not been seen yet, recursively mark
5432 all the references contained in it. */
5434 #define LAST_MARKED_SIZE 500
5435 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5436 static int last_marked_index
;
5438 /* For debugging--call abort when we cdr down this many
5439 links of a list, in mark_object. In debugging,
5440 the call to abort will hit a breakpoint.
5441 Normally this is zero and the check never goes off. */
5442 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5445 mark_vectorlike (struct Lisp_Vector
*ptr
)
5447 ptrdiff_t size
= ptr
->header
.size
;
5450 eassert (!VECTOR_MARKED_P (ptr
));
5451 VECTOR_MARK (ptr
); /* Else mark it */
5452 if (size
& PSEUDOVECTOR_FLAG
)
5453 size
&= PSEUDOVECTOR_SIZE_MASK
;
5455 /* Note that this size is not the memory-footprint size, but only
5456 the number of Lisp_Object fields that we should trace.
5457 The distinction is used e.g. by Lisp_Process which places extra
5458 non-Lisp_Object fields at the end of the structure. */
5459 for (i
= 0; i
< size
; i
++) /* and then mark its elements */
5460 mark_object (ptr
->contents
[i
]);
5463 /* Like mark_vectorlike but optimized for char-tables (and
5464 sub-char-tables) assuming that the contents are mostly integers or
5468 mark_char_table (struct Lisp_Vector
*ptr
)
5470 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5473 eassert (!VECTOR_MARKED_P (ptr
));
5475 for (i
= 0; i
< size
; i
++)
5477 Lisp_Object val
= ptr
->contents
[i
];
5479 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5481 if (SUB_CHAR_TABLE_P (val
))
5483 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5484 mark_char_table (XVECTOR (val
));
5492 mark_object (Lisp_Object arg
)
5494 register Lisp_Object obj
= arg
;
5495 #ifdef GC_CHECK_MARKED_OBJECTS
5499 ptrdiff_t cdr_count
= 0;
5503 if (PURE_POINTER_P (XPNTR (obj
)))
5506 last_marked
[last_marked_index
++] = obj
;
5507 if (last_marked_index
== LAST_MARKED_SIZE
)
5508 last_marked_index
= 0;
5510 /* Perform some sanity checks on the objects marked here. Abort if
5511 we encounter an object we know is bogus. This increases GC time
5512 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5513 #ifdef GC_CHECK_MARKED_OBJECTS
5515 po
= (void *) XPNTR (obj
);
5517 /* Check that the object pointed to by PO is known to be a Lisp
5518 structure allocated from the heap. */
5519 #define CHECK_ALLOCATED() \
5521 m = mem_find (po); \
5526 /* Check that the object pointed to by PO is live, using predicate
5528 #define CHECK_LIVE(LIVEP) \
5530 if (!LIVEP (m, po)) \
5534 /* Check both of the above conditions. */
5535 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5537 CHECK_ALLOCATED (); \
5538 CHECK_LIVE (LIVEP); \
5541 #else /* not GC_CHECK_MARKED_OBJECTS */
5543 #define CHECK_LIVE(LIVEP) (void) 0
5544 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5546 #endif /* not GC_CHECK_MARKED_OBJECTS */
5548 switch (SWITCH_ENUM_CAST (XTYPE (obj
)))
5552 register struct Lisp_String
*ptr
= XSTRING (obj
);
5553 if (STRING_MARKED_P (ptr
))
5555 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
5556 MARK_INTERVAL_TREE (ptr
->intervals
);
5558 #ifdef GC_CHECK_STRING_BYTES
5559 /* Check that the string size recorded in the string is the
5560 same as the one recorded in the sdata structure. */
5561 CHECK_STRING_BYTES (ptr
);
5562 #endif /* GC_CHECK_STRING_BYTES */
5566 case Lisp_Vectorlike
:
5567 if (VECTOR_MARKED_P (XVECTOR (obj
)))
5569 #ifdef GC_CHECK_MARKED_OBJECTS
5571 if (m
== MEM_NIL
&& !SUBRP (obj
)
5572 && po
!= &buffer_defaults
5573 && po
!= &buffer_local_symbols
)
5575 #endif /* GC_CHECK_MARKED_OBJECTS */
5579 #ifdef GC_CHECK_MARKED_OBJECTS
5580 if (po
!= &buffer_defaults
&& po
!= &buffer_local_symbols
)
5583 for (b
= all_buffers
; b
&& b
!= po
; b
= b
->header
.next
.buffer
)
5588 #endif /* GC_CHECK_MARKED_OBJECTS */
5591 else if (SUBRP (obj
))
5593 else if (COMPILEDP (obj
))
5594 /* We could treat this just like a vector, but it is better to
5595 save the COMPILED_CONSTANTS element for last and avoid
5598 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5599 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5602 CHECK_LIVE (live_vector_p
);
5603 VECTOR_MARK (ptr
); /* Else mark it */
5604 for (i
= 0; i
< size
; i
++) /* and then mark its elements */
5606 if (i
!= COMPILED_CONSTANTS
)
5607 mark_object (ptr
->contents
[i
]);
5609 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
5612 else if (FRAMEP (obj
))
5614 register struct frame
*ptr
= XFRAME (obj
);
5615 mark_vectorlike (XVECTOR (obj
));
5616 mark_face_cache (ptr
->face_cache
);
5618 else if (WINDOWP (obj
))
5620 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5621 struct window
*w
= XWINDOW (obj
);
5622 mark_vectorlike (ptr
);
5623 /* Mark glyphs for leaf windows. Marking window matrices is
5624 sufficient because frame matrices use the same glyph
5626 if (NILP (w
->hchild
)
5628 && w
->current_matrix
)
5630 mark_glyph_matrix (w
->current_matrix
);
5631 mark_glyph_matrix (w
->desired_matrix
);
5634 else if (HASH_TABLE_P (obj
))
5636 struct Lisp_Hash_Table
*h
= XHASH_TABLE (obj
);
5637 mark_vectorlike ((struct Lisp_Vector
*)h
);
5638 /* If hash table is not weak, mark all keys and values.
5639 For weak tables, mark only the vector. */
5641 mark_object (h
->key_and_value
);
5643 VECTOR_MARK (XVECTOR (h
->key_and_value
));
5645 else if (CHAR_TABLE_P (obj
))
5646 mark_char_table (XVECTOR (obj
));
5648 mark_vectorlike (XVECTOR (obj
));
5653 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
5654 struct Lisp_Symbol
*ptrx
;
5658 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
5660 mark_object (ptr
->function
);
5661 mark_object (ptr
->plist
);
5662 switch (ptr
->redirect
)
5664 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
5665 case SYMBOL_VARALIAS
:
5668 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
5672 case SYMBOL_LOCALIZED
:
5674 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
5675 /* If the value is forwarded to a buffer or keyboard field,
5676 these are marked when we see the corresponding object.
5677 And if it's forwarded to a C variable, either it's not
5678 a Lisp_Object var, or it's staticpro'd already. */
5679 mark_object (blv
->where
);
5680 mark_object (blv
->valcell
);
5681 mark_object (blv
->defcell
);
5684 case SYMBOL_FORWARDED
:
5685 /* If the value is forwarded to a buffer or keyboard field,
5686 these are marked when we see the corresponding object.
5687 And if it's forwarded to a C variable, either it's not
5688 a Lisp_Object var, or it's staticpro'd already. */
5692 if (!PURE_POINTER_P (XSTRING (ptr
->xname
)))
5693 MARK_STRING (XSTRING (ptr
->xname
));
5694 MARK_INTERVAL_TREE (STRING_INTERVALS (ptr
->xname
));
5699 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun */
5700 XSETSYMBOL (obj
, ptrx
);
5707 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
5708 if (XMISCANY (obj
)->gcmarkbit
)
5710 XMISCANY (obj
)->gcmarkbit
= 1;
5712 switch (XMISCTYPE (obj
))
5715 case Lisp_Misc_Marker
:
5716 /* DO NOT mark thru the marker's chain.
5717 The buffer's markers chain does not preserve markers from gc;
5718 instead, markers are removed from the chain when freed by gc. */
5721 case Lisp_Misc_Save_Value
:
5724 register struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
5725 /* If DOGC is set, POINTER is the address of a memory
5726 area containing INTEGER potential Lisp_Objects. */
5729 Lisp_Object
*p
= (Lisp_Object
*) ptr
->pointer
;
5731 for (nelt
= ptr
->integer
; nelt
> 0; nelt
--, p
++)
5732 mark_maybe_object (*p
);
5738 case Lisp_Misc_Overlay
:
5740 struct Lisp_Overlay
*ptr
= XOVERLAY (obj
);
5741 mark_object (ptr
->start
);
5742 mark_object (ptr
->end
);
5743 mark_object (ptr
->plist
);
5746 XSETMISC (obj
, ptr
->next
);
5759 register struct Lisp_Cons
*ptr
= XCONS (obj
);
5760 if (CONS_MARKED_P (ptr
))
5762 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
5764 /* If the cdr is nil, avoid recursion for the car. */
5765 if (EQ (ptr
->u
.cdr
, Qnil
))
5771 mark_object (ptr
->car
);
5774 if (cdr_count
== mark_object_loop_halt
)
5780 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
5781 FLOAT_MARK (XFLOAT (obj
));
5792 #undef CHECK_ALLOCATED
5793 #undef CHECK_ALLOCATED_AND_LIVE
5796 /* Mark the pointers in a buffer structure. */
5799 mark_buffer (Lisp_Object buf
)
5801 register struct buffer
*buffer
= XBUFFER (buf
);
5802 register Lisp_Object
*ptr
, tmp
;
5803 Lisp_Object base_buffer
;
5805 eassert (!VECTOR_MARKED_P (buffer
));
5806 VECTOR_MARK (buffer
);
5808 MARK_INTERVAL_TREE (BUF_INTERVALS (buffer
));
5810 /* For now, we just don't mark the undo_list. It's done later in
5811 a special way just before the sweep phase, and after stripping
5812 some of its elements that are not needed any more. */
5814 if (buffer
->overlays_before
)
5816 XSETMISC (tmp
, buffer
->overlays_before
);
5819 if (buffer
->overlays_after
)
5821 XSETMISC (tmp
, buffer
->overlays_after
);
5825 /* buffer-local Lisp variables start at `undo_list',
5826 tho only the ones from `name' on are GC'd normally. */
5827 for (ptr
= &buffer
->BUFFER_INTERNAL_FIELD (name
);
5828 ptr
<= &PER_BUFFER_VALUE (buffer
,
5829 PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER
));
5833 /* If this is an indirect buffer, mark its base buffer. */
5834 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5836 XSETBUFFER (base_buffer
, buffer
->base_buffer
);
5837 mark_buffer (base_buffer
);
5841 /* Mark the Lisp pointers in the terminal objects.
5842 Called by Fgarbage_collect. */
5845 mark_terminals (void)
5848 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5850 eassert (t
->name
!= NULL
);
5851 #ifdef HAVE_WINDOW_SYSTEM
5852 /* If a terminal object is reachable from a stacpro'ed object,
5853 it might have been marked already. Make sure the image cache
5855 mark_image_cache (t
->image_cache
);
5856 #endif /* HAVE_WINDOW_SYSTEM */
5857 if (!VECTOR_MARKED_P (t
))
5858 mark_vectorlike ((struct Lisp_Vector
*)t
);
5864 /* Value is non-zero if OBJ will survive the current GC because it's
5865 either marked or does not need to be marked to survive. */
5868 survives_gc_p (Lisp_Object obj
)
5872 switch (XTYPE (obj
))
5879 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
5883 survives_p
= XMISCANY (obj
)->gcmarkbit
;
5887 survives_p
= STRING_MARKED_P (XSTRING (obj
));
5890 case Lisp_Vectorlike
:
5891 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
5895 survives_p
= CONS_MARKED_P (XCONS (obj
));
5899 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
5906 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
5911 /* Sweep: find all structures not marked, and free them. */
5916 /* Remove or mark entries in weak hash tables.
5917 This must be done before any object is unmarked. */
5918 sweep_weak_hash_tables ();
5921 #ifdef GC_CHECK_STRING_BYTES
5922 if (!noninteractive
)
5923 check_string_bytes (1);
5926 /* Put all unmarked conses on free list */
5928 register struct cons_block
*cblk
;
5929 struct cons_block
**cprev
= &cons_block
;
5930 register int lim
= cons_block_index
;
5931 EMACS_INT num_free
= 0, num_used
= 0;
5935 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
5939 int ilim
= (lim
+ BITS_PER_INT
- 1) / BITS_PER_INT
;
5941 /* Scan the mark bits an int at a time. */
5942 for (i
= 0; i
< ilim
; i
++)
5944 if (cblk
->gcmarkbits
[i
] == -1)
5946 /* Fast path - all cons cells for this int are marked. */
5947 cblk
->gcmarkbits
[i
] = 0;
5948 num_used
+= BITS_PER_INT
;
5952 /* Some cons cells for this int are not marked.
5953 Find which ones, and free them. */
5954 int start
, pos
, stop
;
5956 start
= i
* BITS_PER_INT
;
5958 if (stop
> BITS_PER_INT
)
5959 stop
= BITS_PER_INT
;
5962 for (pos
= start
; pos
< stop
; pos
++)
5964 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
5967 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
5968 cons_free_list
= &cblk
->conses
[pos
];
5970 cons_free_list
->car
= Vdead
;
5976 CONS_UNMARK (&cblk
->conses
[pos
]);
5982 lim
= CONS_BLOCK_SIZE
;
5983 /* If this block contains only free conses and we have already
5984 seen more than two blocks worth of free conses then deallocate
5986 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
5988 *cprev
= cblk
->next
;
5989 /* Unhook from the free list. */
5990 cons_free_list
= cblk
->conses
[0].u
.chain
;
5991 lisp_align_free (cblk
);
5995 num_free
+= this_free
;
5996 cprev
= &cblk
->next
;
5999 total_conses
= num_used
;
6000 total_free_conses
= num_free
;
6003 /* Put all unmarked floats on free list */
6005 register struct float_block
*fblk
;
6006 struct float_block
**fprev
= &float_block
;
6007 register int lim
= float_block_index
;
6008 EMACS_INT num_free
= 0, num_used
= 0;
6010 float_free_list
= 0;
6012 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6016 for (i
= 0; i
< lim
; i
++)
6017 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6020 fblk
->floats
[i
].u
.chain
= float_free_list
;
6021 float_free_list
= &fblk
->floats
[i
];
6026 FLOAT_UNMARK (&fblk
->floats
[i
]);
6028 lim
= FLOAT_BLOCK_SIZE
;
6029 /* If this block contains only free floats and we have already
6030 seen more than two blocks worth of free floats then deallocate
6032 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6034 *fprev
= fblk
->next
;
6035 /* Unhook from the free list. */
6036 float_free_list
= fblk
->floats
[0].u
.chain
;
6037 lisp_align_free (fblk
);
6041 num_free
+= this_free
;
6042 fprev
= &fblk
->next
;
6045 total_floats
= num_used
;
6046 total_free_floats
= num_free
;
6049 /* Put all unmarked intervals on free list */
6051 register struct interval_block
*iblk
;
6052 struct interval_block
**iprev
= &interval_block
;
6053 register int lim
= interval_block_index
;
6054 EMACS_INT num_free
= 0, num_used
= 0;
6056 interval_free_list
= 0;
6058 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6063 for (i
= 0; i
< lim
; i
++)
6065 if (!iblk
->intervals
[i
].gcmarkbit
)
6067 SET_INTERVAL_PARENT (&iblk
->intervals
[i
], interval_free_list
);
6068 interval_free_list
= &iblk
->intervals
[i
];
6074 iblk
->intervals
[i
].gcmarkbit
= 0;
6077 lim
= INTERVAL_BLOCK_SIZE
;
6078 /* If this block contains only free intervals and we have already
6079 seen more than two blocks worth of free intervals then
6080 deallocate this block. */
6081 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6083 *iprev
= iblk
->next
;
6084 /* Unhook from the free list. */
6085 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6090 num_free
+= this_free
;
6091 iprev
= &iblk
->next
;
6094 total_intervals
= num_used
;
6095 total_free_intervals
= num_free
;
6098 /* Put all unmarked symbols on free list */
6100 register struct symbol_block
*sblk
;
6101 struct symbol_block
**sprev
= &symbol_block
;
6102 register int lim
= symbol_block_index
;
6103 EMACS_INT num_free
= 0, num_used
= 0;
6105 symbol_free_list
= NULL
;
6107 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6110 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6111 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6113 for (; sym
< end
; ++sym
)
6115 /* Check if the symbol was created during loadup. In such a case
6116 it might be pointed to by pure bytecode which we don't trace,
6117 so we conservatively assume that it is live. */
6118 int pure_p
= PURE_POINTER_P (XSTRING (sym
->s
.xname
));
6120 if (!sym
->s
.gcmarkbit
&& !pure_p
)
6122 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6123 xfree (SYMBOL_BLV (&sym
->s
));
6124 sym
->s
.next
= symbol_free_list
;
6125 symbol_free_list
= &sym
->s
;
6127 symbol_free_list
->function
= Vdead
;
6135 UNMARK_STRING (XSTRING (sym
->s
.xname
));
6136 sym
->s
.gcmarkbit
= 0;
6140 lim
= SYMBOL_BLOCK_SIZE
;
6141 /* If this block contains only free symbols and we have already
6142 seen more than two blocks worth of free symbols then deallocate
6144 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6146 *sprev
= sblk
->next
;
6147 /* Unhook from the free list. */
6148 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6153 num_free
+= this_free
;
6154 sprev
= &sblk
->next
;
6157 total_symbols
= num_used
;
6158 total_free_symbols
= num_free
;
6161 /* Put all unmarked misc's on free list.
6162 For a marker, first unchain it from the buffer it points into. */
6164 register struct marker_block
*mblk
;
6165 struct marker_block
**mprev
= &marker_block
;
6166 register int lim
= marker_block_index
;
6167 EMACS_INT num_free
= 0, num_used
= 0;
6169 marker_free_list
= 0;
6171 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6176 for (i
= 0; i
< lim
; i
++)
6178 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6180 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6181 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6182 /* Set the type of the freed object to Lisp_Misc_Free.
6183 We could leave the type alone, since nobody checks it,
6184 but this might catch bugs faster. */
6185 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6186 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6187 marker_free_list
= &mblk
->markers
[i
].m
;
6193 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6196 lim
= MARKER_BLOCK_SIZE
;
6197 /* If this block contains only free markers and we have already
6198 seen more than two blocks worth of free markers then deallocate
6200 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6202 *mprev
= mblk
->next
;
6203 /* Unhook from the free list. */
6204 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6209 num_free
+= this_free
;
6210 mprev
= &mblk
->next
;
6214 total_markers
= num_used
;
6215 total_free_markers
= num_free
;
6218 /* Free all unmarked buffers */
6220 register struct buffer
*buffer
= all_buffers
, *prev
= 0, *next
;
6223 if (!VECTOR_MARKED_P (buffer
))
6226 prev
->header
.next
= buffer
->header
.next
;
6228 all_buffers
= buffer
->header
.next
.buffer
;
6229 next
= buffer
->header
.next
.buffer
;
6235 VECTOR_UNMARK (buffer
);
6236 UNMARK_BALANCE_INTERVALS (BUF_INTERVALS (buffer
));
6237 prev
= buffer
, buffer
= buffer
->header
.next
.buffer
;
6241 /* Free all unmarked vectors */
6243 register struct Lisp_Vector
*vector
= all_vectors
, *prev
= 0, *next
;
6244 total_vector_size
= 0;
6247 if (!VECTOR_MARKED_P (vector
))
6250 prev
->header
.next
= vector
->header
.next
;
6252 all_vectors
= vector
->header
.next
.vector
;
6253 next
= vector
->header
.next
.vector
;
6260 VECTOR_UNMARK (vector
);
6261 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
6262 total_vector_size
+= PSEUDOVECTOR_SIZE_MASK
& vector
->header
.size
;
6264 total_vector_size
+= vector
->header
.size
;
6265 prev
= vector
, vector
= vector
->header
.next
.vector
;
6269 #ifdef GC_CHECK_STRING_BYTES
6270 if (!noninteractive
)
6271 check_string_bytes (1);
6278 /* Debugging aids. */
6280 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6281 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6282 This may be helpful in debugging Emacs's memory usage.
6283 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6288 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6293 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6294 doc
: /* Return a list of counters that measure how much consing there has been.
6295 Each of these counters increments for a certain kind of object.
6296 The counters wrap around from the largest positive integer to zero.
6297 Garbage collection does not decrease them.
6298 The elements of the value are as follows:
6299 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6300 All are in units of 1 = one object consed
6301 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6303 MISCS include overlays, markers, and some internal types.
6304 Frames, windows, buffers, and subprocesses count as vectors
6305 (but the contents of a buffer's text do not count here). */)
6308 Lisp_Object consed
[8];
6310 consed
[0] = make_number (min (MOST_POSITIVE_FIXNUM
, cons_cells_consed
));
6311 consed
[1] = make_number (min (MOST_POSITIVE_FIXNUM
, floats_consed
));
6312 consed
[2] = make_number (min (MOST_POSITIVE_FIXNUM
, vector_cells_consed
));
6313 consed
[3] = make_number (min (MOST_POSITIVE_FIXNUM
, symbols_consed
));
6314 consed
[4] = make_number (min (MOST_POSITIVE_FIXNUM
, string_chars_consed
));
6315 consed
[5] = make_number (min (MOST_POSITIVE_FIXNUM
, misc_objects_consed
));
6316 consed
[6] = make_number (min (MOST_POSITIVE_FIXNUM
, intervals_consed
));
6317 consed
[7] = make_number (min (MOST_POSITIVE_FIXNUM
, strings_consed
));
6319 return Flist (8, consed
);
6322 /* Find at most FIND_MAX symbols which have OBJ as their value or
6323 function. This is used in gdbinit's `xwhichsymbols' command. */
6326 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6328 struct symbol_block
*sblk
;
6329 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6330 Lisp_Object found
= Qnil
;
6334 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6336 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
6339 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
6341 struct Lisp_Symbol
*sym
= &aligned_sym
->s
;
6345 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6348 XSETSYMBOL (tem
, sym
);
6349 val
= find_symbol_value (tem
);
6351 || EQ (sym
->function
, obj
)
6352 || (!NILP (sym
->function
)
6353 && COMPILEDP (sym
->function
)
6354 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
6357 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)))
6359 found
= Fcons (tem
, found
);
6360 if (--find_max
== 0)
6368 unbind_to (gc_count
, Qnil
);
6372 #ifdef ENABLE_CHECKING
6373 int suppress_checking
;
6376 die (const char *msg
, const char *file
, int line
)
6378 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: %s\r\n",
6384 /* Initialization */
6387 init_alloc_once (void)
6389 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6391 pure_size
= PURESIZE
;
6392 pure_bytes_used
= 0;
6393 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
6394 pure_bytes_used_before_overflow
= 0;
6396 /* Initialize the list of free aligned blocks. */
6399 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6401 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6405 ignore_warnings
= 1;
6406 #ifdef DOUG_LEA_MALLOC
6407 mallopt (M_TRIM_THRESHOLD
, 128*1024); /* trim threshold */
6408 mallopt (M_MMAP_THRESHOLD
, 64*1024); /* mmap threshold */
6409 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* max. number of mmap'ed areas */
6417 init_weak_hash_tables ();
6420 malloc_hysteresis
= 32;
6422 malloc_hysteresis
= 0;
6425 refill_memory_reserve ();
6427 ignore_warnings
= 0;
6429 byte_stack_list
= 0;
6431 consing_since_gc
= 0;
6432 gc_cons_threshold
= 100000 * sizeof (Lisp_Object
);
6433 gc_relative_threshold
= 0;
6440 byte_stack_list
= 0;
6442 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6443 setjmp_tested_p
= longjmps_done
= 0;
6446 Vgc_elapsed
= make_float (0.0);
6451 syms_of_alloc (void)
6453 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6454 doc
: /* Number of bytes of consing between garbage collections.
6455 Garbage collection can happen automatically once this many bytes have been
6456 allocated since the last garbage collection. All data types count.
6458 Garbage collection happens automatically only when `eval' is called.
6460 By binding this temporarily to a large number, you can effectively
6461 prevent garbage collection during a part of the program.
6462 See also `gc-cons-percentage'. */);
6464 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6465 doc
: /* Portion of the heap used for allocation.
6466 Garbage collection can happen automatically once this portion of the heap
6467 has been allocated since the last garbage collection.
6468 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6469 Vgc_cons_percentage
= make_float (0.1);
6471 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6472 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
6474 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6475 doc
: /* Number of cons cells that have been consed so far. */);
6477 DEFVAR_INT ("floats-consed", floats_consed
,
6478 doc
: /* Number of floats that have been consed so far. */);
6480 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
6481 doc
: /* Number of vector cells that have been consed so far. */);
6483 DEFVAR_INT ("symbols-consed", symbols_consed
,
6484 doc
: /* Number of symbols that have been consed so far. */);
6486 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
6487 doc
: /* Number of string characters that have been consed so far. */);
6489 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
6490 doc
: /* Number of miscellaneous objects that have been consed so far.
6491 These include markers and overlays, plus certain objects not visible
6494 DEFVAR_INT ("intervals-consed", intervals_consed
,
6495 doc
: /* Number of intervals that have been consed so far. */);
6497 DEFVAR_INT ("strings-consed", strings_consed
,
6498 doc
: /* Number of strings that have been consed so far. */);
6500 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
6501 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
6502 This means that certain objects should be allocated in shared (pure) space.
6503 It can also be set to a hash-table, in which case this table is used to
6504 do hash-consing of the objects allocated to pure space. */);
6506 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
6507 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
6508 garbage_collection_messages
= 0;
6510 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
6511 doc
: /* Hook run after garbage collection has finished. */);
6512 Vpost_gc_hook
= Qnil
;
6513 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
6515 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
6516 doc
: /* Precomputed `signal' argument for memory-full error. */);
6517 /* We build this in advance because if we wait until we need it, we might
6518 not be able to allocate the memory to hold it. */
6520 = pure_cons (Qerror
,
6521 pure_cons (make_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"), Qnil
));
6523 DEFVAR_LISP ("memory-full", Vmemory_full
,
6524 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
6525 Vmemory_full
= Qnil
;
6527 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
6528 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
6530 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
6531 doc
: /* Accumulated time elapsed in garbage collections.
6532 The time is in seconds as a floating point value. */);
6533 DEFVAR_INT ("gcs-done", gcs_done
,
6534 doc
: /* Accumulated number of garbage collections done. */);
6539 defsubr (&Smake_byte_code
);
6540 defsubr (&Smake_list
);
6541 defsubr (&Smake_vector
);
6542 defsubr (&Smake_string
);
6543 defsubr (&Smake_bool_vector
);
6544 defsubr (&Smake_symbol
);
6545 defsubr (&Smake_marker
);
6546 defsubr (&Spurecopy
);
6547 defsubr (&Sgarbage_collect
);
6548 defsubr (&Smemory_limit
);
6549 defsubr (&Smemory_use_counts
);
6551 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
6552 defsubr (&Sgc_status
);