1 /* Storage allocation and gc for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2012
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
23 #include <limits.h> /* For CHAR_BIT. */
32 /* This file is part of the core Lisp implementation, and thus must
33 deal with the real data structures. If the Lisp implementation is
34 replaced, this file likely will not be used. */
36 #undef HIDE_LISP_IMPLEMENTATION
39 #include "intervals.h"
45 #include "blockinput.h"
46 #include "character.h"
47 #include "syssignal.h"
48 #include "termhooks.h" /* For struct terminal. */
52 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
53 memory. Can do this only if using gmalloc.c. */
55 #if defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC
56 #undef GC_MALLOC_CHECK
61 extern POINTER_TYPE
*sbrk ();
70 #ifdef DOUG_LEA_MALLOC
74 /* Specify maximum number of areas to mmap. It would be nice to use a
75 value that explicitly means "no limit". */
77 #define MMAP_MAX_AREAS 100000000
79 #else /* not DOUG_LEA_MALLOC */
81 /* The following come from gmalloc.c. */
83 extern size_t _bytes_used
;
84 extern size_t __malloc_extra_blocks
;
86 #endif /* not DOUG_LEA_MALLOC */
88 #if ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT
91 /* When GTK uses the file chooser dialog, different backends can be loaded
92 dynamically. One such a backend is the Gnome VFS backend that gets loaded
93 if you run Gnome. That backend creates several threads and also allocates
96 Also, gconf and gsettings may create several threads.
98 If Emacs sets malloc hooks (! SYSTEM_MALLOC) and the emacs_blocked_*
99 functions below are called from malloc, there is a chance that one
100 of these threads preempts the Emacs main thread and the hook variables
101 end up in an inconsistent state. So we have a mutex to prevent that (note
102 that the backend handles concurrent access to malloc within its own threads
103 but Emacs code running in the main thread is not included in that control).
105 When UNBLOCK_INPUT is called, reinvoke_input_signal may be called. If this
106 happens in one of the backend threads we will have two threads that tries
107 to run Emacs code at once, and the code is not prepared for that.
108 To prevent that, we only call BLOCK/UNBLOCK from the main thread. */
110 static pthread_mutex_t alloc_mutex
;
112 #define BLOCK_INPUT_ALLOC \
115 if (pthread_equal (pthread_self (), main_thread)) \
117 pthread_mutex_lock (&alloc_mutex); \
120 #define UNBLOCK_INPUT_ALLOC \
123 pthread_mutex_unlock (&alloc_mutex); \
124 if (pthread_equal (pthread_self (), main_thread)) \
129 #else /* ! defined HAVE_PTHREAD */
131 #define BLOCK_INPUT_ALLOC BLOCK_INPUT
132 #define UNBLOCK_INPUT_ALLOC UNBLOCK_INPUT
134 #endif /* ! defined HAVE_PTHREAD */
135 #endif /* ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT */
137 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
138 to a struct Lisp_String. */
140 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
141 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
142 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
144 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
145 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
146 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
148 /* Value is the number of bytes of S, a pointer to a struct Lisp_String.
149 Be careful during GC, because S->size contains the mark bit for
152 #define GC_STRING_BYTES(S) (STRING_BYTES (S))
154 /* Global variables. */
155 struct emacs_globals globals
;
157 /* Number of bytes of consing done since the last gc. */
159 EMACS_INT consing_since_gc
;
161 /* Similar minimum, computed from Vgc_cons_percentage. */
163 EMACS_INT gc_relative_threshold
;
165 /* Minimum number of bytes of consing since GC before next GC,
166 when memory is full. */
168 EMACS_INT memory_full_cons_threshold
;
170 /* Nonzero during GC. */
174 /* Nonzero means abort if try to GC.
175 This is for code which is written on the assumption that
176 no GC will happen, so as to verify that assumption. */
180 /* Number of live and free conses etc. */
182 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_vector_size
;
183 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
184 static EMACS_INT total_free_floats
, total_floats
;
186 /* Points to memory space allocated as "spare", to be freed if we run
187 out of memory. We keep one large block, four cons-blocks, and
188 two string blocks. */
190 static char *spare_memory
[7];
192 /* Amount of spare memory to keep in large reserve block, or to see
193 whether this much is available when malloc fails on a larger request. */
195 #define SPARE_MEMORY (1 << 14)
197 /* Number of extra blocks malloc should get when it needs more core. */
199 static int malloc_hysteresis
;
201 /* Initialize it to a nonzero value to force it into data space
202 (rather than bss space). That way unexec will remap it into text
203 space (pure), on some systems. We have not implemented the
204 remapping on more recent systems because this is less important
205 nowadays than in the days of small memories and timesharing. */
207 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
208 #define PUREBEG (char *) pure
210 /* Pointer to the pure area, and its size. */
212 static char *purebeg
;
213 static ptrdiff_t pure_size
;
215 /* Number of bytes of pure storage used before pure storage overflowed.
216 If this is non-zero, this implies that an overflow occurred. */
218 static ptrdiff_t pure_bytes_used_before_overflow
;
220 /* Value is non-zero if P points into pure space. */
222 #define PURE_POINTER_P(P) \
223 ((uintptr_t) (P) - (uintptr_t) purebeg <= pure_size)
225 /* Index in pure at which next pure Lisp object will be allocated.. */
227 static ptrdiff_t pure_bytes_used_lisp
;
229 /* Number of bytes allocated for non-Lisp objects in pure storage. */
231 static ptrdiff_t pure_bytes_used_non_lisp
;
233 /* If nonzero, this is a warning delivered by malloc and not yet
236 const char *pending_malloc_warning
;
238 /* Maximum amount of C stack to save when a GC happens. */
240 #ifndef MAX_SAVE_STACK
241 #define MAX_SAVE_STACK 16000
244 /* Buffer in which we save a copy of the C stack at each GC. */
246 #if MAX_SAVE_STACK > 0
247 static char *stack_copy
;
248 static ptrdiff_t stack_copy_size
;
251 /* Non-zero means ignore malloc warnings. Set during initialization.
252 Currently not used. */
254 static int ignore_warnings
;
256 static Lisp_Object Qgc_cons_threshold
;
257 Lisp_Object Qchar_table_extra_slots
;
259 /* Hook run after GC has finished. */
261 static Lisp_Object Qpost_gc_hook
;
263 static void mark_buffer (Lisp_Object
);
264 static void mark_terminals (void);
265 static void gc_sweep (void);
266 static void mark_glyph_matrix (struct glyph_matrix
*);
267 static void mark_face_cache (struct face_cache
*);
269 #if !defined REL_ALLOC || defined SYSTEM_MALLOC
270 static void refill_memory_reserve (void);
272 static struct Lisp_String
*allocate_string (void);
273 static void compact_small_strings (void);
274 static void free_large_strings (void);
275 static void sweep_strings (void);
276 static void free_misc (Lisp_Object
);
277 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
279 /* When scanning the C stack for live Lisp objects, Emacs keeps track
280 of what memory allocated via lisp_malloc is intended for what
281 purpose. This enumeration specifies the type of memory. */
292 /* We used to keep separate mem_types for subtypes of vectors such as
293 process, hash_table, frame, terminal, and window, but we never made
294 use of the distinction, so it only caused source-code complexity
295 and runtime slowdown. Minor but pointless. */
299 static POINTER_TYPE
*lisp_align_malloc (size_t, enum mem_type
);
300 static POINTER_TYPE
*lisp_malloc (size_t, enum mem_type
);
303 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
305 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
306 #include <stdio.h> /* For fprintf. */
309 /* A unique object in pure space used to make some Lisp objects
310 on free lists recognizable in O(1). */
312 static Lisp_Object Vdead
;
313 #define DEADP(x) EQ (x, Vdead)
315 #ifdef GC_MALLOC_CHECK
317 enum mem_type allocated_mem_type
;
318 static int dont_register_blocks
;
320 #endif /* GC_MALLOC_CHECK */
322 /* A node in the red-black tree describing allocated memory containing
323 Lisp data. Each such block is recorded with its start and end
324 address when it is allocated, and removed from the tree when it
327 A red-black tree is a balanced binary tree with the following
330 1. Every node is either red or black.
331 2. Every leaf is black.
332 3. If a node is red, then both of its children are black.
333 4. Every simple path from a node to a descendant leaf contains
334 the same number of black nodes.
335 5. The root is always black.
337 When nodes are inserted into the tree, or deleted from the tree,
338 the tree is "fixed" so that these properties are always true.
340 A red-black tree with N internal nodes has height at most 2
341 log(N+1). Searches, insertions and deletions are done in O(log N).
342 Please see a text book about data structures for a detailed
343 description of red-black trees. Any book worth its salt should
348 /* Children of this node. These pointers are never NULL. When there
349 is no child, the value is MEM_NIL, which points to a dummy node. */
350 struct mem_node
*left
, *right
;
352 /* The parent of this node. In the root node, this is NULL. */
353 struct mem_node
*parent
;
355 /* Start and end of allocated region. */
359 enum {MEM_BLACK
, MEM_RED
} color
;
365 /* Base address of stack. Set in main. */
367 Lisp_Object
*stack_base
;
369 /* Root of the tree describing allocated Lisp memory. */
371 static struct mem_node
*mem_root
;
373 /* Lowest and highest known address in the heap. */
375 static void *min_heap_address
, *max_heap_address
;
377 /* Sentinel node of the tree. */
379 static struct mem_node mem_z
;
380 #define MEM_NIL &mem_z
382 static struct Lisp_Vector
*allocate_vectorlike (ptrdiff_t);
383 static void lisp_free (POINTER_TYPE
*);
384 static void mark_stack (void);
385 static int live_vector_p (struct mem_node
*, void *);
386 static int live_buffer_p (struct mem_node
*, void *);
387 static int live_string_p (struct mem_node
*, void *);
388 static int live_cons_p (struct mem_node
*, void *);
389 static int live_symbol_p (struct mem_node
*, void *);
390 static int live_float_p (struct mem_node
*, void *);
391 static int live_misc_p (struct mem_node
*, void *);
392 static void mark_maybe_object (Lisp_Object
);
393 static void mark_memory (void *, void *);
394 static void mem_init (void);
395 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
396 static void mem_insert_fixup (struct mem_node
*);
397 static void mem_rotate_left (struct mem_node
*);
398 static void mem_rotate_right (struct mem_node
*);
399 static void mem_delete (struct mem_node
*);
400 static void mem_delete_fixup (struct mem_node
*);
401 static inline struct mem_node
*mem_find (void *);
404 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
405 static void check_gcpros (void);
408 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
414 /* Recording what needs to be marked for gc. */
416 struct gcpro
*gcprolist
;
418 /* Addresses of staticpro'd variables. Initialize it to a nonzero
419 value; otherwise some compilers put it into BSS. */
421 #define NSTATICS 0x640
422 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
424 /* Index of next unused slot in staticvec. */
426 static int staticidx
= 0;
428 static POINTER_TYPE
*pure_alloc (size_t, int);
431 /* Value is SZ rounded up to the next multiple of ALIGNMENT.
432 ALIGNMENT must be a power of 2. */
434 #define ALIGN(ptr, ALIGNMENT) \
435 ((POINTER_TYPE *) ((((uintptr_t) (ptr)) + (ALIGNMENT) - 1) \
436 & ~((ALIGNMENT) - 1)))
440 /************************************************************************
442 ************************************************************************/
444 /* Function malloc calls this if it finds we are near exhausting storage. */
447 malloc_warning (const char *str
)
449 pending_malloc_warning
= str
;
453 /* Display an already-pending malloc warning. */
456 display_malloc_warning (void)
458 call3 (intern ("display-warning"),
460 build_string (pending_malloc_warning
),
461 intern ("emergency"));
462 pending_malloc_warning
= 0;
465 /* Called if we can't allocate relocatable space for a buffer. */
468 buffer_memory_full (ptrdiff_t nbytes
)
470 /* If buffers use the relocating allocator, no need to free
471 spare_memory, because we may have plenty of malloc space left
472 that we could get, and if we don't, the malloc that fails will
473 itself cause spare_memory to be freed. If buffers don't use the
474 relocating allocator, treat this like any other failing
478 memory_full (nbytes
);
481 /* This used to call error, but if we've run out of memory, we could
482 get infinite recursion trying to build the string. */
483 xsignal (Qnil
, Vmemory_signal_data
);
487 #ifndef XMALLOC_OVERRUN_CHECK
488 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
491 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
494 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
495 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
496 block size in little-endian order. The trailer consists of
497 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
499 The header is used to detect whether this block has been allocated
500 through these functions, as some low-level libc functions may
501 bypass the malloc hooks. */
503 #define XMALLOC_OVERRUN_CHECK_SIZE 16
504 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
505 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
507 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
508 hold a size_t value and (2) the header size is a multiple of the
509 alignment that Emacs needs for C types and for USE_LSB_TAG. */
510 #define XMALLOC_BASE_ALIGNMENT \
513 union { long double d; intmax_t i; void *p; } u; \
518 /* A common multiple of the positive integers A and B. Ideally this
519 would be the least common multiple, but there's no way to do that
520 as a constant expression in C, so do the best that we can easily do. */
521 # define COMMON_MULTIPLE(a, b) \
522 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
523 # define XMALLOC_HEADER_ALIGNMENT \
524 COMMON_MULTIPLE (1 << GCTYPEBITS, XMALLOC_BASE_ALIGNMENT)
526 # define XMALLOC_HEADER_ALIGNMENT XMALLOC_BASE_ALIGNMENT
528 #define XMALLOC_OVERRUN_SIZE_SIZE \
529 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
530 + XMALLOC_HEADER_ALIGNMENT - 1) \
531 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
532 - XMALLOC_OVERRUN_CHECK_SIZE)
534 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
535 { '\x9a', '\x9b', '\xae', '\xaf',
536 '\xbf', '\xbe', '\xce', '\xcf',
537 '\xea', '\xeb', '\xec', '\xed',
538 '\xdf', '\xde', '\x9c', '\x9d' };
540 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
541 { '\xaa', '\xab', '\xac', '\xad',
542 '\xba', '\xbb', '\xbc', '\xbd',
543 '\xca', '\xcb', '\xcc', '\xcd',
544 '\xda', '\xdb', '\xdc', '\xdd' };
546 /* Insert and extract the block size in the header. */
549 xmalloc_put_size (unsigned char *ptr
, size_t size
)
552 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
554 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
560 xmalloc_get_size (unsigned char *ptr
)
564 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
565 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
574 /* The call depth in overrun_check functions. For example, this might happen:
576 overrun_check_malloc()
577 -> malloc -> (via hook)_-> emacs_blocked_malloc
578 -> overrun_check_malloc
579 call malloc (hooks are NULL, so real malloc is called).
580 malloc returns 10000.
581 add overhead, return 10016.
582 <- (back in overrun_check_malloc)
583 add overhead again, return 10032
584 xmalloc returns 10032.
589 overrun_check_free(10032)
591 free(10016) <- crash, because 10000 is the original pointer. */
593 static ptrdiff_t check_depth
;
595 /* Like malloc, but wraps allocated block with header and trailer. */
597 static POINTER_TYPE
*
598 overrun_check_malloc (size_t size
)
600 register unsigned char *val
;
601 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
602 if (SIZE_MAX
- overhead
< size
)
605 val
= (unsigned char *) malloc (size
+ overhead
);
606 if (val
&& check_depth
== 1)
608 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
609 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
610 xmalloc_put_size (val
, size
);
611 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
612 XMALLOC_OVERRUN_CHECK_SIZE
);
615 return (POINTER_TYPE
*)val
;
619 /* Like realloc, but checks old block for overrun, and wraps new block
620 with header and trailer. */
622 static POINTER_TYPE
*
623 overrun_check_realloc (POINTER_TYPE
*block
, size_t size
)
625 register unsigned char *val
= (unsigned char *) block
;
626 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
627 if (SIZE_MAX
- overhead
< size
)
632 && memcmp (xmalloc_overrun_check_header
,
633 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
634 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
636 size_t osize
= xmalloc_get_size (val
);
637 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
638 XMALLOC_OVERRUN_CHECK_SIZE
))
640 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
641 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
642 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
645 val
= (unsigned char *) realloc ((POINTER_TYPE
*)val
, size
+ overhead
);
647 if (val
&& check_depth
== 1)
649 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
650 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
651 xmalloc_put_size (val
, size
);
652 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
653 XMALLOC_OVERRUN_CHECK_SIZE
);
656 return (POINTER_TYPE
*)val
;
659 /* Like free, but checks block for overrun. */
662 overrun_check_free (POINTER_TYPE
*block
)
664 unsigned char *val
= (unsigned char *) block
;
669 && memcmp (xmalloc_overrun_check_header
,
670 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
671 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
673 size_t osize
= xmalloc_get_size (val
);
674 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
675 XMALLOC_OVERRUN_CHECK_SIZE
))
677 #ifdef XMALLOC_CLEAR_FREE_MEMORY
678 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
679 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
681 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
682 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
683 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
694 #define malloc overrun_check_malloc
695 #define realloc overrun_check_realloc
696 #define free overrun_check_free
700 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
701 there's no need to block input around malloc. */
702 #define MALLOC_BLOCK_INPUT ((void)0)
703 #define MALLOC_UNBLOCK_INPUT ((void)0)
705 #define MALLOC_BLOCK_INPUT BLOCK_INPUT
706 #define MALLOC_UNBLOCK_INPUT UNBLOCK_INPUT
709 /* Like malloc but check for no memory and block interrupt input.. */
712 xmalloc (size_t size
)
714 register POINTER_TYPE
*val
;
717 val
= (POINTER_TYPE
*) malloc (size
);
718 MALLOC_UNBLOCK_INPUT
;
726 /* Like realloc but check for no memory and block interrupt input.. */
729 xrealloc (POINTER_TYPE
*block
, size_t size
)
731 register POINTER_TYPE
*val
;
734 /* We must call malloc explicitly when BLOCK is 0, since some
735 reallocs don't do this. */
737 val
= (POINTER_TYPE
*) malloc (size
);
739 val
= (POINTER_TYPE
*) realloc (block
, size
);
740 MALLOC_UNBLOCK_INPUT
;
748 /* Like free but block interrupt input. */
751 xfree (POINTER_TYPE
*block
)
757 MALLOC_UNBLOCK_INPUT
;
758 /* We don't call refill_memory_reserve here
759 because that duplicates doing so in emacs_blocked_free
760 and the criterion should go there. */
764 /* Other parts of Emacs pass large int values to allocator functions
765 expecting ptrdiff_t. This is portable in practice, but check it to
767 verify (INT_MAX
<= PTRDIFF_MAX
);
770 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
771 Signal an error on memory exhaustion, and block interrupt input. */
774 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
776 xassert (0 <= nitems
&& 0 < item_size
);
777 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
778 memory_full (SIZE_MAX
);
779 return xmalloc (nitems
* item_size
);
783 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
784 Signal an error on memory exhaustion, and block interrupt input. */
787 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
789 xassert (0 <= nitems
&& 0 < item_size
);
790 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
791 memory_full (SIZE_MAX
);
792 return xrealloc (pa
, nitems
* item_size
);
796 /* Grow PA, which points to an array of *NITEMS items, and return the
797 location of the reallocated array, updating *NITEMS to reflect its
798 new size. The new array will contain at least NITEMS_INCR_MIN more
799 items, but will not contain more than NITEMS_MAX items total.
800 ITEM_SIZE is the size of each item, in bytes.
802 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
803 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
806 If PA is null, then allocate a new array instead of reallocating
807 the old one. Thus, to grow an array A without saving its old
808 contents, invoke xfree (A) immediately followed by xgrowalloc (0,
811 Block interrupt input as needed. If memory exhaustion occurs, set
812 *NITEMS to zero if PA is null, and signal an error (i.e., do not
816 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
817 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
819 /* The approximate size to use for initial small allocation
820 requests. This is the largest "small" request for the GNU C
822 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
824 /* If the array is tiny, grow it to about (but no greater than)
825 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
826 ptrdiff_t n
= *nitems
;
827 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
828 ptrdiff_t half_again
= n
>> 1;
829 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
831 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
832 NITEMS_MAX, and what the C language can represent safely. */
833 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
834 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
835 ? nitems_max
: C_language_max
);
836 ptrdiff_t nitems_incr_max
= n_max
- n
;
837 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
839 xassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
842 if (nitems_incr_max
< incr
)
843 memory_full (SIZE_MAX
);
845 pa
= xrealloc (pa
, n
* item_size
);
851 /* Like strdup, but uses xmalloc. */
854 xstrdup (const char *s
)
856 size_t len
= strlen (s
) + 1;
857 char *p
= (char *) xmalloc (len
);
863 /* Unwind for SAFE_ALLOCA */
866 safe_alloca_unwind (Lisp_Object arg
)
868 register struct Lisp_Save_Value
*p
= XSAVE_VALUE (arg
);
878 /* Like malloc but used for allocating Lisp data. NBYTES is the
879 number of bytes to allocate, TYPE describes the intended use of the
880 allocated memory block (for strings, for conses, ...). */
883 static void *lisp_malloc_loser
;
886 static POINTER_TYPE
*
887 lisp_malloc (size_t nbytes
, enum mem_type type
)
893 #ifdef GC_MALLOC_CHECK
894 allocated_mem_type
= type
;
897 val
= (void *) malloc (nbytes
);
900 /* If the memory just allocated cannot be addressed thru a Lisp
901 object's pointer, and it needs to be,
902 that's equivalent to running out of memory. */
903 if (val
&& type
!= MEM_TYPE_NON_LISP
)
906 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
907 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
909 lisp_malloc_loser
= val
;
916 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
917 if (val
&& type
!= MEM_TYPE_NON_LISP
)
918 mem_insert (val
, (char *) val
+ nbytes
, type
);
921 MALLOC_UNBLOCK_INPUT
;
923 memory_full (nbytes
);
927 /* Free BLOCK. This must be called to free memory allocated with a
928 call to lisp_malloc. */
931 lisp_free (POINTER_TYPE
*block
)
935 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
936 mem_delete (mem_find (block
));
938 MALLOC_UNBLOCK_INPUT
;
941 /* Allocation of aligned blocks of memory to store Lisp data. */
942 /* The entry point is lisp_align_malloc which returns blocks of at most */
943 /* BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
945 /* Use posix_memalloc if the system has it and we're using the system's
946 malloc (because our gmalloc.c routines don't have posix_memalign although
947 its memalloc could be used). */
948 #if defined (HAVE_POSIX_MEMALIGN) && defined (SYSTEM_MALLOC)
949 #define USE_POSIX_MEMALIGN 1
952 /* BLOCK_ALIGN has to be a power of 2. */
953 #define BLOCK_ALIGN (1 << 10)
955 /* Padding to leave at the end of a malloc'd block. This is to give
956 malloc a chance to minimize the amount of memory wasted to alignment.
957 It should be tuned to the particular malloc library used.
958 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
959 posix_memalign on the other hand would ideally prefer a value of 4
960 because otherwise, there's 1020 bytes wasted between each ablocks.
961 In Emacs, testing shows that those 1020 can most of the time be
962 efficiently used by malloc to place other objects, so a value of 0 can
963 still preferable unless you have a lot of aligned blocks and virtually
965 #define BLOCK_PADDING 0
966 #define BLOCK_BYTES \
967 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
969 /* Internal data structures and constants. */
971 #define ABLOCKS_SIZE 16
973 /* An aligned block of memory. */
978 char payload
[BLOCK_BYTES
];
979 struct ablock
*next_free
;
981 /* `abase' is the aligned base of the ablocks. */
982 /* It is overloaded to hold the virtual `busy' field that counts
983 the number of used ablock in the parent ablocks.
984 The first ablock has the `busy' field, the others have the `abase'
985 field. To tell the difference, we assume that pointers will have
986 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
987 is used to tell whether the real base of the parent ablocks is `abase'
988 (if not, the word before the first ablock holds a pointer to the
990 struct ablocks
*abase
;
991 /* The padding of all but the last ablock is unused. The padding of
992 the last ablock in an ablocks is not allocated. */
994 char padding
[BLOCK_PADDING
];
998 /* A bunch of consecutive aligned blocks. */
1001 struct ablock blocks
[ABLOCKS_SIZE
];
1004 /* Size of the block requested from malloc or memalign. */
1005 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1007 #define ABLOCK_ABASE(block) \
1008 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1009 ? (struct ablocks *)(block) \
1012 /* Virtual `busy' field. */
1013 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1015 /* Pointer to the (not necessarily aligned) malloc block. */
1016 #ifdef USE_POSIX_MEMALIGN
1017 #define ABLOCKS_BASE(abase) (abase)
1019 #define ABLOCKS_BASE(abase) \
1020 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void**)abase)[-1])
1023 /* The list of free ablock. */
1024 static struct ablock
*free_ablock
;
1026 /* Allocate an aligned block of nbytes.
1027 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1028 smaller or equal to BLOCK_BYTES. */
1029 static POINTER_TYPE
*
1030 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1033 struct ablocks
*abase
;
1035 eassert (nbytes
<= BLOCK_BYTES
);
1039 #ifdef GC_MALLOC_CHECK
1040 allocated_mem_type
= type
;
1046 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1048 #ifdef DOUG_LEA_MALLOC
1049 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1050 because mapped region contents are not preserved in
1052 mallopt (M_MMAP_MAX
, 0);
1055 #ifdef USE_POSIX_MEMALIGN
1057 int err
= posix_memalign (&base
, BLOCK_ALIGN
, ABLOCKS_BYTES
);
1063 base
= malloc (ABLOCKS_BYTES
);
1064 abase
= ALIGN (base
, BLOCK_ALIGN
);
1069 MALLOC_UNBLOCK_INPUT
;
1070 memory_full (ABLOCKS_BYTES
);
1073 aligned
= (base
== abase
);
1075 ((void**)abase
)[-1] = base
;
1077 #ifdef DOUG_LEA_MALLOC
1078 /* Back to a reasonable maximum of mmap'ed areas. */
1079 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1083 /* If the memory just allocated cannot be addressed thru a Lisp
1084 object's pointer, and it needs to be, that's equivalent to
1085 running out of memory. */
1086 if (type
!= MEM_TYPE_NON_LISP
)
1089 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1090 XSETCONS (tem
, end
);
1091 if ((char *) XCONS (tem
) != end
)
1093 lisp_malloc_loser
= base
;
1095 MALLOC_UNBLOCK_INPUT
;
1096 memory_full (SIZE_MAX
);
1101 /* Initialize the blocks and put them on the free list.
1102 Is `base' was not properly aligned, we can't use the last block. */
1103 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1105 abase
->blocks
[i
].abase
= abase
;
1106 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1107 free_ablock
= &abase
->blocks
[i
];
1109 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1111 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1112 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1113 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1114 eassert (ABLOCKS_BASE (abase
) == base
);
1115 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1118 abase
= ABLOCK_ABASE (free_ablock
);
1119 ABLOCKS_BUSY (abase
) =
1120 (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1122 free_ablock
= free_ablock
->x
.next_free
;
1124 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1125 if (type
!= MEM_TYPE_NON_LISP
)
1126 mem_insert (val
, (char *) val
+ nbytes
, type
);
1129 MALLOC_UNBLOCK_INPUT
;
1131 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1136 lisp_align_free (POINTER_TYPE
*block
)
1138 struct ablock
*ablock
= block
;
1139 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1142 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1143 mem_delete (mem_find (block
));
1145 /* Put on free list. */
1146 ablock
->x
.next_free
= free_ablock
;
1147 free_ablock
= ablock
;
1148 /* Update busy count. */
1149 ABLOCKS_BUSY (abase
) =
1150 (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1152 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1153 { /* All the blocks are free. */
1154 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1155 struct ablock
**tem
= &free_ablock
;
1156 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1160 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1163 *tem
= (*tem
)->x
.next_free
;
1166 tem
= &(*tem
)->x
.next_free
;
1168 eassert ((aligned
& 1) == aligned
);
1169 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1170 #ifdef USE_POSIX_MEMALIGN
1171 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1173 free (ABLOCKS_BASE (abase
));
1175 MALLOC_UNBLOCK_INPUT
;
1178 /* Return a new buffer structure allocated from the heap with
1179 a call to lisp_malloc. */
1182 allocate_buffer (void)
1185 = (struct buffer
*) lisp_malloc (sizeof (struct buffer
),
1187 XSETPVECTYPESIZE (b
, PVEC_BUFFER
,
1188 ((sizeof (struct buffer
) + sizeof (EMACS_INT
) - 1)
1189 / sizeof (EMACS_INT
)));
1194 #ifndef SYSTEM_MALLOC
1196 /* Arranging to disable input signals while we're in malloc.
1198 This only works with GNU malloc. To help out systems which can't
1199 use GNU malloc, all the calls to malloc, realloc, and free
1200 elsewhere in the code should be inside a BLOCK_INPUT/UNBLOCK_INPUT
1201 pair; unfortunately, we have no idea what C library functions
1202 might call malloc, so we can't really protect them unless you're
1203 using GNU malloc. Fortunately, most of the major operating systems
1204 can use GNU malloc. */
1207 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
1208 there's no need to block input around malloc. */
1210 #ifndef DOUG_LEA_MALLOC
1211 extern void * (*__malloc_hook
) (size_t, const void *);
1212 extern void * (*__realloc_hook
) (void *, size_t, const void *);
1213 extern void (*__free_hook
) (void *, const void *);
1214 /* Else declared in malloc.h, perhaps with an extra arg. */
1215 #endif /* DOUG_LEA_MALLOC */
1216 static void * (*old_malloc_hook
) (size_t, const void *);
1217 static void * (*old_realloc_hook
) (void *, size_t, const void*);
1218 static void (*old_free_hook
) (void*, const void*);
1220 #ifdef DOUG_LEA_MALLOC
1221 # define BYTES_USED (mallinfo ().uordblks)
1223 # define BYTES_USED _bytes_used
1226 static size_t bytes_used_when_reconsidered
;
1228 /* Value of _bytes_used, when spare_memory was freed. */
1230 static size_t bytes_used_when_full
;
1232 /* This function is used as the hook for free to call. */
1235 emacs_blocked_free (void *ptr
, const void *ptr2
)
1239 #ifdef GC_MALLOC_CHECK
1245 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1248 "Freeing `%p' which wasn't allocated with malloc\n", ptr
);
1253 /* fprintf (stderr, "free %p...%p (%p)\n", m->start, m->end, ptr); */
1257 #endif /* GC_MALLOC_CHECK */
1259 __free_hook
= old_free_hook
;
1262 /* If we released our reserve (due to running out of memory),
1263 and we have a fair amount free once again,
1264 try to set aside another reserve in case we run out once more. */
1265 if (! NILP (Vmemory_full
)
1266 /* Verify there is enough space that even with the malloc
1267 hysteresis this call won't run out again.
1268 The code here is correct as long as SPARE_MEMORY
1269 is substantially larger than the block size malloc uses. */
1270 && (bytes_used_when_full
1271 > ((bytes_used_when_reconsidered
= BYTES_USED
)
1272 + max (malloc_hysteresis
, 4) * SPARE_MEMORY
)))
1273 refill_memory_reserve ();
1275 __free_hook
= emacs_blocked_free
;
1276 UNBLOCK_INPUT_ALLOC
;
1280 /* This function is the malloc hook that Emacs uses. */
1283 emacs_blocked_malloc (size_t size
, const void *ptr
)
1288 __malloc_hook
= old_malloc_hook
;
1289 #ifdef DOUG_LEA_MALLOC
1290 /* Segfaults on my system. --lorentey */
1291 /* mallopt (M_TOP_PAD, malloc_hysteresis * 4096); */
1293 __malloc_extra_blocks
= malloc_hysteresis
;
1296 value
= (void *) malloc (size
);
1298 #ifdef GC_MALLOC_CHECK
1300 struct mem_node
*m
= mem_find (value
);
1303 fprintf (stderr
, "Malloc returned %p which is already in use\n",
1305 fprintf (stderr
, "Region in use is %p...%p, %u bytes, type %d\n",
1306 m
->start
, m
->end
, (char *) m
->end
- (char *) m
->start
,
1311 if (!dont_register_blocks
)
1313 mem_insert (value
, (char *) value
+ max (1, size
), allocated_mem_type
);
1314 allocated_mem_type
= MEM_TYPE_NON_LISP
;
1317 #endif /* GC_MALLOC_CHECK */
1319 __malloc_hook
= emacs_blocked_malloc
;
1320 UNBLOCK_INPUT_ALLOC
;
1322 /* fprintf (stderr, "%p malloc\n", value); */
1327 /* This function is the realloc hook that Emacs uses. */
1330 emacs_blocked_realloc (void *ptr
, size_t size
, const void *ptr2
)
1335 __realloc_hook
= old_realloc_hook
;
1337 #ifdef GC_MALLOC_CHECK
1340 struct mem_node
*m
= mem_find (ptr
);
1341 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1344 "Realloc of %p which wasn't allocated with malloc\n",
1352 /* fprintf (stderr, "%p -> realloc\n", ptr); */
1354 /* Prevent malloc from registering blocks. */
1355 dont_register_blocks
= 1;
1356 #endif /* GC_MALLOC_CHECK */
1358 value
= (void *) realloc (ptr
, size
);
1360 #ifdef GC_MALLOC_CHECK
1361 dont_register_blocks
= 0;
1364 struct mem_node
*m
= mem_find (value
);
1367 fprintf (stderr
, "Realloc returns memory that is already in use\n");
1371 /* Can't handle zero size regions in the red-black tree. */
1372 mem_insert (value
, (char *) value
+ max (size
, 1), MEM_TYPE_NON_LISP
);
1375 /* fprintf (stderr, "%p <- realloc\n", value); */
1376 #endif /* GC_MALLOC_CHECK */
1378 __realloc_hook
= emacs_blocked_realloc
;
1379 UNBLOCK_INPUT_ALLOC
;
1386 /* Called from Fdump_emacs so that when the dumped Emacs starts, it has a
1387 normal malloc. Some thread implementations need this as they call
1388 malloc before main. The pthread_self call in BLOCK_INPUT_ALLOC then
1389 calls malloc because it is the first call, and we have an endless loop. */
1392 reset_malloc_hooks (void)
1394 __free_hook
= old_free_hook
;
1395 __malloc_hook
= old_malloc_hook
;
1396 __realloc_hook
= old_realloc_hook
;
1398 #endif /* HAVE_PTHREAD */
1401 /* Called from main to set up malloc to use our hooks. */
1404 uninterrupt_malloc (void)
1407 #ifdef DOUG_LEA_MALLOC
1408 pthread_mutexattr_t attr
;
1410 /* GLIBC has a faster way to do this, but let's keep it portable.
1411 This is according to the Single UNIX Specification. */
1412 pthread_mutexattr_init (&attr
);
1413 pthread_mutexattr_settype (&attr
, PTHREAD_MUTEX_RECURSIVE
);
1414 pthread_mutex_init (&alloc_mutex
, &attr
);
1415 #else /* !DOUG_LEA_MALLOC */
1416 /* Some systems such as Solaris 2.6 don't have a recursive mutex,
1417 and the bundled gmalloc.c doesn't require it. */
1418 pthread_mutex_init (&alloc_mutex
, NULL
);
1419 #endif /* !DOUG_LEA_MALLOC */
1420 #endif /* HAVE_PTHREAD */
1422 if (__free_hook
!= emacs_blocked_free
)
1423 old_free_hook
= __free_hook
;
1424 __free_hook
= emacs_blocked_free
;
1426 if (__malloc_hook
!= emacs_blocked_malloc
)
1427 old_malloc_hook
= __malloc_hook
;
1428 __malloc_hook
= emacs_blocked_malloc
;
1430 if (__realloc_hook
!= emacs_blocked_realloc
)
1431 old_realloc_hook
= __realloc_hook
;
1432 __realloc_hook
= emacs_blocked_realloc
;
1435 #endif /* not SYNC_INPUT */
1436 #endif /* not SYSTEM_MALLOC */
1440 /***********************************************************************
1442 ***********************************************************************/
1444 /* Number of intervals allocated in an interval_block structure.
1445 The 1020 is 1024 minus malloc overhead. */
1447 #define INTERVAL_BLOCK_SIZE \
1448 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1450 /* Intervals are allocated in chunks in form of an interval_block
1453 struct interval_block
1455 /* Place `intervals' first, to preserve alignment. */
1456 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1457 struct interval_block
*next
;
1460 /* Current interval block. Its `next' pointer points to older
1463 static struct interval_block
*interval_block
;
1465 /* Index in interval_block above of the next unused interval
1468 static int interval_block_index
;
1470 /* Number of free and live intervals. */
1472 static EMACS_INT total_free_intervals
, total_intervals
;
1474 /* List of free intervals. */
1476 static INTERVAL interval_free_list
;
1479 /* Initialize interval allocation. */
1482 init_intervals (void)
1484 interval_block
= NULL
;
1485 interval_block_index
= INTERVAL_BLOCK_SIZE
;
1486 interval_free_list
= 0;
1490 /* Return a new interval. */
1493 make_interval (void)
1497 /* eassert (!handling_signal); */
1501 if (interval_free_list
)
1503 val
= interval_free_list
;
1504 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1508 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1510 register struct interval_block
*newi
;
1512 newi
= (struct interval_block
*) lisp_malloc (sizeof *newi
,
1515 newi
->next
= interval_block
;
1516 interval_block
= newi
;
1517 interval_block_index
= 0;
1519 val
= &interval_block
->intervals
[interval_block_index
++];
1522 MALLOC_UNBLOCK_INPUT
;
1524 consing_since_gc
+= sizeof (struct interval
);
1526 RESET_INTERVAL (val
);
1532 /* Mark Lisp objects in interval I. */
1535 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1537 eassert (!i
->gcmarkbit
); /* Intervals are never shared. */
1539 mark_object (i
->plist
);
1543 /* Mark the interval tree rooted in TREE. Don't call this directly;
1544 use the macro MARK_INTERVAL_TREE instead. */
1547 mark_interval_tree (register INTERVAL tree
)
1549 /* No need to test if this tree has been marked already; this
1550 function is always called through the MARK_INTERVAL_TREE macro,
1551 which takes care of that. */
1553 traverse_intervals_noorder (tree
, mark_interval
, Qnil
);
1557 /* Mark the interval tree rooted in I. */
1559 #define MARK_INTERVAL_TREE(i) \
1561 if (!NULL_INTERVAL_P (i) && !i->gcmarkbit) \
1562 mark_interval_tree (i); \
1566 #define UNMARK_BALANCE_INTERVALS(i) \
1568 if (! NULL_INTERVAL_P (i)) \
1569 (i) = balance_intervals (i); \
1573 /* Number support. If USE_LISP_UNION_TYPE is in effect, we
1574 can't create number objects in macros. */
1577 make_number (EMACS_INT n
)
1581 obj
.s
.type
= Lisp_Int
;
1586 /* Convert the pointer-sized word P to EMACS_INT while preserving its
1587 type and ptr fields. */
1589 widen_to_Lisp_Object (void *p
)
1591 intptr_t i
= (intptr_t) p
;
1592 #ifdef USE_LISP_UNION_TYPE
1601 /***********************************************************************
1603 ***********************************************************************/
1605 /* Lisp_Strings are allocated in string_block structures. When a new
1606 string_block is allocated, all the Lisp_Strings it contains are
1607 added to a free-list string_free_list. When a new Lisp_String is
1608 needed, it is taken from that list. During the sweep phase of GC,
1609 string_blocks that are entirely free are freed, except two which
1612 String data is allocated from sblock structures. Strings larger
1613 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1614 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1616 Sblocks consist internally of sdata structures, one for each
1617 Lisp_String. The sdata structure points to the Lisp_String it
1618 belongs to. The Lisp_String points back to the `u.data' member of
1619 its sdata structure.
1621 When a Lisp_String is freed during GC, it is put back on
1622 string_free_list, and its `data' member and its sdata's `string'
1623 pointer is set to null. The size of the string is recorded in the
1624 `u.nbytes' member of the sdata. So, sdata structures that are no
1625 longer used, can be easily recognized, and it's easy to compact the
1626 sblocks of small strings which we do in compact_small_strings. */
1628 /* Size in bytes of an sblock structure used for small strings. This
1629 is 8192 minus malloc overhead. */
1631 #define SBLOCK_SIZE 8188
1633 /* Strings larger than this are considered large strings. String data
1634 for large strings is allocated from individual sblocks. */
1636 #define LARGE_STRING_BYTES 1024
1638 /* Structure describing string memory sub-allocated from an sblock.
1639 This is where the contents of Lisp strings are stored. */
1643 /* Back-pointer to the string this sdata belongs to. If null, this
1644 structure is free, and the NBYTES member of the union below
1645 contains the string's byte size (the same value that STRING_BYTES
1646 would return if STRING were non-null). If non-null, STRING_BYTES
1647 (STRING) is the size of the data, and DATA contains the string's
1649 struct Lisp_String
*string
;
1651 #ifdef GC_CHECK_STRING_BYTES
1654 unsigned char data
[1];
1656 #define SDATA_NBYTES(S) (S)->nbytes
1657 #define SDATA_DATA(S) (S)->data
1658 #define SDATA_SELECTOR(member) member
1660 #else /* not GC_CHECK_STRING_BYTES */
1664 /* When STRING is non-null. */
1665 unsigned char data
[1];
1667 /* When STRING is null. */
1671 #define SDATA_NBYTES(S) (S)->u.nbytes
1672 #define SDATA_DATA(S) (S)->u.data
1673 #define SDATA_SELECTOR(member) u.member
1675 #endif /* not GC_CHECK_STRING_BYTES */
1677 #define SDATA_DATA_OFFSET offsetof (struct sdata, SDATA_SELECTOR (data))
1681 /* Structure describing a block of memory which is sub-allocated to
1682 obtain string data memory for strings. Blocks for small strings
1683 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1684 as large as needed. */
1689 struct sblock
*next
;
1691 /* Pointer to the next free sdata block. This points past the end
1692 of the sblock if there isn't any space left in this block. */
1693 struct sdata
*next_free
;
1695 /* Start of data. */
1696 struct sdata first_data
;
1699 /* Number of Lisp strings in a string_block structure. The 1020 is
1700 1024 minus malloc overhead. */
1702 #define STRING_BLOCK_SIZE \
1703 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1705 /* Structure describing a block from which Lisp_String structures
1710 /* Place `strings' first, to preserve alignment. */
1711 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1712 struct string_block
*next
;
1715 /* Head and tail of the list of sblock structures holding Lisp string
1716 data. We always allocate from current_sblock. The NEXT pointers
1717 in the sblock structures go from oldest_sblock to current_sblock. */
1719 static struct sblock
*oldest_sblock
, *current_sblock
;
1721 /* List of sblocks for large strings. */
1723 static struct sblock
*large_sblocks
;
1725 /* List of string_block structures. */
1727 static struct string_block
*string_blocks
;
1729 /* Free-list of Lisp_Strings. */
1731 static struct Lisp_String
*string_free_list
;
1733 /* Number of live and free Lisp_Strings. */
1735 static EMACS_INT total_strings
, total_free_strings
;
1737 /* Number of bytes used by live strings. */
1739 static EMACS_INT total_string_size
;
1741 /* Given a pointer to a Lisp_String S which is on the free-list
1742 string_free_list, return a pointer to its successor in the
1745 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1747 /* Return a pointer to the sdata structure belonging to Lisp string S.
1748 S must be live, i.e. S->data must not be null. S->data is actually
1749 a pointer to the `u.data' member of its sdata structure; the
1750 structure starts at a constant offset in front of that. */
1752 #define SDATA_OF_STRING(S) ((struct sdata *) ((S)->data - SDATA_DATA_OFFSET))
1755 #ifdef GC_CHECK_STRING_OVERRUN
1757 /* We check for overrun in string data blocks by appending a small
1758 "cookie" after each allocated string data block, and check for the
1759 presence of this cookie during GC. */
1761 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1762 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1763 { '\xde', '\xad', '\xbe', '\xef' };
1766 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1769 /* Value is the size of an sdata structure large enough to hold NBYTES
1770 bytes of string data. The value returned includes a terminating
1771 NUL byte, the size of the sdata structure, and padding. */
1773 #ifdef GC_CHECK_STRING_BYTES
1775 #define SDATA_SIZE(NBYTES) \
1776 ((SDATA_DATA_OFFSET \
1778 + sizeof (ptrdiff_t) - 1) \
1779 & ~(sizeof (ptrdiff_t) - 1))
1781 #else /* not GC_CHECK_STRING_BYTES */
1783 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1784 less than the size of that member. The 'max' is not needed when
1785 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1786 alignment code reserves enough space. */
1788 #define SDATA_SIZE(NBYTES) \
1789 ((SDATA_DATA_OFFSET \
1790 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1792 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1794 + sizeof (ptrdiff_t) - 1) \
1795 & ~(sizeof (ptrdiff_t) - 1))
1797 #endif /* not GC_CHECK_STRING_BYTES */
1799 /* Extra bytes to allocate for each string. */
1801 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1803 /* Exact bound on the number of bytes in a string, not counting the
1804 terminating null. A string cannot contain more bytes than
1805 STRING_BYTES_BOUND, nor can it be so long that the size_t
1806 arithmetic in allocate_string_data would overflow while it is
1807 calculating a value to be passed to malloc. */
1808 #define STRING_BYTES_MAX \
1809 min (STRING_BYTES_BOUND, \
1810 ((SIZE_MAX - XMALLOC_OVERRUN_CHECK_OVERHEAD \
1812 - offsetof (struct sblock, first_data) \
1813 - SDATA_DATA_OFFSET) \
1814 & ~(sizeof (EMACS_INT) - 1)))
1816 /* Initialize string allocation. Called from init_alloc_once. */
1821 total_strings
= total_free_strings
= total_string_size
= 0;
1822 oldest_sblock
= current_sblock
= large_sblocks
= NULL
;
1823 string_blocks
= NULL
;
1824 string_free_list
= NULL
;
1825 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1826 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1830 #ifdef GC_CHECK_STRING_BYTES
1832 static int check_string_bytes_count
;
1834 #define CHECK_STRING_BYTES(S) STRING_BYTES (S)
1837 /* Like GC_STRING_BYTES, but with debugging check. */
1840 string_bytes (struct Lisp_String
*s
)
1843 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1845 if (!PURE_POINTER_P (s
)
1847 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1852 /* Check validity of Lisp strings' string_bytes member in B. */
1855 check_sblock (struct sblock
*b
)
1857 struct sdata
*from
, *end
, *from_end
;
1861 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1863 /* Compute the next FROM here because copying below may
1864 overwrite data we need to compute it. */
1867 /* Check that the string size recorded in the string is the
1868 same as the one recorded in the sdata structure. */
1870 CHECK_STRING_BYTES (from
->string
);
1873 nbytes
= GC_STRING_BYTES (from
->string
);
1875 nbytes
= SDATA_NBYTES (from
);
1877 nbytes
= SDATA_SIZE (nbytes
);
1878 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1883 /* Check validity of Lisp strings' string_bytes member. ALL_P
1884 non-zero means check all strings, otherwise check only most
1885 recently allocated strings. Used for hunting a bug. */
1888 check_string_bytes (int all_p
)
1894 for (b
= large_sblocks
; b
; b
= b
->next
)
1896 struct Lisp_String
*s
= b
->first_data
.string
;
1898 CHECK_STRING_BYTES (s
);
1901 for (b
= oldest_sblock
; b
; b
= b
->next
)
1905 check_sblock (current_sblock
);
1908 #endif /* GC_CHECK_STRING_BYTES */
1910 #ifdef GC_CHECK_STRING_FREE_LIST
1912 /* Walk through the string free list looking for bogus next pointers.
1913 This may catch buffer overrun from a previous string. */
1916 check_string_free_list (void)
1918 struct Lisp_String
*s
;
1920 /* Pop a Lisp_String off the free-list. */
1921 s
= string_free_list
;
1924 if ((uintptr_t) s
< 1024)
1926 s
= NEXT_FREE_LISP_STRING (s
);
1930 #define check_string_free_list()
1933 /* Return a new Lisp_String. */
1935 static struct Lisp_String
*
1936 allocate_string (void)
1938 struct Lisp_String
*s
;
1940 /* eassert (!handling_signal); */
1944 /* If the free-list is empty, allocate a new string_block, and
1945 add all the Lisp_Strings in it to the free-list. */
1946 if (string_free_list
== NULL
)
1948 struct string_block
*b
;
1951 b
= (struct string_block
*) lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1952 memset (b
, 0, sizeof *b
);
1953 b
->next
= string_blocks
;
1956 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1959 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1960 string_free_list
= s
;
1963 total_free_strings
+= STRING_BLOCK_SIZE
;
1966 check_string_free_list ();
1968 /* Pop a Lisp_String off the free-list. */
1969 s
= string_free_list
;
1970 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1972 MALLOC_UNBLOCK_INPUT
;
1974 /* Probably not strictly necessary, but play it safe. */
1975 memset (s
, 0, sizeof *s
);
1977 --total_free_strings
;
1980 consing_since_gc
+= sizeof *s
;
1982 #ifdef GC_CHECK_STRING_BYTES
1983 if (!noninteractive
)
1985 if (++check_string_bytes_count
== 200)
1987 check_string_bytes_count
= 0;
1988 check_string_bytes (1);
1991 check_string_bytes (0);
1993 #endif /* GC_CHECK_STRING_BYTES */
1999 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
2000 plus a NUL byte at the end. Allocate an sdata structure for S, and
2001 set S->data to its `u.data' member. Store a NUL byte at the end of
2002 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
2003 S->data if it was initially non-null. */
2006 allocate_string_data (struct Lisp_String
*s
,
2007 EMACS_INT nchars
, EMACS_INT nbytes
)
2009 struct sdata
*data
, *old_data
;
2011 ptrdiff_t needed
, old_nbytes
;
2013 if (STRING_BYTES_MAX
< nbytes
)
2016 /* Determine the number of bytes needed to store NBYTES bytes
2018 needed
= SDATA_SIZE (nbytes
);
2019 old_data
= s
->data
? SDATA_OF_STRING (s
) : NULL
;
2020 old_nbytes
= GC_STRING_BYTES (s
);
2024 if (nbytes
> LARGE_STRING_BYTES
)
2026 size_t size
= offsetof (struct sblock
, first_data
) + needed
;
2028 #ifdef DOUG_LEA_MALLOC
2029 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
2030 because mapped region contents are not preserved in
2033 In case you think of allowing it in a dumped Emacs at the
2034 cost of not being able to re-dump, there's another reason:
2035 mmap'ed data typically have an address towards the top of the
2036 address space, which won't fit into an EMACS_INT (at least on
2037 32-bit systems with the current tagging scheme). --fx */
2038 mallopt (M_MMAP_MAX
, 0);
2041 b
= (struct sblock
*) lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
2043 #ifdef DOUG_LEA_MALLOC
2044 /* Back to a reasonable maximum of mmap'ed areas. */
2045 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2048 b
->next_free
= &b
->first_data
;
2049 b
->first_data
.string
= NULL
;
2050 b
->next
= large_sblocks
;
2053 else if (current_sblock
== NULL
2054 || (((char *) current_sblock
+ SBLOCK_SIZE
2055 - (char *) current_sblock
->next_free
)
2056 < (needed
+ GC_STRING_EXTRA
)))
2058 /* Not enough room in the current sblock. */
2059 b
= (struct sblock
*) lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
2060 b
->next_free
= &b
->first_data
;
2061 b
->first_data
.string
= NULL
;
2065 current_sblock
->next
= b
;
2073 data
= b
->next_free
;
2074 b
->next_free
= (struct sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
2076 MALLOC_UNBLOCK_INPUT
;
2079 s
->data
= SDATA_DATA (data
);
2080 #ifdef GC_CHECK_STRING_BYTES
2081 SDATA_NBYTES (data
) = nbytes
;
2084 s
->size_byte
= nbytes
;
2085 s
->data
[nbytes
] = '\0';
2086 #ifdef GC_CHECK_STRING_OVERRUN
2087 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
2088 GC_STRING_OVERRUN_COOKIE_SIZE
);
2091 /* If S had already data assigned, mark that as free by setting its
2092 string back-pointer to null, and recording the size of the data
2096 SDATA_NBYTES (old_data
) = old_nbytes
;
2097 old_data
->string
= NULL
;
2100 consing_since_gc
+= needed
;
2104 /* Sweep and compact strings. */
2107 sweep_strings (void)
2109 struct string_block
*b
, *next
;
2110 struct string_block
*live_blocks
= NULL
;
2112 string_free_list
= NULL
;
2113 total_strings
= total_free_strings
= 0;
2114 total_string_size
= 0;
2116 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
2117 for (b
= string_blocks
; b
; b
= next
)
2120 struct Lisp_String
*free_list_before
= string_free_list
;
2124 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
2126 struct Lisp_String
*s
= b
->strings
+ i
;
2130 /* String was not on free-list before. */
2131 if (STRING_MARKED_P (s
))
2133 /* String is live; unmark it and its intervals. */
2136 if (!NULL_INTERVAL_P (s
->intervals
))
2137 UNMARK_BALANCE_INTERVALS (s
->intervals
);
2140 total_string_size
+= STRING_BYTES (s
);
2144 /* String is dead. Put it on the free-list. */
2145 struct sdata
*data
= SDATA_OF_STRING (s
);
2147 /* Save the size of S in its sdata so that we know
2148 how large that is. Reset the sdata's string
2149 back-pointer so that we know it's free. */
2150 #ifdef GC_CHECK_STRING_BYTES
2151 if (GC_STRING_BYTES (s
) != SDATA_NBYTES (data
))
2154 data
->u
.nbytes
= GC_STRING_BYTES (s
);
2156 data
->string
= NULL
;
2158 /* Reset the strings's `data' member so that we
2162 /* Put the string on the free-list. */
2163 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2164 string_free_list
= s
;
2170 /* S was on the free-list before. Put it there again. */
2171 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2172 string_free_list
= s
;
2177 /* Free blocks that contain free Lisp_Strings only, except
2178 the first two of them. */
2179 if (nfree
== STRING_BLOCK_SIZE
2180 && total_free_strings
> STRING_BLOCK_SIZE
)
2183 string_free_list
= free_list_before
;
2187 total_free_strings
+= nfree
;
2188 b
->next
= live_blocks
;
2193 check_string_free_list ();
2195 string_blocks
= live_blocks
;
2196 free_large_strings ();
2197 compact_small_strings ();
2199 check_string_free_list ();
2203 /* Free dead large strings. */
2206 free_large_strings (void)
2208 struct sblock
*b
, *next
;
2209 struct sblock
*live_blocks
= NULL
;
2211 for (b
= large_sblocks
; b
; b
= next
)
2215 if (b
->first_data
.string
== NULL
)
2219 b
->next
= live_blocks
;
2224 large_sblocks
= live_blocks
;
2228 /* Compact data of small strings. Free sblocks that don't contain
2229 data of live strings after compaction. */
2232 compact_small_strings (void)
2234 struct sblock
*b
, *tb
, *next
;
2235 struct sdata
*from
, *to
, *end
, *tb_end
;
2236 struct sdata
*to_end
, *from_end
;
2238 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2239 to, and TB_END is the end of TB. */
2241 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2242 to
= &tb
->first_data
;
2244 /* Step through the blocks from the oldest to the youngest. We
2245 expect that old blocks will stabilize over time, so that less
2246 copying will happen this way. */
2247 for (b
= oldest_sblock
; b
; b
= b
->next
)
2250 xassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2252 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
2254 /* Compute the next FROM here because copying below may
2255 overwrite data we need to compute it. */
2258 #ifdef GC_CHECK_STRING_BYTES
2259 /* Check that the string size recorded in the string is the
2260 same as the one recorded in the sdata structure. */
2262 && GC_STRING_BYTES (from
->string
) != SDATA_NBYTES (from
))
2264 #endif /* GC_CHECK_STRING_BYTES */
2267 nbytes
= GC_STRING_BYTES (from
->string
);
2269 nbytes
= SDATA_NBYTES (from
);
2271 if (nbytes
> LARGE_STRING_BYTES
)
2274 nbytes
= SDATA_SIZE (nbytes
);
2275 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2277 #ifdef GC_CHECK_STRING_OVERRUN
2278 if (memcmp (string_overrun_cookie
,
2279 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2280 GC_STRING_OVERRUN_COOKIE_SIZE
))
2284 /* FROM->string non-null means it's alive. Copy its data. */
2287 /* If TB is full, proceed with the next sblock. */
2288 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2289 if (to_end
> tb_end
)
2293 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2294 to
= &tb
->first_data
;
2295 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2298 /* Copy, and update the string's `data' pointer. */
2301 xassert (tb
!= b
|| to
< from
);
2302 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2303 to
->string
->data
= SDATA_DATA (to
);
2306 /* Advance past the sdata we copied to. */
2312 /* The rest of the sblocks following TB don't contain live data, so
2313 we can free them. */
2314 for (b
= tb
->next
; b
; b
= next
)
2322 current_sblock
= tb
;
2326 string_overflow (void)
2328 error ("Maximum string size exceeded");
2331 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2332 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2333 LENGTH must be an integer.
2334 INIT must be an integer that represents a character. */)
2335 (Lisp_Object length
, Lisp_Object init
)
2337 register Lisp_Object val
;
2338 register unsigned char *p
, *end
;
2342 CHECK_NATNUM (length
);
2343 CHECK_CHARACTER (init
);
2345 c
= XFASTINT (init
);
2346 if (ASCII_CHAR_P (c
))
2348 nbytes
= XINT (length
);
2349 val
= make_uninit_string (nbytes
);
2351 end
= p
+ SCHARS (val
);
2357 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2358 int len
= CHAR_STRING (c
, str
);
2359 EMACS_INT string_len
= XINT (length
);
2361 if (string_len
> STRING_BYTES_MAX
/ len
)
2363 nbytes
= len
* string_len
;
2364 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2369 memcpy (p
, str
, len
);
2379 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2380 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2381 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2382 (Lisp_Object length
, Lisp_Object init
)
2384 register Lisp_Object val
;
2385 struct Lisp_Bool_Vector
*p
;
2386 ptrdiff_t length_in_chars
;
2387 EMACS_INT length_in_elts
;
2390 CHECK_NATNUM (length
);
2392 bits_per_value
= sizeof (EMACS_INT
) * BOOL_VECTOR_BITS_PER_CHAR
;
2394 length_in_elts
= (XFASTINT (length
) + bits_per_value
- 1) / bits_per_value
;
2396 /* We must allocate one more elements than LENGTH_IN_ELTS for the
2397 slot `size' of the struct Lisp_Bool_Vector. */
2398 val
= Fmake_vector (make_number (length_in_elts
+ 1), Qnil
);
2400 /* No Lisp_Object to trace in there. */
2401 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0);
2403 p
= XBOOL_VECTOR (val
);
2404 p
->size
= XFASTINT (length
);
2406 length_in_chars
= ((XFASTINT (length
) + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2407 / BOOL_VECTOR_BITS_PER_CHAR
);
2408 if (length_in_chars
)
2410 memset (p
->data
, ! NILP (init
) ? -1 : 0, length_in_chars
);
2412 /* Clear any extraneous bits in the last byte. */
2413 p
->data
[length_in_chars
- 1]
2414 &= (1 << (XINT (length
) % BOOL_VECTOR_BITS_PER_CHAR
)) - 1;
2421 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2422 of characters from the contents. This string may be unibyte or
2423 multibyte, depending on the contents. */
2426 make_string (const char *contents
, ptrdiff_t nbytes
)
2428 register Lisp_Object val
;
2429 ptrdiff_t nchars
, multibyte_nbytes
;
2431 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2432 &nchars
, &multibyte_nbytes
);
2433 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2434 /* CONTENTS contains no multibyte sequences or contains an invalid
2435 multibyte sequence. We must make unibyte string. */
2436 val
= make_unibyte_string (contents
, nbytes
);
2438 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2443 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2446 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2448 register Lisp_Object val
;
2449 val
= make_uninit_string (length
);
2450 memcpy (SDATA (val
), contents
, length
);
2455 /* Make a multibyte string from NCHARS characters occupying NBYTES
2456 bytes at CONTENTS. */
2459 make_multibyte_string (const char *contents
,
2460 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2462 register Lisp_Object val
;
2463 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2464 memcpy (SDATA (val
), contents
, nbytes
);
2469 /* Make a string from NCHARS characters occupying NBYTES bytes at
2470 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2473 make_string_from_bytes (const char *contents
,
2474 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2476 register Lisp_Object val
;
2477 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2478 memcpy (SDATA (val
), contents
, nbytes
);
2479 if (SBYTES (val
) == SCHARS (val
))
2480 STRING_SET_UNIBYTE (val
);
2485 /* Make a string from NCHARS characters occupying NBYTES bytes at
2486 CONTENTS. The argument MULTIBYTE controls whether to label the
2487 string as multibyte. If NCHARS is negative, it counts the number of
2488 characters by itself. */
2491 make_specified_string (const char *contents
,
2492 ptrdiff_t nchars
, ptrdiff_t nbytes
, int multibyte
)
2494 register Lisp_Object val
;
2499 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2504 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2505 memcpy (SDATA (val
), contents
, nbytes
);
2507 STRING_SET_UNIBYTE (val
);
2512 /* Make a string from the data at STR, treating it as multibyte if the
2516 build_string (const char *str
)
2518 return make_string (str
, strlen (str
));
2522 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2523 occupying LENGTH bytes. */
2526 make_uninit_string (EMACS_INT length
)
2531 return empty_unibyte_string
;
2532 val
= make_uninit_multibyte_string (length
, length
);
2533 STRING_SET_UNIBYTE (val
);
2538 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2539 which occupy NBYTES bytes. */
2542 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2545 struct Lisp_String
*s
;
2550 return empty_multibyte_string
;
2552 s
= allocate_string ();
2553 allocate_string_data (s
, nchars
, nbytes
);
2554 XSETSTRING (string
, s
);
2555 string_chars_consed
+= nbytes
;
2561 /***********************************************************************
2563 ***********************************************************************/
2565 /* We store float cells inside of float_blocks, allocating a new
2566 float_block with malloc whenever necessary. Float cells reclaimed
2567 by GC are put on a free list to be reallocated before allocating
2568 any new float cells from the latest float_block. */
2570 #define FLOAT_BLOCK_SIZE \
2571 (((BLOCK_BYTES - sizeof (struct float_block *) \
2572 /* The compiler might add padding at the end. */ \
2573 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2574 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2576 #define GETMARKBIT(block,n) \
2577 (((block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2578 >> ((n) % (sizeof (int) * CHAR_BIT))) \
2581 #define SETMARKBIT(block,n) \
2582 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2583 |= 1 << ((n) % (sizeof (int) * CHAR_BIT))
2585 #define UNSETMARKBIT(block,n) \
2586 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2587 &= ~(1 << ((n) % (sizeof (int) * CHAR_BIT)))
2589 #define FLOAT_BLOCK(fptr) \
2590 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2592 #define FLOAT_INDEX(fptr) \
2593 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2597 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2598 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2599 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2600 struct float_block
*next
;
2603 #define FLOAT_MARKED_P(fptr) \
2604 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2606 #define FLOAT_MARK(fptr) \
2607 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2609 #define FLOAT_UNMARK(fptr) \
2610 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2612 /* Current float_block. */
2614 static struct float_block
*float_block
;
2616 /* Index of first unused Lisp_Float in the current float_block. */
2618 static int float_block_index
;
2620 /* Free-list of Lisp_Floats. */
2622 static struct Lisp_Float
*float_free_list
;
2625 /* Initialize float allocation. */
2631 float_block_index
= FLOAT_BLOCK_SIZE
; /* Force alloc of new float_block. */
2632 float_free_list
= 0;
2636 /* Return a new float object with value FLOAT_VALUE. */
2639 make_float (double float_value
)
2641 register Lisp_Object val
;
2643 /* eassert (!handling_signal); */
2647 if (float_free_list
)
2649 /* We use the data field for chaining the free list
2650 so that we won't use the same field that has the mark bit. */
2651 XSETFLOAT (val
, float_free_list
);
2652 float_free_list
= float_free_list
->u
.chain
;
2656 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2658 register struct float_block
*new;
2660 new = (struct float_block
*) lisp_align_malloc (sizeof *new,
2662 new->next
= float_block
;
2663 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2665 float_block_index
= 0;
2667 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2668 float_block_index
++;
2671 MALLOC_UNBLOCK_INPUT
;
2673 XFLOAT_INIT (val
, float_value
);
2674 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2675 consing_since_gc
+= sizeof (struct Lisp_Float
);
2682 /***********************************************************************
2684 ***********************************************************************/
2686 /* We store cons cells inside of cons_blocks, allocating a new
2687 cons_block with malloc whenever necessary. Cons cells reclaimed by
2688 GC are put on a free list to be reallocated before allocating
2689 any new cons cells from the latest cons_block. */
2691 #define CONS_BLOCK_SIZE \
2692 (((BLOCK_BYTES - sizeof (struct cons_block *)) * CHAR_BIT) \
2693 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2695 #define CONS_BLOCK(fptr) \
2696 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2698 #define CONS_INDEX(fptr) \
2699 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2703 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2704 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2705 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2706 struct cons_block
*next
;
2709 #define CONS_MARKED_P(fptr) \
2710 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2712 #define CONS_MARK(fptr) \
2713 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2715 #define CONS_UNMARK(fptr) \
2716 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2718 /* Current cons_block. */
2720 static struct cons_block
*cons_block
;
2722 /* Index of first unused Lisp_Cons in the current block. */
2724 static int cons_block_index
;
2726 /* Free-list of Lisp_Cons structures. */
2728 static struct Lisp_Cons
*cons_free_list
;
2731 /* Initialize cons allocation. */
2737 cons_block_index
= CONS_BLOCK_SIZE
; /* Force alloc of new cons_block. */
2742 /* Explicitly free a cons cell by putting it on the free-list. */
2745 free_cons (struct Lisp_Cons
*ptr
)
2747 ptr
->u
.chain
= cons_free_list
;
2751 cons_free_list
= ptr
;
2754 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2755 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2756 (Lisp_Object car
, Lisp_Object cdr
)
2758 register Lisp_Object val
;
2760 /* eassert (!handling_signal); */
2766 /* We use the cdr for chaining the free list
2767 so that we won't use the same field that has the mark bit. */
2768 XSETCONS (val
, cons_free_list
);
2769 cons_free_list
= cons_free_list
->u
.chain
;
2773 if (cons_block_index
== CONS_BLOCK_SIZE
)
2775 register struct cons_block
*new;
2776 new = (struct cons_block
*) lisp_align_malloc (sizeof *new,
2778 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2779 new->next
= cons_block
;
2781 cons_block_index
= 0;
2783 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2787 MALLOC_UNBLOCK_INPUT
;
2791 eassert (!CONS_MARKED_P (XCONS (val
)));
2792 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2793 cons_cells_consed
++;
2797 #ifdef GC_CHECK_CONS_LIST
2798 /* Get an error now if there's any junk in the cons free list. */
2800 check_cons_list (void)
2802 struct Lisp_Cons
*tail
= cons_free_list
;
2805 tail
= tail
->u
.chain
;
2809 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2812 list1 (Lisp_Object arg1
)
2814 return Fcons (arg1
, Qnil
);
2818 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2820 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2825 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2827 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2832 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2834 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2839 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2841 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2842 Fcons (arg5
, Qnil
)))));
2846 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2847 doc
: /* Return a newly created list with specified arguments as elements.
2848 Any number of arguments, even zero arguments, are allowed.
2849 usage: (list &rest OBJECTS) */)
2850 (ptrdiff_t nargs
, Lisp_Object
*args
)
2852 register Lisp_Object val
;
2858 val
= Fcons (args
[nargs
], val
);
2864 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2865 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2866 (register Lisp_Object length
, Lisp_Object init
)
2868 register Lisp_Object val
;
2869 register EMACS_INT size
;
2871 CHECK_NATNUM (length
);
2872 size
= XFASTINT (length
);
2877 val
= Fcons (init
, val
);
2882 val
= Fcons (init
, val
);
2887 val
= Fcons (init
, val
);
2892 val
= Fcons (init
, val
);
2897 val
= Fcons (init
, val
);
2912 /***********************************************************************
2914 ***********************************************************************/
2916 /* Singly-linked list of all vectors. */
2918 static struct Lisp_Vector
*all_vectors
;
2920 /* Handy constants for vectorlike objects. */
2923 header_size
= offsetof (struct Lisp_Vector
, contents
),
2924 word_size
= sizeof (Lisp_Object
)
2927 /* Value is a pointer to a newly allocated Lisp_Vector structure
2928 with room for LEN Lisp_Objects. */
2930 static struct Lisp_Vector
*
2931 allocate_vectorlike (ptrdiff_t len
)
2933 struct Lisp_Vector
*p
;
2938 #ifdef DOUG_LEA_MALLOC
2939 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
2940 because mapped region contents are not preserved in
2942 mallopt (M_MMAP_MAX
, 0);
2945 /* This gets triggered by code which I haven't bothered to fix. --Stef */
2946 /* eassert (!handling_signal); */
2948 nbytes
= header_size
+ len
* word_size
;
2949 p
= (struct Lisp_Vector
*) lisp_malloc (nbytes
, MEM_TYPE_VECTORLIKE
);
2951 #ifdef DOUG_LEA_MALLOC
2952 /* Back to a reasonable maximum of mmap'ed areas. */
2953 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2956 consing_since_gc
+= nbytes
;
2957 vector_cells_consed
+= len
;
2959 p
->header
.next
.vector
= all_vectors
;
2962 MALLOC_UNBLOCK_INPUT
;
2968 /* Allocate a vector with LEN slots. */
2970 struct Lisp_Vector
*
2971 allocate_vector (EMACS_INT len
)
2973 struct Lisp_Vector
*v
;
2974 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
2976 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
2977 memory_full (SIZE_MAX
);
2978 v
= allocate_vectorlike (len
);
2979 v
->header
.size
= len
;
2984 /* Allocate other vector-like structures. */
2986 struct Lisp_Vector
*
2987 allocate_pseudovector (int memlen
, int lisplen
, int tag
)
2989 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
2992 /* Only the first lisplen slots will be traced normally by the GC. */
2993 for (i
= 0; i
< lisplen
; ++i
)
2994 v
->contents
[i
] = Qnil
;
2996 XSETPVECTYPESIZE (v
, tag
, lisplen
);
3000 struct Lisp_Hash_Table
*
3001 allocate_hash_table (void)
3003 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
3008 allocate_window (void)
3010 return ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
3015 allocate_terminal (void)
3017 struct terminal
*t
= ALLOCATE_PSEUDOVECTOR (struct terminal
,
3018 next_terminal
, PVEC_TERMINAL
);
3019 /* Zero out the non-GC'd fields. FIXME: This should be made unnecessary. */
3020 memset (&t
->next_terminal
, 0,
3021 (char*) (t
+ 1) - (char*) &t
->next_terminal
);
3027 allocate_frame (void)
3029 struct frame
*f
= ALLOCATE_PSEUDOVECTOR (struct frame
,
3030 face_cache
, PVEC_FRAME
);
3031 /* Zero out the non-GC'd fields. FIXME: This should be made unnecessary. */
3032 memset (&f
->face_cache
, 0,
3033 (char *) (f
+ 1) - (char *) &f
->face_cache
);
3038 struct Lisp_Process
*
3039 allocate_process (void)
3041 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3045 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3046 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3047 See also the function `vector'. */)
3048 (register Lisp_Object length
, Lisp_Object init
)
3051 register ptrdiff_t sizei
;
3052 register ptrdiff_t i
;
3053 register struct Lisp_Vector
*p
;
3055 CHECK_NATNUM (length
);
3057 p
= allocate_vector (XFASTINT (length
));
3058 sizei
= XFASTINT (length
);
3059 for (i
= 0; i
< sizei
; i
++)
3060 p
->contents
[i
] = init
;
3062 XSETVECTOR (vector
, p
);
3067 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3068 doc
: /* Return a newly created vector with specified arguments as elements.
3069 Any number of arguments, even zero arguments, are allowed.
3070 usage: (vector &rest OBJECTS) */)
3071 (ptrdiff_t nargs
, Lisp_Object
*args
)
3073 register Lisp_Object len
, val
;
3075 register struct Lisp_Vector
*p
;
3077 XSETFASTINT (len
, nargs
);
3078 val
= Fmake_vector (len
, Qnil
);
3080 for (i
= 0; i
< nargs
; i
++)
3081 p
->contents
[i
] = args
[i
];
3086 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3087 doc
: /* Create a byte-code object with specified arguments as elements.
3088 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3089 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3090 and (optional) INTERACTIVE-SPEC.
3091 The first four arguments are required; at most six have any
3093 The ARGLIST can be either like the one of `lambda', in which case the arguments
3094 will be dynamically bound before executing the byte code, or it can be an
3095 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3096 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3097 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3098 argument to catch the left-over arguments. If such an integer is used, the
3099 arguments will not be dynamically bound but will be instead pushed on the
3100 stack before executing the byte-code.
3101 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3102 (ptrdiff_t nargs
, Lisp_Object
*args
)
3104 register Lisp_Object len
, val
;
3106 register struct Lisp_Vector
*p
;
3108 XSETFASTINT (len
, nargs
);
3109 if (!NILP (Vpurify_flag
))
3110 val
= make_pure_vector (nargs
);
3112 val
= Fmake_vector (len
, Qnil
);
3114 if (nargs
> 1 && STRINGP (args
[1]) && STRING_MULTIBYTE (args
[1]))
3115 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3116 earlier because they produced a raw 8-bit string for byte-code
3117 and now such a byte-code string is loaded as multibyte while
3118 raw 8-bit characters converted to multibyte form. Thus, now we
3119 must convert them back to the original unibyte form. */
3120 args
[1] = Fstring_as_unibyte (args
[1]);
3123 for (i
= 0; i
< nargs
; i
++)
3125 if (!NILP (Vpurify_flag
))
3126 args
[i
] = Fpurecopy (args
[i
]);
3127 p
->contents
[i
] = args
[i
];
3129 XSETPVECTYPE (p
, PVEC_COMPILED
);
3130 XSETCOMPILED (val
, p
);
3136 /***********************************************************************
3138 ***********************************************************************/
3140 /* Each symbol_block is just under 1020 bytes long, since malloc
3141 really allocates in units of powers of two and uses 4 bytes for its
3144 #define SYMBOL_BLOCK_SIZE \
3145 ((1020 - sizeof (struct symbol_block *)) / sizeof (struct Lisp_Symbol))
3149 /* Place `symbols' first, to preserve alignment. */
3150 struct Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3151 struct symbol_block
*next
;
3154 /* Current symbol block and index of first unused Lisp_Symbol
3157 static struct symbol_block
*symbol_block
;
3158 static int symbol_block_index
;
3160 /* List of free symbols. */
3162 static struct Lisp_Symbol
*symbol_free_list
;
3165 /* Initialize symbol allocation. */
3170 symbol_block
= NULL
;
3171 symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3172 symbol_free_list
= 0;
3176 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3177 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3178 Its value and function definition are void, and its property list is nil. */)
3181 register Lisp_Object val
;
3182 register struct Lisp_Symbol
*p
;
3184 CHECK_STRING (name
);
3186 /* eassert (!handling_signal); */
3190 if (symbol_free_list
)
3192 XSETSYMBOL (val
, symbol_free_list
);
3193 symbol_free_list
= symbol_free_list
->next
;
3197 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3199 struct symbol_block
*new;
3200 new = (struct symbol_block
*) lisp_malloc (sizeof *new,
3202 new->next
= symbol_block
;
3204 symbol_block_index
= 0;
3206 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
]);
3207 symbol_block_index
++;
3210 MALLOC_UNBLOCK_INPUT
;
3215 p
->redirect
= SYMBOL_PLAINVAL
;
3216 SET_SYMBOL_VAL (p
, Qunbound
);
3217 p
->function
= Qunbound
;
3220 p
->interned
= SYMBOL_UNINTERNED
;
3222 p
->declared_special
= 0;
3223 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3230 /***********************************************************************
3231 Marker (Misc) Allocation
3232 ***********************************************************************/
3234 /* Allocation of markers and other objects that share that structure.
3235 Works like allocation of conses. */
3237 #define MARKER_BLOCK_SIZE \
3238 ((1020 - sizeof (struct marker_block *)) / sizeof (union Lisp_Misc))
3242 /* Place `markers' first, to preserve alignment. */
3243 union Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3244 struct marker_block
*next
;
3247 static struct marker_block
*marker_block
;
3248 static int marker_block_index
;
3250 static union Lisp_Misc
*marker_free_list
;
3255 marker_block
= NULL
;
3256 marker_block_index
= MARKER_BLOCK_SIZE
;
3257 marker_free_list
= 0;
3260 /* Return a newly allocated Lisp_Misc object, with no substructure. */
3263 allocate_misc (void)
3267 /* eassert (!handling_signal); */
3271 if (marker_free_list
)
3273 XSETMISC (val
, marker_free_list
);
3274 marker_free_list
= marker_free_list
->u_free
.chain
;
3278 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3280 struct marker_block
*new;
3281 new = (struct marker_block
*) lisp_malloc (sizeof *new,
3283 new->next
= marker_block
;
3285 marker_block_index
= 0;
3286 total_free_markers
+= MARKER_BLOCK_SIZE
;
3288 XSETMISC (val
, &marker_block
->markers
[marker_block_index
]);
3289 marker_block_index
++;
3292 MALLOC_UNBLOCK_INPUT
;
3294 --total_free_markers
;
3295 consing_since_gc
+= sizeof (union Lisp_Misc
);
3296 misc_objects_consed
++;
3297 XMISCANY (val
)->gcmarkbit
= 0;
3301 /* Free a Lisp_Misc object */
3304 free_misc (Lisp_Object misc
)
3306 XMISCTYPE (misc
) = Lisp_Misc_Free
;
3307 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3308 marker_free_list
= XMISC (misc
);
3310 total_free_markers
++;
3313 /* Return a Lisp_Misc_Save_Value object containing POINTER and
3314 INTEGER. This is used to package C values to call record_unwind_protect.
3315 The unwind function can get the C values back using XSAVE_VALUE. */
3318 make_save_value (void *pointer
, ptrdiff_t integer
)
3320 register Lisp_Object val
;
3321 register struct Lisp_Save_Value
*p
;
3323 val
= allocate_misc ();
3324 XMISCTYPE (val
) = Lisp_Misc_Save_Value
;
3325 p
= XSAVE_VALUE (val
);
3326 p
->pointer
= pointer
;
3327 p
->integer
= integer
;
3332 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3333 doc
: /* Return a newly allocated marker which does not point at any place. */)
3336 register Lisp_Object val
;
3337 register struct Lisp_Marker
*p
;
3339 val
= allocate_misc ();
3340 XMISCTYPE (val
) = Lisp_Misc_Marker
;
3346 p
->insertion_type
= 0;
3350 /* Put MARKER back on the free list after using it temporarily. */
3353 free_marker (Lisp_Object marker
)
3355 unchain_marker (XMARKER (marker
));
3360 /* Return a newly created vector or string with specified arguments as
3361 elements. If all the arguments are characters that can fit
3362 in a string of events, make a string; otherwise, make a vector.
3364 Any number of arguments, even zero arguments, are allowed. */
3367 make_event_array (register int nargs
, Lisp_Object
*args
)
3371 for (i
= 0; i
< nargs
; i
++)
3372 /* The things that fit in a string
3373 are characters that are in 0...127,
3374 after discarding the meta bit and all the bits above it. */
3375 if (!INTEGERP (args
[i
])
3376 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3377 return Fvector (nargs
, args
);
3379 /* Since the loop exited, we know that all the things in it are
3380 characters, so we can make a string. */
3384 result
= Fmake_string (make_number (nargs
), make_number (0));
3385 for (i
= 0; i
< nargs
; i
++)
3387 SSET (result
, i
, XINT (args
[i
]));
3388 /* Move the meta bit to the right place for a string char. */
3389 if (XINT (args
[i
]) & CHAR_META
)
3390 SSET (result
, i
, SREF (result
, i
) | 0x80);
3399 /************************************************************************
3400 Memory Full Handling
3401 ************************************************************************/
3404 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3405 there may have been size_t overflow so that malloc was never
3406 called, or perhaps malloc was invoked successfully but the
3407 resulting pointer had problems fitting into a tagged EMACS_INT. In
3408 either case this counts as memory being full even though malloc did
3412 memory_full (size_t nbytes
)
3414 /* Do not go into hysterics merely because a large request failed. */
3415 int enough_free_memory
= 0;
3416 if (SPARE_MEMORY
< nbytes
)
3421 p
= malloc (SPARE_MEMORY
);
3425 enough_free_memory
= 1;
3427 MALLOC_UNBLOCK_INPUT
;
3430 if (! enough_free_memory
)
3436 memory_full_cons_threshold
= sizeof (struct cons_block
);
3438 /* The first time we get here, free the spare memory. */
3439 for (i
= 0; i
< sizeof (spare_memory
) / sizeof (char *); i
++)
3440 if (spare_memory
[i
])
3443 free (spare_memory
[i
]);
3444 else if (i
>= 1 && i
<= 4)
3445 lisp_align_free (spare_memory
[i
]);
3447 lisp_free (spare_memory
[i
]);
3448 spare_memory
[i
] = 0;
3451 /* Record the space now used. When it decreases substantially,
3452 we can refill the memory reserve. */
3453 #if !defined SYSTEM_MALLOC && !defined SYNC_INPUT
3454 bytes_used_when_full
= BYTES_USED
;
3458 /* This used to call error, but if we've run out of memory, we could
3459 get infinite recursion trying to build the string. */
3460 xsignal (Qnil
, Vmemory_signal_data
);
3463 /* If we released our reserve (due to running out of memory),
3464 and we have a fair amount free once again,
3465 try to set aside another reserve in case we run out once more.
3467 This is called when a relocatable block is freed in ralloc.c,
3468 and also directly from this file, in case we're not using ralloc.c. */
3471 refill_memory_reserve (void)
3473 #ifndef SYSTEM_MALLOC
3474 if (spare_memory
[0] == 0)
3475 spare_memory
[0] = (char *) malloc (SPARE_MEMORY
);
3476 if (spare_memory
[1] == 0)
3477 spare_memory
[1] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3479 if (spare_memory
[2] == 0)
3480 spare_memory
[2] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3482 if (spare_memory
[3] == 0)
3483 spare_memory
[3] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3485 if (spare_memory
[4] == 0)
3486 spare_memory
[4] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3488 if (spare_memory
[5] == 0)
3489 spare_memory
[5] = (char *) lisp_malloc (sizeof (struct string_block
),
3491 if (spare_memory
[6] == 0)
3492 spare_memory
[6] = (char *) lisp_malloc (sizeof (struct string_block
),
3494 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3495 Vmemory_full
= Qnil
;
3499 /************************************************************************
3501 ************************************************************************/
3503 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3505 /* Conservative C stack marking requires a method to identify possibly
3506 live Lisp objects given a pointer value. We do this by keeping
3507 track of blocks of Lisp data that are allocated in a red-black tree
3508 (see also the comment of mem_node which is the type of nodes in
3509 that tree). Function lisp_malloc adds information for an allocated
3510 block to the red-black tree with calls to mem_insert, and function
3511 lisp_free removes it with mem_delete. Functions live_string_p etc
3512 call mem_find to lookup information about a given pointer in the
3513 tree, and use that to determine if the pointer points to a Lisp
3516 /* Initialize this part of alloc.c. */
3521 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3522 mem_z
.parent
= NULL
;
3523 mem_z
.color
= MEM_BLACK
;
3524 mem_z
.start
= mem_z
.end
= NULL
;
3529 /* Value is a pointer to the mem_node containing START. Value is
3530 MEM_NIL if there is no node in the tree containing START. */
3532 static inline struct mem_node
*
3533 mem_find (void *start
)
3537 if (start
< min_heap_address
|| start
> max_heap_address
)
3540 /* Make the search always successful to speed up the loop below. */
3541 mem_z
.start
= start
;
3542 mem_z
.end
= (char *) start
+ 1;
3545 while (start
< p
->start
|| start
>= p
->end
)
3546 p
= start
< p
->start
? p
->left
: p
->right
;
3551 /* Insert a new node into the tree for a block of memory with start
3552 address START, end address END, and type TYPE. Value is a
3553 pointer to the node that was inserted. */
3555 static struct mem_node
*
3556 mem_insert (void *start
, void *end
, enum mem_type type
)
3558 struct mem_node
*c
, *parent
, *x
;
3560 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3561 min_heap_address
= start
;
3562 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3563 max_heap_address
= end
;
3565 /* See where in the tree a node for START belongs. In this
3566 particular application, it shouldn't happen that a node is already
3567 present. For debugging purposes, let's check that. */
3571 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3573 while (c
!= MEM_NIL
)
3575 if (start
>= c
->start
&& start
< c
->end
)
3578 c
= start
< c
->start
? c
->left
: c
->right
;
3581 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3583 while (c
!= MEM_NIL
)
3586 c
= start
< c
->start
? c
->left
: c
->right
;
3589 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3591 /* Create a new node. */
3592 #ifdef GC_MALLOC_CHECK
3593 x
= (struct mem_node
*) _malloc_internal (sizeof *x
);
3597 x
= (struct mem_node
*) xmalloc (sizeof *x
);
3603 x
->left
= x
->right
= MEM_NIL
;
3606 /* Insert it as child of PARENT or install it as root. */
3609 if (start
< parent
->start
)
3617 /* Re-establish red-black tree properties. */
3618 mem_insert_fixup (x
);
3624 /* Re-establish the red-black properties of the tree, and thereby
3625 balance the tree, after node X has been inserted; X is always red. */
3628 mem_insert_fixup (struct mem_node
*x
)
3630 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3632 /* X is red and its parent is red. This is a violation of
3633 red-black tree property #3. */
3635 if (x
->parent
== x
->parent
->parent
->left
)
3637 /* We're on the left side of our grandparent, and Y is our
3639 struct mem_node
*y
= x
->parent
->parent
->right
;
3641 if (y
->color
== MEM_RED
)
3643 /* Uncle and parent are red but should be black because
3644 X is red. Change the colors accordingly and proceed
3645 with the grandparent. */
3646 x
->parent
->color
= MEM_BLACK
;
3647 y
->color
= MEM_BLACK
;
3648 x
->parent
->parent
->color
= MEM_RED
;
3649 x
= x
->parent
->parent
;
3653 /* Parent and uncle have different colors; parent is
3654 red, uncle is black. */
3655 if (x
== x
->parent
->right
)
3658 mem_rotate_left (x
);
3661 x
->parent
->color
= MEM_BLACK
;
3662 x
->parent
->parent
->color
= MEM_RED
;
3663 mem_rotate_right (x
->parent
->parent
);
3668 /* This is the symmetrical case of above. */
3669 struct mem_node
*y
= x
->parent
->parent
->left
;
3671 if (y
->color
== MEM_RED
)
3673 x
->parent
->color
= MEM_BLACK
;
3674 y
->color
= MEM_BLACK
;
3675 x
->parent
->parent
->color
= MEM_RED
;
3676 x
= x
->parent
->parent
;
3680 if (x
== x
->parent
->left
)
3683 mem_rotate_right (x
);
3686 x
->parent
->color
= MEM_BLACK
;
3687 x
->parent
->parent
->color
= MEM_RED
;
3688 mem_rotate_left (x
->parent
->parent
);
3693 /* The root may have been changed to red due to the algorithm. Set
3694 it to black so that property #5 is satisfied. */
3695 mem_root
->color
= MEM_BLACK
;
3706 mem_rotate_left (struct mem_node
*x
)
3710 /* Turn y's left sub-tree into x's right sub-tree. */
3713 if (y
->left
!= MEM_NIL
)
3714 y
->left
->parent
= x
;
3716 /* Y's parent was x's parent. */
3718 y
->parent
= x
->parent
;
3720 /* Get the parent to point to y instead of x. */
3723 if (x
== x
->parent
->left
)
3724 x
->parent
->left
= y
;
3726 x
->parent
->right
= y
;
3731 /* Put x on y's left. */
3745 mem_rotate_right (struct mem_node
*x
)
3747 struct mem_node
*y
= x
->left
;
3750 if (y
->right
!= MEM_NIL
)
3751 y
->right
->parent
= x
;
3754 y
->parent
= x
->parent
;
3757 if (x
== x
->parent
->right
)
3758 x
->parent
->right
= y
;
3760 x
->parent
->left
= y
;
3771 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
3774 mem_delete (struct mem_node
*z
)
3776 struct mem_node
*x
, *y
;
3778 if (!z
|| z
== MEM_NIL
)
3781 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
3786 while (y
->left
!= MEM_NIL
)
3790 if (y
->left
!= MEM_NIL
)
3795 x
->parent
= y
->parent
;
3798 if (y
== y
->parent
->left
)
3799 y
->parent
->left
= x
;
3801 y
->parent
->right
= x
;
3808 z
->start
= y
->start
;
3813 if (y
->color
== MEM_BLACK
)
3814 mem_delete_fixup (x
);
3816 #ifdef GC_MALLOC_CHECK
3824 /* Re-establish the red-black properties of the tree, after a
3828 mem_delete_fixup (struct mem_node
*x
)
3830 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
3832 if (x
== x
->parent
->left
)
3834 struct mem_node
*w
= x
->parent
->right
;
3836 if (w
->color
== MEM_RED
)
3838 w
->color
= MEM_BLACK
;
3839 x
->parent
->color
= MEM_RED
;
3840 mem_rotate_left (x
->parent
);
3841 w
= x
->parent
->right
;
3844 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
3851 if (w
->right
->color
== MEM_BLACK
)
3853 w
->left
->color
= MEM_BLACK
;
3855 mem_rotate_right (w
);
3856 w
= x
->parent
->right
;
3858 w
->color
= x
->parent
->color
;
3859 x
->parent
->color
= MEM_BLACK
;
3860 w
->right
->color
= MEM_BLACK
;
3861 mem_rotate_left (x
->parent
);
3867 struct mem_node
*w
= x
->parent
->left
;
3869 if (w
->color
== MEM_RED
)
3871 w
->color
= MEM_BLACK
;
3872 x
->parent
->color
= MEM_RED
;
3873 mem_rotate_right (x
->parent
);
3874 w
= x
->parent
->left
;
3877 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
3884 if (w
->left
->color
== MEM_BLACK
)
3886 w
->right
->color
= MEM_BLACK
;
3888 mem_rotate_left (w
);
3889 w
= x
->parent
->left
;
3892 w
->color
= x
->parent
->color
;
3893 x
->parent
->color
= MEM_BLACK
;
3894 w
->left
->color
= MEM_BLACK
;
3895 mem_rotate_right (x
->parent
);
3901 x
->color
= MEM_BLACK
;
3905 /* Value is non-zero if P is a pointer to a live Lisp string on
3906 the heap. M is a pointer to the mem_block for P. */
3909 live_string_p (struct mem_node
*m
, void *p
)
3911 if (m
->type
== MEM_TYPE_STRING
)
3913 struct string_block
*b
= (struct string_block
*) m
->start
;
3914 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
3916 /* P must point to the start of a Lisp_String structure, and it
3917 must not be on the free-list. */
3919 && offset
% sizeof b
->strings
[0] == 0
3920 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
3921 && ((struct Lisp_String
*) p
)->data
!= NULL
);
3928 /* Value is non-zero if P is a pointer to a live Lisp cons on
3929 the heap. M is a pointer to the mem_block for P. */
3932 live_cons_p (struct mem_node
*m
, void *p
)
3934 if (m
->type
== MEM_TYPE_CONS
)
3936 struct cons_block
*b
= (struct cons_block
*) m
->start
;
3937 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
3939 /* P must point to the start of a Lisp_Cons, not be
3940 one of the unused cells in the current cons block,
3941 and not be on the free-list. */
3943 && offset
% sizeof b
->conses
[0] == 0
3944 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
3946 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
3947 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
3954 /* Value is non-zero if P is a pointer to a live Lisp symbol on
3955 the heap. M is a pointer to the mem_block for P. */
3958 live_symbol_p (struct mem_node
*m
, void *p
)
3960 if (m
->type
== MEM_TYPE_SYMBOL
)
3962 struct symbol_block
*b
= (struct symbol_block
*) m
->start
;
3963 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
3965 /* P must point to the start of a Lisp_Symbol, not be
3966 one of the unused cells in the current symbol block,
3967 and not be on the free-list. */
3969 && offset
% sizeof b
->symbols
[0] == 0
3970 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
3971 && (b
!= symbol_block
3972 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
3973 && !EQ (((struct Lisp_Symbol
*) p
)->function
, Vdead
));
3980 /* Value is non-zero if P is a pointer to a live Lisp float on
3981 the heap. M is a pointer to the mem_block for P. */
3984 live_float_p (struct mem_node
*m
, void *p
)
3986 if (m
->type
== MEM_TYPE_FLOAT
)
3988 struct float_block
*b
= (struct float_block
*) m
->start
;
3989 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
3991 /* P must point to the start of a Lisp_Float and not be
3992 one of the unused cells in the current float block. */
3994 && offset
% sizeof b
->floats
[0] == 0
3995 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
3996 && (b
!= float_block
3997 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4004 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4005 the heap. M is a pointer to the mem_block for P. */
4008 live_misc_p (struct mem_node
*m
, void *p
)
4010 if (m
->type
== MEM_TYPE_MISC
)
4012 struct marker_block
*b
= (struct marker_block
*) m
->start
;
4013 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4015 /* P must point to the start of a Lisp_Misc, not be
4016 one of the unused cells in the current misc block,
4017 and not be on the free-list. */
4019 && offset
% sizeof b
->markers
[0] == 0
4020 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4021 && (b
!= marker_block
4022 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4023 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4030 /* Value is non-zero if P is a pointer to a live vector-like object.
4031 M is a pointer to the mem_block for P. */
4034 live_vector_p (struct mem_node
*m
, void *p
)
4036 return (p
== m
->start
&& m
->type
== MEM_TYPE_VECTORLIKE
);
4040 /* Value is non-zero if P is a pointer to a live buffer. M is a
4041 pointer to the mem_block for P. */
4044 live_buffer_p (struct mem_node
*m
, void *p
)
4046 /* P must point to the start of the block, and the buffer
4047 must not have been killed. */
4048 return (m
->type
== MEM_TYPE_BUFFER
4050 && !NILP (((struct buffer
*) p
)->BUFFER_INTERNAL_FIELD (name
)));
4053 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4057 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4059 /* Array of objects that are kept alive because the C stack contains
4060 a pattern that looks like a reference to them . */
4062 #define MAX_ZOMBIES 10
4063 static Lisp_Object zombies
[MAX_ZOMBIES
];
4065 /* Number of zombie objects. */
4067 static EMACS_INT nzombies
;
4069 /* Number of garbage collections. */
4071 static EMACS_INT ngcs
;
4073 /* Average percentage of zombies per collection. */
4075 static double avg_zombies
;
4077 /* Max. number of live and zombie objects. */
4079 static EMACS_INT max_live
, max_zombies
;
4081 /* Average number of live objects per GC. */
4083 static double avg_live
;
4085 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4086 doc
: /* Show information about live and zombie objects. */)
4089 Lisp_Object args
[8], zombie_list
= Qnil
;
4091 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); i
++)
4092 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4093 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4094 args
[1] = make_number (ngcs
);
4095 args
[2] = make_float (avg_live
);
4096 args
[3] = make_float (avg_zombies
);
4097 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4098 args
[5] = make_number (max_live
);
4099 args
[6] = make_number (max_zombies
);
4100 args
[7] = zombie_list
;
4101 return Fmessage (8, args
);
4104 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4107 /* Mark OBJ if we can prove it's a Lisp_Object. */
4110 mark_maybe_object (Lisp_Object obj
)
4118 po
= (void *) XPNTR (obj
);
4125 switch (XTYPE (obj
))
4128 mark_p
= (live_string_p (m
, po
)
4129 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4133 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4137 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4141 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4144 case Lisp_Vectorlike
:
4145 /* Note: can't check BUFFERP before we know it's a
4146 buffer because checking that dereferences the pointer
4147 PO which might point anywhere. */
4148 if (live_vector_p (m
, po
))
4149 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4150 else if (live_buffer_p (m
, po
))
4151 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4155 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4164 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4165 if (nzombies
< MAX_ZOMBIES
)
4166 zombies
[nzombies
] = obj
;
4175 /* If P points to Lisp data, mark that as live if it isn't already
4179 mark_maybe_pointer (void *p
)
4183 /* Quickly rule out some values which can't point to Lisp data. */
4186 8 /* USE_LSB_TAG needs Lisp data to be aligned on multiples of 8. */
4188 2 /* We assume that Lisp data is aligned on even addresses. */
4196 Lisp_Object obj
= Qnil
;
4200 case MEM_TYPE_NON_LISP
:
4201 /* Nothing to do; not a pointer to Lisp memory. */
4204 case MEM_TYPE_BUFFER
:
4205 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4206 XSETVECTOR (obj
, p
);
4210 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4214 case MEM_TYPE_STRING
:
4215 if (live_string_p (m
, p
)
4216 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4217 XSETSTRING (obj
, p
);
4221 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4225 case MEM_TYPE_SYMBOL
:
4226 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4227 XSETSYMBOL (obj
, p
);
4230 case MEM_TYPE_FLOAT
:
4231 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4235 case MEM_TYPE_VECTORLIKE
:
4236 if (live_vector_p (m
, p
))
4239 XSETVECTOR (tem
, p
);
4240 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4255 /* Alignment of pointer values. Use offsetof, as it sometimes returns
4256 a smaller alignment than GCC's __alignof__ and mark_memory might
4257 miss objects if __alignof__ were used. */
4258 #define GC_POINTER_ALIGNMENT offsetof (struct {char a; void *b;}, b)
4260 /* Define POINTERS_MIGHT_HIDE_IN_OBJECTS to 1 if marking via C pointers does
4261 not suffice, which is the typical case. A host where a Lisp_Object is
4262 wider than a pointer might allocate a Lisp_Object in non-adjacent halves.
4263 If USE_LSB_TAG, the bottom half is not a valid pointer, but it should
4264 suffice to widen it to to a Lisp_Object and check it that way. */
4265 #if defined USE_LSB_TAG || UINTPTR_MAX >> VALBITS != 0
4266 # if !defined USE_LSB_TAG && UINTPTR_MAX >> VALBITS >> GCTYPEBITS != 0
4267 /* If tag bits straddle pointer-word boundaries, neither mark_maybe_pointer
4268 nor mark_maybe_object can follow the pointers. This should not occur on
4269 any practical porting target. */
4270 # error "MSB type bits straddle pointer-word boundaries"
4272 /* Marking via C pointers does not suffice, because Lisp_Objects contain
4273 pointer words that hold pointers ORed with type bits. */
4274 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 1
4276 /* Marking via C pointers suffices, because Lisp_Objects contain pointer
4277 words that hold unmodified pointers. */
4278 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 0
4281 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4282 or END+OFFSET..START. */
4285 mark_memory (void *start
, void *end
)
4290 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4294 /* Make START the pointer to the start of the memory region,
4295 if it isn't already. */
4303 /* Mark Lisp data pointed to. This is necessary because, in some
4304 situations, the C compiler optimizes Lisp objects away, so that
4305 only a pointer to them remains. Example:
4307 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4310 Lisp_Object obj = build_string ("test");
4311 struct Lisp_String *s = XSTRING (obj);
4312 Fgarbage_collect ();
4313 fprintf (stderr, "test `%s'\n", s->data);
4317 Here, `obj' isn't really used, and the compiler optimizes it
4318 away. The only reference to the life string is through the
4321 for (pp
= start
; (void *) pp
< end
; pp
++)
4322 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4324 void *p
= *(void **) ((char *) pp
+ i
);
4325 mark_maybe_pointer (p
);
4326 if (POINTERS_MIGHT_HIDE_IN_OBJECTS
)
4327 mark_maybe_object (widen_to_Lisp_Object (p
));
4331 /* setjmp will work with GCC unless NON_SAVING_SETJMP is defined in
4332 the GCC system configuration. In gcc 3.2, the only systems for
4333 which this is so are i386-sco5 non-ELF, i386-sysv3 (maybe included
4334 by others?) and ns32k-pc532-min. */
4336 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4338 static int setjmp_tested_p
, longjmps_done
;
4340 #define SETJMP_WILL_LIKELY_WORK "\
4342 Emacs garbage collector has been changed to use conservative stack\n\
4343 marking. Emacs has determined that the method it uses to do the\n\
4344 marking will likely work on your system, but this isn't sure.\n\
4346 If you are a system-programmer, or can get the help of a local wizard\n\
4347 who is, please take a look at the function mark_stack in alloc.c, and\n\
4348 verify that the methods used are appropriate for your system.\n\
4350 Please mail the result to <emacs-devel@gnu.org>.\n\
4353 #define SETJMP_WILL_NOT_WORK "\
4355 Emacs garbage collector has been changed to use conservative stack\n\
4356 marking. Emacs has determined that the default method it uses to do the\n\
4357 marking will not work on your system. We will need a system-dependent\n\
4358 solution for your system.\n\
4360 Please take a look at the function mark_stack in alloc.c, and\n\
4361 try to find a way to make it work on your system.\n\
4363 Note that you may get false negatives, depending on the compiler.\n\
4364 In particular, you need to use -O with GCC for this test.\n\
4366 Please mail the result to <emacs-devel@gnu.org>.\n\
4370 /* Perform a quick check if it looks like setjmp saves registers in a
4371 jmp_buf. Print a message to stderr saying so. When this test
4372 succeeds, this is _not_ a proof that setjmp is sufficient for
4373 conservative stack marking. Only the sources or a disassembly
4384 /* Arrange for X to be put in a register. */
4390 if (longjmps_done
== 1)
4392 /* Came here after the longjmp at the end of the function.
4394 If x == 1, the longjmp has restored the register to its
4395 value before the setjmp, and we can hope that setjmp
4396 saves all such registers in the jmp_buf, although that
4399 For other values of X, either something really strange is
4400 taking place, or the setjmp just didn't save the register. */
4403 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4406 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4413 if (longjmps_done
== 1)
4417 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4420 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4422 /* Abort if anything GCPRO'd doesn't survive the GC. */
4430 for (p
= gcprolist
; p
; p
= p
->next
)
4431 for (i
= 0; i
< p
->nvars
; ++i
)
4432 if (!survives_gc_p (p
->var
[i
]))
4433 /* FIXME: It's not necessarily a bug. It might just be that the
4434 GCPRO is unnecessary or should release the object sooner. */
4438 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4445 fprintf (stderr
, "\nZombies kept alive = %"pI
"d:\n", nzombies
);
4446 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4448 fprintf (stderr
, " %d = ", i
);
4449 debug_print (zombies
[i
]);
4453 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4456 /* Mark live Lisp objects on the C stack.
4458 There are several system-dependent problems to consider when
4459 porting this to new architectures:
4463 We have to mark Lisp objects in CPU registers that can hold local
4464 variables or are used to pass parameters.
4466 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4467 something that either saves relevant registers on the stack, or
4468 calls mark_maybe_object passing it each register's contents.
4470 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4471 implementation assumes that calling setjmp saves registers we need
4472 to see in a jmp_buf which itself lies on the stack. This doesn't
4473 have to be true! It must be verified for each system, possibly
4474 by taking a look at the source code of setjmp.
4476 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4477 can use it as a machine independent method to store all registers
4478 to the stack. In this case the macros described in the previous
4479 two paragraphs are not used.
4483 Architectures differ in the way their processor stack is organized.
4484 For example, the stack might look like this
4487 | Lisp_Object | size = 4
4489 | something else | size = 2
4491 | Lisp_Object | size = 4
4495 In such a case, not every Lisp_Object will be aligned equally. To
4496 find all Lisp_Object on the stack it won't be sufficient to walk
4497 the stack in steps of 4 bytes. Instead, two passes will be
4498 necessary, one starting at the start of the stack, and a second
4499 pass starting at the start of the stack + 2. Likewise, if the
4500 minimal alignment of Lisp_Objects on the stack is 1, four passes
4501 would be necessary, each one starting with one byte more offset
4502 from the stack start. */
4509 #ifdef HAVE___BUILTIN_UNWIND_INIT
4510 /* Force callee-saved registers and register windows onto the stack.
4511 This is the preferred method if available, obviating the need for
4512 machine dependent methods. */
4513 __builtin_unwind_init ();
4515 #else /* not HAVE___BUILTIN_UNWIND_INIT */
4516 #ifndef GC_SAVE_REGISTERS_ON_STACK
4517 /* jmp_buf may not be aligned enough on darwin-ppc64 */
4518 union aligned_jmpbuf
{
4522 volatile int stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4524 /* This trick flushes the register windows so that all the state of
4525 the process is contained in the stack. */
4526 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4527 needed on ia64 too. See mach_dep.c, where it also says inline
4528 assembler doesn't work with relevant proprietary compilers. */
4530 #if defined (__sparc64__) && defined (__FreeBSD__)
4531 /* FreeBSD does not have a ta 3 handler. */
4538 /* Save registers that we need to see on the stack. We need to see
4539 registers used to hold register variables and registers used to
4541 #ifdef GC_SAVE_REGISTERS_ON_STACK
4542 GC_SAVE_REGISTERS_ON_STACK (end
);
4543 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4545 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4546 setjmp will definitely work, test it
4547 and print a message with the result
4549 if (!setjmp_tested_p
)
4551 setjmp_tested_p
= 1;
4554 #endif /* GC_SETJMP_WORKS */
4557 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4558 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4559 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
4561 /* This assumes that the stack is a contiguous region in memory. If
4562 that's not the case, something has to be done here to iterate
4563 over the stack segments. */
4564 mark_memory (stack_base
, end
);
4566 /* Allow for marking a secondary stack, like the register stack on the
4568 #ifdef GC_MARK_SECONDARY_STACK
4569 GC_MARK_SECONDARY_STACK ();
4572 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4577 #endif /* GC_MARK_STACK != 0 */
4580 /* Determine whether it is safe to access memory at address P. */
4582 valid_pointer_p (void *p
)
4585 return w32_valid_pointer_p (p
, 16);
4589 /* Obviously, we cannot just access it (we would SEGV trying), so we
4590 trick the o/s to tell us whether p is a valid pointer.
4591 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4592 not validate p in that case. */
4596 int valid
= (emacs_write (fd
[1], (char *) p
, 16) == 16);
4597 emacs_close (fd
[1]);
4598 emacs_close (fd
[0]);
4606 /* Return 1 if OBJ is a valid lisp object.
4607 Return 0 if OBJ is NOT a valid lisp object.
4608 Return -1 if we cannot validate OBJ.
4609 This function can be quite slow,
4610 so it should only be used in code for manual debugging. */
4613 valid_lisp_object_p (Lisp_Object obj
)
4623 p
= (void *) XPNTR (obj
);
4624 if (PURE_POINTER_P (p
))
4628 return valid_pointer_p (p
);
4635 int valid
= valid_pointer_p (p
);
4647 case MEM_TYPE_NON_LISP
:
4650 case MEM_TYPE_BUFFER
:
4651 return live_buffer_p (m
, p
);
4654 return live_cons_p (m
, p
);
4656 case MEM_TYPE_STRING
:
4657 return live_string_p (m
, p
);
4660 return live_misc_p (m
, p
);
4662 case MEM_TYPE_SYMBOL
:
4663 return live_symbol_p (m
, p
);
4665 case MEM_TYPE_FLOAT
:
4666 return live_float_p (m
, p
);
4668 case MEM_TYPE_VECTORLIKE
:
4669 return live_vector_p (m
, p
);
4682 /***********************************************************************
4683 Pure Storage Management
4684 ***********************************************************************/
4686 /* Allocate room for SIZE bytes from pure Lisp storage and return a
4687 pointer to it. TYPE is the Lisp type for which the memory is
4688 allocated. TYPE < 0 means it's not used for a Lisp object. */
4690 static POINTER_TYPE
*
4691 pure_alloc (size_t size
, int type
)
4693 POINTER_TYPE
*result
;
4695 size_t alignment
= (1 << GCTYPEBITS
);
4697 size_t alignment
= sizeof (EMACS_INT
);
4699 /* Give Lisp_Floats an extra alignment. */
4700 if (type
== Lisp_Float
)
4702 #if defined __GNUC__ && __GNUC__ >= 2
4703 alignment
= __alignof (struct Lisp_Float
);
4705 alignment
= sizeof (struct Lisp_Float
);
4713 /* Allocate space for a Lisp object from the beginning of the free
4714 space with taking account of alignment. */
4715 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
4716 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
4720 /* Allocate space for a non-Lisp object from the end of the free
4722 pure_bytes_used_non_lisp
+= size
;
4723 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4725 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
4727 if (pure_bytes_used
<= pure_size
)
4730 /* Don't allocate a large amount here,
4731 because it might get mmap'd and then its address
4732 might not be usable. */
4733 purebeg
= (char *) xmalloc (10000);
4735 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
4736 pure_bytes_used
= 0;
4737 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
4742 /* Print a warning if PURESIZE is too small. */
4745 check_pure_size (void)
4747 if (pure_bytes_used_before_overflow
)
4748 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
4750 pure_bytes_used
+ pure_bytes_used_before_overflow
);
4754 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
4755 the non-Lisp data pool of the pure storage, and return its start
4756 address. Return NULL if not found. */
4759 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
4762 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
4763 const unsigned char *p
;
4766 if (pure_bytes_used_non_lisp
<= nbytes
)
4769 /* Set up the Boyer-Moore table. */
4771 for (i
= 0; i
< 256; i
++)
4774 p
= (const unsigned char *) data
;
4776 bm_skip
[*p
++] = skip
;
4778 last_char_skip
= bm_skip
['\0'];
4780 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4781 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
4783 /* See the comments in the function `boyer_moore' (search.c) for the
4784 use of `infinity'. */
4785 infinity
= pure_bytes_used_non_lisp
+ 1;
4786 bm_skip
['\0'] = infinity
;
4788 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
4792 /* Check the last character (== '\0'). */
4795 start
+= bm_skip
[*(p
+ start
)];
4797 while (start
<= start_max
);
4799 if (start
< infinity
)
4800 /* Couldn't find the last character. */
4803 /* No less than `infinity' means we could find the last
4804 character at `p[start - infinity]'. */
4807 /* Check the remaining characters. */
4808 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
4810 return non_lisp_beg
+ start
;
4812 start
+= last_char_skip
;
4814 while (start
<= start_max
);
4820 /* Return a string allocated in pure space. DATA is a buffer holding
4821 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
4822 non-zero means make the result string multibyte.
4824 Must get an error if pure storage is full, since if it cannot hold
4825 a large string it may be able to hold conses that point to that
4826 string; then the string is not protected from gc. */
4829 make_pure_string (const char *data
,
4830 ptrdiff_t nchars
, ptrdiff_t nbytes
, int multibyte
)
4833 struct Lisp_String
*s
;
4835 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
4836 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
4837 if (s
->data
== NULL
)
4839 s
->data
= (unsigned char *) pure_alloc (nbytes
+ 1, -1);
4840 memcpy (s
->data
, data
, nbytes
);
4841 s
->data
[nbytes
] = '\0';
4844 s
->size_byte
= multibyte
? nbytes
: -1;
4845 s
->intervals
= NULL_INTERVAL
;
4846 XSETSTRING (string
, s
);
4850 /* Return a string a string allocated in pure space. Do not allocate
4851 the string data, just point to DATA. */
4854 make_pure_c_string (const char *data
)
4857 struct Lisp_String
*s
;
4858 ptrdiff_t nchars
= strlen (data
);
4860 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
4863 s
->data
= (unsigned char *) data
;
4864 s
->intervals
= NULL_INTERVAL
;
4865 XSETSTRING (string
, s
);
4869 /* Return a cons allocated from pure space. Give it pure copies
4870 of CAR as car and CDR as cdr. */
4873 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
4875 register Lisp_Object
new;
4876 struct Lisp_Cons
*p
;
4878 p
= (struct Lisp_Cons
*) pure_alloc (sizeof *p
, Lisp_Cons
);
4880 XSETCAR (new, Fpurecopy (car
));
4881 XSETCDR (new, Fpurecopy (cdr
));
4886 /* Value is a float object with value NUM allocated from pure space. */
4889 make_pure_float (double num
)
4891 register Lisp_Object
new;
4892 struct Lisp_Float
*p
;
4894 p
= (struct Lisp_Float
*) pure_alloc (sizeof *p
, Lisp_Float
);
4896 XFLOAT_INIT (new, num
);
4901 /* Return a vector with room for LEN Lisp_Objects allocated from
4905 make_pure_vector (ptrdiff_t len
)
4908 struct Lisp_Vector
*p
;
4909 size_t size
= (offsetof (struct Lisp_Vector
, contents
)
4910 + len
* sizeof (Lisp_Object
));
4912 p
= (struct Lisp_Vector
*) pure_alloc (size
, Lisp_Vectorlike
);
4913 XSETVECTOR (new, p
);
4914 XVECTOR (new)->header
.size
= len
;
4919 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
4920 doc
: /* Make a copy of object OBJ in pure storage.
4921 Recursively copies contents of vectors and cons cells.
4922 Does not copy symbols. Copies strings without text properties. */)
4923 (register Lisp_Object obj
)
4925 if (NILP (Vpurify_flag
))
4928 if (PURE_POINTER_P (XPNTR (obj
)))
4931 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
4933 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
4939 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
4940 else if (FLOATP (obj
))
4941 obj
= make_pure_float (XFLOAT_DATA (obj
));
4942 else if (STRINGP (obj
))
4943 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
4945 STRING_MULTIBYTE (obj
));
4946 else if (COMPILEDP (obj
) || VECTORP (obj
))
4948 register struct Lisp_Vector
*vec
;
4949 register ptrdiff_t i
;
4953 if (size
& PSEUDOVECTOR_FLAG
)
4954 size
&= PSEUDOVECTOR_SIZE_MASK
;
4955 vec
= XVECTOR (make_pure_vector (size
));
4956 for (i
= 0; i
< size
; i
++)
4957 vec
->contents
[i
] = Fpurecopy (XVECTOR (obj
)->contents
[i
]);
4958 if (COMPILEDP (obj
))
4960 XSETPVECTYPE (vec
, PVEC_COMPILED
);
4961 XSETCOMPILED (obj
, vec
);
4964 XSETVECTOR (obj
, vec
);
4966 else if (MARKERP (obj
))
4967 error ("Attempt to copy a marker to pure storage");
4969 /* Not purified, don't hash-cons. */
4972 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
4973 Fputhash (obj
, obj
, Vpurify_flag
);
4980 /***********************************************************************
4982 ***********************************************************************/
4984 /* Put an entry in staticvec, pointing at the variable with address
4988 staticpro (Lisp_Object
*varaddress
)
4990 staticvec
[staticidx
++] = varaddress
;
4991 if (staticidx
>= NSTATICS
)
4996 /***********************************************************************
4998 ***********************************************************************/
5000 /* Temporarily prevent garbage collection. */
5003 inhibit_garbage_collection (void)
5005 ptrdiff_t count
= SPECPDL_INDEX ();
5007 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5012 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5013 doc
: /* Reclaim storage for Lisp objects no longer needed.
5014 Garbage collection happens automatically if you cons more than
5015 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5016 `garbage-collect' normally returns a list with info on amount of space in use:
5017 ((USED-CONSES . FREE-CONSES) (USED-SYMS . FREE-SYMS)
5018 (USED-MISCS . FREE-MISCS) USED-STRING-CHARS USED-VECTOR-SLOTS
5019 (USED-FLOATS . FREE-FLOATS) (USED-INTERVALS . FREE-INTERVALS)
5020 (USED-STRINGS . FREE-STRINGS))
5021 However, if there was overflow in pure space, `garbage-collect'
5022 returns nil, because real GC can't be done.
5023 See Info node `(elisp)Garbage Collection'. */)
5026 register struct specbinding
*bind
;
5027 char stack_top_variable
;
5030 Lisp_Object total
[8];
5031 ptrdiff_t count
= SPECPDL_INDEX ();
5032 EMACS_TIME t1
, t2
, t3
;
5037 /* Can't GC if pure storage overflowed because we can't determine
5038 if something is a pure object or not. */
5039 if (pure_bytes_used_before_overflow
)
5044 /* Don't keep undo information around forever.
5045 Do this early on, so it is no problem if the user quits. */
5047 register struct buffer
*nextb
= all_buffers
;
5051 /* If a buffer's undo list is Qt, that means that undo is
5052 turned off in that buffer. Calling truncate_undo_list on
5053 Qt tends to return NULL, which effectively turns undo back on.
5054 So don't call truncate_undo_list if undo_list is Qt. */
5055 if (! NILP (nextb
->BUFFER_INTERNAL_FIELD (name
)) && ! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
5056 truncate_undo_list (nextb
);
5058 /* Shrink buffer gaps, but skip indirect and dead buffers. */
5059 if (nextb
->base_buffer
== 0 && !NILP (nextb
->BUFFER_INTERNAL_FIELD (name
))
5060 && ! nextb
->text
->inhibit_shrinking
)
5062 /* If a buffer's gap size is more than 10% of the buffer
5063 size, or larger than 2000 bytes, then shrink it
5064 accordingly. Keep a minimum size of 20 bytes. */
5065 int size
= min (2000, max (20, (nextb
->text
->z_byte
/ 10)));
5067 if (nextb
->text
->gap_size
> size
)
5069 struct buffer
*save_current
= current_buffer
;
5070 current_buffer
= nextb
;
5071 make_gap (-(nextb
->text
->gap_size
- size
));
5072 current_buffer
= save_current
;
5076 nextb
= nextb
->header
.next
.buffer
;
5080 EMACS_GET_TIME (t1
);
5082 /* In case user calls debug_print during GC,
5083 don't let that cause a recursive GC. */
5084 consing_since_gc
= 0;
5086 /* Save what's currently displayed in the echo area. */
5087 message_p
= push_message ();
5088 record_unwind_protect (pop_message_unwind
, Qnil
);
5090 /* Save a copy of the contents of the stack, for debugging. */
5091 #if MAX_SAVE_STACK > 0
5092 if (NILP (Vpurify_flag
))
5095 ptrdiff_t stack_size
;
5096 if (&stack_top_variable
< stack_bottom
)
5098 stack
= &stack_top_variable
;
5099 stack_size
= stack_bottom
- &stack_top_variable
;
5103 stack
= stack_bottom
;
5104 stack_size
= &stack_top_variable
- stack_bottom
;
5106 if (stack_size
<= MAX_SAVE_STACK
)
5108 if (stack_copy_size
< stack_size
)
5110 stack_copy
= (char *) xrealloc (stack_copy
, stack_size
);
5111 stack_copy_size
= stack_size
;
5113 memcpy (stack_copy
, stack
, stack_size
);
5116 #endif /* MAX_SAVE_STACK > 0 */
5118 if (garbage_collection_messages
)
5119 message1_nolog ("Garbage collecting...");
5123 shrink_regexp_cache ();
5127 /* clear_marks (); */
5129 /* Mark all the special slots that serve as the roots of accessibility. */
5131 for (i
= 0; i
< staticidx
; i
++)
5132 mark_object (*staticvec
[i
]);
5134 for (bind
= specpdl
; bind
!= specpdl_ptr
; bind
++)
5136 mark_object (bind
->symbol
);
5137 mark_object (bind
->old_value
);
5145 extern void xg_mark_data (void);
5150 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5151 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5155 register struct gcpro
*tail
;
5156 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5157 for (i
= 0; i
< tail
->nvars
; i
++)
5158 mark_object (tail
->var
[i
]);
5162 struct catchtag
*catch;
5163 struct handler
*handler
;
5165 for (catch = catchlist
; catch; catch = catch->next
)
5167 mark_object (catch->tag
);
5168 mark_object (catch->val
);
5170 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5172 mark_object (handler
->handler
);
5173 mark_object (handler
->var
);
5179 #ifdef HAVE_WINDOW_SYSTEM
5180 mark_fringe_data ();
5183 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5187 /* Everything is now marked, except for the things that require special
5188 finalization, i.e. the undo_list.
5189 Look thru every buffer's undo list
5190 for elements that update markers that were not marked,
5193 register struct buffer
*nextb
= all_buffers
;
5197 /* If a buffer's undo list is Qt, that means that undo is
5198 turned off in that buffer. Calling truncate_undo_list on
5199 Qt tends to return NULL, which effectively turns undo back on.
5200 So don't call truncate_undo_list if undo_list is Qt. */
5201 if (! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
5203 Lisp_Object tail
, prev
;
5204 tail
= nextb
->BUFFER_INTERNAL_FIELD (undo_list
);
5206 while (CONSP (tail
))
5208 if (CONSP (XCAR (tail
))
5209 && MARKERP (XCAR (XCAR (tail
)))
5210 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5213 nextb
->BUFFER_INTERNAL_FIELD (undo_list
) = tail
= XCDR (tail
);
5217 XSETCDR (prev
, tail
);
5227 /* Now that we have stripped the elements that need not be in the
5228 undo_list any more, we can finally mark the list. */
5229 mark_object (nextb
->BUFFER_INTERNAL_FIELD (undo_list
));
5231 nextb
= nextb
->header
.next
.buffer
;
5237 /* Clear the mark bits that we set in certain root slots. */
5239 unmark_byte_stack ();
5240 VECTOR_UNMARK (&buffer_defaults
);
5241 VECTOR_UNMARK (&buffer_local_symbols
);
5243 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5251 /* clear_marks (); */
5254 consing_since_gc
= 0;
5255 if (gc_cons_threshold
< 10000)
5256 gc_cons_threshold
= 10000;
5258 gc_relative_threshold
= 0;
5259 if (FLOATP (Vgc_cons_percentage
))
5260 { /* Set gc_cons_combined_threshold. */
5263 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5264 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5265 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5266 tot
+= total_string_size
;
5267 tot
+= total_vector_size
* sizeof (Lisp_Object
);
5268 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5269 tot
+= total_intervals
* sizeof (struct interval
);
5270 tot
+= total_strings
* sizeof (struct Lisp_String
);
5272 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5275 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5276 gc_relative_threshold
= tot
;
5278 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5282 if (garbage_collection_messages
)
5284 if (message_p
|| minibuf_level
> 0)
5287 message1_nolog ("Garbage collecting...done");
5290 unbind_to (count
, Qnil
);
5292 total
[0] = Fcons (make_number (total_conses
),
5293 make_number (total_free_conses
));
5294 total
[1] = Fcons (make_number (total_symbols
),
5295 make_number (total_free_symbols
));
5296 total
[2] = Fcons (make_number (total_markers
),
5297 make_number (total_free_markers
));
5298 total
[3] = make_number (total_string_size
);
5299 total
[4] = make_number (total_vector_size
);
5300 total
[5] = Fcons (make_number (total_floats
),
5301 make_number (total_free_floats
));
5302 total
[6] = Fcons (make_number (total_intervals
),
5303 make_number (total_free_intervals
));
5304 total
[7] = Fcons (make_number (total_strings
),
5305 make_number (total_free_strings
));
5307 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5309 /* Compute average percentage of zombies. */
5312 for (i
= 0; i
< 7; ++i
)
5313 if (CONSP (total
[i
]))
5314 nlive
+= XFASTINT (XCAR (total
[i
]));
5316 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5317 max_live
= max (nlive
, max_live
);
5318 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5319 max_zombies
= max (nzombies
, max_zombies
);
5324 if (!NILP (Vpost_gc_hook
))
5326 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5327 safe_run_hooks (Qpost_gc_hook
);
5328 unbind_to (gc_count
, Qnil
);
5331 /* Accumulate statistics. */
5332 EMACS_GET_TIME (t2
);
5333 EMACS_SUB_TIME (t3
, t2
, t1
);
5334 if (FLOATP (Vgc_elapsed
))
5335 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
) +
5337 EMACS_USECS (t3
) * 1.0e-6);
5340 return Flist (sizeof total
/ sizeof *total
, total
);
5344 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5345 only interesting objects referenced from glyphs are strings. */
5348 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5350 struct glyph_row
*row
= matrix
->rows
;
5351 struct glyph_row
*end
= row
+ matrix
->nrows
;
5353 for (; row
< end
; ++row
)
5357 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5359 struct glyph
*glyph
= row
->glyphs
[area
];
5360 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5362 for (; glyph
< end_glyph
; ++glyph
)
5363 if (STRINGP (glyph
->object
)
5364 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5365 mark_object (glyph
->object
);
5371 /* Mark Lisp faces in the face cache C. */
5374 mark_face_cache (struct face_cache
*c
)
5379 for (i
= 0; i
< c
->used
; ++i
)
5381 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5385 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5386 mark_object (face
->lface
[j
]);
5394 /* Mark reference to a Lisp_Object.
5395 If the object referred to has not been seen yet, recursively mark
5396 all the references contained in it. */
5398 #define LAST_MARKED_SIZE 500
5399 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5400 static int last_marked_index
;
5402 /* For debugging--call abort when we cdr down this many
5403 links of a list, in mark_object. In debugging,
5404 the call to abort will hit a breakpoint.
5405 Normally this is zero and the check never goes off. */
5406 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5409 mark_vectorlike (struct Lisp_Vector
*ptr
)
5411 ptrdiff_t size
= ptr
->header
.size
;
5414 eassert (!VECTOR_MARKED_P (ptr
));
5415 VECTOR_MARK (ptr
); /* Else mark it */
5416 if (size
& PSEUDOVECTOR_FLAG
)
5417 size
&= PSEUDOVECTOR_SIZE_MASK
;
5419 /* Note that this size is not the memory-footprint size, but only
5420 the number of Lisp_Object fields that we should trace.
5421 The distinction is used e.g. by Lisp_Process which places extra
5422 non-Lisp_Object fields at the end of the structure. */
5423 for (i
= 0; i
< size
; i
++) /* and then mark its elements */
5424 mark_object (ptr
->contents
[i
]);
5427 /* Like mark_vectorlike but optimized for char-tables (and
5428 sub-char-tables) assuming that the contents are mostly integers or
5432 mark_char_table (struct Lisp_Vector
*ptr
)
5434 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5437 eassert (!VECTOR_MARKED_P (ptr
));
5439 for (i
= 0; i
< size
; i
++)
5441 Lisp_Object val
= ptr
->contents
[i
];
5443 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5445 if (SUB_CHAR_TABLE_P (val
))
5447 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5448 mark_char_table (XVECTOR (val
));
5456 mark_object (Lisp_Object arg
)
5458 register Lisp_Object obj
= arg
;
5459 #ifdef GC_CHECK_MARKED_OBJECTS
5463 ptrdiff_t cdr_count
= 0;
5467 if (PURE_POINTER_P (XPNTR (obj
)))
5470 last_marked
[last_marked_index
++] = obj
;
5471 if (last_marked_index
== LAST_MARKED_SIZE
)
5472 last_marked_index
= 0;
5474 /* Perform some sanity checks on the objects marked here. Abort if
5475 we encounter an object we know is bogus. This increases GC time
5476 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5477 #ifdef GC_CHECK_MARKED_OBJECTS
5479 po
= (void *) XPNTR (obj
);
5481 /* Check that the object pointed to by PO is known to be a Lisp
5482 structure allocated from the heap. */
5483 #define CHECK_ALLOCATED() \
5485 m = mem_find (po); \
5490 /* Check that the object pointed to by PO is live, using predicate
5492 #define CHECK_LIVE(LIVEP) \
5494 if (!LIVEP (m, po)) \
5498 /* Check both of the above conditions. */
5499 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5501 CHECK_ALLOCATED (); \
5502 CHECK_LIVE (LIVEP); \
5505 #else /* not GC_CHECK_MARKED_OBJECTS */
5507 #define CHECK_LIVE(LIVEP) (void) 0
5508 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5510 #endif /* not GC_CHECK_MARKED_OBJECTS */
5512 switch (SWITCH_ENUM_CAST (XTYPE (obj
)))
5516 register struct Lisp_String
*ptr
= XSTRING (obj
);
5517 if (STRING_MARKED_P (ptr
))
5519 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
5520 MARK_INTERVAL_TREE (ptr
->intervals
);
5522 #ifdef GC_CHECK_STRING_BYTES
5523 /* Check that the string size recorded in the string is the
5524 same as the one recorded in the sdata structure. */
5525 CHECK_STRING_BYTES (ptr
);
5526 #endif /* GC_CHECK_STRING_BYTES */
5530 case Lisp_Vectorlike
:
5531 if (VECTOR_MARKED_P (XVECTOR (obj
)))
5533 #ifdef GC_CHECK_MARKED_OBJECTS
5535 if (m
== MEM_NIL
&& !SUBRP (obj
)
5536 && po
!= &buffer_defaults
5537 && po
!= &buffer_local_symbols
)
5539 #endif /* GC_CHECK_MARKED_OBJECTS */
5543 #ifdef GC_CHECK_MARKED_OBJECTS
5544 if (po
!= &buffer_defaults
&& po
!= &buffer_local_symbols
)
5547 for (b
= all_buffers
; b
&& b
!= po
; b
= b
->header
.next
.buffer
)
5552 #endif /* GC_CHECK_MARKED_OBJECTS */
5555 else if (SUBRP (obj
))
5557 else if (COMPILEDP (obj
))
5558 /* We could treat this just like a vector, but it is better to
5559 save the COMPILED_CONSTANTS element for last and avoid
5562 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5563 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5566 CHECK_LIVE (live_vector_p
);
5567 VECTOR_MARK (ptr
); /* Else mark it */
5568 for (i
= 0; i
< size
; i
++) /* and then mark its elements */
5570 if (i
!= COMPILED_CONSTANTS
)
5571 mark_object (ptr
->contents
[i
]);
5573 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
5576 else if (FRAMEP (obj
))
5578 register struct frame
*ptr
= XFRAME (obj
);
5579 mark_vectorlike (XVECTOR (obj
));
5580 mark_face_cache (ptr
->face_cache
);
5582 else if (WINDOWP (obj
))
5584 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5585 struct window
*w
= XWINDOW (obj
);
5586 mark_vectorlike (ptr
);
5587 /* Mark glyphs for leaf windows. Marking window matrices is
5588 sufficient because frame matrices use the same glyph
5590 if (NILP (w
->hchild
)
5592 && w
->current_matrix
)
5594 mark_glyph_matrix (w
->current_matrix
);
5595 mark_glyph_matrix (w
->desired_matrix
);
5598 else if (HASH_TABLE_P (obj
))
5600 struct Lisp_Hash_Table
*h
= XHASH_TABLE (obj
);
5601 mark_vectorlike ((struct Lisp_Vector
*)h
);
5602 /* If hash table is not weak, mark all keys and values.
5603 For weak tables, mark only the vector. */
5605 mark_object (h
->key_and_value
);
5607 VECTOR_MARK (XVECTOR (h
->key_and_value
));
5609 else if (CHAR_TABLE_P (obj
))
5610 mark_char_table (XVECTOR (obj
));
5612 mark_vectorlike (XVECTOR (obj
));
5617 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
5618 struct Lisp_Symbol
*ptrx
;
5622 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
5624 mark_object (ptr
->function
);
5625 mark_object (ptr
->plist
);
5626 switch (ptr
->redirect
)
5628 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
5629 case SYMBOL_VARALIAS
:
5632 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
5636 case SYMBOL_LOCALIZED
:
5638 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
5639 /* If the value is forwarded to a buffer or keyboard field,
5640 these are marked when we see the corresponding object.
5641 And if it's forwarded to a C variable, either it's not
5642 a Lisp_Object var, or it's staticpro'd already. */
5643 mark_object (blv
->where
);
5644 mark_object (blv
->valcell
);
5645 mark_object (blv
->defcell
);
5648 case SYMBOL_FORWARDED
:
5649 /* If the value is forwarded to a buffer or keyboard field,
5650 these are marked when we see the corresponding object.
5651 And if it's forwarded to a C variable, either it's not
5652 a Lisp_Object var, or it's staticpro'd already. */
5656 if (!PURE_POINTER_P (XSTRING (ptr
->xname
)))
5657 MARK_STRING (XSTRING (ptr
->xname
));
5658 MARK_INTERVAL_TREE (STRING_INTERVALS (ptr
->xname
));
5663 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun */
5664 XSETSYMBOL (obj
, ptrx
);
5671 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
5672 if (XMISCANY (obj
)->gcmarkbit
)
5674 XMISCANY (obj
)->gcmarkbit
= 1;
5676 switch (XMISCTYPE (obj
))
5679 case Lisp_Misc_Marker
:
5680 /* DO NOT mark thru the marker's chain.
5681 The buffer's markers chain does not preserve markers from gc;
5682 instead, markers are removed from the chain when freed by gc. */
5685 case Lisp_Misc_Save_Value
:
5688 register struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
5689 /* If DOGC is set, POINTER is the address of a memory
5690 area containing INTEGER potential Lisp_Objects. */
5693 Lisp_Object
*p
= (Lisp_Object
*) ptr
->pointer
;
5695 for (nelt
= ptr
->integer
; nelt
> 0; nelt
--, p
++)
5696 mark_maybe_object (*p
);
5702 case Lisp_Misc_Overlay
:
5704 struct Lisp_Overlay
*ptr
= XOVERLAY (obj
);
5705 mark_object (ptr
->start
);
5706 mark_object (ptr
->end
);
5707 mark_object (ptr
->plist
);
5710 XSETMISC (obj
, ptr
->next
);
5723 register struct Lisp_Cons
*ptr
= XCONS (obj
);
5724 if (CONS_MARKED_P (ptr
))
5726 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
5728 /* If the cdr is nil, avoid recursion for the car. */
5729 if (EQ (ptr
->u
.cdr
, Qnil
))
5735 mark_object (ptr
->car
);
5738 if (cdr_count
== mark_object_loop_halt
)
5744 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
5745 FLOAT_MARK (XFLOAT (obj
));
5756 #undef CHECK_ALLOCATED
5757 #undef CHECK_ALLOCATED_AND_LIVE
5760 /* Mark the pointers in a buffer structure. */
5763 mark_buffer (Lisp_Object buf
)
5765 register struct buffer
*buffer
= XBUFFER (buf
);
5766 register Lisp_Object
*ptr
, tmp
;
5767 Lisp_Object base_buffer
;
5769 eassert (!VECTOR_MARKED_P (buffer
));
5770 VECTOR_MARK (buffer
);
5772 MARK_INTERVAL_TREE (BUF_INTERVALS (buffer
));
5774 /* For now, we just don't mark the undo_list. It's done later in
5775 a special way just before the sweep phase, and after stripping
5776 some of its elements that are not needed any more. */
5778 if (buffer
->overlays_before
)
5780 XSETMISC (tmp
, buffer
->overlays_before
);
5783 if (buffer
->overlays_after
)
5785 XSETMISC (tmp
, buffer
->overlays_after
);
5789 /* buffer-local Lisp variables start at `undo_list',
5790 tho only the ones from `name' on are GC'd normally. */
5791 for (ptr
= &buffer
->BUFFER_INTERNAL_FIELD (name
);
5792 ptr
<= &PER_BUFFER_VALUE (buffer
,
5793 PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER
));
5797 /* If this is an indirect buffer, mark its base buffer. */
5798 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5800 XSETBUFFER (base_buffer
, buffer
->base_buffer
);
5801 mark_buffer (base_buffer
);
5805 /* Mark the Lisp pointers in the terminal objects.
5806 Called by the Fgarbage_collector. */
5809 mark_terminals (void)
5812 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5814 eassert (t
->name
!= NULL
);
5815 #ifdef HAVE_WINDOW_SYSTEM
5816 /* If a terminal object is reachable from a stacpro'ed object,
5817 it might have been marked already. Make sure the image cache
5819 mark_image_cache (t
->image_cache
);
5820 #endif /* HAVE_WINDOW_SYSTEM */
5821 if (!VECTOR_MARKED_P (t
))
5822 mark_vectorlike ((struct Lisp_Vector
*)t
);
5828 /* Value is non-zero if OBJ will survive the current GC because it's
5829 either marked or does not need to be marked to survive. */
5832 survives_gc_p (Lisp_Object obj
)
5836 switch (XTYPE (obj
))
5843 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
5847 survives_p
= XMISCANY (obj
)->gcmarkbit
;
5851 survives_p
= STRING_MARKED_P (XSTRING (obj
));
5854 case Lisp_Vectorlike
:
5855 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
5859 survives_p
= CONS_MARKED_P (XCONS (obj
));
5863 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
5870 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
5875 /* Sweep: find all structures not marked, and free them. */
5880 /* Remove or mark entries in weak hash tables.
5881 This must be done before any object is unmarked. */
5882 sweep_weak_hash_tables ();
5885 #ifdef GC_CHECK_STRING_BYTES
5886 if (!noninteractive
)
5887 check_string_bytes (1);
5890 /* Put all unmarked conses on free list */
5892 register struct cons_block
*cblk
;
5893 struct cons_block
**cprev
= &cons_block
;
5894 register int lim
= cons_block_index
;
5895 EMACS_INT num_free
= 0, num_used
= 0;
5899 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
5903 int ilim
= (lim
+ BITS_PER_INT
- 1) / BITS_PER_INT
;
5905 /* Scan the mark bits an int at a time. */
5906 for (i
= 0; i
< ilim
; i
++)
5908 if (cblk
->gcmarkbits
[i
] == -1)
5910 /* Fast path - all cons cells for this int are marked. */
5911 cblk
->gcmarkbits
[i
] = 0;
5912 num_used
+= BITS_PER_INT
;
5916 /* Some cons cells for this int are not marked.
5917 Find which ones, and free them. */
5918 int start
, pos
, stop
;
5920 start
= i
* BITS_PER_INT
;
5922 if (stop
> BITS_PER_INT
)
5923 stop
= BITS_PER_INT
;
5926 for (pos
= start
; pos
< stop
; pos
++)
5928 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
5931 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
5932 cons_free_list
= &cblk
->conses
[pos
];
5934 cons_free_list
->car
= Vdead
;
5940 CONS_UNMARK (&cblk
->conses
[pos
]);
5946 lim
= CONS_BLOCK_SIZE
;
5947 /* If this block contains only free conses and we have already
5948 seen more than two blocks worth of free conses then deallocate
5950 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
5952 *cprev
= cblk
->next
;
5953 /* Unhook from the free list. */
5954 cons_free_list
= cblk
->conses
[0].u
.chain
;
5955 lisp_align_free (cblk
);
5959 num_free
+= this_free
;
5960 cprev
= &cblk
->next
;
5963 total_conses
= num_used
;
5964 total_free_conses
= num_free
;
5967 /* Put all unmarked floats on free list */
5969 register struct float_block
*fblk
;
5970 struct float_block
**fprev
= &float_block
;
5971 register int lim
= float_block_index
;
5972 EMACS_INT num_free
= 0, num_used
= 0;
5974 float_free_list
= 0;
5976 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
5980 for (i
= 0; i
< lim
; i
++)
5981 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
5984 fblk
->floats
[i
].u
.chain
= float_free_list
;
5985 float_free_list
= &fblk
->floats
[i
];
5990 FLOAT_UNMARK (&fblk
->floats
[i
]);
5992 lim
= FLOAT_BLOCK_SIZE
;
5993 /* If this block contains only free floats and we have already
5994 seen more than two blocks worth of free floats then deallocate
5996 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
5998 *fprev
= fblk
->next
;
5999 /* Unhook from the free list. */
6000 float_free_list
= fblk
->floats
[0].u
.chain
;
6001 lisp_align_free (fblk
);
6005 num_free
+= this_free
;
6006 fprev
= &fblk
->next
;
6009 total_floats
= num_used
;
6010 total_free_floats
= num_free
;
6013 /* Put all unmarked intervals on free list */
6015 register struct interval_block
*iblk
;
6016 struct interval_block
**iprev
= &interval_block
;
6017 register int lim
= interval_block_index
;
6018 EMACS_INT num_free
= 0, num_used
= 0;
6020 interval_free_list
= 0;
6022 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6027 for (i
= 0; i
< lim
; i
++)
6029 if (!iblk
->intervals
[i
].gcmarkbit
)
6031 SET_INTERVAL_PARENT (&iblk
->intervals
[i
], interval_free_list
);
6032 interval_free_list
= &iblk
->intervals
[i
];
6038 iblk
->intervals
[i
].gcmarkbit
= 0;
6041 lim
= INTERVAL_BLOCK_SIZE
;
6042 /* If this block contains only free intervals and we have already
6043 seen more than two blocks worth of free intervals then
6044 deallocate this block. */
6045 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6047 *iprev
= iblk
->next
;
6048 /* Unhook from the free list. */
6049 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6054 num_free
+= this_free
;
6055 iprev
= &iblk
->next
;
6058 total_intervals
= num_used
;
6059 total_free_intervals
= num_free
;
6062 /* Put all unmarked symbols on free list */
6064 register struct symbol_block
*sblk
;
6065 struct symbol_block
**sprev
= &symbol_block
;
6066 register int lim
= symbol_block_index
;
6067 EMACS_INT num_free
= 0, num_used
= 0;
6069 symbol_free_list
= NULL
;
6071 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6074 struct Lisp_Symbol
*sym
= sblk
->symbols
;
6075 struct Lisp_Symbol
*end
= sym
+ lim
;
6077 for (; sym
< end
; ++sym
)
6079 /* Check if the symbol was created during loadup. In such a case
6080 it might be pointed to by pure bytecode which we don't trace,
6081 so we conservatively assume that it is live. */
6082 int pure_p
= PURE_POINTER_P (XSTRING (sym
->xname
));
6084 if (!sym
->gcmarkbit
&& !pure_p
)
6086 if (sym
->redirect
== SYMBOL_LOCALIZED
)
6087 xfree (SYMBOL_BLV (sym
));
6088 sym
->next
= symbol_free_list
;
6089 symbol_free_list
= sym
;
6091 symbol_free_list
->function
= Vdead
;
6099 UNMARK_STRING (XSTRING (sym
->xname
));
6104 lim
= SYMBOL_BLOCK_SIZE
;
6105 /* If this block contains only free symbols and we have already
6106 seen more than two blocks worth of free symbols then deallocate
6108 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6110 *sprev
= sblk
->next
;
6111 /* Unhook from the free list. */
6112 symbol_free_list
= sblk
->symbols
[0].next
;
6117 num_free
+= this_free
;
6118 sprev
= &sblk
->next
;
6121 total_symbols
= num_used
;
6122 total_free_symbols
= num_free
;
6125 /* Put all unmarked misc's on free list.
6126 For a marker, first unchain it from the buffer it points into. */
6128 register struct marker_block
*mblk
;
6129 struct marker_block
**mprev
= &marker_block
;
6130 register int lim
= marker_block_index
;
6131 EMACS_INT num_free
= 0, num_used
= 0;
6133 marker_free_list
= 0;
6135 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6140 for (i
= 0; i
< lim
; i
++)
6142 if (!mblk
->markers
[i
].u_any
.gcmarkbit
)
6144 if (mblk
->markers
[i
].u_any
.type
== Lisp_Misc_Marker
)
6145 unchain_marker (&mblk
->markers
[i
].u_marker
);
6146 /* Set the type of the freed object to Lisp_Misc_Free.
6147 We could leave the type alone, since nobody checks it,
6148 but this might catch bugs faster. */
6149 mblk
->markers
[i
].u_marker
.type
= Lisp_Misc_Free
;
6150 mblk
->markers
[i
].u_free
.chain
= marker_free_list
;
6151 marker_free_list
= &mblk
->markers
[i
];
6157 mblk
->markers
[i
].u_any
.gcmarkbit
= 0;
6160 lim
= MARKER_BLOCK_SIZE
;
6161 /* If this block contains only free markers and we have already
6162 seen more than two blocks worth of free markers then deallocate
6164 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6166 *mprev
= mblk
->next
;
6167 /* Unhook from the free list. */
6168 marker_free_list
= mblk
->markers
[0].u_free
.chain
;
6173 num_free
+= this_free
;
6174 mprev
= &mblk
->next
;
6178 total_markers
= num_used
;
6179 total_free_markers
= num_free
;
6182 /* Free all unmarked buffers */
6184 register struct buffer
*buffer
= all_buffers
, *prev
= 0, *next
;
6187 if (!VECTOR_MARKED_P (buffer
))
6190 prev
->header
.next
= buffer
->header
.next
;
6192 all_buffers
= buffer
->header
.next
.buffer
;
6193 next
= buffer
->header
.next
.buffer
;
6199 VECTOR_UNMARK (buffer
);
6200 UNMARK_BALANCE_INTERVALS (BUF_INTERVALS (buffer
));
6201 prev
= buffer
, buffer
= buffer
->header
.next
.buffer
;
6205 /* Free all unmarked vectors */
6207 register struct Lisp_Vector
*vector
= all_vectors
, *prev
= 0, *next
;
6208 total_vector_size
= 0;
6211 if (!VECTOR_MARKED_P (vector
))
6214 prev
->header
.next
= vector
->header
.next
;
6216 all_vectors
= vector
->header
.next
.vector
;
6217 next
= vector
->header
.next
.vector
;
6224 VECTOR_UNMARK (vector
);
6225 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
6226 total_vector_size
+= PSEUDOVECTOR_SIZE_MASK
& vector
->header
.size
;
6228 total_vector_size
+= vector
->header
.size
;
6229 prev
= vector
, vector
= vector
->header
.next
.vector
;
6233 #ifdef GC_CHECK_STRING_BYTES
6234 if (!noninteractive
)
6235 check_string_bytes (1);
6242 /* Debugging aids. */
6244 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6245 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6246 This may be helpful in debugging Emacs's memory usage.
6247 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6252 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6257 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6258 doc
: /* Return a list of counters that measure how much consing there has been.
6259 Each of these counters increments for a certain kind of object.
6260 The counters wrap around from the largest positive integer to zero.
6261 Garbage collection does not decrease them.
6262 The elements of the value are as follows:
6263 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6264 All are in units of 1 = one object consed
6265 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6267 MISCS include overlays, markers, and some internal types.
6268 Frames, windows, buffers, and subprocesses count as vectors
6269 (but the contents of a buffer's text do not count here). */)
6272 Lisp_Object consed
[8];
6274 consed
[0] = make_number (min (MOST_POSITIVE_FIXNUM
, cons_cells_consed
));
6275 consed
[1] = make_number (min (MOST_POSITIVE_FIXNUM
, floats_consed
));
6276 consed
[2] = make_number (min (MOST_POSITIVE_FIXNUM
, vector_cells_consed
));
6277 consed
[3] = make_number (min (MOST_POSITIVE_FIXNUM
, symbols_consed
));
6278 consed
[4] = make_number (min (MOST_POSITIVE_FIXNUM
, string_chars_consed
));
6279 consed
[5] = make_number (min (MOST_POSITIVE_FIXNUM
, misc_objects_consed
));
6280 consed
[6] = make_number (min (MOST_POSITIVE_FIXNUM
, intervals_consed
));
6281 consed
[7] = make_number (min (MOST_POSITIVE_FIXNUM
, strings_consed
));
6283 return Flist (8, consed
);
6286 /* Find at most FIND_MAX symbols which have OBJ as their value or
6287 function. This is used in gdbinit's `xwhichsymbols' command. */
6290 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6292 struct symbol_block
*sblk
;
6293 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6294 Lisp_Object found
= Qnil
;
6298 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6300 struct Lisp_Symbol
*sym
= sblk
->symbols
;
6303 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, sym
++)
6308 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6311 XSETSYMBOL (tem
, sym
);
6312 val
= find_symbol_value (tem
);
6314 || EQ (sym
->function
, obj
)
6315 || (!NILP (sym
->function
)
6316 && COMPILEDP (sym
->function
)
6317 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
6320 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)))
6322 found
= Fcons (tem
, found
);
6323 if (--find_max
== 0)
6331 unbind_to (gc_count
, Qnil
);
6335 #ifdef ENABLE_CHECKING
6336 int suppress_checking
;
6339 die (const char *msg
, const char *file
, int line
)
6341 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: %s\r\n",
6347 /* Initialization */
6350 init_alloc_once (void)
6352 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6354 pure_size
= PURESIZE
;
6355 pure_bytes_used
= 0;
6356 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
6357 pure_bytes_used_before_overflow
= 0;
6359 /* Initialize the list of free aligned blocks. */
6362 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6364 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6368 ignore_warnings
= 1;
6369 #ifdef DOUG_LEA_MALLOC
6370 mallopt (M_TRIM_THRESHOLD
, 128*1024); /* trim threshold */
6371 mallopt (M_MMAP_THRESHOLD
, 64*1024); /* mmap threshold */
6372 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* max. number of mmap'ed areas */
6380 init_weak_hash_tables ();
6383 malloc_hysteresis
= 32;
6385 malloc_hysteresis
= 0;
6388 refill_memory_reserve ();
6390 ignore_warnings
= 0;
6392 byte_stack_list
= 0;
6394 consing_since_gc
= 0;
6395 gc_cons_threshold
= 100000 * sizeof (Lisp_Object
);
6396 gc_relative_threshold
= 0;
6403 byte_stack_list
= 0;
6405 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6406 setjmp_tested_p
= longjmps_done
= 0;
6409 Vgc_elapsed
= make_float (0.0);
6414 syms_of_alloc (void)
6416 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6417 doc
: /* Number of bytes of consing between garbage collections.
6418 Garbage collection can happen automatically once this many bytes have been
6419 allocated since the last garbage collection. All data types count.
6421 Garbage collection happens automatically only when `eval' is called.
6423 By binding this temporarily to a large number, you can effectively
6424 prevent garbage collection during a part of the program.
6425 See also `gc-cons-percentage'. */);
6427 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6428 doc
: /* Portion of the heap used for allocation.
6429 Garbage collection can happen automatically once this portion of the heap
6430 has been allocated since the last garbage collection.
6431 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6432 Vgc_cons_percentage
= make_float (0.1);
6434 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6435 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
6437 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6438 doc
: /* Number of cons cells that have been consed so far. */);
6440 DEFVAR_INT ("floats-consed", floats_consed
,
6441 doc
: /* Number of floats that have been consed so far. */);
6443 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
6444 doc
: /* Number of vector cells that have been consed so far. */);
6446 DEFVAR_INT ("symbols-consed", symbols_consed
,
6447 doc
: /* Number of symbols that have been consed so far. */);
6449 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
6450 doc
: /* Number of string characters that have been consed so far. */);
6452 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
6453 doc
: /* Number of miscellaneous objects that have been consed so far.
6454 These include markers and overlays, plus certain objects not visible
6457 DEFVAR_INT ("intervals-consed", intervals_consed
,
6458 doc
: /* Number of intervals that have been consed so far. */);
6460 DEFVAR_INT ("strings-consed", strings_consed
,
6461 doc
: /* Number of strings that have been consed so far. */);
6463 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
6464 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
6465 This means that certain objects should be allocated in shared (pure) space.
6466 It can also be set to a hash-table, in which case this table is used to
6467 do hash-consing of the objects allocated to pure space. */);
6469 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
6470 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
6471 garbage_collection_messages
= 0;
6473 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
6474 doc
: /* Hook run after garbage collection has finished. */);
6475 Vpost_gc_hook
= Qnil
;
6476 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
6478 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
6479 doc
: /* Precomputed `signal' argument for memory-full error. */);
6480 /* We build this in advance because if we wait until we need it, we might
6481 not be able to allocate the memory to hold it. */
6483 = pure_cons (Qerror
,
6484 pure_cons (make_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"), Qnil
));
6486 DEFVAR_LISP ("memory-full", Vmemory_full
,
6487 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
6488 Vmemory_full
= Qnil
;
6490 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
6491 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
6493 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
6494 doc
: /* Accumulated time elapsed in garbage collections.
6495 The time is in seconds as a floating point value. */);
6496 DEFVAR_INT ("gcs-done", gcs_done
,
6497 doc
: /* Accumulated number of garbage collections done. */);
6502 defsubr (&Smake_byte_code
);
6503 defsubr (&Smake_list
);
6504 defsubr (&Smake_vector
);
6505 defsubr (&Smake_string
);
6506 defsubr (&Smake_bool_vector
);
6507 defsubr (&Smake_symbol
);
6508 defsubr (&Smake_marker
);
6509 defsubr (&Spurecopy
);
6510 defsubr (&Sgarbage_collect
);
6511 defsubr (&Smemory_limit
);
6512 defsubr (&Smemory_use_counts
);
6514 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
6515 defsubr (&Sgc_status
);