1 /* Storage allocation and gc for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2011
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <limits.h> /* For CHAR_BIT. */
31 /* This file is part of the core Lisp implementation, and thus must
32 deal with the real data structures. If the Lisp implementation is
33 replaced, this file likely will not be used. */
35 #undef HIDE_LISP_IMPLEMENTATION
38 #include "intervals.h"
44 #include "blockinput.h"
45 #include "character.h"
46 #include "syssignal.h"
47 #include "termhooks.h" /* For struct terminal. */
51 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
52 memory. Can do this only if using gmalloc.c. */
54 #if defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC
55 #undef GC_MALLOC_CHECK
60 extern POINTER_TYPE
*sbrk ();
69 #ifdef DOUG_LEA_MALLOC
73 /* Specify maximum number of areas to mmap. It would be nice to use a
74 value that explicitly means "no limit". */
76 #define MMAP_MAX_AREAS 100000000
78 #else /* not DOUG_LEA_MALLOC */
80 /* The following come from gmalloc.c. */
82 extern size_t _bytes_used
;
83 extern size_t __malloc_extra_blocks
;
85 #endif /* not DOUG_LEA_MALLOC */
87 #if ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT
90 /* When GTK uses the file chooser dialog, different backends can be loaded
91 dynamically. One such a backend is the Gnome VFS backend that gets loaded
92 if you run Gnome. That backend creates several threads and also allocates
95 Also, gconf and gsettings may create several threads.
97 If Emacs sets malloc hooks (! SYSTEM_MALLOC) and the emacs_blocked_*
98 functions below are called from malloc, there is a chance that one
99 of these threads preempts the Emacs main thread and the hook variables
100 end up in an inconsistent state. So we have a mutex to prevent that (note
101 that the backend handles concurrent access to malloc within its own threads
102 but Emacs code running in the main thread is not included in that control).
104 When UNBLOCK_INPUT is called, reinvoke_input_signal may be called. If this
105 happens in one of the backend threads we will have two threads that tries
106 to run Emacs code at once, and the code is not prepared for that.
107 To prevent that, we only call BLOCK/UNBLOCK from the main thread. */
109 static pthread_mutex_t alloc_mutex
;
111 #define BLOCK_INPUT_ALLOC \
114 if (pthread_equal (pthread_self (), main_thread)) \
116 pthread_mutex_lock (&alloc_mutex); \
119 #define UNBLOCK_INPUT_ALLOC \
122 pthread_mutex_unlock (&alloc_mutex); \
123 if (pthread_equal (pthread_self (), main_thread)) \
128 #else /* ! defined HAVE_PTHREAD */
130 #define BLOCK_INPUT_ALLOC BLOCK_INPUT
131 #define UNBLOCK_INPUT_ALLOC UNBLOCK_INPUT
133 #endif /* ! defined HAVE_PTHREAD */
134 #endif /* ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT */
136 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
137 to a struct Lisp_String. */
139 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
140 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
141 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
143 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
144 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
145 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
147 /* Value is the number of bytes of S, a pointer to a struct Lisp_String.
148 Be careful during GC, because S->size contains the mark bit for
151 #define GC_STRING_BYTES(S) (STRING_BYTES (S))
153 /* Global variables. */
154 struct emacs_globals globals
;
156 /* Number of bytes of consing done since the last gc. */
158 EMACS_INT consing_since_gc
;
160 /* Similar minimum, computed from Vgc_cons_percentage. */
162 EMACS_INT gc_relative_threshold
;
164 /* Minimum number of bytes of consing since GC before next GC,
165 when memory is full. */
167 EMACS_INT memory_full_cons_threshold
;
169 /* Nonzero during GC. */
173 /* Nonzero means abort if try to GC.
174 This is for code which is written on the assumption that
175 no GC will happen, so as to verify that assumption. */
179 /* Number of live and free conses etc. */
181 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_vector_size
;
182 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
183 static EMACS_INT total_free_floats
, total_floats
;
185 /* Points to memory space allocated as "spare", to be freed if we run
186 out of memory. We keep one large block, four cons-blocks, and
187 two string blocks. */
189 static char *spare_memory
[7];
191 /* Amount of spare memory to keep in large reserve block, or to see
192 whether this much is available when malloc fails on a larger request. */
194 #define SPARE_MEMORY (1 << 14)
196 /* Number of extra blocks malloc should get when it needs more core. */
198 static int malloc_hysteresis
;
200 /* Initialize it to a nonzero value to force it into data space
201 (rather than bss space). That way unexec will remap it into text
202 space (pure), on some systems. We have not implemented the
203 remapping on more recent systems because this is less important
204 nowadays than in the days of small memories and timesharing. */
206 #ifndef VIRT_ADDR_VARIES
209 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
210 #define PUREBEG (char *) pure
212 /* Pointer to the pure area, and its size. */
214 static char *purebeg
;
215 static ptrdiff_t pure_size
;
217 /* Number of bytes of pure storage used before pure storage overflowed.
218 If this is non-zero, this implies that an overflow occurred. */
220 static ptrdiff_t pure_bytes_used_before_overflow
;
222 /* Value is non-zero if P points into pure space. */
224 #define PURE_POINTER_P(P) \
225 (((PNTR_COMPARISON_TYPE) (P) \
226 < (PNTR_COMPARISON_TYPE) ((char *) purebeg + pure_size)) \
227 && ((PNTR_COMPARISON_TYPE) (P) \
228 >= (PNTR_COMPARISON_TYPE) purebeg))
230 /* Index in pure at which next pure Lisp object will be allocated.. */
232 static ptrdiff_t pure_bytes_used_lisp
;
234 /* Number of bytes allocated for non-Lisp objects in pure storage. */
236 static ptrdiff_t pure_bytes_used_non_lisp
;
238 /* If nonzero, this is a warning delivered by malloc and not yet
241 const char *pending_malloc_warning
;
243 /* Maximum amount of C stack to save when a GC happens. */
245 #ifndef MAX_SAVE_STACK
246 #define MAX_SAVE_STACK 16000
249 /* Buffer in which we save a copy of the C stack at each GC. */
251 #if MAX_SAVE_STACK > 0
252 static char *stack_copy
;
253 static ptrdiff_t stack_copy_size
;
256 /* Non-zero means ignore malloc warnings. Set during initialization.
257 Currently not used. */
259 static int ignore_warnings
;
261 static Lisp_Object Qgc_cons_threshold
;
262 Lisp_Object Qchar_table_extra_slots
;
264 /* Hook run after GC has finished. */
266 static Lisp_Object Qpost_gc_hook
;
268 static void mark_buffer (Lisp_Object
);
269 static void mark_terminals (void);
270 static void gc_sweep (void);
271 static void mark_glyph_matrix (struct glyph_matrix
*);
272 static void mark_face_cache (struct face_cache
*);
274 #if !defined REL_ALLOC || defined SYSTEM_MALLOC
275 static void refill_memory_reserve (void);
277 static struct Lisp_String
*allocate_string (void);
278 static void compact_small_strings (void);
279 static void free_large_strings (void);
280 static void sweep_strings (void);
281 static void free_misc (Lisp_Object
);
283 /* When scanning the C stack for live Lisp objects, Emacs keeps track
284 of what memory allocated via lisp_malloc is intended for what
285 purpose. This enumeration specifies the type of memory. */
296 /* We used to keep separate mem_types for subtypes of vectors such as
297 process, hash_table, frame, terminal, and window, but we never made
298 use of the distinction, so it only caused source-code complexity
299 and runtime slowdown. Minor but pointless. */
303 static POINTER_TYPE
*lisp_align_malloc (size_t, enum mem_type
);
304 static POINTER_TYPE
*lisp_malloc (size_t, enum mem_type
);
307 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
309 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
310 #include <stdio.h> /* For fprintf. */
313 /* A unique object in pure space used to make some Lisp objects
314 on free lists recognizable in O(1). */
316 static Lisp_Object Vdead
;
318 #ifdef GC_MALLOC_CHECK
320 enum mem_type allocated_mem_type
;
321 static int dont_register_blocks
;
323 #endif /* GC_MALLOC_CHECK */
325 /* A node in the red-black tree describing allocated memory containing
326 Lisp data. Each such block is recorded with its start and end
327 address when it is allocated, and removed from the tree when it
330 A red-black tree is a balanced binary tree with the following
333 1. Every node is either red or black.
334 2. Every leaf is black.
335 3. If a node is red, then both of its children are black.
336 4. Every simple path from a node to a descendant leaf contains
337 the same number of black nodes.
338 5. The root is always black.
340 When nodes are inserted into the tree, or deleted from the tree,
341 the tree is "fixed" so that these properties are always true.
343 A red-black tree with N internal nodes has height at most 2
344 log(N+1). Searches, insertions and deletions are done in O(log N).
345 Please see a text book about data structures for a detailed
346 description of red-black trees. Any book worth its salt should
351 /* Children of this node. These pointers are never NULL. When there
352 is no child, the value is MEM_NIL, which points to a dummy node. */
353 struct mem_node
*left
, *right
;
355 /* The parent of this node. In the root node, this is NULL. */
356 struct mem_node
*parent
;
358 /* Start and end of allocated region. */
362 enum {MEM_BLACK
, MEM_RED
} color
;
368 /* Base address of stack. Set in main. */
370 Lisp_Object
*stack_base
;
372 /* Root of the tree describing allocated Lisp memory. */
374 static struct mem_node
*mem_root
;
376 /* Lowest and highest known address in the heap. */
378 static void *min_heap_address
, *max_heap_address
;
380 /* Sentinel node of the tree. */
382 static struct mem_node mem_z
;
383 #define MEM_NIL &mem_z
385 static struct Lisp_Vector
*allocate_vectorlike (ptrdiff_t);
386 static void lisp_free (POINTER_TYPE
*);
387 static void mark_stack (void);
388 static int live_vector_p (struct mem_node
*, void *);
389 static int live_buffer_p (struct mem_node
*, void *);
390 static int live_string_p (struct mem_node
*, void *);
391 static int live_cons_p (struct mem_node
*, void *);
392 static int live_symbol_p (struct mem_node
*, void *);
393 static int live_float_p (struct mem_node
*, void *);
394 static int live_misc_p (struct mem_node
*, void *);
395 static void mark_maybe_object (Lisp_Object
);
396 static void mark_memory (void *, void *, int);
397 static void mem_init (void);
398 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
399 static void mem_insert_fixup (struct mem_node
*);
400 static void mem_rotate_left (struct mem_node
*);
401 static void mem_rotate_right (struct mem_node
*);
402 static void mem_delete (struct mem_node
*);
403 static void mem_delete_fixup (struct mem_node
*);
404 static inline struct mem_node
*mem_find (void *);
407 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
408 static void check_gcpros (void);
411 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
413 /* Recording what needs to be marked for gc. */
415 struct gcpro
*gcprolist
;
417 /* Addresses of staticpro'd variables. Initialize it to a nonzero
418 value; otherwise some compilers put it into BSS. */
420 #define NSTATICS 0x640
421 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
423 /* Index of next unused slot in staticvec. */
425 static int staticidx
= 0;
427 static POINTER_TYPE
*pure_alloc (size_t, int);
430 /* Value is SZ rounded up to the next multiple of ALIGNMENT.
431 ALIGNMENT must be a power of 2. */
433 #define ALIGN(ptr, ALIGNMENT) \
434 ((POINTER_TYPE *) ((((uintptr_t) (ptr)) + (ALIGNMENT) - 1) \
435 & ~((ALIGNMENT) - 1)))
439 /************************************************************************
441 ************************************************************************/
443 /* Function malloc calls this if it finds we are near exhausting storage. */
446 malloc_warning (const char *str
)
448 pending_malloc_warning
= str
;
452 /* Display an already-pending malloc warning. */
455 display_malloc_warning (void)
457 call3 (intern ("display-warning"),
459 build_string (pending_malloc_warning
),
460 intern ("emergency"));
461 pending_malloc_warning
= 0;
464 /* Called if we can't allocate relocatable space for a buffer. */
467 buffer_memory_full (ptrdiff_t nbytes
)
469 /* If buffers use the relocating allocator, no need to free
470 spare_memory, because we may have plenty of malloc space left
471 that we could get, and if we don't, the malloc that fails will
472 itself cause spare_memory to be freed. If buffers don't use the
473 relocating allocator, treat this like any other failing
477 memory_full (nbytes
);
480 /* This used to call error, but if we've run out of memory, we could
481 get infinite recursion trying to build the string. */
482 xsignal (Qnil
, Vmemory_signal_data
);
486 #ifndef XMALLOC_OVERRUN_CHECK
487 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
490 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
493 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
494 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
495 block size in little-endian order. The trailer consists of
496 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
498 The header is used to detect whether this block has been allocated
499 through these functions, as some low-level libc functions may
500 bypass the malloc hooks. */
502 #define XMALLOC_OVERRUN_CHECK_SIZE 16
503 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
504 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
506 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
507 hold a size_t value and (2) the header size is a multiple of the
508 alignment that Emacs needs for C types and for USE_LSB_TAG. */
509 #define XMALLOC_BASE_ALIGNMENT \
512 union { long double d; intmax_t i; void *p; } u; \
517 /* A common multiple of the positive integers A and B. Ideally this
518 would be the least common multiple, but there's no way to do that
519 as a constant expression in C, so do the best that we can easily do. */
520 # define COMMON_MULTIPLE(a, b) \
521 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
522 # define XMALLOC_HEADER_ALIGNMENT \
523 COMMON_MULTIPLE (1 << GCTYPEBITS, XMALLOC_BASE_ALIGNMENT)
525 # define XMALLOC_HEADER_ALIGNMENT XMALLOC_BASE_ALIGNMENT
527 #define XMALLOC_OVERRUN_SIZE_SIZE \
528 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
529 + XMALLOC_HEADER_ALIGNMENT - 1) \
530 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
531 - XMALLOC_OVERRUN_CHECK_SIZE)
533 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
534 { '\x9a', '\x9b', '\xae', '\xaf',
535 '\xbf', '\xbe', '\xce', '\xcf',
536 '\xea', '\xeb', '\xec', '\xed',
537 '\xdf', '\xde', '\x9c', '\x9d' };
539 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
540 { '\xaa', '\xab', '\xac', '\xad',
541 '\xba', '\xbb', '\xbc', '\xbd',
542 '\xca', '\xcb', '\xcc', '\xcd',
543 '\xda', '\xdb', '\xdc', '\xdd' };
545 /* Insert and extract the block size in the header. */
548 xmalloc_put_size (unsigned char *ptr
, size_t size
)
551 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
553 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
559 xmalloc_get_size (unsigned char *ptr
)
563 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
564 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
573 /* The call depth in overrun_check functions. For example, this might happen:
575 overrun_check_malloc()
576 -> malloc -> (via hook)_-> emacs_blocked_malloc
577 -> overrun_check_malloc
578 call malloc (hooks are NULL, so real malloc is called).
579 malloc returns 10000.
580 add overhead, return 10016.
581 <- (back in overrun_check_malloc)
582 add overhead again, return 10032
583 xmalloc returns 10032.
588 overrun_check_free(10032)
590 free(10016) <- crash, because 10000 is the original pointer. */
592 static ptrdiff_t check_depth
;
594 /* Like malloc, but wraps allocated block with header and trailer. */
596 static POINTER_TYPE
*
597 overrun_check_malloc (size_t size
)
599 register unsigned char *val
;
600 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
601 if (SIZE_MAX
- overhead
< size
)
604 val
= (unsigned char *) malloc (size
+ overhead
);
605 if (val
&& check_depth
== 1)
607 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
608 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
609 xmalloc_put_size (val
, size
);
610 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
611 XMALLOC_OVERRUN_CHECK_SIZE
);
614 return (POINTER_TYPE
*)val
;
618 /* Like realloc, but checks old block for overrun, and wraps new block
619 with header and trailer. */
621 static POINTER_TYPE
*
622 overrun_check_realloc (POINTER_TYPE
*block
, size_t size
)
624 register unsigned char *val
= (unsigned char *) block
;
625 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
626 if (SIZE_MAX
- overhead
< size
)
631 && memcmp (xmalloc_overrun_check_header
,
632 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
633 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
635 size_t osize
= xmalloc_get_size (val
);
636 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
637 XMALLOC_OVERRUN_CHECK_SIZE
))
639 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
640 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
641 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
644 val
= (unsigned char *) realloc ((POINTER_TYPE
*)val
, size
+ overhead
);
646 if (val
&& check_depth
== 1)
648 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
649 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
650 xmalloc_put_size (val
, size
);
651 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
652 XMALLOC_OVERRUN_CHECK_SIZE
);
655 return (POINTER_TYPE
*)val
;
658 /* Like free, but checks block for overrun. */
661 overrun_check_free (POINTER_TYPE
*block
)
663 unsigned char *val
= (unsigned char *) block
;
668 && memcmp (xmalloc_overrun_check_header
,
669 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
670 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
672 size_t osize
= xmalloc_get_size (val
);
673 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
674 XMALLOC_OVERRUN_CHECK_SIZE
))
676 #ifdef XMALLOC_CLEAR_FREE_MEMORY
677 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
678 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
680 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
681 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
682 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
693 #define malloc overrun_check_malloc
694 #define realloc overrun_check_realloc
695 #define free overrun_check_free
699 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
700 there's no need to block input around malloc. */
701 #define MALLOC_BLOCK_INPUT ((void)0)
702 #define MALLOC_UNBLOCK_INPUT ((void)0)
704 #define MALLOC_BLOCK_INPUT BLOCK_INPUT
705 #define MALLOC_UNBLOCK_INPUT UNBLOCK_INPUT
708 /* Like malloc but check for no memory and block interrupt input.. */
711 xmalloc (size_t size
)
713 register POINTER_TYPE
*val
;
716 val
= (POINTER_TYPE
*) malloc (size
);
717 MALLOC_UNBLOCK_INPUT
;
725 /* Like realloc but check for no memory and block interrupt input.. */
728 xrealloc (POINTER_TYPE
*block
, size_t size
)
730 register POINTER_TYPE
*val
;
733 /* We must call malloc explicitly when BLOCK is 0, since some
734 reallocs don't do this. */
736 val
= (POINTER_TYPE
*) malloc (size
);
738 val
= (POINTER_TYPE
*) realloc (block
, size
);
739 MALLOC_UNBLOCK_INPUT
;
747 /* Like free but block interrupt input. */
750 xfree (POINTER_TYPE
*block
)
756 MALLOC_UNBLOCK_INPUT
;
757 /* We don't call refill_memory_reserve here
758 because that duplicates doing so in emacs_blocked_free
759 and the criterion should go there. */
763 /* Other parts of Emacs pass large int values to allocator functions
764 expecting ptrdiff_t. This is portable in practice, but check it to
766 verify (INT_MAX
<= PTRDIFF_MAX
);
769 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
770 Signal an error on memory exhaustion, and block interrupt input. */
773 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
775 xassert (0 <= nitems
&& 0 < item_size
);
776 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
777 memory_full (SIZE_MAX
);
778 return xmalloc (nitems
* item_size
);
782 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
783 Signal an error on memory exhaustion, and block interrupt input. */
786 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
788 xassert (0 <= nitems
&& 0 < item_size
);
789 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
790 memory_full (SIZE_MAX
);
791 return xrealloc (pa
, nitems
* item_size
);
795 /* Grow PA, which points to an array of *NITEMS items, and return the
796 location of the reallocated array, updating *NITEMS to reflect its
797 new size. The new array will contain at least NITEMS_INCR_MIN more
798 items, but will not contain more than NITEMS_MAX items total.
799 ITEM_SIZE is the size of each item, in bytes.
801 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
802 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
805 If PA is null, then allocate a new array instead of reallocating
806 the old one. Thus, to grow an array A without saving its old
807 contents, invoke xfree (A) immediately followed by xgrowalloc (0,
810 Block interrupt input as needed. If memory exhaustion occurs, set
811 *NITEMS to zero if PA is null, and signal an error (i.e., do not
815 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
816 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
818 /* The approximate size to use for initial small allocation
819 requests. This is the largest "small" request for the GNU C
821 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
823 /* If the array is tiny, grow it to about (but no greater than)
824 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
825 ptrdiff_t n
= *nitems
;
826 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
827 ptrdiff_t half_again
= n
>> 1;
828 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
830 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
831 NITEMS_MAX, and what the C language can represent safely. */
832 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
833 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
834 ? nitems_max
: C_language_max
);
835 ptrdiff_t nitems_incr_max
= n_max
- n
;
836 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
838 xassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
841 if (nitems_incr_max
< incr
)
842 memory_full (SIZE_MAX
);
844 pa
= xrealloc (pa
, n
* item_size
);
850 /* Like strdup, but uses xmalloc. */
853 xstrdup (const char *s
)
855 size_t len
= strlen (s
) + 1;
856 char *p
= (char *) xmalloc (len
);
862 /* Unwind for SAFE_ALLOCA */
865 safe_alloca_unwind (Lisp_Object arg
)
867 register struct Lisp_Save_Value
*p
= XSAVE_VALUE (arg
);
877 /* Like malloc but used for allocating Lisp data. NBYTES is the
878 number of bytes to allocate, TYPE describes the intended use of the
879 allcated memory block (for strings, for conses, ...). */
882 static void *lisp_malloc_loser
;
885 static POINTER_TYPE
*
886 lisp_malloc (size_t nbytes
, enum mem_type type
)
892 #ifdef GC_MALLOC_CHECK
893 allocated_mem_type
= type
;
896 val
= (void *) malloc (nbytes
);
899 /* If the memory just allocated cannot be addressed thru a Lisp
900 object's pointer, and it needs to be,
901 that's equivalent to running out of memory. */
902 if (val
&& type
!= MEM_TYPE_NON_LISP
)
905 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
906 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
908 lisp_malloc_loser
= val
;
915 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
916 if (val
&& type
!= MEM_TYPE_NON_LISP
)
917 mem_insert (val
, (char *) val
+ nbytes
, type
);
920 MALLOC_UNBLOCK_INPUT
;
922 memory_full (nbytes
);
926 /* Free BLOCK. This must be called to free memory allocated with a
927 call to lisp_malloc. */
930 lisp_free (POINTER_TYPE
*block
)
934 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
935 mem_delete (mem_find (block
));
937 MALLOC_UNBLOCK_INPUT
;
940 /* Allocation of aligned blocks of memory to store Lisp data. */
941 /* The entry point is lisp_align_malloc which returns blocks of at most */
942 /* BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
944 /* Use posix_memalloc if the system has it and we're using the system's
945 malloc (because our gmalloc.c routines don't have posix_memalign although
946 its memalloc could be used). */
947 #if defined (HAVE_POSIX_MEMALIGN) && defined (SYSTEM_MALLOC)
948 #define USE_POSIX_MEMALIGN 1
951 /* BLOCK_ALIGN has to be a power of 2. */
952 #define BLOCK_ALIGN (1 << 10)
954 /* Padding to leave at the end of a malloc'd block. This is to give
955 malloc a chance to minimize the amount of memory wasted to alignment.
956 It should be tuned to the particular malloc library used.
957 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
958 posix_memalign on the other hand would ideally prefer a value of 4
959 because otherwise, there's 1020 bytes wasted between each ablocks.
960 In Emacs, testing shows that those 1020 can most of the time be
961 efficiently used by malloc to place other objects, so a value of 0 can
962 still preferable unless you have a lot of aligned blocks and virtually
964 #define BLOCK_PADDING 0
965 #define BLOCK_BYTES \
966 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
968 /* Internal data structures and constants. */
970 #define ABLOCKS_SIZE 16
972 /* An aligned block of memory. */
977 char payload
[BLOCK_BYTES
];
978 struct ablock
*next_free
;
980 /* `abase' is the aligned base of the ablocks. */
981 /* It is overloaded to hold the virtual `busy' field that counts
982 the number of used ablock in the parent ablocks.
983 The first ablock has the `busy' field, the others have the `abase'
984 field. To tell the difference, we assume that pointers will have
985 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
986 is used to tell whether the real base of the parent ablocks is `abase'
987 (if not, the word before the first ablock holds a pointer to the
989 struct ablocks
*abase
;
990 /* The padding of all but the last ablock is unused. The padding of
991 the last ablock in an ablocks is not allocated. */
993 char padding
[BLOCK_PADDING
];
997 /* A bunch of consecutive aligned blocks. */
1000 struct ablock blocks
[ABLOCKS_SIZE
];
1003 /* Size of the block requested from malloc or memalign. */
1004 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1006 #define ABLOCK_ABASE(block) \
1007 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1008 ? (struct ablocks *)(block) \
1011 /* Virtual `busy' field. */
1012 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1014 /* Pointer to the (not necessarily aligned) malloc block. */
1015 #ifdef USE_POSIX_MEMALIGN
1016 #define ABLOCKS_BASE(abase) (abase)
1018 #define ABLOCKS_BASE(abase) \
1019 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void**)abase)[-1])
1022 /* The list of free ablock. */
1023 static struct ablock
*free_ablock
;
1025 /* Allocate an aligned block of nbytes.
1026 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1027 smaller or equal to BLOCK_BYTES. */
1028 static POINTER_TYPE
*
1029 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1032 struct ablocks
*abase
;
1034 eassert (nbytes
<= BLOCK_BYTES
);
1038 #ifdef GC_MALLOC_CHECK
1039 allocated_mem_type
= type
;
1045 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1047 #ifdef DOUG_LEA_MALLOC
1048 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1049 because mapped region contents are not preserved in
1051 mallopt (M_MMAP_MAX
, 0);
1054 #ifdef USE_POSIX_MEMALIGN
1056 int err
= posix_memalign (&base
, BLOCK_ALIGN
, ABLOCKS_BYTES
);
1062 base
= malloc (ABLOCKS_BYTES
);
1063 abase
= ALIGN (base
, BLOCK_ALIGN
);
1068 MALLOC_UNBLOCK_INPUT
;
1069 memory_full (ABLOCKS_BYTES
);
1072 aligned
= (base
== abase
);
1074 ((void**)abase
)[-1] = base
;
1076 #ifdef DOUG_LEA_MALLOC
1077 /* Back to a reasonable maximum of mmap'ed areas. */
1078 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1082 /* If the memory just allocated cannot be addressed thru a Lisp
1083 object's pointer, and it needs to be, that's equivalent to
1084 running out of memory. */
1085 if (type
!= MEM_TYPE_NON_LISP
)
1088 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1089 XSETCONS (tem
, end
);
1090 if ((char *) XCONS (tem
) != end
)
1092 lisp_malloc_loser
= base
;
1094 MALLOC_UNBLOCK_INPUT
;
1095 memory_full (SIZE_MAX
);
1100 /* Initialize the blocks and put them on the free list.
1101 Is `base' was not properly aligned, we can't use the last block. */
1102 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1104 abase
->blocks
[i
].abase
= abase
;
1105 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1106 free_ablock
= &abase
->blocks
[i
];
1108 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1110 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1111 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1112 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1113 eassert (ABLOCKS_BASE (abase
) == base
);
1114 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1117 abase
= ABLOCK_ABASE (free_ablock
);
1118 ABLOCKS_BUSY (abase
) =
1119 (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1121 free_ablock
= free_ablock
->x
.next_free
;
1123 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1124 if (type
!= MEM_TYPE_NON_LISP
)
1125 mem_insert (val
, (char *) val
+ nbytes
, type
);
1128 MALLOC_UNBLOCK_INPUT
;
1130 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1135 lisp_align_free (POINTER_TYPE
*block
)
1137 struct ablock
*ablock
= block
;
1138 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1141 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1142 mem_delete (mem_find (block
));
1144 /* Put on free list. */
1145 ablock
->x
.next_free
= free_ablock
;
1146 free_ablock
= ablock
;
1147 /* Update busy count. */
1148 ABLOCKS_BUSY (abase
) =
1149 (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1151 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1152 { /* All the blocks are free. */
1153 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1154 struct ablock
**tem
= &free_ablock
;
1155 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1159 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1162 *tem
= (*tem
)->x
.next_free
;
1165 tem
= &(*tem
)->x
.next_free
;
1167 eassert ((aligned
& 1) == aligned
);
1168 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1169 #ifdef USE_POSIX_MEMALIGN
1170 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1172 free (ABLOCKS_BASE (abase
));
1174 MALLOC_UNBLOCK_INPUT
;
1177 /* Return a new buffer structure allocated from the heap with
1178 a call to lisp_malloc. */
1181 allocate_buffer (void)
1184 = (struct buffer
*) lisp_malloc (sizeof (struct buffer
),
1186 XSETPVECTYPESIZE (b
, PVEC_BUFFER
,
1187 ((sizeof (struct buffer
) + sizeof (EMACS_INT
) - 1)
1188 / sizeof (EMACS_INT
)));
1193 #ifndef SYSTEM_MALLOC
1195 /* Arranging to disable input signals while we're in malloc.
1197 This only works with GNU malloc. To help out systems which can't
1198 use GNU malloc, all the calls to malloc, realloc, and free
1199 elsewhere in the code should be inside a BLOCK_INPUT/UNBLOCK_INPUT
1200 pair; unfortunately, we have no idea what C library functions
1201 might call malloc, so we can't really protect them unless you're
1202 using GNU malloc. Fortunately, most of the major operating systems
1203 can use GNU malloc. */
1206 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
1207 there's no need to block input around malloc. */
1209 #ifndef DOUG_LEA_MALLOC
1210 extern void * (*__malloc_hook
) (size_t, const void *);
1211 extern void * (*__realloc_hook
) (void *, size_t, const void *);
1212 extern void (*__free_hook
) (void *, const void *);
1213 /* Else declared in malloc.h, perhaps with an extra arg. */
1214 #endif /* DOUG_LEA_MALLOC */
1215 static void * (*old_malloc_hook
) (size_t, const void *);
1216 static void * (*old_realloc_hook
) (void *, size_t, const void*);
1217 static void (*old_free_hook
) (void*, const void*);
1219 #ifdef DOUG_LEA_MALLOC
1220 # define BYTES_USED (mallinfo ().uordblks)
1222 # define BYTES_USED _bytes_used
1225 static size_t bytes_used_when_reconsidered
;
1227 /* Value of _bytes_used, when spare_memory was freed. */
1229 static size_t bytes_used_when_full
;
1231 /* This function is used as the hook for free to call. */
1234 emacs_blocked_free (void *ptr
, const void *ptr2
)
1238 #ifdef GC_MALLOC_CHECK
1244 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1247 "Freeing `%p' which wasn't allocated with malloc\n", ptr
);
1252 /* fprintf (stderr, "free %p...%p (%p)\n", m->start, m->end, ptr); */
1256 #endif /* GC_MALLOC_CHECK */
1258 __free_hook
= old_free_hook
;
1261 /* If we released our reserve (due to running out of memory),
1262 and we have a fair amount free once again,
1263 try to set aside another reserve in case we run out once more. */
1264 if (! NILP (Vmemory_full
)
1265 /* Verify there is enough space that even with the malloc
1266 hysteresis this call won't run out again.
1267 The code here is correct as long as SPARE_MEMORY
1268 is substantially larger than the block size malloc uses. */
1269 && (bytes_used_when_full
1270 > ((bytes_used_when_reconsidered
= BYTES_USED
)
1271 + max (malloc_hysteresis
, 4) * SPARE_MEMORY
)))
1272 refill_memory_reserve ();
1274 __free_hook
= emacs_blocked_free
;
1275 UNBLOCK_INPUT_ALLOC
;
1279 /* This function is the malloc hook that Emacs uses. */
1282 emacs_blocked_malloc (size_t size
, const void *ptr
)
1287 __malloc_hook
= old_malloc_hook
;
1288 #ifdef DOUG_LEA_MALLOC
1289 /* Segfaults on my system. --lorentey */
1290 /* mallopt (M_TOP_PAD, malloc_hysteresis * 4096); */
1292 __malloc_extra_blocks
= malloc_hysteresis
;
1295 value
= (void *) malloc (size
);
1297 #ifdef GC_MALLOC_CHECK
1299 struct mem_node
*m
= mem_find (value
);
1302 fprintf (stderr
, "Malloc returned %p which is already in use\n",
1304 fprintf (stderr
, "Region in use is %p...%p, %u bytes, type %d\n",
1305 m
->start
, m
->end
, (char *) m
->end
- (char *) m
->start
,
1310 if (!dont_register_blocks
)
1312 mem_insert (value
, (char *) value
+ max (1, size
), allocated_mem_type
);
1313 allocated_mem_type
= MEM_TYPE_NON_LISP
;
1316 #endif /* GC_MALLOC_CHECK */
1318 __malloc_hook
= emacs_blocked_malloc
;
1319 UNBLOCK_INPUT_ALLOC
;
1321 /* fprintf (stderr, "%p malloc\n", value); */
1326 /* This function is the realloc hook that Emacs uses. */
1329 emacs_blocked_realloc (void *ptr
, size_t size
, const void *ptr2
)
1334 __realloc_hook
= old_realloc_hook
;
1336 #ifdef GC_MALLOC_CHECK
1339 struct mem_node
*m
= mem_find (ptr
);
1340 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1343 "Realloc of %p which wasn't allocated with malloc\n",
1351 /* fprintf (stderr, "%p -> realloc\n", ptr); */
1353 /* Prevent malloc from registering blocks. */
1354 dont_register_blocks
= 1;
1355 #endif /* GC_MALLOC_CHECK */
1357 value
= (void *) realloc (ptr
, size
);
1359 #ifdef GC_MALLOC_CHECK
1360 dont_register_blocks
= 0;
1363 struct mem_node
*m
= mem_find (value
);
1366 fprintf (stderr
, "Realloc returns memory that is already in use\n");
1370 /* Can't handle zero size regions in the red-black tree. */
1371 mem_insert (value
, (char *) value
+ max (size
, 1), MEM_TYPE_NON_LISP
);
1374 /* fprintf (stderr, "%p <- realloc\n", value); */
1375 #endif /* GC_MALLOC_CHECK */
1377 __realloc_hook
= emacs_blocked_realloc
;
1378 UNBLOCK_INPUT_ALLOC
;
1385 /* Called from Fdump_emacs so that when the dumped Emacs starts, it has a
1386 normal malloc. Some thread implementations need this as they call
1387 malloc before main. The pthread_self call in BLOCK_INPUT_ALLOC then
1388 calls malloc because it is the first call, and we have an endless loop. */
1391 reset_malloc_hooks (void)
1393 __free_hook
= old_free_hook
;
1394 __malloc_hook
= old_malloc_hook
;
1395 __realloc_hook
= old_realloc_hook
;
1397 #endif /* HAVE_PTHREAD */
1400 /* Called from main to set up malloc to use our hooks. */
1403 uninterrupt_malloc (void)
1406 #ifdef DOUG_LEA_MALLOC
1407 pthread_mutexattr_t attr
;
1409 /* GLIBC has a faster way to do this, but lets keep it portable.
1410 This is according to the Single UNIX Specification. */
1411 pthread_mutexattr_init (&attr
);
1412 pthread_mutexattr_settype (&attr
, PTHREAD_MUTEX_RECURSIVE
);
1413 pthread_mutex_init (&alloc_mutex
, &attr
);
1414 #else /* !DOUG_LEA_MALLOC */
1415 /* Some systems such as Solaris 2.6 don't have a recursive mutex,
1416 and the bundled gmalloc.c doesn't require it. */
1417 pthread_mutex_init (&alloc_mutex
, NULL
);
1418 #endif /* !DOUG_LEA_MALLOC */
1419 #endif /* HAVE_PTHREAD */
1421 if (__free_hook
!= emacs_blocked_free
)
1422 old_free_hook
= __free_hook
;
1423 __free_hook
= emacs_blocked_free
;
1425 if (__malloc_hook
!= emacs_blocked_malloc
)
1426 old_malloc_hook
= __malloc_hook
;
1427 __malloc_hook
= emacs_blocked_malloc
;
1429 if (__realloc_hook
!= emacs_blocked_realloc
)
1430 old_realloc_hook
= __realloc_hook
;
1431 __realloc_hook
= emacs_blocked_realloc
;
1434 #endif /* not SYNC_INPUT */
1435 #endif /* not SYSTEM_MALLOC */
1439 /***********************************************************************
1441 ***********************************************************************/
1443 /* Number of intervals allocated in an interval_block structure.
1444 The 1020 is 1024 minus malloc overhead. */
1446 #define INTERVAL_BLOCK_SIZE \
1447 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1449 /* Intervals are allocated in chunks in form of an interval_block
1452 struct interval_block
1454 /* Place `intervals' first, to preserve alignment. */
1455 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1456 struct interval_block
*next
;
1459 /* Current interval block. Its `next' pointer points to older
1462 static struct interval_block
*interval_block
;
1464 /* Index in interval_block above of the next unused interval
1467 static int interval_block_index
;
1469 /* Number of free and live intervals. */
1471 static EMACS_INT total_free_intervals
, total_intervals
;
1473 /* List of free intervals. */
1475 static INTERVAL interval_free_list
;
1478 /* Initialize interval allocation. */
1481 init_intervals (void)
1483 interval_block
= NULL
;
1484 interval_block_index
= INTERVAL_BLOCK_SIZE
;
1485 interval_free_list
= 0;
1489 /* Return a new interval. */
1492 make_interval (void)
1496 /* eassert (!handling_signal); */
1500 if (interval_free_list
)
1502 val
= interval_free_list
;
1503 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1507 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1509 register struct interval_block
*newi
;
1511 newi
= (struct interval_block
*) lisp_malloc (sizeof *newi
,
1514 newi
->next
= interval_block
;
1515 interval_block
= newi
;
1516 interval_block_index
= 0;
1518 val
= &interval_block
->intervals
[interval_block_index
++];
1521 MALLOC_UNBLOCK_INPUT
;
1523 consing_since_gc
+= sizeof (struct interval
);
1525 RESET_INTERVAL (val
);
1531 /* Mark Lisp objects in interval I. */
1534 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1536 eassert (!i
->gcmarkbit
); /* Intervals are never shared. */
1538 mark_object (i
->plist
);
1542 /* Mark the interval tree rooted in TREE. Don't call this directly;
1543 use the macro MARK_INTERVAL_TREE instead. */
1546 mark_interval_tree (register INTERVAL tree
)
1548 /* No need to test if this tree has been marked already; this
1549 function is always called through the MARK_INTERVAL_TREE macro,
1550 which takes care of that. */
1552 traverse_intervals_noorder (tree
, mark_interval
, Qnil
);
1556 /* Mark the interval tree rooted in I. */
1558 #define MARK_INTERVAL_TREE(i) \
1560 if (!NULL_INTERVAL_P (i) && !i->gcmarkbit) \
1561 mark_interval_tree (i); \
1565 #define UNMARK_BALANCE_INTERVALS(i) \
1567 if (! NULL_INTERVAL_P (i)) \
1568 (i) = balance_intervals (i); \
1572 /* Number support. If USE_LISP_UNION_TYPE is in effect, we
1573 can't create number objects in macros. */
1576 make_number (EMACS_INT n
)
1580 obj
.s
.type
= Lisp_Int
;
1585 /***********************************************************************
1587 ***********************************************************************/
1589 /* Lisp_Strings are allocated in string_block structures. When a new
1590 string_block is allocated, all the Lisp_Strings it contains are
1591 added to a free-list string_free_list. When a new Lisp_String is
1592 needed, it is taken from that list. During the sweep phase of GC,
1593 string_blocks that are entirely free are freed, except two which
1596 String data is allocated from sblock structures. Strings larger
1597 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1598 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1600 Sblocks consist internally of sdata structures, one for each
1601 Lisp_String. The sdata structure points to the Lisp_String it
1602 belongs to. The Lisp_String points back to the `u.data' member of
1603 its sdata structure.
1605 When a Lisp_String is freed during GC, it is put back on
1606 string_free_list, and its `data' member and its sdata's `string'
1607 pointer is set to null. The size of the string is recorded in the
1608 `u.nbytes' member of the sdata. So, sdata structures that are no
1609 longer used, can be easily recognized, and it's easy to compact the
1610 sblocks of small strings which we do in compact_small_strings. */
1612 /* Size in bytes of an sblock structure used for small strings. This
1613 is 8192 minus malloc overhead. */
1615 #define SBLOCK_SIZE 8188
1617 /* Strings larger than this are considered large strings. String data
1618 for large strings is allocated from individual sblocks. */
1620 #define LARGE_STRING_BYTES 1024
1622 /* Structure describing string memory sub-allocated from an sblock.
1623 This is where the contents of Lisp strings are stored. */
1627 /* Back-pointer to the string this sdata belongs to. If null, this
1628 structure is free, and the NBYTES member of the union below
1629 contains the string's byte size (the same value that STRING_BYTES
1630 would return if STRING were non-null). If non-null, STRING_BYTES
1631 (STRING) is the size of the data, and DATA contains the string's
1633 struct Lisp_String
*string
;
1635 #ifdef GC_CHECK_STRING_BYTES
1638 unsigned char data
[1];
1640 #define SDATA_NBYTES(S) (S)->nbytes
1641 #define SDATA_DATA(S) (S)->data
1642 #define SDATA_SELECTOR(member) member
1644 #else /* not GC_CHECK_STRING_BYTES */
1648 /* When STRING is non-null. */
1649 unsigned char data
[1];
1651 /* When STRING is null. */
1655 #define SDATA_NBYTES(S) (S)->u.nbytes
1656 #define SDATA_DATA(S) (S)->u.data
1657 #define SDATA_SELECTOR(member) u.member
1659 #endif /* not GC_CHECK_STRING_BYTES */
1661 #define SDATA_DATA_OFFSET offsetof (struct sdata, SDATA_SELECTOR (data))
1665 /* Structure describing a block of memory which is sub-allocated to
1666 obtain string data memory for strings. Blocks for small strings
1667 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1668 as large as needed. */
1673 struct sblock
*next
;
1675 /* Pointer to the next free sdata block. This points past the end
1676 of the sblock if there isn't any space left in this block. */
1677 struct sdata
*next_free
;
1679 /* Start of data. */
1680 struct sdata first_data
;
1683 /* Number of Lisp strings in a string_block structure. The 1020 is
1684 1024 minus malloc overhead. */
1686 #define STRING_BLOCK_SIZE \
1687 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1689 /* Structure describing a block from which Lisp_String structures
1694 /* Place `strings' first, to preserve alignment. */
1695 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1696 struct string_block
*next
;
1699 /* Head and tail of the list of sblock structures holding Lisp string
1700 data. We always allocate from current_sblock. The NEXT pointers
1701 in the sblock structures go from oldest_sblock to current_sblock. */
1703 static struct sblock
*oldest_sblock
, *current_sblock
;
1705 /* List of sblocks for large strings. */
1707 static struct sblock
*large_sblocks
;
1709 /* List of string_block structures. */
1711 static struct string_block
*string_blocks
;
1713 /* Free-list of Lisp_Strings. */
1715 static struct Lisp_String
*string_free_list
;
1717 /* Number of live and free Lisp_Strings. */
1719 static EMACS_INT total_strings
, total_free_strings
;
1721 /* Number of bytes used by live strings. */
1723 static EMACS_INT total_string_size
;
1725 /* Given a pointer to a Lisp_String S which is on the free-list
1726 string_free_list, return a pointer to its successor in the
1729 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1731 /* Return a pointer to the sdata structure belonging to Lisp string S.
1732 S must be live, i.e. S->data must not be null. S->data is actually
1733 a pointer to the `u.data' member of its sdata structure; the
1734 structure starts at a constant offset in front of that. */
1736 #define SDATA_OF_STRING(S) ((struct sdata *) ((S)->data - SDATA_DATA_OFFSET))
1739 #ifdef GC_CHECK_STRING_OVERRUN
1741 /* We check for overrun in string data blocks by appending a small
1742 "cookie" after each allocated string data block, and check for the
1743 presence of this cookie during GC. */
1745 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1746 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1747 { '\xde', '\xad', '\xbe', '\xef' };
1750 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1753 /* Value is the size of an sdata structure large enough to hold NBYTES
1754 bytes of string data. The value returned includes a terminating
1755 NUL byte, the size of the sdata structure, and padding. */
1757 #ifdef GC_CHECK_STRING_BYTES
1759 #define SDATA_SIZE(NBYTES) \
1760 ((SDATA_DATA_OFFSET \
1762 + sizeof (ptrdiff_t) - 1) \
1763 & ~(sizeof (ptrdiff_t) - 1))
1765 #else /* not GC_CHECK_STRING_BYTES */
1767 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1768 less than the size of that member. The 'max' is not needed when
1769 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1770 alignment code reserves enough space. */
1772 #define SDATA_SIZE(NBYTES) \
1773 ((SDATA_DATA_OFFSET \
1774 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1776 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1778 + sizeof (ptrdiff_t) - 1) \
1779 & ~(sizeof (ptrdiff_t) - 1))
1781 #endif /* not GC_CHECK_STRING_BYTES */
1783 /* Extra bytes to allocate for each string. */
1785 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1787 /* Exact bound on the number of bytes in a string, not counting the
1788 terminating null. A string cannot contain more bytes than
1789 STRING_BYTES_BOUND, nor can it be so long that the size_t
1790 arithmetic in allocate_string_data would overflow while it is
1791 calculating a value to be passed to malloc. */
1792 #define STRING_BYTES_MAX \
1793 min (STRING_BYTES_BOUND, \
1794 ((SIZE_MAX - XMALLOC_OVERRUN_CHECK_OVERHEAD \
1796 - offsetof (struct sblock, first_data) \
1797 - SDATA_DATA_OFFSET) \
1798 & ~(sizeof (EMACS_INT) - 1)))
1800 /* Initialize string allocation. Called from init_alloc_once. */
1805 total_strings
= total_free_strings
= total_string_size
= 0;
1806 oldest_sblock
= current_sblock
= large_sblocks
= NULL
;
1807 string_blocks
= NULL
;
1808 string_free_list
= NULL
;
1809 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1810 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1814 #ifdef GC_CHECK_STRING_BYTES
1816 static int check_string_bytes_count
;
1818 #define CHECK_STRING_BYTES(S) STRING_BYTES (S)
1821 /* Like GC_STRING_BYTES, but with debugging check. */
1824 string_bytes (struct Lisp_String
*s
)
1827 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1829 if (!PURE_POINTER_P (s
)
1831 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1836 /* Check validity of Lisp strings' string_bytes member in B. */
1839 check_sblock (struct sblock
*b
)
1841 struct sdata
*from
, *end
, *from_end
;
1845 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1847 /* Compute the next FROM here because copying below may
1848 overwrite data we need to compute it. */
1851 /* Check that the string size recorded in the string is the
1852 same as the one recorded in the sdata structure. */
1854 CHECK_STRING_BYTES (from
->string
);
1857 nbytes
= GC_STRING_BYTES (from
->string
);
1859 nbytes
= SDATA_NBYTES (from
);
1861 nbytes
= SDATA_SIZE (nbytes
);
1862 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1867 /* Check validity of Lisp strings' string_bytes member. ALL_P
1868 non-zero means check all strings, otherwise check only most
1869 recently allocated strings. Used for hunting a bug. */
1872 check_string_bytes (int all_p
)
1878 for (b
= large_sblocks
; b
; b
= b
->next
)
1880 struct Lisp_String
*s
= b
->first_data
.string
;
1882 CHECK_STRING_BYTES (s
);
1885 for (b
= oldest_sblock
; b
; b
= b
->next
)
1889 check_sblock (current_sblock
);
1892 #endif /* GC_CHECK_STRING_BYTES */
1894 #ifdef GC_CHECK_STRING_FREE_LIST
1896 /* Walk through the string free list looking for bogus next pointers.
1897 This may catch buffer overrun from a previous string. */
1900 check_string_free_list (void)
1902 struct Lisp_String
*s
;
1904 /* Pop a Lisp_String off the free-list. */
1905 s
= string_free_list
;
1908 if ((uintptr_t) s
< 1024)
1910 s
= NEXT_FREE_LISP_STRING (s
);
1914 #define check_string_free_list()
1917 /* Return a new Lisp_String. */
1919 static struct Lisp_String
*
1920 allocate_string (void)
1922 struct Lisp_String
*s
;
1924 /* eassert (!handling_signal); */
1928 /* If the free-list is empty, allocate a new string_block, and
1929 add all the Lisp_Strings in it to the free-list. */
1930 if (string_free_list
== NULL
)
1932 struct string_block
*b
;
1935 b
= (struct string_block
*) lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1936 memset (b
, 0, sizeof *b
);
1937 b
->next
= string_blocks
;
1940 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1943 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1944 string_free_list
= s
;
1947 total_free_strings
+= STRING_BLOCK_SIZE
;
1950 check_string_free_list ();
1952 /* Pop a Lisp_String off the free-list. */
1953 s
= string_free_list
;
1954 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1956 MALLOC_UNBLOCK_INPUT
;
1958 /* Probably not strictly necessary, but play it safe. */
1959 memset (s
, 0, sizeof *s
);
1961 --total_free_strings
;
1964 consing_since_gc
+= sizeof *s
;
1966 #ifdef GC_CHECK_STRING_BYTES
1967 if (!noninteractive
)
1969 if (++check_string_bytes_count
== 200)
1971 check_string_bytes_count
= 0;
1972 check_string_bytes (1);
1975 check_string_bytes (0);
1977 #endif /* GC_CHECK_STRING_BYTES */
1983 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1984 plus a NUL byte at the end. Allocate an sdata structure for S, and
1985 set S->data to its `u.data' member. Store a NUL byte at the end of
1986 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1987 S->data if it was initially non-null. */
1990 allocate_string_data (struct Lisp_String
*s
,
1991 EMACS_INT nchars
, EMACS_INT nbytes
)
1993 struct sdata
*data
, *old_data
;
1995 ptrdiff_t needed
, old_nbytes
;
1997 if (STRING_BYTES_MAX
< nbytes
)
2000 /* Determine the number of bytes needed to store NBYTES bytes
2002 needed
= SDATA_SIZE (nbytes
);
2003 old_data
= s
->data
? SDATA_OF_STRING (s
) : NULL
;
2004 old_nbytes
= GC_STRING_BYTES (s
);
2008 if (nbytes
> LARGE_STRING_BYTES
)
2010 size_t size
= offsetof (struct sblock
, first_data
) + needed
;
2012 #ifdef DOUG_LEA_MALLOC
2013 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
2014 because mapped region contents are not preserved in
2017 In case you think of allowing it in a dumped Emacs at the
2018 cost of not being able to re-dump, there's another reason:
2019 mmap'ed data typically have an address towards the top of the
2020 address space, which won't fit into an EMACS_INT (at least on
2021 32-bit systems with the current tagging scheme). --fx */
2022 mallopt (M_MMAP_MAX
, 0);
2025 b
= (struct sblock
*) lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
2027 #ifdef DOUG_LEA_MALLOC
2028 /* Back to a reasonable maximum of mmap'ed areas. */
2029 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2032 b
->next_free
= &b
->first_data
;
2033 b
->first_data
.string
= NULL
;
2034 b
->next
= large_sblocks
;
2037 else if (current_sblock
== NULL
2038 || (((char *) current_sblock
+ SBLOCK_SIZE
2039 - (char *) current_sblock
->next_free
)
2040 < (needed
+ GC_STRING_EXTRA
)))
2042 /* Not enough room in the current sblock. */
2043 b
= (struct sblock
*) lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
2044 b
->next_free
= &b
->first_data
;
2045 b
->first_data
.string
= NULL
;
2049 current_sblock
->next
= b
;
2057 data
= b
->next_free
;
2058 b
->next_free
= (struct sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
2060 MALLOC_UNBLOCK_INPUT
;
2063 s
->data
= SDATA_DATA (data
);
2064 #ifdef GC_CHECK_STRING_BYTES
2065 SDATA_NBYTES (data
) = nbytes
;
2068 s
->size_byte
= nbytes
;
2069 s
->data
[nbytes
] = '\0';
2070 #ifdef GC_CHECK_STRING_OVERRUN
2071 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
2072 GC_STRING_OVERRUN_COOKIE_SIZE
);
2075 /* If S had already data assigned, mark that as free by setting its
2076 string back-pointer to null, and recording the size of the data
2080 SDATA_NBYTES (old_data
) = old_nbytes
;
2081 old_data
->string
= NULL
;
2084 consing_since_gc
+= needed
;
2088 /* Sweep and compact strings. */
2091 sweep_strings (void)
2093 struct string_block
*b
, *next
;
2094 struct string_block
*live_blocks
= NULL
;
2096 string_free_list
= NULL
;
2097 total_strings
= total_free_strings
= 0;
2098 total_string_size
= 0;
2100 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
2101 for (b
= string_blocks
; b
; b
= next
)
2104 struct Lisp_String
*free_list_before
= string_free_list
;
2108 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
2110 struct Lisp_String
*s
= b
->strings
+ i
;
2114 /* String was not on free-list before. */
2115 if (STRING_MARKED_P (s
))
2117 /* String is live; unmark it and its intervals. */
2120 if (!NULL_INTERVAL_P (s
->intervals
))
2121 UNMARK_BALANCE_INTERVALS (s
->intervals
);
2124 total_string_size
+= STRING_BYTES (s
);
2128 /* String is dead. Put it on the free-list. */
2129 struct sdata
*data
= SDATA_OF_STRING (s
);
2131 /* Save the size of S in its sdata so that we know
2132 how large that is. Reset the sdata's string
2133 back-pointer so that we know it's free. */
2134 #ifdef GC_CHECK_STRING_BYTES
2135 if (GC_STRING_BYTES (s
) != SDATA_NBYTES (data
))
2138 data
->u
.nbytes
= GC_STRING_BYTES (s
);
2140 data
->string
= NULL
;
2142 /* Reset the strings's `data' member so that we
2146 /* Put the string on the free-list. */
2147 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2148 string_free_list
= s
;
2154 /* S was on the free-list before. Put it there again. */
2155 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2156 string_free_list
= s
;
2161 /* Free blocks that contain free Lisp_Strings only, except
2162 the first two of them. */
2163 if (nfree
== STRING_BLOCK_SIZE
2164 && total_free_strings
> STRING_BLOCK_SIZE
)
2167 string_free_list
= free_list_before
;
2171 total_free_strings
+= nfree
;
2172 b
->next
= live_blocks
;
2177 check_string_free_list ();
2179 string_blocks
= live_blocks
;
2180 free_large_strings ();
2181 compact_small_strings ();
2183 check_string_free_list ();
2187 /* Free dead large strings. */
2190 free_large_strings (void)
2192 struct sblock
*b
, *next
;
2193 struct sblock
*live_blocks
= NULL
;
2195 for (b
= large_sblocks
; b
; b
= next
)
2199 if (b
->first_data
.string
== NULL
)
2203 b
->next
= live_blocks
;
2208 large_sblocks
= live_blocks
;
2212 /* Compact data of small strings. Free sblocks that don't contain
2213 data of live strings after compaction. */
2216 compact_small_strings (void)
2218 struct sblock
*b
, *tb
, *next
;
2219 struct sdata
*from
, *to
, *end
, *tb_end
;
2220 struct sdata
*to_end
, *from_end
;
2222 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2223 to, and TB_END is the end of TB. */
2225 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2226 to
= &tb
->first_data
;
2228 /* Step through the blocks from the oldest to the youngest. We
2229 expect that old blocks will stabilize over time, so that less
2230 copying will happen this way. */
2231 for (b
= oldest_sblock
; b
; b
= b
->next
)
2234 xassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2236 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
2238 /* Compute the next FROM here because copying below may
2239 overwrite data we need to compute it. */
2242 #ifdef GC_CHECK_STRING_BYTES
2243 /* Check that the string size recorded in the string is the
2244 same as the one recorded in the sdata structure. */
2246 && GC_STRING_BYTES (from
->string
) != SDATA_NBYTES (from
))
2248 #endif /* GC_CHECK_STRING_BYTES */
2251 nbytes
= GC_STRING_BYTES (from
->string
);
2253 nbytes
= SDATA_NBYTES (from
);
2255 if (nbytes
> LARGE_STRING_BYTES
)
2258 nbytes
= SDATA_SIZE (nbytes
);
2259 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2261 #ifdef GC_CHECK_STRING_OVERRUN
2262 if (memcmp (string_overrun_cookie
,
2263 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2264 GC_STRING_OVERRUN_COOKIE_SIZE
))
2268 /* FROM->string non-null means it's alive. Copy its data. */
2271 /* If TB is full, proceed with the next sblock. */
2272 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2273 if (to_end
> tb_end
)
2277 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2278 to
= &tb
->first_data
;
2279 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2282 /* Copy, and update the string's `data' pointer. */
2285 xassert (tb
!= b
|| to
< from
);
2286 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2287 to
->string
->data
= SDATA_DATA (to
);
2290 /* Advance past the sdata we copied to. */
2296 /* The rest of the sblocks following TB don't contain live data, so
2297 we can free them. */
2298 for (b
= tb
->next
; b
; b
= next
)
2306 current_sblock
= tb
;
2310 string_overflow (void)
2312 error ("Maximum string size exceeded");
2315 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2316 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2317 LENGTH must be an integer.
2318 INIT must be an integer that represents a character. */)
2319 (Lisp_Object length
, Lisp_Object init
)
2321 register Lisp_Object val
;
2322 register unsigned char *p
, *end
;
2326 CHECK_NATNUM (length
);
2327 CHECK_CHARACTER (init
);
2329 c
= XFASTINT (init
);
2330 if (ASCII_CHAR_P (c
))
2332 nbytes
= XINT (length
);
2333 val
= make_uninit_string (nbytes
);
2335 end
= p
+ SCHARS (val
);
2341 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2342 int len
= CHAR_STRING (c
, str
);
2343 EMACS_INT string_len
= XINT (length
);
2345 if (string_len
> STRING_BYTES_MAX
/ len
)
2347 nbytes
= len
* string_len
;
2348 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2353 memcpy (p
, str
, len
);
2363 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2364 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2365 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2366 (Lisp_Object length
, Lisp_Object init
)
2368 register Lisp_Object val
;
2369 struct Lisp_Bool_Vector
*p
;
2370 ptrdiff_t length_in_chars
;
2371 EMACS_INT length_in_elts
;
2374 CHECK_NATNUM (length
);
2376 bits_per_value
= sizeof (EMACS_INT
) * BOOL_VECTOR_BITS_PER_CHAR
;
2378 length_in_elts
= (XFASTINT (length
) + bits_per_value
- 1) / bits_per_value
;
2380 /* We must allocate one more elements than LENGTH_IN_ELTS for the
2381 slot `size' of the struct Lisp_Bool_Vector. */
2382 val
= Fmake_vector (make_number (length_in_elts
+ 1), Qnil
);
2384 /* No Lisp_Object to trace in there. */
2385 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0);
2387 p
= XBOOL_VECTOR (val
);
2388 p
->size
= XFASTINT (length
);
2390 length_in_chars
= ((XFASTINT (length
) + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2391 / BOOL_VECTOR_BITS_PER_CHAR
);
2392 if (length_in_chars
)
2394 memset (p
->data
, ! NILP (init
) ? -1 : 0, length_in_chars
);
2396 /* Clear any extraneous bits in the last byte. */
2397 p
->data
[length_in_chars
- 1]
2398 &= (1 << (XINT (length
) % BOOL_VECTOR_BITS_PER_CHAR
)) - 1;
2405 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2406 of characters from the contents. This string may be unibyte or
2407 multibyte, depending on the contents. */
2410 make_string (const char *contents
, ptrdiff_t nbytes
)
2412 register Lisp_Object val
;
2413 ptrdiff_t nchars
, multibyte_nbytes
;
2415 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2416 &nchars
, &multibyte_nbytes
);
2417 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2418 /* CONTENTS contains no multibyte sequences or contains an invalid
2419 multibyte sequence. We must make unibyte string. */
2420 val
= make_unibyte_string (contents
, nbytes
);
2422 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2427 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2430 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2432 register Lisp_Object val
;
2433 val
= make_uninit_string (length
);
2434 memcpy (SDATA (val
), contents
, length
);
2439 /* Make a multibyte string from NCHARS characters occupying NBYTES
2440 bytes at CONTENTS. */
2443 make_multibyte_string (const char *contents
,
2444 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2446 register Lisp_Object val
;
2447 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2448 memcpy (SDATA (val
), contents
, nbytes
);
2453 /* Make a string from NCHARS characters occupying NBYTES bytes at
2454 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2457 make_string_from_bytes (const char *contents
,
2458 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2460 register Lisp_Object val
;
2461 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2462 memcpy (SDATA (val
), contents
, nbytes
);
2463 if (SBYTES (val
) == SCHARS (val
))
2464 STRING_SET_UNIBYTE (val
);
2469 /* Make a string from NCHARS characters occupying NBYTES bytes at
2470 CONTENTS. The argument MULTIBYTE controls whether to label the
2471 string as multibyte. If NCHARS is negative, it counts the number of
2472 characters by itself. */
2475 make_specified_string (const char *contents
,
2476 ptrdiff_t nchars
, ptrdiff_t nbytes
, int multibyte
)
2478 register Lisp_Object val
;
2483 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2488 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2489 memcpy (SDATA (val
), contents
, nbytes
);
2491 STRING_SET_UNIBYTE (val
);
2496 /* Make a string from the data at STR, treating it as multibyte if the
2500 build_string (const char *str
)
2502 return make_string (str
, strlen (str
));
2506 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2507 occupying LENGTH bytes. */
2510 make_uninit_string (EMACS_INT length
)
2515 return empty_unibyte_string
;
2516 val
= make_uninit_multibyte_string (length
, length
);
2517 STRING_SET_UNIBYTE (val
);
2522 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2523 which occupy NBYTES bytes. */
2526 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2529 struct Lisp_String
*s
;
2534 return empty_multibyte_string
;
2536 s
= allocate_string ();
2537 allocate_string_data (s
, nchars
, nbytes
);
2538 XSETSTRING (string
, s
);
2539 string_chars_consed
+= nbytes
;
2545 /***********************************************************************
2547 ***********************************************************************/
2549 /* We store float cells inside of float_blocks, allocating a new
2550 float_block with malloc whenever necessary. Float cells reclaimed
2551 by GC are put on a free list to be reallocated before allocating
2552 any new float cells from the latest float_block. */
2554 #define FLOAT_BLOCK_SIZE \
2555 (((BLOCK_BYTES - sizeof (struct float_block *) \
2556 /* The compiler might add padding at the end. */ \
2557 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2558 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2560 #define GETMARKBIT(block,n) \
2561 (((block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2562 >> ((n) % (sizeof (int) * CHAR_BIT))) \
2565 #define SETMARKBIT(block,n) \
2566 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2567 |= 1 << ((n) % (sizeof (int) * CHAR_BIT))
2569 #define UNSETMARKBIT(block,n) \
2570 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2571 &= ~(1 << ((n) % (sizeof (int) * CHAR_BIT)))
2573 #define FLOAT_BLOCK(fptr) \
2574 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2576 #define FLOAT_INDEX(fptr) \
2577 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2581 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2582 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2583 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2584 struct float_block
*next
;
2587 #define FLOAT_MARKED_P(fptr) \
2588 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2590 #define FLOAT_MARK(fptr) \
2591 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2593 #define FLOAT_UNMARK(fptr) \
2594 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2596 /* Current float_block. */
2598 static struct float_block
*float_block
;
2600 /* Index of first unused Lisp_Float in the current float_block. */
2602 static int float_block_index
;
2604 /* Free-list of Lisp_Floats. */
2606 static struct Lisp_Float
*float_free_list
;
2609 /* Initialize float allocation. */
2615 float_block_index
= FLOAT_BLOCK_SIZE
; /* Force alloc of new float_block. */
2616 float_free_list
= 0;
2620 /* Return a new float object with value FLOAT_VALUE. */
2623 make_float (double float_value
)
2625 register Lisp_Object val
;
2627 /* eassert (!handling_signal); */
2631 if (float_free_list
)
2633 /* We use the data field for chaining the free list
2634 so that we won't use the same field that has the mark bit. */
2635 XSETFLOAT (val
, float_free_list
);
2636 float_free_list
= float_free_list
->u
.chain
;
2640 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2642 register struct float_block
*new;
2644 new = (struct float_block
*) lisp_align_malloc (sizeof *new,
2646 new->next
= float_block
;
2647 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2649 float_block_index
= 0;
2651 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2652 float_block_index
++;
2655 MALLOC_UNBLOCK_INPUT
;
2657 XFLOAT_INIT (val
, float_value
);
2658 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2659 consing_since_gc
+= sizeof (struct Lisp_Float
);
2666 /***********************************************************************
2668 ***********************************************************************/
2670 /* We store cons cells inside of cons_blocks, allocating a new
2671 cons_block with malloc whenever necessary. Cons cells reclaimed by
2672 GC are put on a free list to be reallocated before allocating
2673 any new cons cells from the latest cons_block. */
2675 #define CONS_BLOCK_SIZE \
2676 (((BLOCK_BYTES - sizeof (struct cons_block *)) * CHAR_BIT) \
2677 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2679 #define CONS_BLOCK(fptr) \
2680 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2682 #define CONS_INDEX(fptr) \
2683 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2687 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2688 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2689 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2690 struct cons_block
*next
;
2693 #define CONS_MARKED_P(fptr) \
2694 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2696 #define CONS_MARK(fptr) \
2697 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2699 #define CONS_UNMARK(fptr) \
2700 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2702 /* Current cons_block. */
2704 static struct cons_block
*cons_block
;
2706 /* Index of first unused Lisp_Cons in the current block. */
2708 static int cons_block_index
;
2710 /* Free-list of Lisp_Cons structures. */
2712 static struct Lisp_Cons
*cons_free_list
;
2715 /* Initialize cons allocation. */
2721 cons_block_index
= CONS_BLOCK_SIZE
; /* Force alloc of new cons_block. */
2726 /* Explicitly free a cons cell by putting it on the free-list. */
2729 free_cons (struct Lisp_Cons
*ptr
)
2731 ptr
->u
.chain
= cons_free_list
;
2735 cons_free_list
= ptr
;
2738 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2739 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2740 (Lisp_Object car
, Lisp_Object cdr
)
2742 register Lisp_Object val
;
2744 /* eassert (!handling_signal); */
2750 /* We use the cdr for chaining the free list
2751 so that we won't use the same field that has the mark bit. */
2752 XSETCONS (val
, cons_free_list
);
2753 cons_free_list
= cons_free_list
->u
.chain
;
2757 if (cons_block_index
== CONS_BLOCK_SIZE
)
2759 register struct cons_block
*new;
2760 new = (struct cons_block
*) lisp_align_malloc (sizeof *new,
2762 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2763 new->next
= cons_block
;
2765 cons_block_index
= 0;
2767 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2771 MALLOC_UNBLOCK_INPUT
;
2775 eassert (!CONS_MARKED_P (XCONS (val
)));
2776 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2777 cons_cells_consed
++;
2781 #ifdef GC_CHECK_CONS_LIST
2782 /* Get an error now if there's any junk in the cons free list. */
2784 check_cons_list (void)
2786 struct Lisp_Cons
*tail
= cons_free_list
;
2789 tail
= tail
->u
.chain
;
2793 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2796 list1 (Lisp_Object arg1
)
2798 return Fcons (arg1
, Qnil
);
2802 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2804 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2809 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2811 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2816 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2818 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2823 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2825 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2826 Fcons (arg5
, Qnil
)))));
2830 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2831 doc
: /* Return a newly created list with specified arguments as elements.
2832 Any number of arguments, even zero arguments, are allowed.
2833 usage: (list &rest OBJECTS) */)
2834 (ptrdiff_t nargs
, Lisp_Object
*args
)
2836 register Lisp_Object val
;
2842 val
= Fcons (args
[nargs
], val
);
2848 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2849 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2850 (register Lisp_Object length
, Lisp_Object init
)
2852 register Lisp_Object val
;
2853 register EMACS_INT size
;
2855 CHECK_NATNUM (length
);
2856 size
= XFASTINT (length
);
2861 val
= Fcons (init
, val
);
2866 val
= Fcons (init
, val
);
2871 val
= Fcons (init
, val
);
2876 val
= Fcons (init
, val
);
2881 val
= Fcons (init
, val
);
2896 /***********************************************************************
2898 ***********************************************************************/
2900 /* Singly-linked list of all vectors. */
2902 static struct Lisp_Vector
*all_vectors
;
2904 /* Handy constants for vectorlike objects. */
2907 header_size
= offsetof (struct Lisp_Vector
, contents
),
2908 word_size
= sizeof (Lisp_Object
)
2911 /* Value is a pointer to a newly allocated Lisp_Vector structure
2912 with room for LEN Lisp_Objects. */
2914 static struct Lisp_Vector
*
2915 allocate_vectorlike (ptrdiff_t len
)
2917 struct Lisp_Vector
*p
;
2922 #ifdef DOUG_LEA_MALLOC
2923 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
2924 because mapped region contents are not preserved in
2926 mallopt (M_MMAP_MAX
, 0);
2929 /* This gets triggered by code which I haven't bothered to fix. --Stef */
2930 /* eassert (!handling_signal); */
2932 nbytes
= header_size
+ len
* word_size
;
2933 p
= (struct Lisp_Vector
*) lisp_malloc (nbytes
, MEM_TYPE_VECTORLIKE
);
2935 #ifdef DOUG_LEA_MALLOC
2936 /* Back to a reasonable maximum of mmap'ed areas. */
2937 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2940 consing_since_gc
+= nbytes
;
2941 vector_cells_consed
+= len
;
2943 p
->header
.next
.vector
= all_vectors
;
2946 MALLOC_UNBLOCK_INPUT
;
2952 /* Allocate a vector with LEN slots. */
2954 struct Lisp_Vector
*
2955 allocate_vector (EMACS_INT len
)
2957 struct Lisp_Vector
*v
;
2958 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
2960 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
2961 memory_full (SIZE_MAX
);
2962 v
= allocate_vectorlike (len
);
2963 v
->header
.size
= len
;
2968 /* Allocate other vector-like structures. */
2970 struct Lisp_Vector
*
2971 allocate_pseudovector (int memlen
, int lisplen
, int tag
)
2973 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
2976 /* Only the first lisplen slots will be traced normally by the GC. */
2977 for (i
= 0; i
< lisplen
; ++i
)
2978 v
->contents
[i
] = Qnil
;
2980 XSETPVECTYPESIZE (v
, tag
, lisplen
);
2984 struct Lisp_Hash_Table
*
2985 allocate_hash_table (void)
2987 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
2992 allocate_window (void)
2994 return ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
2999 allocate_terminal (void)
3001 struct terminal
*t
= ALLOCATE_PSEUDOVECTOR (struct terminal
,
3002 next_terminal
, PVEC_TERMINAL
);
3003 /* Zero out the non-GC'd fields. FIXME: This should be made unnecessary. */
3004 memset (&t
->next_terminal
, 0,
3005 (char*) (t
+ 1) - (char*) &t
->next_terminal
);
3011 allocate_frame (void)
3013 struct frame
*f
= ALLOCATE_PSEUDOVECTOR (struct frame
,
3014 face_cache
, PVEC_FRAME
);
3015 /* Zero out the non-GC'd fields. FIXME: This should be made unnecessary. */
3016 memset (&f
->face_cache
, 0,
3017 (char *) (f
+ 1) - (char *) &f
->face_cache
);
3022 struct Lisp_Process
*
3023 allocate_process (void)
3025 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3029 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3030 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3031 See also the function `vector'. */)
3032 (register Lisp_Object length
, Lisp_Object init
)
3035 register ptrdiff_t sizei
;
3036 register ptrdiff_t i
;
3037 register struct Lisp_Vector
*p
;
3039 CHECK_NATNUM (length
);
3041 p
= allocate_vector (XFASTINT (length
));
3042 sizei
= XFASTINT (length
);
3043 for (i
= 0; i
< sizei
; i
++)
3044 p
->contents
[i
] = init
;
3046 XSETVECTOR (vector
, p
);
3051 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3052 doc
: /* Return a newly created vector with specified arguments as elements.
3053 Any number of arguments, even zero arguments, are allowed.
3054 usage: (vector &rest OBJECTS) */)
3055 (ptrdiff_t nargs
, Lisp_Object
*args
)
3057 register Lisp_Object len
, val
;
3059 register struct Lisp_Vector
*p
;
3061 XSETFASTINT (len
, nargs
);
3062 val
= Fmake_vector (len
, Qnil
);
3064 for (i
= 0; i
< nargs
; i
++)
3065 p
->contents
[i
] = args
[i
];
3070 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3071 doc
: /* Create a byte-code object with specified arguments as elements.
3072 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3073 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3074 and (optional) INTERACTIVE-SPEC.
3075 The first four arguments are required; at most six have any
3077 The ARGLIST can be either like the one of `lambda', in which case the arguments
3078 will be dynamically bound before executing the byte code, or it can be an
3079 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3080 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3081 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3082 argument to catch the left-over arguments. If such an integer is used, the
3083 arguments will not be dynamically bound but will be instead pushed on the
3084 stack before executing the byte-code.
3085 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3086 (ptrdiff_t nargs
, Lisp_Object
*args
)
3088 register Lisp_Object len
, val
;
3090 register struct Lisp_Vector
*p
;
3092 XSETFASTINT (len
, nargs
);
3093 if (!NILP (Vpurify_flag
))
3094 val
= make_pure_vector (nargs
);
3096 val
= Fmake_vector (len
, Qnil
);
3098 if (nargs
> 1 && STRINGP (args
[1]) && STRING_MULTIBYTE (args
[1]))
3099 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3100 earlier because they produced a raw 8-bit string for byte-code
3101 and now such a byte-code string is loaded as multibyte while
3102 raw 8-bit characters converted to multibyte form. Thus, now we
3103 must convert them back to the original unibyte form. */
3104 args
[1] = Fstring_as_unibyte (args
[1]);
3107 for (i
= 0; i
< nargs
; i
++)
3109 if (!NILP (Vpurify_flag
))
3110 args
[i
] = Fpurecopy (args
[i
]);
3111 p
->contents
[i
] = args
[i
];
3113 XSETPVECTYPE (p
, PVEC_COMPILED
);
3114 XSETCOMPILED (val
, p
);
3120 /***********************************************************************
3122 ***********************************************************************/
3124 /* Each symbol_block is just under 1020 bytes long, since malloc
3125 really allocates in units of powers of two and uses 4 bytes for its
3128 #define SYMBOL_BLOCK_SIZE \
3129 ((1020 - sizeof (struct symbol_block *)) / sizeof (struct Lisp_Symbol))
3133 /* Place `symbols' first, to preserve alignment. */
3134 struct Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3135 struct symbol_block
*next
;
3138 /* Current symbol block and index of first unused Lisp_Symbol
3141 static struct symbol_block
*symbol_block
;
3142 static int symbol_block_index
;
3144 /* List of free symbols. */
3146 static struct Lisp_Symbol
*symbol_free_list
;
3149 /* Initialize symbol allocation. */
3154 symbol_block
= NULL
;
3155 symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3156 symbol_free_list
= 0;
3160 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3161 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3162 Its value and function definition are void, and its property list is nil. */)
3165 register Lisp_Object val
;
3166 register struct Lisp_Symbol
*p
;
3168 CHECK_STRING (name
);
3170 /* eassert (!handling_signal); */
3174 if (symbol_free_list
)
3176 XSETSYMBOL (val
, symbol_free_list
);
3177 symbol_free_list
= symbol_free_list
->next
;
3181 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3183 struct symbol_block
*new;
3184 new = (struct symbol_block
*) lisp_malloc (sizeof *new,
3186 new->next
= symbol_block
;
3188 symbol_block_index
= 0;
3190 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
]);
3191 symbol_block_index
++;
3194 MALLOC_UNBLOCK_INPUT
;
3199 p
->redirect
= SYMBOL_PLAINVAL
;
3200 SET_SYMBOL_VAL (p
, Qunbound
);
3201 p
->function
= Qunbound
;
3204 p
->interned
= SYMBOL_UNINTERNED
;
3206 p
->declared_special
= 0;
3207 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3214 /***********************************************************************
3215 Marker (Misc) Allocation
3216 ***********************************************************************/
3218 /* Allocation of markers and other objects that share that structure.
3219 Works like allocation of conses. */
3221 #define MARKER_BLOCK_SIZE \
3222 ((1020 - sizeof (struct marker_block *)) / sizeof (union Lisp_Misc))
3226 /* Place `markers' first, to preserve alignment. */
3227 union Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3228 struct marker_block
*next
;
3231 static struct marker_block
*marker_block
;
3232 static int marker_block_index
;
3234 static union Lisp_Misc
*marker_free_list
;
3239 marker_block
= NULL
;
3240 marker_block_index
= MARKER_BLOCK_SIZE
;
3241 marker_free_list
= 0;
3244 /* Return a newly allocated Lisp_Misc object, with no substructure. */
3247 allocate_misc (void)
3251 /* eassert (!handling_signal); */
3255 if (marker_free_list
)
3257 XSETMISC (val
, marker_free_list
);
3258 marker_free_list
= marker_free_list
->u_free
.chain
;
3262 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3264 struct marker_block
*new;
3265 new = (struct marker_block
*) lisp_malloc (sizeof *new,
3267 new->next
= marker_block
;
3269 marker_block_index
= 0;
3270 total_free_markers
+= MARKER_BLOCK_SIZE
;
3272 XSETMISC (val
, &marker_block
->markers
[marker_block_index
]);
3273 marker_block_index
++;
3276 MALLOC_UNBLOCK_INPUT
;
3278 --total_free_markers
;
3279 consing_since_gc
+= sizeof (union Lisp_Misc
);
3280 misc_objects_consed
++;
3281 XMISCANY (val
)->gcmarkbit
= 0;
3285 /* Free a Lisp_Misc object */
3288 free_misc (Lisp_Object misc
)
3290 XMISCTYPE (misc
) = Lisp_Misc_Free
;
3291 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3292 marker_free_list
= XMISC (misc
);
3294 total_free_markers
++;
3297 /* Return a Lisp_Misc_Save_Value object containing POINTER and
3298 INTEGER. This is used to package C values to call record_unwind_protect.
3299 The unwind function can get the C values back using XSAVE_VALUE. */
3302 make_save_value (void *pointer
, ptrdiff_t integer
)
3304 register Lisp_Object val
;
3305 register struct Lisp_Save_Value
*p
;
3307 val
= allocate_misc ();
3308 XMISCTYPE (val
) = Lisp_Misc_Save_Value
;
3309 p
= XSAVE_VALUE (val
);
3310 p
->pointer
= pointer
;
3311 p
->integer
= integer
;
3316 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3317 doc
: /* Return a newly allocated marker which does not point at any place. */)
3320 register Lisp_Object val
;
3321 register struct Lisp_Marker
*p
;
3323 val
= allocate_misc ();
3324 XMISCTYPE (val
) = Lisp_Misc_Marker
;
3330 p
->insertion_type
= 0;
3334 /* Put MARKER back on the free list after using it temporarily. */
3337 free_marker (Lisp_Object marker
)
3339 unchain_marker (XMARKER (marker
));
3344 /* Return a newly created vector or string with specified arguments as
3345 elements. If all the arguments are characters that can fit
3346 in a string of events, make a string; otherwise, make a vector.
3348 Any number of arguments, even zero arguments, are allowed. */
3351 make_event_array (register int nargs
, Lisp_Object
*args
)
3355 for (i
= 0; i
< nargs
; i
++)
3356 /* The things that fit in a string
3357 are characters that are in 0...127,
3358 after discarding the meta bit and all the bits above it. */
3359 if (!INTEGERP (args
[i
])
3360 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3361 return Fvector (nargs
, args
);
3363 /* Since the loop exited, we know that all the things in it are
3364 characters, so we can make a string. */
3368 result
= Fmake_string (make_number (nargs
), make_number (0));
3369 for (i
= 0; i
< nargs
; i
++)
3371 SSET (result
, i
, XINT (args
[i
]));
3372 /* Move the meta bit to the right place for a string char. */
3373 if (XINT (args
[i
]) & CHAR_META
)
3374 SSET (result
, i
, SREF (result
, i
) | 0x80);
3383 /************************************************************************
3384 Memory Full Handling
3385 ************************************************************************/
3388 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3389 there may have been size_t overflow so that malloc was never
3390 called, or perhaps malloc was invoked successfully but the
3391 resulting pointer had problems fitting into a tagged EMACS_INT. In
3392 either case this counts as memory being full even though malloc did
3396 memory_full (size_t nbytes
)
3398 /* Do not go into hysterics merely because a large request failed. */
3399 int enough_free_memory
= 0;
3400 if (SPARE_MEMORY
< nbytes
)
3405 p
= malloc (SPARE_MEMORY
);
3409 enough_free_memory
= 1;
3411 MALLOC_UNBLOCK_INPUT
;
3414 if (! enough_free_memory
)
3420 memory_full_cons_threshold
= sizeof (struct cons_block
);
3422 /* The first time we get here, free the spare memory. */
3423 for (i
= 0; i
< sizeof (spare_memory
) / sizeof (char *); i
++)
3424 if (spare_memory
[i
])
3427 free (spare_memory
[i
]);
3428 else if (i
>= 1 && i
<= 4)
3429 lisp_align_free (spare_memory
[i
]);
3431 lisp_free (spare_memory
[i
]);
3432 spare_memory
[i
] = 0;
3435 /* Record the space now used. When it decreases substantially,
3436 we can refill the memory reserve. */
3437 #if !defined SYSTEM_MALLOC && !defined SYNC_INPUT
3438 bytes_used_when_full
= BYTES_USED
;
3442 /* This used to call error, but if we've run out of memory, we could
3443 get infinite recursion trying to build the string. */
3444 xsignal (Qnil
, Vmemory_signal_data
);
3447 /* If we released our reserve (due to running out of memory),
3448 and we have a fair amount free once again,
3449 try to set aside another reserve in case we run out once more.
3451 This is called when a relocatable block is freed in ralloc.c,
3452 and also directly from this file, in case we're not using ralloc.c. */
3455 refill_memory_reserve (void)
3457 #ifndef SYSTEM_MALLOC
3458 if (spare_memory
[0] == 0)
3459 spare_memory
[0] = (char *) malloc (SPARE_MEMORY
);
3460 if (spare_memory
[1] == 0)
3461 spare_memory
[1] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3463 if (spare_memory
[2] == 0)
3464 spare_memory
[2] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3466 if (spare_memory
[3] == 0)
3467 spare_memory
[3] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3469 if (spare_memory
[4] == 0)
3470 spare_memory
[4] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3472 if (spare_memory
[5] == 0)
3473 spare_memory
[5] = (char *) lisp_malloc (sizeof (struct string_block
),
3475 if (spare_memory
[6] == 0)
3476 spare_memory
[6] = (char *) lisp_malloc (sizeof (struct string_block
),
3478 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3479 Vmemory_full
= Qnil
;
3483 /************************************************************************
3485 ************************************************************************/
3487 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3489 /* Conservative C stack marking requires a method to identify possibly
3490 live Lisp objects given a pointer value. We do this by keeping
3491 track of blocks of Lisp data that are allocated in a red-black tree
3492 (see also the comment of mem_node which is the type of nodes in
3493 that tree). Function lisp_malloc adds information for an allocated
3494 block to the red-black tree with calls to mem_insert, and function
3495 lisp_free removes it with mem_delete. Functions live_string_p etc
3496 call mem_find to lookup information about a given pointer in the
3497 tree, and use that to determine if the pointer points to a Lisp
3500 /* Initialize this part of alloc.c. */
3505 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3506 mem_z
.parent
= NULL
;
3507 mem_z
.color
= MEM_BLACK
;
3508 mem_z
.start
= mem_z
.end
= NULL
;
3513 /* Value is a pointer to the mem_node containing START. Value is
3514 MEM_NIL if there is no node in the tree containing START. */
3516 static inline struct mem_node
*
3517 mem_find (void *start
)
3521 if (start
< min_heap_address
|| start
> max_heap_address
)
3524 /* Make the search always successful to speed up the loop below. */
3525 mem_z
.start
= start
;
3526 mem_z
.end
= (char *) start
+ 1;
3529 while (start
< p
->start
|| start
>= p
->end
)
3530 p
= start
< p
->start
? p
->left
: p
->right
;
3535 /* Insert a new node into the tree for a block of memory with start
3536 address START, end address END, and type TYPE. Value is a
3537 pointer to the node that was inserted. */
3539 static struct mem_node
*
3540 mem_insert (void *start
, void *end
, enum mem_type type
)
3542 struct mem_node
*c
, *parent
, *x
;
3544 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3545 min_heap_address
= start
;
3546 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3547 max_heap_address
= end
;
3549 /* See where in the tree a node for START belongs. In this
3550 particular application, it shouldn't happen that a node is already
3551 present. For debugging purposes, let's check that. */
3555 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3557 while (c
!= MEM_NIL
)
3559 if (start
>= c
->start
&& start
< c
->end
)
3562 c
= start
< c
->start
? c
->left
: c
->right
;
3565 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3567 while (c
!= MEM_NIL
)
3570 c
= start
< c
->start
? c
->left
: c
->right
;
3573 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3575 /* Create a new node. */
3576 #ifdef GC_MALLOC_CHECK
3577 x
= (struct mem_node
*) _malloc_internal (sizeof *x
);
3581 x
= (struct mem_node
*) xmalloc (sizeof *x
);
3587 x
->left
= x
->right
= MEM_NIL
;
3590 /* Insert it as child of PARENT or install it as root. */
3593 if (start
< parent
->start
)
3601 /* Re-establish red-black tree properties. */
3602 mem_insert_fixup (x
);
3608 /* Re-establish the red-black properties of the tree, and thereby
3609 balance the tree, after node X has been inserted; X is always red. */
3612 mem_insert_fixup (struct mem_node
*x
)
3614 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3616 /* X is red and its parent is red. This is a violation of
3617 red-black tree property #3. */
3619 if (x
->parent
== x
->parent
->parent
->left
)
3621 /* We're on the left side of our grandparent, and Y is our
3623 struct mem_node
*y
= x
->parent
->parent
->right
;
3625 if (y
->color
== MEM_RED
)
3627 /* Uncle and parent are red but should be black because
3628 X is red. Change the colors accordingly and proceed
3629 with the grandparent. */
3630 x
->parent
->color
= MEM_BLACK
;
3631 y
->color
= MEM_BLACK
;
3632 x
->parent
->parent
->color
= MEM_RED
;
3633 x
= x
->parent
->parent
;
3637 /* Parent and uncle have different colors; parent is
3638 red, uncle is black. */
3639 if (x
== x
->parent
->right
)
3642 mem_rotate_left (x
);
3645 x
->parent
->color
= MEM_BLACK
;
3646 x
->parent
->parent
->color
= MEM_RED
;
3647 mem_rotate_right (x
->parent
->parent
);
3652 /* This is the symmetrical case of above. */
3653 struct mem_node
*y
= x
->parent
->parent
->left
;
3655 if (y
->color
== MEM_RED
)
3657 x
->parent
->color
= MEM_BLACK
;
3658 y
->color
= MEM_BLACK
;
3659 x
->parent
->parent
->color
= MEM_RED
;
3660 x
= x
->parent
->parent
;
3664 if (x
== x
->parent
->left
)
3667 mem_rotate_right (x
);
3670 x
->parent
->color
= MEM_BLACK
;
3671 x
->parent
->parent
->color
= MEM_RED
;
3672 mem_rotate_left (x
->parent
->parent
);
3677 /* The root may have been changed to red due to the algorithm. Set
3678 it to black so that property #5 is satisfied. */
3679 mem_root
->color
= MEM_BLACK
;
3690 mem_rotate_left (struct mem_node
*x
)
3694 /* Turn y's left sub-tree into x's right sub-tree. */
3697 if (y
->left
!= MEM_NIL
)
3698 y
->left
->parent
= x
;
3700 /* Y's parent was x's parent. */
3702 y
->parent
= x
->parent
;
3704 /* Get the parent to point to y instead of x. */
3707 if (x
== x
->parent
->left
)
3708 x
->parent
->left
= y
;
3710 x
->parent
->right
= y
;
3715 /* Put x on y's left. */
3729 mem_rotate_right (struct mem_node
*x
)
3731 struct mem_node
*y
= x
->left
;
3734 if (y
->right
!= MEM_NIL
)
3735 y
->right
->parent
= x
;
3738 y
->parent
= x
->parent
;
3741 if (x
== x
->parent
->right
)
3742 x
->parent
->right
= y
;
3744 x
->parent
->left
= y
;
3755 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
3758 mem_delete (struct mem_node
*z
)
3760 struct mem_node
*x
, *y
;
3762 if (!z
|| z
== MEM_NIL
)
3765 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
3770 while (y
->left
!= MEM_NIL
)
3774 if (y
->left
!= MEM_NIL
)
3779 x
->parent
= y
->parent
;
3782 if (y
== y
->parent
->left
)
3783 y
->parent
->left
= x
;
3785 y
->parent
->right
= x
;
3792 z
->start
= y
->start
;
3797 if (y
->color
== MEM_BLACK
)
3798 mem_delete_fixup (x
);
3800 #ifdef GC_MALLOC_CHECK
3808 /* Re-establish the red-black properties of the tree, after a
3812 mem_delete_fixup (struct mem_node
*x
)
3814 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
3816 if (x
== x
->parent
->left
)
3818 struct mem_node
*w
= x
->parent
->right
;
3820 if (w
->color
== MEM_RED
)
3822 w
->color
= MEM_BLACK
;
3823 x
->parent
->color
= MEM_RED
;
3824 mem_rotate_left (x
->parent
);
3825 w
= x
->parent
->right
;
3828 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
3835 if (w
->right
->color
== MEM_BLACK
)
3837 w
->left
->color
= MEM_BLACK
;
3839 mem_rotate_right (w
);
3840 w
= x
->parent
->right
;
3842 w
->color
= x
->parent
->color
;
3843 x
->parent
->color
= MEM_BLACK
;
3844 w
->right
->color
= MEM_BLACK
;
3845 mem_rotate_left (x
->parent
);
3851 struct mem_node
*w
= x
->parent
->left
;
3853 if (w
->color
== MEM_RED
)
3855 w
->color
= MEM_BLACK
;
3856 x
->parent
->color
= MEM_RED
;
3857 mem_rotate_right (x
->parent
);
3858 w
= x
->parent
->left
;
3861 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
3868 if (w
->left
->color
== MEM_BLACK
)
3870 w
->right
->color
= MEM_BLACK
;
3872 mem_rotate_left (w
);
3873 w
= x
->parent
->left
;
3876 w
->color
= x
->parent
->color
;
3877 x
->parent
->color
= MEM_BLACK
;
3878 w
->left
->color
= MEM_BLACK
;
3879 mem_rotate_right (x
->parent
);
3885 x
->color
= MEM_BLACK
;
3889 /* Value is non-zero if P is a pointer to a live Lisp string on
3890 the heap. M is a pointer to the mem_block for P. */
3893 live_string_p (struct mem_node
*m
, void *p
)
3895 if (m
->type
== MEM_TYPE_STRING
)
3897 struct string_block
*b
= (struct string_block
*) m
->start
;
3898 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
3900 /* P must point to the start of a Lisp_String structure, and it
3901 must not be on the free-list. */
3903 && offset
% sizeof b
->strings
[0] == 0
3904 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
3905 && ((struct Lisp_String
*) p
)->data
!= NULL
);
3912 /* Value is non-zero if P is a pointer to a live Lisp cons on
3913 the heap. M is a pointer to the mem_block for P. */
3916 live_cons_p (struct mem_node
*m
, void *p
)
3918 if (m
->type
== MEM_TYPE_CONS
)
3920 struct cons_block
*b
= (struct cons_block
*) m
->start
;
3921 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
3923 /* P must point to the start of a Lisp_Cons, not be
3924 one of the unused cells in the current cons block,
3925 and not be on the free-list. */
3927 && offset
% sizeof b
->conses
[0] == 0
3928 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
3930 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
3931 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
3938 /* Value is non-zero if P is a pointer to a live Lisp symbol on
3939 the heap. M is a pointer to the mem_block for P. */
3942 live_symbol_p (struct mem_node
*m
, void *p
)
3944 if (m
->type
== MEM_TYPE_SYMBOL
)
3946 struct symbol_block
*b
= (struct symbol_block
*) m
->start
;
3947 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
3949 /* P must point to the start of a Lisp_Symbol, not be
3950 one of the unused cells in the current symbol block,
3951 and not be on the free-list. */
3953 && offset
% sizeof b
->symbols
[0] == 0
3954 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
3955 && (b
!= symbol_block
3956 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
3957 && !EQ (((struct Lisp_Symbol
*) p
)->function
, Vdead
));
3964 /* Value is non-zero if P is a pointer to a live Lisp float on
3965 the heap. M is a pointer to the mem_block for P. */
3968 live_float_p (struct mem_node
*m
, void *p
)
3970 if (m
->type
== MEM_TYPE_FLOAT
)
3972 struct float_block
*b
= (struct float_block
*) m
->start
;
3973 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
3975 /* P must point to the start of a Lisp_Float and not be
3976 one of the unused cells in the current float block. */
3978 && offset
% sizeof b
->floats
[0] == 0
3979 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
3980 && (b
!= float_block
3981 || offset
/ sizeof b
->floats
[0] < float_block_index
));
3988 /* Value is non-zero if P is a pointer to a live Lisp Misc on
3989 the heap. M is a pointer to the mem_block for P. */
3992 live_misc_p (struct mem_node
*m
, void *p
)
3994 if (m
->type
== MEM_TYPE_MISC
)
3996 struct marker_block
*b
= (struct marker_block
*) m
->start
;
3997 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
3999 /* P must point to the start of a Lisp_Misc, not be
4000 one of the unused cells in the current misc block,
4001 and not be on the free-list. */
4003 && offset
% sizeof b
->markers
[0] == 0
4004 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4005 && (b
!= marker_block
4006 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4007 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4014 /* Value is non-zero if P is a pointer to a live vector-like object.
4015 M is a pointer to the mem_block for P. */
4018 live_vector_p (struct mem_node
*m
, void *p
)
4020 return (p
== m
->start
&& m
->type
== MEM_TYPE_VECTORLIKE
);
4024 /* Value is non-zero if P is a pointer to a live buffer. M is a
4025 pointer to the mem_block for P. */
4028 live_buffer_p (struct mem_node
*m
, void *p
)
4030 /* P must point to the start of the block, and the buffer
4031 must not have been killed. */
4032 return (m
->type
== MEM_TYPE_BUFFER
4034 && !NILP (((struct buffer
*) p
)->BUFFER_INTERNAL_FIELD (name
)));
4037 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4041 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4043 /* Array of objects that are kept alive because the C stack contains
4044 a pattern that looks like a reference to them . */
4046 #define MAX_ZOMBIES 10
4047 static Lisp_Object zombies
[MAX_ZOMBIES
];
4049 /* Number of zombie objects. */
4051 static EMACS_INT nzombies
;
4053 /* Number of garbage collections. */
4055 static EMACS_INT ngcs
;
4057 /* Average percentage of zombies per collection. */
4059 static double avg_zombies
;
4061 /* Max. number of live and zombie objects. */
4063 static EMACS_INT max_live
, max_zombies
;
4065 /* Average number of live objects per GC. */
4067 static double avg_live
;
4069 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4070 doc
: /* Show information about live and zombie objects. */)
4073 Lisp_Object args
[8], zombie_list
= Qnil
;
4075 for (i
= 0; i
< nzombies
; i
++)
4076 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4077 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4078 args
[1] = make_number (ngcs
);
4079 args
[2] = make_float (avg_live
);
4080 args
[3] = make_float (avg_zombies
);
4081 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4082 args
[5] = make_number (max_live
);
4083 args
[6] = make_number (max_zombies
);
4084 args
[7] = zombie_list
;
4085 return Fmessage (8, args
);
4088 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4091 /* Mark OBJ if we can prove it's a Lisp_Object. */
4094 mark_maybe_object (Lisp_Object obj
)
4102 po
= (void *) XPNTR (obj
);
4109 switch (XTYPE (obj
))
4112 mark_p
= (live_string_p (m
, po
)
4113 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4117 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4121 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4125 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4128 case Lisp_Vectorlike
:
4129 /* Note: can't check BUFFERP before we know it's a
4130 buffer because checking that dereferences the pointer
4131 PO which might point anywhere. */
4132 if (live_vector_p (m
, po
))
4133 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4134 else if (live_buffer_p (m
, po
))
4135 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4139 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4148 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4149 if (nzombies
< MAX_ZOMBIES
)
4150 zombies
[nzombies
] = obj
;
4159 /* If P points to Lisp data, mark that as live if it isn't already
4163 mark_maybe_pointer (void *p
)
4167 /* Quickly rule out some values which can't point to Lisp data. */
4170 8 /* USE_LSB_TAG needs Lisp data to be aligned on multiples of 8. */
4172 2 /* We assume that Lisp data is aligned on even addresses. */
4180 Lisp_Object obj
= Qnil
;
4184 case MEM_TYPE_NON_LISP
:
4185 /* Nothing to do; not a pointer to Lisp memory. */
4188 case MEM_TYPE_BUFFER
:
4189 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4190 XSETVECTOR (obj
, p
);
4194 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4198 case MEM_TYPE_STRING
:
4199 if (live_string_p (m
, p
)
4200 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4201 XSETSTRING (obj
, p
);
4205 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4209 case MEM_TYPE_SYMBOL
:
4210 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4211 XSETSYMBOL (obj
, p
);
4214 case MEM_TYPE_FLOAT
:
4215 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4219 case MEM_TYPE_VECTORLIKE
:
4220 if (live_vector_p (m
, p
))
4223 XSETVECTOR (tem
, p
);
4224 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4239 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4240 or END+OFFSET..START. */
4243 mark_memory (void *start
, void *end
, int offset
)
4248 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4252 /* Make START the pointer to the start of the memory region,
4253 if it isn't already. */
4261 /* Mark Lisp_Objects. */
4262 for (p
= (Lisp_Object
*) ((char *) start
+ offset
); (void *) p
< end
; ++p
)
4263 mark_maybe_object (*p
);
4265 /* Mark Lisp data pointed to. This is necessary because, in some
4266 situations, the C compiler optimizes Lisp objects away, so that
4267 only a pointer to them remains. Example:
4269 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4272 Lisp_Object obj = build_string ("test");
4273 struct Lisp_String *s = XSTRING (obj);
4274 Fgarbage_collect ();
4275 fprintf (stderr, "test `%s'\n", s->data);
4279 Here, `obj' isn't really used, and the compiler optimizes it
4280 away. The only reference to the life string is through the
4283 for (pp
= (void **) ((char *) start
+ offset
); (void *) pp
< end
; ++pp
)
4284 mark_maybe_pointer (*pp
);
4287 /* setjmp will work with GCC unless NON_SAVING_SETJMP is defined in
4288 the GCC system configuration. In gcc 3.2, the only systems for
4289 which this is so are i386-sco5 non-ELF, i386-sysv3 (maybe included
4290 by others?) and ns32k-pc532-min. */
4292 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4294 static int setjmp_tested_p
, longjmps_done
;
4296 #define SETJMP_WILL_LIKELY_WORK "\
4298 Emacs garbage collector has been changed to use conservative stack\n\
4299 marking. Emacs has determined that the method it uses to do the\n\
4300 marking will likely work on your system, but this isn't sure.\n\
4302 If you are a system-programmer, or can get the help of a local wizard\n\
4303 who is, please take a look at the function mark_stack in alloc.c, and\n\
4304 verify that the methods used are appropriate for your system.\n\
4306 Please mail the result to <emacs-devel@gnu.org>.\n\
4309 #define SETJMP_WILL_NOT_WORK "\
4311 Emacs garbage collector has been changed to use conservative stack\n\
4312 marking. Emacs has determined that the default method it uses to do the\n\
4313 marking will not work on your system. We will need a system-dependent\n\
4314 solution for your system.\n\
4316 Please take a look at the function mark_stack in alloc.c, and\n\
4317 try to find a way to make it work on your system.\n\
4319 Note that you may get false negatives, depending on the compiler.\n\
4320 In particular, you need to use -O with GCC for this test.\n\
4322 Please mail the result to <emacs-devel@gnu.org>.\n\
4326 /* Perform a quick check if it looks like setjmp saves registers in a
4327 jmp_buf. Print a message to stderr saying so. When this test
4328 succeeds, this is _not_ a proof that setjmp is sufficient for
4329 conservative stack marking. Only the sources or a disassembly
4340 /* Arrange for X to be put in a register. */
4346 if (longjmps_done
== 1)
4348 /* Came here after the longjmp at the end of the function.
4350 If x == 1, the longjmp has restored the register to its
4351 value before the setjmp, and we can hope that setjmp
4352 saves all such registers in the jmp_buf, although that
4355 For other values of X, either something really strange is
4356 taking place, or the setjmp just didn't save the register. */
4359 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4362 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4369 if (longjmps_done
== 1)
4373 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4376 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4378 /* Abort if anything GCPRO'd doesn't survive the GC. */
4386 for (p
= gcprolist
; p
; p
= p
->next
)
4387 for (i
= 0; i
< p
->nvars
; ++i
)
4388 if (!survives_gc_p (p
->var
[i
]))
4389 /* FIXME: It's not necessarily a bug. It might just be that the
4390 GCPRO is unnecessary or should release the object sooner. */
4394 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4401 fprintf (stderr
, "\nZombies kept alive = %"pI
":\n", nzombies
);
4402 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4404 fprintf (stderr
, " %d = ", i
);
4405 debug_print (zombies
[i
]);
4409 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4412 /* Mark live Lisp objects on the C stack.
4414 There are several system-dependent problems to consider when
4415 porting this to new architectures:
4419 We have to mark Lisp objects in CPU registers that can hold local
4420 variables or are used to pass parameters.
4422 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4423 something that either saves relevant registers on the stack, or
4424 calls mark_maybe_object passing it each register's contents.
4426 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4427 implementation assumes that calling setjmp saves registers we need
4428 to see in a jmp_buf which itself lies on the stack. This doesn't
4429 have to be true! It must be verified for each system, possibly
4430 by taking a look at the source code of setjmp.
4432 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4433 can use it as a machine independent method to store all registers
4434 to the stack. In this case the macros described in the previous
4435 two paragraphs are not used.
4439 Architectures differ in the way their processor stack is organized.
4440 For example, the stack might look like this
4443 | Lisp_Object | size = 4
4445 | something else | size = 2
4447 | Lisp_Object | size = 4
4451 In such a case, not every Lisp_Object will be aligned equally. To
4452 find all Lisp_Object on the stack it won't be sufficient to walk
4453 the stack in steps of 4 bytes. Instead, two passes will be
4454 necessary, one starting at the start of the stack, and a second
4455 pass starting at the start of the stack + 2. Likewise, if the
4456 minimal alignment of Lisp_Objects on the stack is 1, four passes
4457 would be necessary, each one starting with one byte more offset
4458 from the stack start.
4460 The current code assumes by default that Lisp_Objects are aligned
4461 equally on the stack. */
4469 #ifdef HAVE___BUILTIN_UNWIND_INIT
4470 /* Force callee-saved registers and register windows onto the stack.
4471 This is the preferred method if available, obviating the need for
4472 machine dependent methods. */
4473 __builtin_unwind_init ();
4475 #else /* not HAVE___BUILTIN_UNWIND_INIT */
4476 #ifndef GC_SAVE_REGISTERS_ON_STACK
4477 /* jmp_buf may not be aligned enough on darwin-ppc64 */
4478 union aligned_jmpbuf
{
4482 volatile int stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4484 /* This trick flushes the register windows so that all the state of
4485 the process is contained in the stack. */
4486 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4487 needed on ia64 too. See mach_dep.c, where it also says inline
4488 assembler doesn't work with relevant proprietary compilers. */
4490 #if defined (__sparc64__) && defined (__FreeBSD__)
4491 /* FreeBSD does not have a ta 3 handler. */
4498 /* Save registers that we need to see on the stack. We need to see
4499 registers used to hold register variables and registers used to
4501 #ifdef GC_SAVE_REGISTERS_ON_STACK
4502 GC_SAVE_REGISTERS_ON_STACK (end
);
4503 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4505 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4506 setjmp will definitely work, test it
4507 and print a message with the result
4509 if (!setjmp_tested_p
)
4511 setjmp_tested_p
= 1;
4514 #endif /* GC_SETJMP_WORKS */
4517 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4518 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4519 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
4521 /* This assumes that the stack is a contiguous region in memory. If
4522 that's not the case, something has to be done here to iterate
4523 over the stack segments. */
4524 #ifndef GC_LISP_OBJECT_ALIGNMENT
4526 #define GC_LISP_OBJECT_ALIGNMENT __alignof__ (Lisp_Object)
4528 #define GC_LISP_OBJECT_ALIGNMENT sizeof (Lisp_Object)
4531 for (i
= 0; i
< sizeof (Lisp_Object
); i
+= GC_LISP_OBJECT_ALIGNMENT
)
4532 mark_memory (stack_base
, end
, i
);
4533 /* Allow for marking a secondary stack, like the register stack on the
4535 #ifdef GC_MARK_SECONDARY_STACK
4536 GC_MARK_SECONDARY_STACK ();
4539 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4544 #endif /* GC_MARK_STACK != 0 */
4547 /* Determine whether it is safe to access memory at address P. */
4549 valid_pointer_p (void *p
)
4552 return w32_valid_pointer_p (p
, 16);
4556 /* Obviously, we cannot just access it (we would SEGV trying), so we
4557 trick the o/s to tell us whether p is a valid pointer.
4558 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4559 not validate p in that case. */
4563 int valid
= (emacs_write (fd
[1], (char *) p
, 16) == 16);
4564 emacs_close (fd
[1]);
4565 emacs_close (fd
[0]);
4573 /* Return 1 if OBJ is a valid lisp object.
4574 Return 0 if OBJ is NOT a valid lisp object.
4575 Return -1 if we cannot validate OBJ.
4576 This function can be quite slow,
4577 so it should only be used in code for manual debugging. */
4580 valid_lisp_object_p (Lisp_Object obj
)
4590 p
= (void *) XPNTR (obj
);
4591 if (PURE_POINTER_P (p
))
4595 return valid_pointer_p (p
);
4602 int valid
= valid_pointer_p (p
);
4614 case MEM_TYPE_NON_LISP
:
4617 case MEM_TYPE_BUFFER
:
4618 return live_buffer_p (m
, p
);
4621 return live_cons_p (m
, p
);
4623 case MEM_TYPE_STRING
:
4624 return live_string_p (m
, p
);
4627 return live_misc_p (m
, p
);
4629 case MEM_TYPE_SYMBOL
:
4630 return live_symbol_p (m
, p
);
4632 case MEM_TYPE_FLOAT
:
4633 return live_float_p (m
, p
);
4635 case MEM_TYPE_VECTORLIKE
:
4636 return live_vector_p (m
, p
);
4649 /***********************************************************************
4650 Pure Storage Management
4651 ***********************************************************************/
4653 /* Allocate room for SIZE bytes from pure Lisp storage and return a
4654 pointer to it. TYPE is the Lisp type for which the memory is
4655 allocated. TYPE < 0 means it's not used for a Lisp object. */
4657 static POINTER_TYPE
*
4658 pure_alloc (size_t size
, int type
)
4660 POINTER_TYPE
*result
;
4662 size_t alignment
= (1 << GCTYPEBITS
);
4664 size_t alignment
= sizeof (EMACS_INT
);
4666 /* Give Lisp_Floats an extra alignment. */
4667 if (type
== Lisp_Float
)
4669 #if defined __GNUC__ && __GNUC__ >= 2
4670 alignment
= __alignof (struct Lisp_Float
);
4672 alignment
= sizeof (struct Lisp_Float
);
4680 /* Allocate space for a Lisp object from the beginning of the free
4681 space with taking account of alignment. */
4682 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
4683 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
4687 /* Allocate space for a non-Lisp object from the end of the free
4689 pure_bytes_used_non_lisp
+= size
;
4690 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4692 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
4694 if (pure_bytes_used
<= pure_size
)
4697 /* Don't allocate a large amount here,
4698 because it might get mmap'd and then its address
4699 might not be usable. */
4700 purebeg
= (char *) xmalloc (10000);
4702 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
4703 pure_bytes_used
= 0;
4704 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
4709 /* Print a warning if PURESIZE is too small. */
4712 check_pure_size (void)
4714 if (pure_bytes_used_before_overflow
)
4715 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
4717 pure_bytes_used
+ pure_bytes_used_before_overflow
);
4721 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
4722 the non-Lisp data pool of the pure storage, and return its start
4723 address. Return NULL if not found. */
4726 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
4729 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
4730 const unsigned char *p
;
4733 if (pure_bytes_used_non_lisp
<= nbytes
)
4736 /* Set up the Boyer-Moore table. */
4738 for (i
= 0; i
< 256; i
++)
4741 p
= (const unsigned char *) data
;
4743 bm_skip
[*p
++] = skip
;
4745 last_char_skip
= bm_skip
['\0'];
4747 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4748 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
4750 /* See the comments in the function `boyer_moore' (search.c) for the
4751 use of `infinity'. */
4752 infinity
= pure_bytes_used_non_lisp
+ 1;
4753 bm_skip
['\0'] = infinity
;
4755 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
4759 /* Check the last character (== '\0'). */
4762 start
+= bm_skip
[*(p
+ start
)];
4764 while (start
<= start_max
);
4766 if (start
< infinity
)
4767 /* Couldn't find the last character. */
4770 /* No less than `infinity' means we could find the last
4771 character at `p[start - infinity]'. */
4774 /* Check the remaining characters. */
4775 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
4777 return non_lisp_beg
+ start
;
4779 start
+= last_char_skip
;
4781 while (start
<= start_max
);
4787 /* Return a string allocated in pure space. DATA is a buffer holding
4788 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
4789 non-zero means make the result string multibyte.
4791 Must get an error if pure storage is full, since if it cannot hold
4792 a large string it may be able to hold conses that point to that
4793 string; then the string is not protected from gc. */
4796 make_pure_string (const char *data
,
4797 ptrdiff_t nchars
, ptrdiff_t nbytes
, int multibyte
)
4800 struct Lisp_String
*s
;
4802 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
4803 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
4804 if (s
->data
== NULL
)
4806 s
->data
= (unsigned char *) pure_alloc (nbytes
+ 1, -1);
4807 memcpy (s
->data
, data
, nbytes
);
4808 s
->data
[nbytes
] = '\0';
4811 s
->size_byte
= multibyte
? nbytes
: -1;
4812 s
->intervals
= NULL_INTERVAL
;
4813 XSETSTRING (string
, s
);
4817 /* Return a string a string allocated in pure space. Do not allocate
4818 the string data, just point to DATA. */
4821 make_pure_c_string (const char *data
)
4824 struct Lisp_String
*s
;
4825 ptrdiff_t nchars
= strlen (data
);
4827 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
4830 s
->data
= (unsigned char *) data
;
4831 s
->intervals
= NULL_INTERVAL
;
4832 XSETSTRING (string
, s
);
4836 /* Return a cons allocated from pure space. Give it pure copies
4837 of CAR as car and CDR as cdr. */
4840 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
4842 register Lisp_Object
new;
4843 struct Lisp_Cons
*p
;
4845 p
= (struct Lisp_Cons
*) pure_alloc (sizeof *p
, Lisp_Cons
);
4847 XSETCAR (new, Fpurecopy (car
));
4848 XSETCDR (new, Fpurecopy (cdr
));
4853 /* Value is a float object with value NUM allocated from pure space. */
4856 make_pure_float (double num
)
4858 register Lisp_Object
new;
4859 struct Lisp_Float
*p
;
4861 p
= (struct Lisp_Float
*) pure_alloc (sizeof *p
, Lisp_Float
);
4863 XFLOAT_INIT (new, num
);
4868 /* Return a vector with room for LEN Lisp_Objects allocated from
4872 make_pure_vector (ptrdiff_t len
)
4875 struct Lisp_Vector
*p
;
4876 size_t size
= (offsetof (struct Lisp_Vector
, contents
)
4877 + len
* sizeof (Lisp_Object
));
4879 p
= (struct Lisp_Vector
*) pure_alloc (size
, Lisp_Vectorlike
);
4880 XSETVECTOR (new, p
);
4881 XVECTOR (new)->header
.size
= len
;
4886 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
4887 doc
: /* Make a copy of object OBJ in pure storage.
4888 Recursively copies contents of vectors and cons cells.
4889 Does not copy symbols. Copies strings without text properties. */)
4890 (register Lisp_Object obj
)
4892 if (NILP (Vpurify_flag
))
4895 if (PURE_POINTER_P (XPNTR (obj
)))
4898 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
4900 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
4906 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
4907 else if (FLOATP (obj
))
4908 obj
= make_pure_float (XFLOAT_DATA (obj
));
4909 else if (STRINGP (obj
))
4910 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
4912 STRING_MULTIBYTE (obj
));
4913 else if (COMPILEDP (obj
) || VECTORP (obj
))
4915 register struct Lisp_Vector
*vec
;
4916 register ptrdiff_t i
;
4920 if (size
& PSEUDOVECTOR_FLAG
)
4921 size
&= PSEUDOVECTOR_SIZE_MASK
;
4922 vec
= XVECTOR (make_pure_vector (size
));
4923 for (i
= 0; i
< size
; i
++)
4924 vec
->contents
[i
] = Fpurecopy (XVECTOR (obj
)->contents
[i
]);
4925 if (COMPILEDP (obj
))
4927 XSETPVECTYPE (vec
, PVEC_COMPILED
);
4928 XSETCOMPILED (obj
, vec
);
4931 XSETVECTOR (obj
, vec
);
4933 else if (MARKERP (obj
))
4934 error ("Attempt to copy a marker to pure storage");
4936 /* Not purified, don't hash-cons. */
4939 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
4940 Fputhash (obj
, obj
, Vpurify_flag
);
4947 /***********************************************************************
4949 ***********************************************************************/
4951 /* Put an entry in staticvec, pointing at the variable with address
4955 staticpro (Lisp_Object
*varaddress
)
4957 staticvec
[staticidx
++] = varaddress
;
4958 if (staticidx
>= NSTATICS
)
4963 /***********************************************************************
4965 ***********************************************************************/
4967 /* Temporarily prevent garbage collection. */
4970 inhibit_garbage_collection (void)
4972 ptrdiff_t count
= SPECPDL_INDEX ();
4974 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
4979 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
4980 doc
: /* Reclaim storage for Lisp objects no longer needed.
4981 Garbage collection happens automatically if you cons more than
4982 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
4983 `garbage-collect' normally returns a list with info on amount of space in use:
4984 ((USED-CONSES . FREE-CONSES) (USED-SYMS . FREE-SYMS)
4985 (USED-MARKERS . FREE-MARKERS) USED-STRING-CHARS USED-VECTOR-SLOTS
4986 (USED-FLOATS . FREE-FLOATS) (USED-INTERVALS . FREE-INTERVALS)
4987 (USED-STRINGS . FREE-STRINGS))
4988 However, if there was overflow in pure space, `garbage-collect'
4989 returns nil, because real GC can't be done. */)
4992 register struct specbinding
*bind
;
4993 char stack_top_variable
;
4996 Lisp_Object total
[8];
4997 ptrdiff_t count
= SPECPDL_INDEX ();
4998 EMACS_TIME t1
, t2
, t3
;
5003 /* Can't GC if pure storage overflowed because we can't determine
5004 if something is a pure object or not. */
5005 if (pure_bytes_used_before_overflow
)
5010 /* Don't keep undo information around forever.
5011 Do this early on, so it is no problem if the user quits. */
5013 register struct buffer
*nextb
= all_buffers
;
5017 /* If a buffer's undo list is Qt, that means that undo is
5018 turned off in that buffer. Calling truncate_undo_list on
5019 Qt tends to return NULL, which effectively turns undo back on.
5020 So don't call truncate_undo_list if undo_list is Qt. */
5021 if (! NILP (nextb
->BUFFER_INTERNAL_FIELD (name
)) && ! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
5022 truncate_undo_list (nextb
);
5024 /* Shrink buffer gaps, but skip indirect and dead buffers. */
5025 if (nextb
->base_buffer
== 0 && !NILP (nextb
->BUFFER_INTERNAL_FIELD (name
))
5026 && ! nextb
->text
->inhibit_shrinking
)
5028 /* If a buffer's gap size is more than 10% of the buffer
5029 size, or larger than 2000 bytes, then shrink it
5030 accordingly. Keep a minimum size of 20 bytes. */
5031 int size
= min (2000, max (20, (nextb
->text
->z_byte
/ 10)));
5033 if (nextb
->text
->gap_size
> size
)
5035 struct buffer
*save_current
= current_buffer
;
5036 current_buffer
= nextb
;
5037 make_gap (-(nextb
->text
->gap_size
- size
));
5038 current_buffer
= save_current
;
5042 nextb
= nextb
->header
.next
.buffer
;
5046 EMACS_GET_TIME (t1
);
5048 /* In case user calls debug_print during GC,
5049 don't let that cause a recursive GC. */
5050 consing_since_gc
= 0;
5052 /* Save what's currently displayed in the echo area. */
5053 message_p
= push_message ();
5054 record_unwind_protect (pop_message_unwind
, Qnil
);
5056 /* Save a copy of the contents of the stack, for debugging. */
5057 #if MAX_SAVE_STACK > 0
5058 if (NILP (Vpurify_flag
))
5061 ptrdiff_t stack_size
;
5062 if (&stack_top_variable
< stack_bottom
)
5064 stack
= &stack_top_variable
;
5065 stack_size
= stack_bottom
- &stack_top_variable
;
5069 stack
= stack_bottom
;
5070 stack_size
= &stack_top_variable
- stack_bottom
;
5072 if (stack_size
<= MAX_SAVE_STACK
)
5074 if (stack_copy_size
< stack_size
)
5076 stack_copy
= (char *) xrealloc (stack_copy
, stack_size
);
5077 stack_copy_size
= stack_size
;
5079 memcpy (stack_copy
, stack
, stack_size
);
5082 #endif /* MAX_SAVE_STACK > 0 */
5084 if (garbage_collection_messages
)
5085 message1_nolog ("Garbage collecting...");
5089 shrink_regexp_cache ();
5093 /* clear_marks (); */
5095 /* Mark all the special slots that serve as the roots of accessibility. */
5097 for (i
= 0; i
< staticidx
; i
++)
5098 mark_object (*staticvec
[i
]);
5100 for (bind
= specpdl
; bind
!= specpdl_ptr
; bind
++)
5102 mark_object (bind
->symbol
);
5103 mark_object (bind
->old_value
);
5111 extern void xg_mark_data (void);
5116 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5117 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5121 register struct gcpro
*tail
;
5122 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5123 for (i
= 0; i
< tail
->nvars
; i
++)
5124 mark_object (tail
->var
[i
]);
5128 struct catchtag
*catch;
5129 struct handler
*handler
;
5131 for (catch = catchlist
; catch; catch = catch->next
)
5133 mark_object (catch->tag
);
5134 mark_object (catch->val
);
5136 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5138 mark_object (handler
->handler
);
5139 mark_object (handler
->var
);
5145 #ifdef HAVE_WINDOW_SYSTEM
5146 mark_fringe_data ();
5149 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5153 /* Everything is now marked, except for the things that require special
5154 finalization, i.e. the undo_list.
5155 Look thru every buffer's undo list
5156 for elements that update markers that were not marked,
5159 register struct buffer
*nextb
= all_buffers
;
5163 /* If a buffer's undo list is Qt, that means that undo is
5164 turned off in that buffer. Calling truncate_undo_list on
5165 Qt tends to return NULL, which effectively turns undo back on.
5166 So don't call truncate_undo_list if undo_list is Qt. */
5167 if (! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
5169 Lisp_Object tail
, prev
;
5170 tail
= nextb
->BUFFER_INTERNAL_FIELD (undo_list
);
5172 while (CONSP (tail
))
5174 if (CONSP (XCAR (tail
))
5175 && MARKERP (XCAR (XCAR (tail
)))
5176 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5179 nextb
->BUFFER_INTERNAL_FIELD (undo_list
) = tail
= XCDR (tail
);
5183 XSETCDR (prev
, tail
);
5193 /* Now that we have stripped the elements that need not be in the
5194 undo_list any more, we can finally mark the list. */
5195 mark_object (nextb
->BUFFER_INTERNAL_FIELD (undo_list
));
5197 nextb
= nextb
->header
.next
.buffer
;
5203 /* Clear the mark bits that we set in certain root slots. */
5205 unmark_byte_stack ();
5206 VECTOR_UNMARK (&buffer_defaults
);
5207 VECTOR_UNMARK (&buffer_local_symbols
);
5209 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5217 /* clear_marks (); */
5220 consing_since_gc
= 0;
5221 if (gc_cons_threshold
< 10000)
5222 gc_cons_threshold
= 10000;
5224 gc_relative_threshold
= 0;
5225 if (FLOATP (Vgc_cons_percentage
))
5226 { /* Set gc_cons_combined_threshold. */
5229 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5230 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5231 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5232 tot
+= total_string_size
;
5233 tot
+= total_vector_size
* sizeof (Lisp_Object
);
5234 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5235 tot
+= total_intervals
* sizeof (struct interval
);
5236 tot
+= total_strings
* sizeof (struct Lisp_String
);
5238 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5241 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5242 gc_relative_threshold
= tot
;
5244 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5248 if (garbage_collection_messages
)
5250 if (message_p
|| minibuf_level
> 0)
5253 message1_nolog ("Garbage collecting...done");
5256 unbind_to (count
, Qnil
);
5258 total
[0] = Fcons (make_number (total_conses
),
5259 make_number (total_free_conses
));
5260 total
[1] = Fcons (make_number (total_symbols
),
5261 make_number (total_free_symbols
));
5262 total
[2] = Fcons (make_number (total_markers
),
5263 make_number (total_free_markers
));
5264 total
[3] = make_number (total_string_size
);
5265 total
[4] = make_number (total_vector_size
);
5266 total
[5] = Fcons (make_number (total_floats
),
5267 make_number (total_free_floats
));
5268 total
[6] = Fcons (make_number (total_intervals
),
5269 make_number (total_free_intervals
));
5270 total
[7] = Fcons (make_number (total_strings
),
5271 make_number (total_free_strings
));
5273 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5275 /* Compute average percentage of zombies. */
5278 for (i
= 0; i
< 7; ++i
)
5279 if (CONSP (total
[i
]))
5280 nlive
+= XFASTINT (XCAR (total
[i
]));
5282 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5283 max_live
= max (nlive
, max_live
);
5284 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5285 max_zombies
= max (nzombies
, max_zombies
);
5290 if (!NILP (Vpost_gc_hook
))
5292 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5293 safe_run_hooks (Qpost_gc_hook
);
5294 unbind_to (gc_count
, Qnil
);
5297 /* Accumulate statistics. */
5298 EMACS_GET_TIME (t2
);
5299 EMACS_SUB_TIME (t3
, t2
, t1
);
5300 if (FLOATP (Vgc_elapsed
))
5301 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
) +
5303 EMACS_USECS (t3
) * 1.0e-6);
5306 return Flist (sizeof total
/ sizeof *total
, total
);
5310 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5311 only interesting objects referenced from glyphs are strings. */
5314 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5316 struct glyph_row
*row
= matrix
->rows
;
5317 struct glyph_row
*end
= row
+ matrix
->nrows
;
5319 for (; row
< end
; ++row
)
5323 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5325 struct glyph
*glyph
= row
->glyphs
[area
];
5326 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5328 for (; glyph
< end_glyph
; ++glyph
)
5329 if (STRINGP (glyph
->object
)
5330 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5331 mark_object (glyph
->object
);
5337 /* Mark Lisp faces in the face cache C. */
5340 mark_face_cache (struct face_cache
*c
)
5345 for (i
= 0; i
< c
->used
; ++i
)
5347 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5351 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5352 mark_object (face
->lface
[j
]);
5360 /* Mark reference to a Lisp_Object.
5361 If the object referred to has not been seen yet, recursively mark
5362 all the references contained in it. */
5364 #define LAST_MARKED_SIZE 500
5365 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5366 static int last_marked_index
;
5368 /* For debugging--call abort when we cdr down this many
5369 links of a list, in mark_object. In debugging,
5370 the call to abort will hit a breakpoint.
5371 Normally this is zero and the check never goes off. */
5372 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5375 mark_vectorlike (struct Lisp_Vector
*ptr
)
5377 ptrdiff_t size
= ptr
->header
.size
;
5380 eassert (!VECTOR_MARKED_P (ptr
));
5381 VECTOR_MARK (ptr
); /* Else mark it */
5382 if (size
& PSEUDOVECTOR_FLAG
)
5383 size
&= PSEUDOVECTOR_SIZE_MASK
;
5385 /* Note that this size is not the memory-footprint size, but only
5386 the number of Lisp_Object fields that we should trace.
5387 The distinction is used e.g. by Lisp_Process which places extra
5388 non-Lisp_Object fields at the end of the structure. */
5389 for (i
= 0; i
< size
; i
++) /* and then mark its elements */
5390 mark_object (ptr
->contents
[i
]);
5393 /* Like mark_vectorlike but optimized for char-tables (and
5394 sub-char-tables) assuming that the contents are mostly integers or
5398 mark_char_table (struct Lisp_Vector
*ptr
)
5400 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5403 eassert (!VECTOR_MARKED_P (ptr
));
5405 for (i
= 0; i
< size
; i
++)
5407 Lisp_Object val
= ptr
->contents
[i
];
5409 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5411 if (SUB_CHAR_TABLE_P (val
))
5413 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5414 mark_char_table (XVECTOR (val
));
5422 mark_object (Lisp_Object arg
)
5424 register Lisp_Object obj
= arg
;
5425 #ifdef GC_CHECK_MARKED_OBJECTS
5429 ptrdiff_t cdr_count
= 0;
5433 if (PURE_POINTER_P (XPNTR (obj
)))
5436 last_marked
[last_marked_index
++] = obj
;
5437 if (last_marked_index
== LAST_MARKED_SIZE
)
5438 last_marked_index
= 0;
5440 /* Perform some sanity checks on the objects marked here. Abort if
5441 we encounter an object we know is bogus. This increases GC time
5442 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5443 #ifdef GC_CHECK_MARKED_OBJECTS
5445 po
= (void *) XPNTR (obj
);
5447 /* Check that the object pointed to by PO is known to be a Lisp
5448 structure allocated from the heap. */
5449 #define CHECK_ALLOCATED() \
5451 m = mem_find (po); \
5456 /* Check that the object pointed to by PO is live, using predicate
5458 #define CHECK_LIVE(LIVEP) \
5460 if (!LIVEP (m, po)) \
5464 /* Check both of the above conditions. */
5465 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5467 CHECK_ALLOCATED (); \
5468 CHECK_LIVE (LIVEP); \
5471 #else /* not GC_CHECK_MARKED_OBJECTS */
5473 #define CHECK_LIVE(LIVEP) (void) 0
5474 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5476 #endif /* not GC_CHECK_MARKED_OBJECTS */
5478 switch (SWITCH_ENUM_CAST (XTYPE (obj
)))
5482 register struct Lisp_String
*ptr
= XSTRING (obj
);
5483 if (STRING_MARKED_P (ptr
))
5485 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
5486 MARK_INTERVAL_TREE (ptr
->intervals
);
5488 #ifdef GC_CHECK_STRING_BYTES
5489 /* Check that the string size recorded in the string is the
5490 same as the one recorded in the sdata structure. */
5491 CHECK_STRING_BYTES (ptr
);
5492 #endif /* GC_CHECK_STRING_BYTES */
5496 case Lisp_Vectorlike
:
5497 if (VECTOR_MARKED_P (XVECTOR (obj
)))
5499 #ifdef GC_CHECK_MARKED_OBJECTS
5501 if (m
== MEM_NIL
&& !SUBRP (obj
)
5502 && po
!= &buffer_defaults
5503 && po
!= &buffer_local_symbols
)
5505 #endif /* GC_CHECK_MARKED_OBJECTS */
5509 #ifdef GC_CHECK_MARKED_OBJECTS
5510 if (po
!= &buffer_defaults
&& po
!= &buffer_local_symbols
)
5513 for (b
= all_buffers
; b
&& b
!= po
; b
= b
->header
.next
.buffer
)
5518 #endif /* GC_CHECK_MARKED_OBJECTS */
5521 else if (SUBRP (obj
))
5523 else if (COMPILEDP (obj
))
5524 /* We could treat this just like a vector, but it is better to
5525 save the COMPILED_CONSTANTS element for last and avoid
5528 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5529 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5532 CHECK_LIVE (live_vector_p
);
5533 VECTOR_MARK (ptr
); /* Else mark it */
5534 for (i
= 0; i
< size
; i
++) /* and then mark its elements */
5536 if (i
!= COMPILED_CONSTANTS
)
5537 mark_object (ptr
->contents
[i
]);
5539 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
5542 else if (FRAMEP (obj
))
5544 register struct frame
*ptr
= XFRAME (obj
);
5545 mark_vectorlike (XVECTOR (obj
));
5546 mark_face_cache (ptr
->face_cache
);
5548 else if (WINDOWP (obj
))
5550 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5551 struct window
*w
= XWINDOW (obj
);
5552 mark_vectorlike (ptr
);
5553 /* Mark glyphs for leaf windows. Marking window matrices is
5554 sufficient because frame matrices use the same glyph
5556 if (NILP (w
->hchild
)
5558 && w
->current_matrix
)
5560 mark_glyph_matrix (w
->current_matrix
);
5561 mark_glyph_matrix (w
->desired_matrix
);
5564 else if (HASH_TABLE_P (obj
))
5566 struct Lisp_Hash_Table
*h
= XHASH_TABLE (obj
);
5567 mark_vectorlike ((struct Lisp_Vector
*)h
);
5568 /* If hash table is not weak, mark all keys and values.
5569 For weak tables, mark only the vector. */
5571 mark_object (h
->key_and_value
);
5573 VECTOR_MARK (XVECTOR (h
->key_and_value
));
5575 else if (CHAR_TABLE_P (obj
))
5576 mark_char_table (XVECTOR (obj
));
5578 mark_vectorlike (XVECTOR (obj
));
5583 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
5584 struct Lisp_Symbol
*ptrx
;
5588 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
5590 mark_object (ptr
->function
);
5591 mark_object (ptr
->plist
);
5592 switch (ptr
->redirect
)
5594 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
5595 case SYMBOL_VARALIAS
:
5598 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
5602 case SYMBOL_LOCALIZED
:
5604 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
5605 /* If the value is forwarded to a buffer or keyboard field,
5606 these are marked when we see the corresponding object.
5607 And if it's forwarded to a C variable, either it's not
5608 a Lisp_Object var, or it's staticpro'd already. */
5609 mark_object (blv
->where
);
5610 mark_object (blv
->valcell
);
5611 mark_object (blv
->defcell
);
5614 case SYMBOL_FORWARDED
:
5615 /* If the value is forwarded to a buffer or keyboard field,
5616 these are marked when we see the corresponding object.
5617 And if it's forwarded to a C variable, either it's not
5618 a Lisp_Object var, or it's staticpro'd already. */
5622 if (!PURE_POINTER_P (XSTRING (ptr
->xname
)))
5623 MARK_STRING (XSTRING (ptr
->xname
));
5624 MARK_INTERVAL_TREE (STRING_INTERVALS (ptr
->xname
));
5629 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun */
5630 XSETSYMBOL (obj
, ptrx
);
5637 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
5638 if (XMISCANY (obj
)->gcmarkbit
)
5640 XMISCANY (obj
)->gcmarkbit
= 1;
5642 switch (XMISCTYPE (obj
))
5645 case Lisp_Misc_Marker
:
5646 /* DO NOT mark thru the marker's chain.
5647 The buffer's markers chain does not preserve markers from gc;
5648 instead, markers are removed from the chain when freed by gc. */
5651 case Lisp_Misc_Save_Value
:
5654 register struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
5655 /* If DOGC is set, POINTER is the address of a memory
5656 area containing INTEGER potential Lisp_Objects. */
5659 Lisp_Object
*p
= (Lisp_Object
*) ptr
->pointer
;
5661 for (nelt
= ptr
->integer
; nelt
> 0; nelt
--, p
++)
5662 mark_maybe_object (*p
);
5668 case Lisp_Misc_Overlay
:
5670 struct Lisp_Overlay
*ptr
= XOVERLAY (obj
);
5671 mark_object (ptr
->start
);
5672 mark_object (ptr
->end
);
5673 mark_object (ptr
->plist
);
5676 XSETMISC (obj
, ptr
->next
);
5689 register struct Lisp_Cons
*ptr
= XCONS (obj
);
5690 if (CONS_MARKED_P (ptr
))
5692 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
5694 /* If the cdr is nil, avoid recursion for the car. */
5695 if (EQ (ptr
->u
.cdr
, Qnil
))
5701 mark_object (ptr
->car
);
5704 if (cdr_count
== mark_object_loop_halt
)
5710 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
5711 FLOAT_MARK (XFLOAT (obj
));
5722 #undef CHECK_ALLOCATED
5723 #undef CHECK_ALLOCATED_AND_LIVE
5726 /* Mark the pointers in a buffer structure. */
5729 mark_buffer (Lisp_Object buf
)
5731 register struct buffer
*buffer
= XBUFFER (buf
);
5732 register Lisp_Object
*ptr
, tmp
;
5733 Lisp_Object base_buffer
;
5735 eassert (!VECTOR_MARKED_P (buffer
));
5736 VECTOR_MARK (buffer
);
5738 MARK_INTERVAL_TREE (BUF_INTERVALS (buffer
));
5740 /* For now, we just don't mark the undo_list. It's done later in
5741 a special way just before the sweep phase, and after stripping
5742 some of its elements that are not needed any more. */
5744 if (buffer
->overlays_before
)
5746 XSETMISC (tmp
, buffer
->overlays_before
);
5749 if (buffer
->overlays_after
)
5751 XSETMISC (tmp
, buffer
->overlays_after
);
5755 /* buffer-local Lisp variables start at `undo_list',
5756 tho only the ones from `name' on are GC'd normally. */
5757 for (ptr
= &buffer
->BUFFER_INTERNAL_FIELD (name
);
5758 ptr
<= &PER_BUFFER_VALUE (buffer
,
5759 PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER
));
5763 /* If this is an indirect buffer, mark its base buffer. */
5764 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5766 XSETBUFFER (base_buffer
, buffer
->base_buffer
);
5767 mark_buffer (base_buffer
);
5771 /* Mark the Lisp pointers in the terminal objects.
5772 Called by the Fgarbage_collector. */
5775 mark_terminals (void)
5778 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5780 eassert (t
->name
!= NULL
);
5781 #ifdef HAVE_WINDOW_SYSTEM
5782 /* If a terminal object is reachable from a stacpro'ed object,
5783 it might have been marked already. Make sure the image cache
5785 mark_image_cache (t
->image_cache
);
5786 #endif /* HAVE_WINDOW_SYSTEM */
5787 if (!VECTOR_MARKED_P (t
))
5788 mark_vectorlike ((struct Lisp_Vector
*)t
);
5794 /* Value is non-zero if OBJ will survive the current GC because it's
5795 either marked or does not need to be marked to survive. */
5798 survives_gc_p (Lisp_Object obj
)
5802 switch (XTYPE (obj
))
5809 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
5813 survives_p
= XMISCANY (obj
)->gcmarkbit
;
5817 survives_p
= STRING_MARKED_P (XSTRING (obj
));
5820 case Lisp_Vectorlike
:
5821 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
5825 survives_p
= CONS_MARKED_P (XCONS (obj
));
5829 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
5836 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
5841 /* Sweep: find all structures not marked, and free them. */
5846 /* Remove or mark entries in weak hash tables.
5847 This must be done before any object is unmarked. */
5848 sweep_weak_hash_tables ();
5851 #ifdef GC_CHECK_STRING_BYTES
5852 if (!noninteractive
)
5853 check_string_bytes (1);
5856 /* Put all unmarked conses on free list */
5858 register struct cons_block
*cblk
;
5859 struct cons_block
**cprev
= &cons_block
;
5860 register int lim
= cons_block_index
;
5861 EMACS_INT num_free
= 0, num_used
= 0;
5865 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
5869 int ilim
= (lim
+ BITS_PER_INT
- 1) / BITS_PER_INT
;
5871 /* Scan the mark bits an int at a time. */
5872 for (i
= 0; i
< ilim
; i
++)
5874 if (cblk
->gcmarkbits
[i
] == -1)
5876 /* Fast path - all cons cells for this int are marked. */
5877 cblk
->gcmarkbits
[i
] = 0;
5878 num_used
+= BITS_PER_INT
;
5882 /* Some cons cells for this int are not marked.
5883 Find which ones, and free them. */
5884 int start
, pos
, stop
;
5886 start
= i
* BITS_PER_INT
;
5888 if (stop
> BITS_PER_INT
)
5889 stop
= BITS_PER_INT
;
5892 for (pos
= start
; pos
< stop
; pos
++)
5894 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
5897 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
5898 cons_free_list
= &cblk
->conses
[pos
];
5900 cons_free_list
->car
= Vdead
;
5906 CONS_UNMARK (&cblk
->conses
[pos
]);
5912 lim
= CONS_BLOCK_SIZE
;
5913 /* If this block contains only free conses and we have already
5914 seen more than two blocks worth of free conses then deallocate
5916 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
5918 *cprev
= cblk
->next
;
5919 /* Unhook from the free list. */
5920 cons_free_list
= cblk
->conses
[0].u
.chain
;
5921 lisp_align_free (cblk
);
5925 num_free
+= this_free
;
5926 cprev
= &cblk
->next
;
5929 total_conses
= num_used
;
5930 total_free_conses
= num_free
;
5933 /* Put all unmarked floats on free list */
5935 register struct float_block
*fblk
;
5936 struct float_block
**fprev
= &float_block
;
5937 register int lim
= float_block_index
;
5938 EMACS_INT num_free
= 0, num_used
= 0;
5940 float_free_list
= 0;
5942 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
5946 for (i
= 0; i
< lim
; i
++)
5947 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
5950 fblk
->floats
[i
].u
.chain
= float_free_list
;
5951 float_free_list
= &fblk
->floats
[i
];
5956 FLOAT_UNMARK (&fblk
->floats
[i
]);
5958 lim
= FLOAT_BLOCK_SIZE
;
5959 /* If this block contains only free floats and we have already
5960 seen more than two blocks worth of free floats then deallocate
5962 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
5964 *fprev
= fblk
->next
;
5965 /* Unhook from the free list. */
5966 float_free_list
= fblk
->floats
[0].u
.chain
;
5967 lisp_align_free (fblk
);
5971 num_free
+= this_free
;
5972 fprev
= &fblk
->next
;
5975 total_floats
= num_used
;
5976 total_free_floats
= num_free
;
5979 /* Put all unmarked intervals on free list */
5981 register struct interval_block
*iblk
;
5982 struct interval_block
**iprev
= &interval_block
;
5983 register int lim
= interval_block_index
;
5984 EMACS_INT num_free
= 0, num_used
= 0;
5986 interval_free_list
= 0;
5988 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
5993 for (i
= 0; i
< lim
; i
++)
5995 if (!iblk
->intervals
[i
].gcmarkbit
)
5997 SET_INTERVAL_PARENT (&iblk
->intervals
[i
], interval_free_list
);
5998 interval_free_list
= &iblk
->intervals
[i
];
6004 iblk
->intervals
[i
].gcmarkbit
= 0;
6007 lim
= INTERVAL_BLOCK_SIZE
;
6008 /* If this block contains only free intervals and we have already
6009 seen more than two blocks worth of free intervals then
6010 deallocate this block. */
6011 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6013 *iprev
= iblk
->next
;
6014 /* Unhook from the free list. */
6015 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6020 num_free
+= this_free
;
6021 iprev
= &iblk
->next
;
6024 total_intervals
= num_used
;
6025 total_free_intervals
= num_free
;
6028 /* Put all unmarked symbols on free list */
6030 register struct symbol_block
*sblk
;
6031 struct symbol_block
**sprev
= &symbol_block
;
6032 register int lim
= symbol_block_index
;
6033 EMACS_INT num_free
= 0, num_used
= 0;
6035 symbol_free_list
= NULL
;
6037 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6040 struct Lisp_Symbol
*sym
= sblk
->symbols
;
6041 struct Lisp_Symbol
*end
= sym
+ lim
;
6043 for (; sym
< end
; ++sym
)
6045 /* Check if the symbol was created during loadup. In such a case
6046 it might be pointed to by pure bytecode which we don't trace,
6047 so we conservatively assume that it is live. */
6048 int pure_p
= PURE_POINTER_P (XSTRING (sym
->xname
));
6050 if (!sym
->gcmarkbit
&& !pure_p
)
6052 if (sym
->redirect
== SYMBOL_LOCALIZED
)
6053 xfree (SYMBOL_BLV (sym
));
6054 sym
->next
= symbol_free_list
;
6055 symbol_free_list
= sym
;
6057 symbol_free_list
->function
= Vdead
;
6065 UNMARK_STRING (XSTRING (sym
->xname
));
6070 lim
= SYMBOL_BLOCK_SIZE
;
6071 /* If this block contains only free symbols and we have already
6072 seen more than two blocks worth of free symbols then deallocate
6074 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6076 *sprev
= sblk
->next
;
6077 /* Unhook from the free list. */
6078 symbol_free_list
= sblk
->symbols
[0].next
;
6083 num_free
+= this_free
;
6084 sprev
= &sblk
->next
;
6087 total_symbols
= num_used
;
6088 total_free_symbols
= num_free
;
6091 /* Put all unmarked misc's on free list.
6092 For a marker, first unchain it from the buffer it points into. */
6094 register struct marker_block
*mblk
;
6095 struct marker_block
**mprev
= &marker_block
;
6096 register int lim
= marker_block_index
;
6097 EMACS_INT num_free
= 0, num_used
= 0;
6099 marker_free_list
= 0;
6101 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6106 for (i
= 0; i
< lim
; i
++)
6108 if (!mblk
->markers
[i
].u_any
.gcmarkbit
)
6110 if (mblk
->markers
[i
].u_any
.type
== Lisp_Misc_Marker
)
6111 unchain_marker (&mblk
->markers
[i
].u_marker
);
6112 /* Set the type of the freed object to Lisp_Misc_Free.
6113 We could leave the type alone, since nobody checks it,
6114 but this might catch bugs faster. */
6115 mblk
->markers
[i
].u_marker
.type
= Lisp_Misc_Free
;
6116 mblk
->markers
[i
].u_free
.chain
= marker_free_list
;
6117 marker_free_list
= &mblk
->markers
[i
];
6123 mblk
->markers
[i
].u_any
.gcmarkbit
= 0;
6126 lim
= MARKER_BLOCK_SIZE
;
6127 /* If this block contains only free markers and we have already
6128 seen more than two blocks worth of free markers then deallocate
6130 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6132 *mprev
= mblk
->next
;
6133 /* Unhook from the free list. */
6134 marker_free_list
= mblk
->markers
[0].u_free
.chain
;
6139 num_free
+= this_free
;
6140 mprev
= &mblk
->next
;
6144 total_markers
= num_used
;
6145 total_free_markers
= num_free
;
6148 /* Free all unmarked buffers */
6150 register struct buffer
*buffer
= all_buffers
, *prev
= 0, *next
;
6153 if (!VECTOR_MARKED_P (buffer
))
6156 prev
->header
.next
= buffer
->header
.next
;
6158 all_buffers
= buffer
->header
.next
.buffer
;
6159 next
= buffer
->header
.next
.buffer
;
6165 VECTOR_UNMARK (buffer
);
6166 UNMARK_BALANCE_INTERVALS (BUF_INTERVALS (buffer
));
6167 prev
= buffer
, buffer
= buffer
->header
.next
.buffer
;
6171 /* Free all unmarked vectors */
6173 register struct Lisp_Vector
*vector
= all_vectors
, *prev
= 0, *next
;
6174 total_vector_size
= 0;
6177 if (!VECTOR_MARKED_P (vector
))
6180 prev
->header
.next
= vector
->header
.next
;
6182 all_vectors
= vector
->header
.next
.vector
;
6183 next
= vector
->header
.next
.vector
;
6190 VECTOR_UNMARK (vector
);
6191 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
6192 total_vector_size
+= PSEUDOVECTOR_SIZE_MASK
& vector
->header
.size
;
6194 total_vector_size
+= vector
->header
.size
;
6195 prev
= vector
, vector
= vector
->header
.next
.vector
;
6199 #ifdef GC_CHECK_STRING_BYTES
6200 if (!noninteractive
)
6201 check_string_bytes (1);
6208 /* Debugging aids. */
6210 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6211 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6212 This may be helpful in debugging Emacs's memory usage.
6213 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6218 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6223 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6224 doc
: /* Return a list of counters that measure how much consing there has been.
6225 Each of these counters increments for a certain kind of object.
6226 The counters wrap around from the largest positive integer to zero.
6227 Garbage collection does not decrease them.
6228 The elements of the value are as follows:
6229 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6230 All are in units of 1 = one object consed
6231 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6233 MISCS include overlays, markers, and some internal types.
6234 Frames, windows, buffers, and subprocesses count as vectors
6235 (but the contents of a buffer's text do not count here). */)
6238 Lisp_Object consed
[8];
6240 consed
[0] = make_number (min (MOST_POSITIVE_FIXNUM
, cons_cells_consed
));
6241 consed
[1] = make_number (min (MOST_POSITIVE_FIXNUM
, floats_consed
));
6242 consed
[2] = make_number (min (MOST_POSITIVE_FIXNUM
, vector_cells_consed
));
6243 consed
[3] = make_number (min (MOST_POSITIVE_FIXNUM
, symbols_consed
));
6244 consed
[4] = make_number (min (MOST_POSITIVE_FIXNUM
, string_chars_consed
));
6245 consed
[5] = make_number (min (MOST_POSITIVE_FIXNUM
, misc_objects_consed
));
6246 consed
[6] = make_number (min (MOST_POSITIVE_FIXNUM
, intervals_consed
));
6247 consed
[7] = make_number (min (MOST_POSITIVE_FIXNUM
, strings_consed
));
6249 return Flist (8, consed
);
6252 #ifdef ENABLE_CHECKING
6253 int suppress_checking
;
6256 die (const char *msg
, const char *file
, int line
)
6258 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: %s\r\n",
6264 /* Initialization */
6267 init_alloc_once (void)
6269 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6271 pure_size
= PURESIZE
;
6272 pure_bytes_used
= 0;
6273 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
6274 pure_bytes_used_before_overflow
= 0;
6276 /* Initialize the list of free aligned blocks. */
6279 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6281 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6285 ignore_warnings
= 1;
6286 #ifdef DOUG_LEA_MALLOC
6287 mallopt (M_TRIM_THRESHOLD
, 128*1024); /* trim threshold */
6288 mallopt (M_MMAP_THRESHOLD
, 64*1024); /* mmap threshold */
6289 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* max. number of mmap'ed areas */
6297 init_weak_hash_tables ();
6300 malloc_hysteresis
= 32;
6302 malloc_hysteresis
= 0;
6305 refill_memory_reserve ();
6307 ignore_warnings
= 0;
6309 byte_stack_list
= 0;
6311 consing_since_gc
= 0;
6312 gc_cons_threshold
= 100000 * sizeof (Lisp_Object
);
6313 gc_relative_threshold
= 0;
6320 byte_stack_list
= 0;
6322 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6323 setjmp_tested_p
= longjmps_done
= 0;
6326 Vgc_elapsed
= make_float (0.0);
6331 syms_of_alloc (void)
6333 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6334 doc
: /* *Number of bytes of consing between garbage collections.
6335 Garbage collection can happen automatically once this many bytes have been
6336 allocated since the last garbage collection. All data types count.
6338 Garbage collection happens automatically only when `eval' is called.
6340 By binding this temporarily to a large number, you can effectively
6341 prevent garbage collection during a part of the program.
6342 See also `gc-cons-percentage'. */);
6344 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6345 doc
: /* *Portion of the heap used for allocation.
6346 Garbage collection can happen automatically once this portion of the heap
6347 has been allocated since the last garbage collection.
6348 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6349 Vgc_cons_percentage
= make_float (0.1);
6351 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6352 doc
: /* Number of bytes of sharable Lisp data allocated so far. */);
6354 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6355 doc
: /* Number of cons cells that have been consed so far. */);
6357 DEFVAR_INT ("floats-consed", floats_consed
,
6358 doc
: /* Number of floats that have been consed so far. */);
6360 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
6361 doc
: /* Number of vector cells that have been consed so far. */);
6363 DEFVAR_INT ("symbols-consed", symbols_consed
,
6364 doc
: /* Number of symbols that have been consed so far. */);
6366 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
6367 doc
: /* Number of string characters that have been consed so far. */);
6369 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
6370 doc
: /* Number of miscellaneous objects that have been consed so far. */);
6372 DEFVAR_INT ("intervals-consed", intervals_consed
,
6373 doc
: /* Number of intervals that have been consed so far. */);
6375 DEFVAR_INT ("strings-consed", strings_consed
,
6376 doc
: /* Number of strings that have been consed so far. */);
6378 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
6379 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
6380 This means that certain objects should be allocated in shared (pure) space.
6381 It can also be set to a hash-table, in which case this table is used to
6382 do hash-consing of the objects allocated to pure space. */);
6384 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
6385 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
6386 garbage_collection_messages
= 0;
6388 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
6389 doc
: /* Hook run after garbage collection has finished. */);
6390 Vpost_gc_hook
= Qnil
;
6391 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
6393 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
6394 doc
: /* Precomputed `signal' argument for memory-full error. */);
6395 /* We build this in advance because if we wait until we need it, we might
6396 not be able to allocate the memory to hold it. */
6398 = pure_cons (Qerror
,
6399 pure_cons (make_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"), Qnil
));
6401 DEFVAR_LISP ("memory-full", Vmemory_full
,
6402 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
6403 Vmemory_full
= Qnil
;
6405 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
6406 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
6408 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
6409 doc
: /* Accumulated time elapsed in garbage collections.
6410 The time is in seconds as a floating point value. */);
6411 DEFVAR_INT ("gcs-done", gcs_done
,
6412 doc
: /* Accumulated number of garbage collections done. */);
6417 defsubr (&Smake_byte_code
);
6418 defsubr (&Smake_list
);
6419 defsubr (&Smake_vector
);
6420 defsubr (&Smake_string
);
6421 defsubr (&Smake_bool_vector
);
6422 defsubr (&Smake_symbol
);
6423 defsubr (&Smake_marker
);
6424 defsubr (&Spurecopy
);
6425 defsubr (&Sgarbage_collect
);
6426 defsubr (&Smemory_limit
);
6427 defsubr (&Smemory_use_counts
);
6429 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
6430 defsubr (&Sgc_status
);