1 /* Storage allocation and gc for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2011
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <limits.h> /* For CHAR_BIT. */
31 /* This file is part of the core Lisp implementation, and thus must
32 deal with the real data structures. If the Lisp implementation is
33 replaced, this file likely will not be used. */
35 #undef HIDE_LISP_IMPLEMENTATION
38 #include "intervals.h"
44 #include "blockinput.h"
45 #include "character.h"
46 #include "syssignal.h"
47 #include "termhooks.h" /* For struct terminal. */
51 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
52 memory. Can do this only if using gmalloc.c. */
54 #if defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC
55 #undef GC_MALLOC_CHECK
60 extern POINTER_TYPE
*sbrk ();
69 #ifdef DOUG_LEA_MALLOC
73 /* Specify maximum number of areas to mmap. It would be nice to use a
74 value that explicitly means "no limit". */
76 #define MMAP_MAX_AREAS 100000000
78 #else /* not DOUG_LEA_MALLOC */
80 /* The following come from gmalloc.c. */
82 extern size_t _bytes_used
;
83 extern size_t __malloc_extra_blocks
;
85 #endif /* not DOUG_LEA_MALLOC */
87 #if ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT
90 /* When GTK uses the file chooser dialog, different backends can be loaded
91 dynamically. One such a backend is the Gnome VFS backend that gets loaded
92 if you run Gnome. That backend creates several threads and also allocates
95 Also, gconf and gsettings may create several threads.
97 If Emacs sets malloc hooks (! SYSTEM_MALLOC) and the emacs_blocked_*
98 functions below are called from malloc, there is a chance that one
99 of these threads preempts the Emacs main thread and the hook variables
100 end up in an inconsistent state. So we have a mutex to prevent that (note
101 that the backend handles concurrent access to malloc within its own threads
102 but Emacs code running in the main thread is not included in that control).
104 When UNBLOCK_INPUT is called, reinvoke_input_signal may be called. If this
105 happens in one of the backend threads we will have two threads that tries
106 to run Emacs code at once, and the code is not prepared for that.
107 To prevent that, we only call BLOCK/UNBLOCK from the main thread. */
109 static pthread_mutex_t alloc_mutex
;
111 #define BLOCK_INPUT_ALLOC \
114 if (pthread_equal (pthread_self (), main_thread)) \
116 pthread_mutex_lock (&alloc_mutex); \
119 #define UNBLOCK_INPUT_ALLOC \
122 pthread_mutex_unlock (&alloc_mutex); \
123 if (pthread_equal (pthread_self (), main_thread)) \
128 #else /* ! defined HAVE_PTHREAD */
130 #define BLOCK_INPUT_ALLOC BLOCK_INPUT
131 #define UNBLOCK_INPUT_ALLOC UNBLOCK_INPUT
133 #endif /* ! defined HAVE_PTHREAD */
134 #endif /* ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT */
136 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
137 to a struct Lisp_String. */
139 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
140 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
141 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
143 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
144 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
145 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
147 /* Value is the number of bytes of S, a pointer to a struct Lisp_String.
148 Be careful during GC, because S->size contains the mark bit for
151 #define GC_STRING_BYTES(S) (STRING_BYTES (S))
153 /* Global variables. */
154 struct emacs_globals globals
;
156 /* Number of bytes of consing done since the last gc. */
158 EMACS_INT consing_since_gc
;
160 /* Similar minimum, computed from Vgc_cons_percentage. */
162 EMACS_INT gc_relative_threshold
;
164 /* Minimum number of bytes of consing since GC before next GC,
165 when memory is full. */
167 EMACS_INT memory_full_cons_threshold
;
169 /* Nonzero during GC. */
173 /* Nonzero means abort if try to GC.
174 This is for code which is written on the assumption that
175 no GC will happen, so as to verify that assumption. */
179 /* Number of live and free conses etc. */
181 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_vector_size
;
182 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
183 static EMACS_INT total_free_floats
, total_floats
;
185 /* Points to memory space allocated as "spare", to be freed if we run
186 out of memory. We keep one large block, four cons-blocks, and
187 two string blocks. */
189 static char *spare_memory
[7];
191 /* Amount of spare memory to keep in large reserve block, or to see
192 whether this much is available when malloc fails on a larger request. */
194 #define SPARE_MEMORY (1 << 14)
196 /* Number of extra blocks malloc should get when it needs more core. */
198 static int malloc_hysteresis
;
200 /* Initialize it to a nonzero value to force it into data space
201 (rather than bss space). That way unexec will remap it into text
202 space (pure), on some systems. We have not implemented the
203 remapping on more recent systems because this is less important
204 nowadays than in the days of small memories and timesharing. */
206 #ifndef VIRT_ADDR_VARIES
209 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
210 #define PUREBEG (char *) pure
212 /* Pointer to the pure area, and its size. */
214 static char *purebeg
;
215 static ptrdiff_t pure_size
;
217 /* Number of bytes of pure storage used before pure storage overflowed.
218 If this is non-zero, this implies that an overflow occurred. */
220 static ptrdiff_t pure_bytes_used_before_overflow
;
222 /* Value is non-zero if P points into pure space. */
224 #define PURE_POINTER_P(P) \
225 (((PNTR_COMPARISON_TYPE) (P) \
226 < (PNTR_COMPARISON_TYPE) ((char *) purebeg + pure_size)) \
227 && ((PNTR_COMPARISON_TYPE) (P) \
228 >= (PNTR_COMPARISON_TYPE) purebeg))
230 /* Index in pure at which next pure Lisp object will be allocated.. */
232 static EMACS_INT pure_bytes_used_lisp
;
234 /* Number of bytes allocated for non-Lisp objects in pure storage. */
236 static EMACS_INT pure_bytes_used_non_lisp
;
238 /* If nonzero, this is a warning delivered by malloc and not yet
241 const char *pending_malloc_warning
;
243 /* Maximum amount of C stack to save when a GC happens. */
245 #ifndef MAX_SAVE_STACK
246 #define MAX_SAVE_STACK 16000
249 /* Buffer in which we save a copy of the C stack at each GC. */
251 #if MAX_SAVE_STACK > 0
252 static char *stack_copy
;
253 static ptrdiff_t stack_copy_size
;
256 /* Non-zero means ignore malloc warnings. Set during initialization.
257 Currently not used. */
259 static int ignore_warnings
;
261 static Lisp_Object Qgc_cons_threshold
;
262 Lisp_Object Qchar_table_extra_slots
;
264 /* Hook run after GC has finished. */
266 static Lisp_Object Qpost_gc_hook
;
268 static void mark_buffer (Lisp_Object
);
269 static void mark_terminals (void);
270 static void gc_sweep (void);
271 static void mark_glyph_matrix (struct glyph_matrix
*);
272 static void mark_face_cache (struct face_cache
*);
274 #if !defined REL_ALLOC || defined SYSTEM_MALLOC
275 static void refill_memory_reserve (void);
277 static struct Lisp_String
*allocate_string (void);
278 static void compact_small_strings (void);
279 static void free_large_strings (void);
280 static void sweep_strings (void);
281 static void free_misc (Lisp_Object
);
282 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
284 /* When scanning the C stack for live Lisp objects, Emacs keeps track
285 of what memory allocated via lisp_malloc is intended for what
286 purpose. This enumeration specifies the type of memory. */
297 /* We used to keep separate mem_types for subtypes of vectors such as
298 process, hash_table, frame, terminal, and window, but we never made
299 use of the distinction, so it only caused source-code complexity
300 and runtime slowdown. Minor but pointless. */
304 static POINTER_TYPE
*lisp_align_malloc (size_t, enum mem_type
);
305 static POINTER_TYPE
*lisp_malloc (size_t, enum mem_type
);
308 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
310 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
311 #include <stdio.h> /* For fprintf. */
314 /* A unique object in pure space used to make some Lisp objects
315 on free lists recognizable in O(1). */
317 static Lisp_Object Vdead
;
319 #ifdef GC_MALLOC_CHECK
321 enum mem_type allocated_mem_type
;
322 static int dont_register_blocks
;
324 #endif /* GC_MALLOC_CHECK */
326 /* A node in the red-black tree describing allocated memory containing
327 Lisp data. Each such block is recorded with its start and end
328 address when it is allocated, and removed from the tree when it
331 A red-black tree is a balanced binary tree with the following
334 1. Every node is either red or black.
335 2. Every leaf is black.
336 3. If a node is red, then both of its children are black.
337 4. Every simple path from a node to a descendant leaf contains
338 the same number of black nodes.
339 5. The root is always black.
341 When nodes are inserted into the tree, or deleted from the tree,
342 the tree is "fixed" so that these properties are always true.
344 A red-black tree with N internal nodes has height at most 2
345 log(N+1). Searches, insertions and deletions are done in O(log N).
346 Please see a text book about data structures for a detailed
347 description of red-black trees. Any book worth its salt should
352 /* Children of this node. These pointers are never NULL. When there
353 is no child, the value is MEM_NIL, which points to a dummy node. */
354 struct mem_node
*left
, *right
;
356 /* The parent of this node. In the root node, this is NULL. */
357 struct mem_node
*parent
;
359 /* Start and end of allocated region. */
363 enum {MEM_BLACK
, MEM_RED
} color
;
369 /* Base address of stack. Set in main. */
371 Lisp_Object
*stack_base
;
373 /* Root of the tree describing allocated Lisp memory. */
375 static struct mem_node
*mem_root
;
377 /* Lowest and highest known address in the heap. */
379 static void *min_heap_address
, *max_heap_address
;
381 /* Sentinel node of the tree. */
383 static struct mem_node mem_z
;
384 #define MEM_NIL &mem_z
386 static struct Lisp_Vector
*allocate_vectorlike (EMACS_INT
);
387 static void lisp_free (POINTER_TYPE
*);
388 static void mark_stack (void);
389 static int live_vector_p (struct mem_node
*, void *);
390 static int live_buffer_p (struct mem_node
*, void *);
391 static int live_string_p (struct mem_node
*, void *);
392 static int live_cons_p (struct mem_node
*, void *);
393 static int live_symbol_p (struct mem_node
*, void *);
394 static int live_float_p (struct mem_node
*, void *);
395 static int live_misc_p (struct mem_node
*, void *);
396 static void mark_maybe_object (Lisp_Object
);
397 static void mark_memory (void *, void *);
398 static void mem_init (void);
399 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
400 static void mem_insert_fixup (struct mem_node
*);
401 static void mem_rotate_left (struct mem_node
*);
402 static void mem_rotate_right (struct mem_node
*);
403 static void mem_delete (struct mem_node
*);
404 static void mem_delete_fixup (struct mem_node
*);
405 static inline struct mem_node
*mem_find (void *);
408 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
409 static void check_gcpros (void);
412 #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 (EMACS_INT 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 allcated 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 lets 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 /***********************************************************************
1588 ***********************************************************************/
1590 /* Lisp_Strings are allocated in string_block structures. When a new
1591 string_block is allocated, all the Lisp_Strings it contains are
1592 added to a free-list string_free_list. When a new Lisp_String is
1593 needed, it is taken from that list. During the sweep phase of GC,
1594 string_blocks that are entirely free are freed, except two which
1597 String data is allocated from sblock structures. Strings larger
1598 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1599 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1601 Sblocks consist internally of sdata structures, one for each
1602 Lisp_String. The sdata structure points to the Lisp_String it
1603 belongs to. The Lisp_String points back to the `u.data' member of
1604 its sdata structure.
1606 When a Lisp_String is freed during GC, it is put back on
1607 string_free_list, and its `data' member and its sdata's `string'
1608 pointer is set to null. The size of the string is recorded in the
1609 `u.nbytes' member of the sdata. So, sdata structures that are no
1610 longer used, can be easily recognized, and it's easy to compact the
1611 sblocks of small strings which we do in compact_small_strings. */
1613 /* Size in bytes of an sblock structure used for small strings. This
1614 is 8192 minus malloc overhead. */
1616 #define SBLOCK_SIZE 8188
1618 /* Strings larger than this are considered large strings. String data
1619 for large strings is allocated from individual sblocks. */
1621 #define LARGE_STRING_BYTES 1024
1623 /* Structure describing string memory sub-allocated from an sblock.
1624 This is where the contents of Lisp strings are stored. */
1628 /* Back-pointer to the string this sdata belongs to. If null, this
1629 structure is free, and the NBYTES member of the union below
1630 contains the string's byte size (the same value that STRING_BYTES
1631 would return if STRING were non-null). If non-null, STRING_BYTES
1632 (STRING) is the size of the data, and DATA contains the string's
1634 struct Lisp_String
*string
;
1636 #ifdef GC_CHECK_STRING_BYTES
1639 unsigned char data
[1];
1641 #define SDATA_NBYTES(S) (S)->nbytes
1642 #define SDATA_DATA(S) (S)->data
1643 #define SDATA_SELECTOR(member) member
1645 #else /* not GC_CHECK_STRING_BYTES */
1649 /* When STRING is non-null. */
1650 unsigned char data
[1];
1652 /* When STRING is null. */
1656 #define SDATA_NBYTES(S) (S)->u.nbytes
1657 #define SDATA_DATA(S) (S)->u.data
1658 #define SDATA_SELECTOR(member) u.member
1660 #endif /* not GC_CHECK_STRING_BYTES */
1662 #define SDATA_DATA_OFFSET offsetof (struct sdata, SDATA_SELECTOR (data))
1666 /* Structure describing a block of memory which is sub-allocated to
1667 obtain string data memory for strings. Blocks for small strings
1668 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1669 as large as needed. */
1674 struct sblock
*next
;
1676 /* Pointer to the next free sdata block. This points past the end
1677 of the sblock if there isn't any space left in this block. */
1678 struct sdata
*next_free
;
1680 /* Start of data. */
1681 struct sdata first_data
;
1684 /* Number of Lisp strings in a string_block structure. The 1020 is
1685 1024 minus malloc overhead. */
1687 #define STRING_BLOCK_SIZE \
1688 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1690 /* Structure describing a block from which Lisp_String structures
1695 /* Place `strings' first, to preserve alignment. */
1696 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1697 struct string_block
*next
;
1700 /* Head and tail of the list of sblock structures holding Lisp string
1701 data. We always allocate from current_sblock. The NEXT pointers
1702 in the sblock structures go from oldest_sblock to current_sblock. */
1704 static struct sblock
*oldest_sblock
, *current_sblock
;
1706 /* List of sblocks for large strings. */
1708 static struct sblock
*large_sblocks
;
1710 /* List of string_block structures. */
1712 static struct string_block
*string_blocks
;
1714 /* Free-list of Lisp_Strings. */
1716 static struct Lisp_String
*string_free_list
;
1718 /* Number of live and free Lisp_Strings. */
1720 static EMACS_INT total_strings
, total_free_strings
;
1722 /* Number of bytes used by live strings. */
1724 static EMACS_INT total_string_size
;
1726 /* Given a pointer to a Lisp_String S which is on the free-list
1727 string_free_list, return a pointer to its successor in the
1730 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1732 /* Return a pointer to the sdata structure belonging to Lisp string S.
1733 S must be live, i.e. S->data must not be null. S->data is actually
1734 a pointer to the `u.data' member of its sdata structure; the
1735 structure starts at a constant offset in front of that. */
1737 #define SDATA_OF_STRING(S) ((struct sdata *) ((S)->data - SDATA_DATA_OFFSET))
1740 #ifdef GC_CHECK_STRING_OVERRUN
1742 /* We check for overrun in string data blocks by appending a small
1743 "cookie" after each allocated string data block, and check for the
1744 presence of this cookie during GC. */
1746 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1747 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1748 { '\xde', '\xad', '\xbe', '\xef' };
1751 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1754 /* Value is the size of an sdata structure large enough to hold NBYTES
1755 bytes of string data. The value returned includes a terminating
1756 NUL byte, the size of the sdata structure, and padding. */
1758 #ifdef GC_CHECK_STRING_BYTES
1760 #define SDATA_SIZE(NBYTES) \
1761 ((SDATA_DATA_OFFSET \
1763 + sizeof (EMACS_INT) - 1) \
1764 & ~(sizeof (EMACS_INT) - 1))
1766 #else /* not GC_CHECK_STRING_BYTES */
1768 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1769 less than the size of that member. The 'max' is not needed when
1770 SDATA_DATA_OFFSET is a multiple of sizeof (EMACS_INT), because then the
1771 alignment code reserves enough space. */
1773 #define SDATA_SIZE(NBYTES) \
1774 ((SDATA_DATA_OFFSET \
1775 + (SDATA_DATA_OFFSET % sizeof (EMACS_INT) == 0 \
1777 : max (NBYTES, sizeof (EMACS_INT) - 1)) \
1779 + sizeof (EMACS_INT) - 1) \
1780 & ~(sizeof (EMACS_INT) - 1))
1782 #endif /* not GC_CHECK_STRING_BYTES */
1784 /* Extra bytes to allocate for each string. */
1786 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1788 /* Exact bound on the number of bytes in a string, not counting the
1789 terminating null. A string cannot contain more bytes than
1790 STRING_BYTES_BOUND, nor can it be so long that the size_t
1791 arithmetic in allocate_string_data would overflow while it is
1792 calculating a value to be passed to malloc. */
1793 #define STRING_BYTES_MAX \
1794 min (STRING_BYTES_BOUND, \
1795 ((SIZE_MAX - XMALLOC_OVERRUN_CHECK_OVERHEAD \
1797 - offsetof (struct sblock, first_data) \
1798 - SDATA_DATA_OFFSET) \
1799 & ~(sizeof (EMACS_INT) - 1)))
1801 /* Initialize string allocation. Called from init_alloc_once. */
1806 total_strings
= total_free_strings
= total_string_size
= 0;
1807 oldest_sblock
= current_sblock
= large_sblocks
= NULL
;
1808 string_blocks
= NULL
;
1809 string_free_list
= NULL
;
1810 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1811 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1815 #ifdef GC_CHECK_STRING_BYTES
1817 static int check_string_bytes_count
;
1819 #define CHECK_STRING_BYTES(S) STRING_BYTES (S)
1822 /* Like GC_STRING_BYTES, but with debugging check. */
1825 string_bytes (struct Lisp_String
*s
)
1828 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1830 if (!PURE_POINTER_P (s
)
1832 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1837 /* Check validity of Lisp strings' string_bytes member in B. */
1840 check_sblock (struct sblock
*b
)
1842 struct sdata
*from
, *end
, *from_end
;
1846 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1848 /* Compute the next FROM here because copying below may
1849 overwrite data we need to compute it. */
1852 /* Check that the string size recorded in the string is the
1853 same as the one recorded in the sdata structure. */
1855 CHECK_STRING_BYTES (from
->string
);
1858 nbytes
= GC_STRING_BYTES (from
->string
);
1860 nbytes
= SDATA_NBYTES (from
);
1862 nbytes
= SDATA_SIZE (nbytes
);
1863 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1868 /* Check validity of Lisp strings' string_bytes member. ALL_P
1869 non-zero means check all strings, otherwise check only most
1870 recently allocated strings. Used for hunting a bug. */
1873 check_string_bytes (int all_p
)
1879 for (b
= large_sblocks
; b
; b
= b
->next
)
1881 struct Lisp_String
*s
= b
->first_data
.string
;
1883 CHECK_STRING_BYTES (s
);
1886 for (b
= oldest_sblock
; b
; b
= b
->next
)
1890 check_sblock (current_sblock
);
1893 #endif /* GC_CHECK_STRING_BYTES */
1895 #ifdef GC_CHECK_STRING_FREE_LIST
1897 /* Walk through the string free list looking for bogus next pointers.
1898 This may catch buffer overrun from a previous string. */
1901 check_string_free_list (void)
1903 struct Lisp_String
*s
;
1905 /* Pop a Lisp_String off the free-list. */
1906 s
= string_free_list
;
1909 if ((uintptr_t) s
< 1024)
1911 s
= NEXT_FREE_LISP_STRING (s
);
1915 #define check_string_free_list()
1918 /* Return a new Lisp_String. */
1920 static struct Lisp_String
*
1921 allocate_string (void)
1923 struct Lisp_String
*s
;
1925 /* eassert (!handling_signal); */
1929 /* If the free-list is empty, allocate a new string_block, and
1930 add all the Lisp_Strings in it to the free-list. */
1931 if (string_free_list
== NULL
)
1933 struct string_block
*b
;
1936 b
= (struct string_block
*) lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1937 memset (b
, 0, sizeof *b
);
1938 b
->next
= string_blocks
;
1941 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1944 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1945 string_free_list
= s
;
1948 total_free_strings
+= STRING_BLOCK_SIZE
;
1951 check_string_free_list ();
1953 /* Pop a Lisp_String off the free-list. */
1954 s
= string_free_list
;
1955 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1957 MALLOC_UNBLOCK_INPUT
;
1959 /* Probably not strictly necessary, but play it safe. */
1960 memset (s
, 0, sizeof *s
);
1962 --total_free_strings
;
1965 consing_since_gc
+= sizeof *s
;
1967 #ifdef GC_CHECK_STRING_BYTES
1968 if (!noninteractive
)
1970 if (++check_string_bytes_count
== 200)
1972 check_string_bytes_count
= 0;
1973 check_string_bytes (1);
1976 check_string_bytes (0);
1978 #endif /* GC_CHECK_STRING_BYTES */
1984 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1985 plus a NUL byte at the end. Allocate an sdata structure for S, and
1986 set S->data to its `u.data' member. Store a NUL byte at the end of
1987 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1988 S->data if it was initially non-null. */
1991 allocate_string_data (struct Lisp_String
*s
,
1992 EMACS_INT nchars
, EMACS_INT nbytes
)
1994 struct sdata
*data
, *old_data
;
1996 EMACS_INT needed
, old_nbytes
;
1998 if (STRING_BYTES_MAX
< nbytes
)
2001 /* Determine the number of bytes needed to store NBYTES bytes
2003 needed
= SDATA_SIZE (nbytes
);
2004 old_data
= s
->data
? SDATA_OF_STRING (s
) : NULL
;
2005 old_nbytes
= GC_STRING_BYTES (s
);
2009 if (nbytes
> LARGE_STRING_BYTES
)
2011 size_t size
= offsetof (struct sblock
, first_data
) + needed
;
2013 #ifdef DOUG_LEA_MALLOC
2014 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
2015 because mapped region contents are not preserved in
2018 In case you think of allowing it in a dumped Emacs at the
2019 cost of not being able to re-dump, there's another reason:
2020 mmap'ed data typically have an address towards the top of the
2021 address space, which won't fit into an EMACS_INT (at least on
2022 32-bit systems with the current tagging scheme). --fx */
2023 mallopt (M_MMAP_MAX
, 0);
2026 b
= (struct sblock
*) lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
2028 #ifdef DOUG_LEA_MALLOC
2029 /* Back to a reasonable maximum of mmap'ed areas. */
2030 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2033 b
->next_free
= &b
->first_data
;
2034 b
->first_data
.string
= NULL
;
2035 b
->next
= large_sblocks
;
2038 else if (current_sblock
== NULL
2039 || (((char *) current_sblock
+ SBLOCK_SIZE
2040 - (char *) current_sblock
->next_free
)
2041 < (needed
+ GC_STRING_EXTRA
)))
2043 /* Not enough room in the current sblock. */
2044 b
= (struct sblock
*) lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
2045 b
->next_free
= &b
->first_data
;
2046 b
->first_data
.string
= NULL
;
2050 current_sblock
->next
= b
;
2058 data
= b
->next_free
;
2059 b
->next_free
= (struct sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
2061 MALLOC_UNBLOCK_INPUT
;
2064 s
->data
= SDATA_DATA (data
);
2065 #ifdef GC_CHECK_STRING_BYTES
2066 SDATA_NBYTES (data
) = nbytes
;
2069 s
->size_byte
= nbytes
;
2070 s
->data
[nbytes
] = '\0';
2071 #ifdef GC_CHECK_STRING_OVERRUN
2072 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
2073 GC_STRING_OVERRUN_COOKIE_SIZE
);
2076 /* If S had already data assigned, mark that as free by setting its
2077 string back-pointer to null, and recording the size of the data
2081 SDATA_NBYTES (old_data
) = old_nbytes
;
2082 old_data
->string
= NULL
;
2085 consing_since_gc
+= needed
;
2089 /* Sweep and compact strings. */
2092 sweep_strings (void)
2094 struct string_block
*b
, *next
;
2095 struct string_block
*live_blocks
= NULL
;
2097 string_free_list
= NULL
;
2098 total_strings
= total_free_strings
= 0;
2099 total_string_size
= 0;
2101 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
2102 for (b
= string_blocks
; b
; b
= next
)
2105 struct Lisp_String
*free_list_before
= string_free_list
;
2109 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
2111 struct Lisp_String
*s
= b
->strings
+ i
;
2115 /* String was not on free-list before. */
2116 if (STRING_MARKED_P (s
))
2118 /* String is live; unmark it and its intervals. */
2121 if (!NULL_INTERVAL_P (s
->intervals
))
2122 UNMARK_BALANCE_INTERVALS (s
->intervals
);
2125 total_string_size
+= STRING_BYTES (s
);
2129 /* String is dead. Put it on the free-list. */
2130 struct sdata
*data
= SDATA_OF_STRING (s
);
2132 /* Save the size of S in its sdata so that we know
2133 how large that is. Reset the sdata's string
2134 back-pointer so that we know it's free. */
2135 #ifdef GC_CHECK_STRING_BYTES
2136 if (GC_STRING_BYTES (s
) != SDATA_NBYTES (data
))
2139 data
->u
.nbytes
= GC_STRING_BYTES (s
);
2141 data
->string
= NULL
;
2143 /* Reset the strings's `data' member so that we
2147 /* Put the string on the free-list. */
2148 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2149 string_free_list
= s
;
2155 /* S was on the free-list before. Put it there again. */
2156 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2157 string_free_list
= s
;
2162 /* Free blocks that contain free Lisp_Strings only, except
2163 the first two of them. */
2164 if (nfree
== STRING_BLOCK_SIZE
2165 && total_free_strings
> STRING_BLOCK_SIZE
)
2168 string_free_list
= free_list_before
;
2172 total_free_strings
+= nfree
;
2173 b
->next
= live_blocks
;
2178 check_string_free_list ();
2180 string_blocks
= live_blocks
;
2181 free_large_strings ();
2182 compact_small_strings ();
2184 check_string_free_list ();
2188 /* Free dead large strings. */
2191 free_large_strings (void)
2193 struct sblock
*b
, *next
;
2194 struct sblock
*live_blocks
= NULL
;
2196 for (b
= large_sblocks
; b
; b
= next
)
2200 if (b
->first_data
.string
== NULL
)
2204 b
->next
= live_blocks
;
2209 large_sblocks
= live_blocks
;
2213 /* Compact data of small strings. Free sblocks that don't contain
2214 data of live strings after compaction. */
2217 compact_small_strings (void)
2219 struct sblock
*b
, *tb
, *next
;
2220 struct sdata
*from
, *to
, *end
, *tb_end
;
2221 struct sdata
*to_end
, *from_end
;
2223 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2224 to, and TB_END is the end of TB. */
2226 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2227 to
= &tb
->first_data
;
2229 /* Step through the blocks from the oldest to the youngest. We
2230 expect that old blocks will stabilize over time, so that less
2231 copying will happen this way. */
2232 for (b
= oldest_sblock
; b
; b
= b
->next
)
2235 xassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2237 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
2239 /* Compute the next FROM here because copying below may
2240 overwrite data we need to compute it. */
2243 #ifdef GC_CHECK_STRING_BYTES
2244 /* Check that the string size recorded in the string is the
2245 same as the one recorded in the sdata structure. */
2247 && GC_STRING_BYTES (from
->string
) != SDATA_NBYTES (from
))
2249 #endif /* GC_CHECK_STRING_BYTES */
2252 nbytes
= GC_STRING_BYTES (from
->string
);
2254 nbytes
= SDATA_NBYTES (from
);
2256 if (nbytes
> LARGE_STRING_BYTES
)
2259 nbytes
= SDATA_SIZE (nbytes
);
2260 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2262 #ifdef GC_CHECK_STRING_OVERRUN
2263 if (memcmp (string_overrun_cookie
,
2264 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2265 GC_STRING_OVERRUN_COOKIE_SIZE
))
2269 /* FROM->string non-null means it's alive. Copy its data. */
2272 /* If TB is full, proceed with the next sblock. */
2273 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2274 if (to_end
> tb_end
)
2278 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2279 to
= &tb
->first_data
;
2280 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2283 /* Copy, and update the string's `data' pointer. */
2286 xassert (tb
!= b
|| to
< from
);
2287 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2288 to
->string
->data
= SDATA_DATA (to
);
2291 /* Advance past the sdata we copied to. */
2297 /* The rest of the sblocks following TB don't contain live data, so
2298 we can free them. */
2299 for (b
= tb
->next
; b
; b
= next
)
2307 current_sblock
= tb
;
2311 string_overflow (void)
2313 error ("Maximum string size exceeded");
2316 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2317 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2318 LENGTH must be an integer.
2319 INIT must be an integer that represents a character. */)
2320 (Lisp_Object length
, Lisp_Object init
)
2322 register Lisp_Object val
;
2323 register unsigned char *p
, *end
;
2327 CHECK_NATNUM (length
);
2328 CHECK_CHARACTER (init
);
2330 c
= XFASTINT (init
);
2331 if (ASCII_CHAR_P (c
))
2333 nbytes
= XINT (length
);
2334 val
= make_uninit_string (nbytes
);
2336 end
= p
+ SCHARS (val
);
2342 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2343 int len
= CHAR_STRING (c
, str
);
2344 EMACS_INT string_len
= XINT (length
);
2346 if (string_len
> STRING_BYTES_MAX
/ len
)
2348 nbytes
= len
* string_len
;
2349 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2354 memcpy (p
, str
, len
);
2364 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2365 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2366 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2367 (Lisp_Object length
, Lisp_Object init
)
2369 register Lisp_Object val
;
2370 struct Lisp_Bool_Vector
*p
;
2371 EMACS_INT length_in_chars
, length_in_elts
;
2374 CHECK_NATNUM (length
);
2376 bits_per_value
= sizeof (EMACS_INT
) * BOOL_VECTOR_BITS_PER_CHAR
;
2378 length_in_elts
= (XFASTINT (length
) + bits_per_value
- 1) / bits_per_value
;
2379 length_in_chars
= ((XFASTINT (length
) + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2380 / BOOL_VECTOR_BITS_PER_CHAR
);
2382 /* We must allocate one more elements than LENGTH_IN_ELTS for the
2383 slot `size' of the struct Lisp_Bool_Vector. */
2384 val
= Fmake_vector (make_number (length_in_elts
+ 1), Qnil
);
2386 /* No Lisp_Object to trace in there. */
2387 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0);
2389 p
= XBOOL_VECTOR (val
);
2390 p
->size
= XFASTINT (length
);
2392 if (length_in_chars
)
2394 memset (p
->data
, ! NILP (init
) ? -1 : 0, length_in_chars
);
2396 /* Clear any extraneous bits in the last byte. */
2397 p
->data
[length_in_chars
- 1]
2398 &= (1 << (XINT (length
) % BOOL_VECTOR_BITS_PER_CHAR
)) - 1;
2405 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2406 of characters from the contents. This string may be unibyte or
2407 multibyte, depending on the contents. */
2410 make_string (const char *contents
, EMACS_INT nbytes
)
2412 register Lisp_Object val
;
2413 EMACS_INT nchars
, multibyte_nbytes
;
2415 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2416 &nchars
, &multibyte_nbytes
);
2417 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2418 /* CONTENTS contains no multibyte sequences or contains an invalid
2419 multibyte sequence. We must make unibyte string. */
2420 val
= make_unibyte_string (contents
, nbytes
);
2422 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2427 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2430 make_unibyte_string (const char *contents
, EMACS_INT length
)
2432 register Lisp_Object val
;
2433 val
= make_uninit_string (length
);
2434 memcpy (SDATA (val
), contents
, length
);
2439 /* Make a multibyte string from NCHARS characters occupying NBYTES
2440 bytes at CONTENTS. */
2443 make_multibyte_string (const char *contents
,
2444 EMACS_INT nchars
, EMACS_INT nbytes
)
2446 register Lisp_Object val
;
2447 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2448 memcpy (SDATA (val
), contents
, nbytes
);
2453 /* Make a string from NCHARS characters occupying NBYTES bytes at
2454 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2457 make_string_from_bytes (const char *contents
,
2458 EMACS_INT nchars
, EMACS_INT nbytes
)
2460 register Lisp_Object val
;
2461 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2462 memcpy (SDATA (val
), contents
, nbytes
);
2463 if (SBYTES (val
) == SCHARS (val
))
2464 STRING_SET_UNIBYTE (val
);
2469 /* Make a string from NCHARS characters occupying NBYTES bytes at
2470 CONTENTS. The argument MULTIBYTE controls whether to label the
2471 string as multibyte. If NCHARS is negative, it counts the number of
2472 characters by itself. */
2475 make_specified_string (const char *contents
,
2476 EMACS_INT nchars
, EMACS_INT nbytes
, int multibyte
)
2478 register Lisp_Object val
;
2483 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2488 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2489 memcpy (SDATA (val
), contents
, nbytes
);
2491 STRING_SET_UNIBYTE (val
);
2496 /* Make a string from the data at STR, treating it as multibyte if the
2500 build_string (const char *str
)
2502 return make_string (str
, strlen (str
));
2506 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2507 occupying LENGTH bytes. */
2510 make_uninit_string (EMACS_INT length
)
2515 return empty_unibyte_string
;
2516 val
= make_uninit_multibyte_string (length
, length
);
2517 STRING_SET_UNIBYTE (val
);
2522 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2523 which occupy NBYTES bytes. */
2526 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2529 struct Lisp_String
*s
;
2534 return empty_multibyte_string
;
2536 s
= allocate_string ();
2537 allocate_string_data (s
, nchars
, nbytes
);
2538 XSETSTRING (string
, s
);
2539 string_chars_consed
+= nbytes
;
2545 /***********************************************************************
2547 ***********************************************************************/
2549 /* We store float cells inside of float_blocks, allocating a new
2550 float_block with malloc whenever necessary. Float cells reclaimed
2551 by GC are put on a free list to be reallocated before allocating
2552 any new float cells from the latest float_block. */
2554 #define FLOAT_BLOCK_SIZE \
2555 (((BLOCK_BYTES - sizeof (struct float_block *) \
2556 /* The compiler might add padding at the end. */ \
2557 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2558 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2560 #define GETMARKBIT(block,n) \
2561 (((block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2562 >> ((n) % (sizeof (int) * CHAR_BIT))) \
2565 #define SETMARKBIT(block,n) \
2566 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2567 |= 1 << ((n) % (sizeof (int) * CHAR_BIT))
2569 #define UNSETMARKBIT(block,n) \
2570 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2571 &= ~(1 << ((n) % (sizeof (int) * CHAR_BIT)))
2573 #define FLOAT_BLOCK(fptr) \
2574 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2576 #define FLOAT_INDEX(fptr) \
2577 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2581 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2582 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2583 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2584 struct float_block
*next
;
2587 #define FLOAT_MARKED_P(fptr) \
2588 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2590 #define FLOAT_MARK(fptr) \
2591 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2593 #define FLOAT_UNMARK(fptr) \
2594 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2596 /* Current float_block. */
2598 static struct float_block
*float_block
;
2600 /* Index of first unused Lisp_Float in the current float_block. */
2602 static int float_block_index
;
2604 /* Free-list of Lisp_Floats. */
2606 static struct Lisp_Float
*float_free_list
;
2609 /* Initialize float allocation. */
2615 float_block_index
= FLOAT_BLOCK_SIZE
; /* Force alloc of new float_block. */
2616 float_free_list
= 0;
2620 /* Return a new float object with value FLOAT_VALUE. */
2623 make_float (double float_value
)
2625 register Lisp_Object val
;
2627 /* eassert (!handling_signal); */
2631 if (float_free_list
)
2633 /* We use the data field for chaining the free list
2634 so that we won't use the same field that has the mark bit. */
2635 XSETFLOAT (val
, float_free_list
);
2636 float_free_list
= float_free_list
->u
.chain
;
2640 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2642 register struct float_block
*new;
2644 new = (struct float_block
*) lisp_align_malloc (sizeof *new,
2646 new->next
= float_block
;
2647 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2649 float_block_index
= 0;
2651 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2652 float_block_index
++;
2655 MALLOC_UNBLOCK_INPUT
;
2657 XFLOAT_INIT (val
, float_value
);
2658 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2659 consing_since_gc
+= sizeof (struct Lisp_Float
);
2666 /***********************************************************************
2668 ***********************************************************************/
2670 /* We store cons cells inside of cons_blocks, allocating a new
2671 cons_block with malloc whenever necessary. Cons cells reclaimed by
2672 GC are put on a free list to be reallocated before allocating
2673 any new cons cells from the latest cons_block. */
2675 #define CONS_BLOCK_SIZE \
2676 (((BLOCK_BYTES - sizeof (struct cons_block *)) * CHAR_BIT) \
2677 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2679 #define CONS_BLOCK(fptr) \
2680 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2682 #define CONS_INDEX(fptr) \
2683 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2687 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2688 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2689 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2690 struct cons_block
*next
;
2693 #define CONS_MARKED_P(fptr) \
2694 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2696 #define CONS_MARK(fptr) \
2697 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2699 #define CONS_UNMARK(fptr) \
2700 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2702 /* Current cons_block. */
2704 static struct cons_block
*cons_block
;
2706 /* Index of first unused Lisp_Cons in the current block. */
2708 static int cons_block_index
;
2710 /* Free-list of Lisp_Cons structures. */
2712 static struct Lisp_Cons
*cons_free_list
;
2715 /* Initialize cons allocation. */
2721 cons_block_index
= CONS_BLOCK_SIZE
; /* Force alloc of new cons_block. */
2726 /* Explicitly free a cons cell by putting it on the free-list. */
2729 free_cons (struct Lisp_Cons
*ptr
)
2731 ptr
->u
.chain
= cons_free_list
;
2735 cons_free_list
= ptr
;
2738 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2739 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2740 (Lisp_Object car
, Lisp_Object cdr
)
2742 register Lisp_Object val
;
2744 /* eassert (!handling_signal); */
2750 /* We use the cdr for chaining the free list
2751 so that we won't use the same field that has the mark bit. */
2752 XSETCONS (val
, cons_free_list
);
2753 cons_free_list
= cons_free_list
->u
.chain
;
2757 if (cons_block_index
== CONS_BLOCK_SIZE
)
2759 register struct cons_block
*new;
2760 new = (struct cons_block
*) lisp_align_malloc (sizeof *new,
2762 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2763 new->next
= cons_block
;
2765 cons_block_index
= 0;
2767 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2771 MALLOC_UNBLOCK_INPUT
;
2775 eassert (!CONS_MARKED_P (XCONS (val
)));
2776 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2777 cons_cells_consed
++;
2781 #ifdef GC_CHECK_CONS_LIST
2782 /* Get an error now if there's any junk in the cons free list. */
2784 check_cons_list (void)
2786 struct Lisp_Cons
*tail
= cons_free_list
;
2789 tail
= tail
->u
.chain
;
2793 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2796 list1 (Lisp_Object arg1
)
2798 return Fcons (arg1
, Qnil
);
2802 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2804 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2809 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2811 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2816 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2818 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2823 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2825 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2826 Fcons (arg5
, Qnil
)))));
2830 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2831 doc
: /* Return a newly created list with specified arguments as elements.
2832 Any number of arguments, even zero arguments, are allowed.
2833 usage: (list &rest OBJECTS) */)
2834 (ptrdiff_t nargs
, Lisp_Object
*args
)
2836 register Lisp_Object val
;
2842 val
= Fcons (args
[nargs
], val
);
2848 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2849 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2850 (register Lisp_Object length
, Lisp_Object init
)
2852 register Lisp_Object val
;
2853 register EMACS_INT size
;
2855 CHECK_NATNUM (length
);
2856 size
= XFASTINT (length
);
2861 val
= Fcons (init
, val
);
2866 val
= Fcons (init
, val
);
2871 val
= Fcons (init
, val
);
2876 val
= Fcons (init
, val
);
2881 val
= Fcons (init
, val
);
2896 /***********************************************************************
2898 ***********************************************************************/
2900 /* Singly-linked list of all vectors. */
2902 static struct Lisp_Vector
*all_vectors
;
2904 /* Handy constants for vectorlike objects. */
2907 header_size
= offsetof (struct Lisp_Vector
, contents
),
2908 word_size
= sizeof (Lisp_Object
)
2911 /* Value is a pointer to a newly allocated Lisp_Vector structure
2912 with room for LEN Lisp_Objects. */
2914 static struct Lisp_Vector
*
2915 allocate_vectorlike (EMACS_INT len
)
2917 struct Lisp_Vector
*p
;
2922 #ifdef DOUG_LEA_MALLOC
2923 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
2924 because mapped region contents are not preserved in
2926 mallopt (M_MMAP_MAX
, 0);
2929 /* This gets triggered by code which I haven't bothered to fix. --Stef */
2930 /* eassert (!handling_signal); */
2932 nbytes
= header_size
+ len
* word_size
;
2933 p
= (struct Lisp_Vector
*) lisp_malloc (nbytes
, MEM_TYPE_VECTORLIKE
);
2935 #ifdef DOUG_LEA_MALLOC
2936 /* Back to a reasonable maximum of mmap'ed areas. */
2937 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2940 consing_since_gc
+= nbytes
;
2941 vector_cells_consed
+= len
;
2943 p
->header
.next
.vector
= all_vectors
;
2946 MALLOC_UNBLOCK_INPUT
;
2952 /* Allocate a vector with LEN slots. */
2954 struct Lisp_Vector
*
2955 allocate_vector (EMACS_INT len
)
2957 struct Lisp_Vector
*v
;
2958 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
2960 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
2961 memory_full (SIZE_MAX
);
2962 v
= allocate_vectorlike (len
);
2963 v
->header
.size
= len
;
2968 /* Allocate other vector-like structures. */
2970 struct Lisp_Vector
*
2971 allocate_pseudovector (int memlen
, int lisplen
, EMACS_INT tag
)
2973 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
2976 /* Only the first lisplen slots will be traced normally by the GC. */
2977 for (i
= 0; i
< lisplen
; ++i
)
2978 v
->contents
[i
] = Qnil
;
2980 XSETPVECTYPESIZE (v
, tag
, lisplen
);
2984 struct Lisp_Hash_Table
*
2985 allocate_hash_table (void)
2987 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
2992 allocate_window (void)
2994 return ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
2999 allocate_terminal (void)
3001 struct terminal
*t
= ALLOCATE_PSEUDOVECTOR (struct terminal
,
3002 next_terminal
, PVEC_TERMINAL
);
3003 /* Zero out the non-GC'd fields. FIXME: This should be made unnecessary. */
3004 memset (&t
->next_terminal
, 0,
3005 (char*) (t
+ 1) - (char*) &t
->next_terminal
);
3011 allocate_frame (void)
3013 struct frame
*f
= ALLOCATE_PSEUDOVECTOR (struct frame
,
3014 face_cache
, PVEC_FRAME
);
3015 /* Zero out the non-GC'd fields. FIXME: This should be made unnecessary. */
3016 memset (&f
->face_cache
, 0,
3017 (char *) (f
+ 1) - (char *) &f
->face_cache
);
3022 struct Lisp_Process
*
3023 allocate_process (void)
3025 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3029 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3030 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3031 See also the function `vector'. */)
3032 (register Lisp_Object length
, Lisp_Object init
)
3035 register EMACS_INT sizei
;
3036 register EMACS_INT i
;
3037 register struct Lisp_Vector
*p
;
3039 CHECK_NATNUM (length
);
3040 sizei
= XFASTINT (length
);
3042 p
= allocate_vector (sizei
);
3043 for (i
= 0; i
< sizei
; i
++)
3044 p
->contents
[i
] = init
;
3046 XSETVECTOR (vector
, p
);
3051 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3052 doc
: /* Return a newly created vector with specified arguments as elements.
3053 Any number of arguments, even zero arguments, are allowed.
3054 usage: (vector &rest OBJECTS) */)
3055 (ptrdiff_t nargs
, Lisp_Object
*args
)
3057 register Lisp_Object len
, val
;
3059 register struct Lisp_Vector
*p
;
3061 XSETFASTINT (len
, nargs
);
3062 val
= Fmake_vector (len
, Qnil
);
3064 for (i
= 0; i
< nargs
; i
++)
3065 p
->contents
[i
] = args
[i
];
3070 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3071 doc
: /* Create a byte-code object with specified arguments as elements.
3072 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3073 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3074 and (optional) INTERACTIVE-SPEC.
3075 The first four arguments are required; at most six have any
3077 The ARGLIST can be either like the one of `lambda', in which case the arguments
3078 will be dynamically bound before executing the byte code, or it can be an
3079 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3080 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3081 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3082 argument to catch the left-over arguments. If such an integer is used, the
3083 arguments will not be dynamically bound but will be instead pushed on the
3084 stack before executing the byte-code.
3085 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3086 (ptrdiff_t nargs
, Lisp_Object
*args
)
3088 register Lisp_Object len
, val
;
3090 register struct Lisp_Vector
*p
;
3092 XSETFASTINT (len
, nargs
);
3093 if (!NILP (Vpurify_flag
))
3094 val
= make_pure_vector (nargs
);
3096 val
= Fmake_vector (len
, Qnil
);
3098 if (nargs
> 1 && STRINGP (args
[1]) && STRING_MULTIBYTE (args
[1]))
3099 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3100 earlier because they produced a raw 8-bit string for byte-code
3101 and now such a byte-code string is loaded as multibyte while
3102 raw 8-bit characters converted to multibyte form. Thus, now we
3103 must convert them back to the original unibyte form. */
3104 args
[1] = Fstring_as_unibyte (args
[1]);
3107 for (i
= 0; i
< nargs
; i
++)
3109 if (!NILP (Vpurify_flag
))
3110 args
[i
] = Fpurecopy (args
[i
]);
3111 p
->contents
[i
] = args
[i
];
3113 XSETPVECTYPE (p
, PVEC_COMPILED
);
3114 XSETCOMPILED (val
, p
);
3120 /***********************************************************************
3122 ***********************************************************************/
3124 /* Each symbol_block is just under 1020 bytes long, since malloc
3125 really allocates in units of powers of two and uses 4 bytes for its
3128 #define SYMBOL_BLOCK_SIZE \
3129 ((1020 - sizeof (struct symbol_block *)) / sizeof (struct Lisp_Symbol))
3133 /* Place `symbols' first, to preserve alignment. */
3134 struct Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3135 struct symbol_block
*next
;
3138 /* Current symbol block and index of first unused Lisp_Symbol
3141 static struct symbol_block
*symbol_block
;
3142 static int symbol_block_index
;
3144 /* List of free symbols. */
3146 static struct Lisp_Symbol
*symbol_free_list
;
3149 /* Initialize symbol allocation. */
3154 symbol_block
= NULL
;
3155 symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3156 symbol_free_list
= 0;
3160 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3161 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3162 Its value and function definition are void, and its property list is nil. */)
3165 register Lisp_Object val
;
3166 register struct Lisp_Symbol
*p
;
3168 CHECK_STRING (name
);
3170 /* eassert (!handling_signal); */
3174 if (symbol_free_list
)
3176 XSETSYMBOL (val
, symbol_free_list
);
3177 symbol_free_list
= symbol_free_list
->next
;
3181 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3183 struct symbol_block
*new;
3184 new = (struct symbol_block
*) lisp_malloc (sizeof *new,
3186 new->next
= symbol_block
;
3188 symbol_block_index
= 0;
3190 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
]);
3191 symbol_block_index
++;
3194 MALLOC_UNBLOCK_INPUT
;
3199 p
->redirect
= SYMBOL_PLAINVAL
;
3200 SET_SYMBOL_VAL (p
, Qunbound
);
3201 p
->function
= Qunbound
;
3204 p
->interned
= SYMBOL_UNINTERNED
;
3206 p
->declared_special
= 0;
3207 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3214 /***********************************************************************
3215 Marker (Misc) Allocation
3216 ***********************************************************************/
3218 /* Allocation of markers and other objects that share that structure.
3219 Works like allocation of conses. */
3221 #define MARKER_BLOCK_SIZE \
3222 ((1020 - sizeof (struct marker_block *)) / sizeof (union Lisp_Misc))
3226 /* Place `markers' first, to preserve alignment. */
3227 union Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3228 struct marker_block
*next
;
3231 static struct marker_block
*marker_block
;
3232 static int marker_block_index
;
3234 static union Lisp_Misc
*marker_free_list
;
3239 marker_block
= NULL
;
3240 marker_block_index
= MARKER_BLOCK_SIZE
;
3241 marker_free_list
= 0;
3244 /* Return a newly allocated Lisp_Misc object, with no substructure. */
3247 allocate_misc (void)
3251 /* eassert (!handling_signal); */
3255 if (marker_free_list
)
3257 XSETMISC (val
, marker_free_list
);
3258 marker_free_list
= marker_free_list
->u_free
.chain
;
3262 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3264 struct marker_block
*new;
3265 new = (struct marker_block
*) lisp_malloc (sizeof *new,
3267 new->next
= marker_block
;
3269 marker_block_index
= 0;
3270 total_free_markers
+= MARKER_BLOCK_SIZE
;
3272 XSETMISC (val
, &marker_block
->markers
[marker_block_index
]);
3273 marker_block_index
++;
3276 MALLOC_UNBLOCK_INPUT
;
3278 --total_free_markers
;
3279 consing_since_gc
+= sizeof (union Lisp_Misc
);
3280 misc_objects_consed
++;
3281 XMISCANY (val
)->gcmarkbit
= 0;
3285 /* Free a Lisp_Misc object */
3288 free_misc (Lisp_Object misc
)
3290 XMISCTYPE (misc
) = Lisp_Misc_Free
;
3291 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3292 marker_free_list
= XMISC (misc
);
3294 total_free_markers
++;
3297 /* Return a Lisp_Misc_Save_Value object containing POINTER and
3298 INTEGER. This is used to package C values to call record_unwind_protect.
3299 The unwind function can get the C values back using XSAVE_VALUE. */
3302 make_save_value (void *pointer
, ptrdiff_t integer
)
3304 register Lisp_Object val
;
3305 register struct Lisp_Save_Value
*p
;
3307 val
= allocate_misc ();
3308 XMISCTYPE (val
) = Lisp_Misc_Save_Value
;
3309 p
= XSAVE_VALUE (val
);
3310 p
->pointer
= pointer
;
3311 p
->integer
= integer
;
3316 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3317 doc
: /* Return a newly allocated marker which does not point at any place. */)
3320 register Lisp_Object val
;
3321 register struct Lisp_Marker
*p
;
3323 val
= allocate_misc ();
3324 XMISCTYPE (val
) = Lisp_Misc_Marker
;
3330 p
->insertion_type
= 0;
3334 /* Put MARKER back on the free list after using it temporarily. */
3337 free_marker (Lisp_Object marker
)
3339 unchain_marker (XMARKER (marker
));
3344 /* Return a newly created vector or string with specified arguments as
3345 elements. If all the arguments are characters that can fit
3346 in a string of events, make a string; otherwise, make a vector.
3348 Any number of arguments, even zero arguments, are allowed. */
3351 make_event_array (register int nargs
, Lisp_Object
*args
)
3355 for (i
= 0; i
< nargs
; i
++)
3356 /* The things that fit in a string
3357 are characters that are in 0...127,
3358 after discarding the meta bit and all the bits above it. */
3359 if (!INTEGERP (args
[i
])
3360 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3361 return Fvector (nargs
, args
);
3363 /* Since the loop exited, we know that all the things in it are
3364 characters, so we can make a string. */
3368 result
= Fmake_string (make_number (nargs
), make_number (0));
3369 for (i
= 0; i
< nargs
; i
++)
3371 SSET (result
, i
, XINT (args
[i
]));
3372 /* Move the meta bit to the right place for a string char. */
3373 if (XINT (args
[i
]) & CHAR_META
)
3374 SSET (result
, i
, SREF (result
, i
) | 0x80);
3383 /************************************************************************
3384 Memory Full Handling
3385 ************************************************************************/
3388 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3389 there may have been size_t overflow so that malloc was never
3390 called, or perhaps malloc was invoked successfully but the
3391 resulting pointer had problems fitting into a tagged EMACS_INT. In
3392 either case this counts as memory being full even though malloc did
3396 memory_full (size_t nbytes
)
3398 /* Do not go into hysterics merely because a large request failed. */
3399 int enough_free_memory
= 0;
3400 if (SPARE_MEMORY
< nbytes
)
3405 p
= malloc (SPARE_MEMORY
);
3409 enough_free_memory
= 1;
3411 MALLOC_UNBLOCK_INPUT
;
3414 if (! enough_free_memory
)
3420 memory_full_cons_threshold
= sizeof (struct cons_block
);
3422 /* The first time we get here, free the spare memory. */
3423 for (i
= 0; i
< sizeof (spare_memory
) / sizeof (char *); i
++)
3424 if (spare_memory
[i
])
3427 free (spare_memory
[i
]);
3428 else if (i
>= 1 && i
<= 4)
3429 lisp_align_free (spare_memory
[i
]);
3431 lisp_free (spare_memory
[i
]);
3432 spare_memory
[i
] = 0;
3435 /* Record the space now used. When it decreases substantially,
3436 we can refill the memory reserve. */
3437 #if !defined SYSTEM_MALLOC && !defined SYNC_INPUT
3438 bytes_used_when_full
= BYTES_USED
;
3442 /* This used to call error, but if we've run out of memory, we could
3443 get infinite recursion trying to build the string. */
3444 xsignal (Qnil
, Vmemory_signal_data
);
3447 /* If we released our reserve (due to running out of memory),
3448 and we have a fair amount free once again,
3449 try to set aside another reserve in case we run out once more.
3451 This is called when a relocatable block is freed in ralloc.c,
3452 and also directly from this file, in case we're not using ralloc.c. */
3455 refill_memory_reserve (void)
3457 #ifndef SYSTEM_MALLOC
3458 if (spare_memory
[0] == 0)
3459 spare_memory
[0] = (char *) malloc (SPARE_MEMORY
);
3460 if (spare_memory
[1] == 0)
3461 spare_memory
[1] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3463 if (spare_memory
[2] == 0)
3464 spare_memory
[2] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3466 if (spare_memory
[3] == 0)
3467 spare_memory
[3] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3469 if (spare_memory
[4] == 0)
3470 spare_memory
[4] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3472 if (spare_memory
[5] == 0)
3473 spare_memory
[5] = (char *) lisp_malloc (sizeof (struct string_block
),
3475 if (spare_memory
[6] == 0)
3476 spare_memory
[6] = (char *) lisp_malloc (sizeof (struct string_block
),
3478 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3479 Vmemory_full
= Qnil
;
3483 /************************************************************************
3485 ************************************************************************/
3487 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3489 /* Conservative C stack marking requires a method to identify possibly
3490 live Lisp objects given a pointer value. We do this by keeping
3491 track of blocks of Lisp data that are allocated in a red-black tree
3492 (see also the comment of mem_node which is the type of nodes in
3493 that tree). Function lisp_malloc adds information for an allocated
3494 block to the red-black tree with calls to mem_insert, and function
3495 lisp_free removes it with mem_delete. Functions live_string_p etc
3496 call mem_find to lookup information about a given pointer in the
3497 tree, and use that to determine if the pointer points to a Lisp
3500 /* Initialize this part of alloc.c. */
3505 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3506 mem_z
.parent
= NULL
;
3507 mem_z
.color
= MEM_BLACK
;
3508 mem_z
.start
= mem_z
.end
= NULL
;
3513 /* Value is a pointer to the mem_node containing START. Value is
3514 MEM_NIL if there is no node in the tree containing START. */
3516 static inline struct mem_node
*
3517 mem_find (void *start
)
3521 if (start
< min_heap_address
|| start
> max_heap_address
)
3524 /* Make the search always successful to speed up the loop below. */
3525 mem_z
.start
= start
;
3526 mem_z
.end
= (char *) start
+ 1;
3529 while (start
< p
->start
|| start
>= p
->end
)
3530 p
= start
< p
->start
? p
->left
: p
->right
;
3535 /* Insert a new node into the tree for a block of memory with start
3536 address START, end address END, and type TYPE. Value is a
3537 pointer to the node that was inserted. */
3539 static struct mem_node
*
3540 mem_insert (void *start
, void *end
, enum mem_type type
)
3542 struct mem_node
*c
, *parent
, *x
;
3544 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3545 min_heap_address
= start
;
3546 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3547 max_heap_address
= end
;
3549 /* See where in the tree a node for START belongs. In this
3550 particular application, it shouldn't happen that a node is already
3551 present. For debugging purposes, let's check that. */
3555 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3557 while (c
!= MEM_NIL
)
3559 if (start
>= c
->start
&& start
< c
->end
)
3562 c
= start
< c
->start
? c
->left
: c
->right
;
3565 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3567 while (c
!= MEM_NIL
)
3570 c
= start
< c
->start
? c
->left
: c
->right
;
3573 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3575 /* Create a new node. */
3576 #ifdef GC_MALLOC_CHECK
3577 x
= (struct mem_node
*) _malloc_internal (sizeof *x
);
3581 x
= (struct mem_node
*) xmalloc (sizeof *x
);
3587 x
->left
= x
->right
= MEM_NIL
;
3590 /* Insert it as child of PARENT or install it as root. */
3593 if (start
< parent
->start
)
3601 /* Re-establish red-black tree properties. */
3602 mem_insert_fixup (x
);
3608 /* Re-establish the red-black properties of the tree, and thereby
3609 balance the tree, after node X has been inserted; X is always red. */
3612 mem_insert_fixup (struct mem_node
*x
)
3614 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3616 /* X is red and its parent is red. This is a violation of
3617 red-black tree property #3. */
3619 if (x
->parent
== x
->parent
->parent
->left
)
3621 /* We're on the left side of our grandparent, and Y is our
3623 struct mem_node
*y
= x
->parent
->parent
->right
;
3625 if (y
->color
== MEM_RED
)
3627 /* Uncle and parent are red but should be black because
3628 X is red. Change the colors accordingly and proceed
3629 with the grandparent. */
3630 x
->parent
->color
= MEM_BLACK
;
3631 y
->color
= MEM_BLACK
;
3632 x
->parent
->parent
->color
= MEM_RED
;
3633 x
= x
->parent
->parent
;
3637 /* Parent and uncle have different colors; parent is
3638 red, uncle is black. */
3639 if (x
== x
->parent
->right
)
3642 mem_rotate_left (x
);
3645 x
->parent
->color
= MEM_BLACK
;
3646 x
->parent
->parent
->color
= MEM_RED
;
3647 mem_rotate_right (x
->parent
->parent
);
3652 /* This is the symmetrical case of above. */
3653 struct mem_node
*y
= x
->parent
->parent
->left
;
3655 if (y
->color
== MEM_RED
)
3657 x
->parent
->color
= MEM_BLACK
;
3658 y
->color
= MEM_BLACK
;
3659 x
->parent
->parent
->color
= MEM_RED
;
3660 x
= x
->parent
->parent
;
3664 if (x
== x
->parent
->left
)
3667 mem_rotate_right (x
);
3670 x
->parent
->color
= MEM_BLACK
;
3671 x
->parent
->parent
->color
= MEM_RED
;
3672 mem_rotate_left (x
->parent
->parent
);
3677 /* The root may have been changed to red due to the algorithm. Set
3678 it to black so that property #5 is satisfied. */
3679 mem_root
->color
= MEM_BLACK
;
3690 mem_rotate_left (struct mem_node
*x
)
3694 /* Turn y's left sub-tree into x's right sub-tree. */
3697 if (y
->left
!= MEM_NIL
)
3698 y
->left
->parent
= x
;
3700 /* Y's parent was x's parent. */
3702 y
->parent
= x
->parent
;
3704 /* Get the parent to point to y instead of x. */
3707 if (x
== x
->parent
->left
)
3708 x
->parent
->left
= y
;
3710 x
->parent
->right
= y
;
3715 /* Put x on y's left. */
3729 mem_rotate_right (struct mem_node
*x
)
3731 struct mem_node
*y
= x
->left
;
3734 if (y
->right
!= MEM_NIL
)
3735 y
->right
->parent
= x
;
3738 y
->parent
= x
->parent
;
3741 if (x
== x
->parent
->right
)
3742 x
->parent
->right
= y
;
3744 x
->parent
->left
= y
;
3755 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
3758 mem_delete (struct mem_node
*z
)
3760 struct mem_node
*x
, *y
;
3762 if (!z
|| z
== MEM_NIL
)
3765 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
3770 while (y
->left
!= MEM_NIL
)
3774 if (y
->left
!= MEM_NIL
)
3779 x
->parent
= y
->parent
;
3782 if (y
== y
->parent
->left
)
3783 y
->parent
->left
= x
;
3785 y
->parent
->right
= x
;
3792 z
->start
= y
->start
;
3797 if (y
->color
== MEM_BLACK
)
3798 mem_delete_fixup (x
);
3800 #ifdef GC_MALLOC_CHECK
3808 /* Re-establish the red-black properties of the tree, after a
3812 mem_delete_fixup (struct mem_node
*x
)
3814 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
3816 if (x
== x
->parent
->left
)
3818 struct mem_node
*w
= x
->parent
->right
;
3820 if (w
->color
== MEM_RED
)
3822 w
->color
= MEM_BLACK
;
3823 x
->parent
->color
= MEM_RED
;
3824 mem_rotate_left (x
->parent
);
3825 w
= x
->parent
->right
;
3828 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
3835 if (w
->right
->color
== MEM_BLACK
)
3837 w
->left
->color
= MEM_BLACK
;
3839 mem_rotate_right (w
);
3840 w
= x
->parent
->right
;
3842 w
->color
= x
->parent
->color
;
3843 x
->parent
->color
= MEM_BLACK
;
3844 w
->right
->color
= MEM_BLACK
;
3845 mem_rotate_left (x
->parent
);
3851 struct mem_node
*w
= x
->parent
->left
;
3853 if (w
->color
== MEM_RED
)
3855 w
->color
= MEM_BLACK
;
3856 x
->parent
->color
= MEM_RED
;
3857 mem_rotate_right (x
->parent
);
3858 w
= x
->parent
->left
;
3861 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
3868 if (w
->left
->color
== MEM_BLACK
)
3870 w
->right
->color
= MEM_BLACK
;
3872 mem_rotate_left (w
);
3873 w
= x
->parent
->left
;
3876 w
->color
= x
->parent
->color
;
3877 x
->parent
->color
= MEM_BLACK
;
3878 w
->left
->color
= MEM_BLACK
;
3879 mem_rotate_right (x
->parent
);
3885 x
->color
= MEM_BLACK
;
3889 /* Value is non-zero if P is a pointer to a live Lisp string on
3890 the heap. M is a pointer to the mem_block for P. */
3893 live_string_p (struct mem_node
*m
, void *p
)
3895 if (m
->type
== MEM_TYPE_STRING
)
3897 struct string_block
*b
= (struct string_block
*) m
->start
;
3898 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
3900 /* P must point to the start of a Lisp_String structure, and it
3901 must not be on the free-list. */
3903 && offset
% sizeof b
->strings
[0] == 0
3904 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
3905 && ((struct Lisp_String
*) p
)->data
!= NULL
);
3912 /* Value is non-zero if P is a pointer to a live Lisp cons on
3913 the heap. M is a pointer to the mem_block for P. */
3916 live_cons_p (struct mem_node
*m
, void *p
)
3918 if (m
->type
== MEM_TYPE_CONS
)
3920 struct cons_block
*b
= (struct cons_block
*) m
->start
;
3921 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
3923 /* P must point to the start of a Lisp_Cons, not be
3924 one of the unused cells in the current cons block,
3925 and not be on the free-list. */
3927 && offset
% sizeof b
->conses
[0] == 0
3928 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
3930 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
3931 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
3938 /* Value is non-zero if P is a pointer to a live Lisp symbol on
3939 the heap. M is a pointer to the mem_block for P. */
3942 live_symbol_p (struct mem_node
*m
, void *p
)
3944 if (m
->type
== MEM_TYPE_SYMBOL
)
3946 struct symbol_block
*b
= (struct symbol_block
*) m
->start
;
3947 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
3949 /* P must point to the start of a Lisp_Symbol, not be
3950 one of the unused cells in the current symbol block,
3951 and not be on the free-list. */
3953 && offset
% sizeof b
->symbols
[0] == 0
3954 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
3955 && (b
!= symbol_block
3956 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
3957 && !EQ (((struct Lisp_Symbol
*) p
)->function
, Vdead
));
3964 /* Value is non-zero if P is a pointer to a live Lisp float on
3965 the heap. M is a pointer to the mem_block for P. */
3968 live_float_p (struct mem_node
*m
, void *p
)
3970 if (m
->type
== MEM_TYPE_FLOAT
)
3972 struct float_block
*b
= (struct float_block
*) m
->start
;
3973 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
3975 /* P must point to the start of a Lisp_Float and not be
3976 one of the unused cells in the current float block. */
3978 && offset
% sizeof b
->floats
[0] == 0
3979 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
3980 && (b
!= float_block
3981 || offset
/ sizeof b
->floats
[0] < float_block_index
));
3988 /* Value is non-zero if P is a pointer to a live Lisp Misc on
3989 the heap. M is a pointer to the mem_block for P. */
3992 live_misc_p (struct mem_node
*m
, void *p
)
3994 if (m
->type
== MEM_TYPE_MISC
)
3996 struct marker_block
*b
= (struct marker_block
*) m
->start
;
3997 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
3999 /* P must point to the start of a Lisp_Misc, not be
4000 one of the unused cells in the current misc block,
4001 and not be on the free-list. */
4003 && offset
% sizeof b
->markers
[0] == 0
4004 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4005 && (b
!= marker_block
4006 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4007 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4014 /* Value is non-zero if P is a pointer to a live vector-like object.
4015 M is a pointer to the mem_block for P. */
4018 live_vector_p (struct mem_node
*m
, void *p
)
4020 return (p
== m
->start
&& m
->type
== MEM_TYPE_VECTORLIKE
);
4024 /* Value is non-zero if P is a pointer to a live buffer. M is a
4025 pointer to the mem_block for P. */
4028 live_buffer_p (struct mem_node
*m
, void *p
)
4030 /* P must point to the start of the block, and the buffer
4031 must not have been killed. */
4032 return (m
->type
== MEM_TYPE_BUFFER
4034 && !NILP (((struct buffer
*) p
)->BUFFER_INTERNAL_FIELD (name
)));
4037 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4041 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4043 /* Array of objects that are kept alive because the C stack contains
4044 a pattern that looks like a reference to them . */
4046 #define MAX_ZOMBIES 10
4047 static Lisp_Object zombies
[MAX_ZOMBIES
];
4049 /* Number of zombie objects. */
4051 static EMACS_INT nzombies
;
4053 /* Number of garbage collections. */
4055 static EMACS_INT ngcs
;
4057 /* Average percentage of zombies per collection. */
4059 static double avg_zombies
;
4061 /* Max. number of live and zombie objects. */
4063 static EMACS_INT max_live
, max_zombies
;
4065 /* Average number of live objects per GC. */
4067 static double avg_live
;
4069 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4070 doc
: /* Show information about live and zombie objects. */)
4073 Lisp_Object args
[8], zombie_list
= Qnil
;
4075 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); i
++)
4076 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4077 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4078 args
[1] = make_number (ngcs
);
4079 args
[2] = make_float (avg_live
);
4080 args
[3] = make_float (avg_zombies
);
4081 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4082 args
[5] = make_number (max_live
);
4083 args
[6] = make_number (max_zombies
);
4084 args
[7] = zombie_list
;
4085 return Fmessage (8, args
);
4088 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4091 /* Mark OBJ if we can prove it's a Lisp_Object. */
4094 mark_maybe_object (Lisp_Object obj
)
4102 po
= (void *) XPNTR (obj
);
4109 switch (XTYPE (obj
))
4112 mark_p
= (live_string_p (m
, po
)
4113 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4117 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4121 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4125 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4128 case Lisp_Vectorlike
:
4129 /* Note: can't check BUFFERP before we know it's a
4130 buffer because checking that dereferences the pointer
4131 PO which might point anywhere. */
4132 if (live_vector_p (m
, po
))
4133 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4134 else if (live_buffer_p (m
, po
))
4135 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4139 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4148 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4149 if (nzombies
< MAX_ZOMBIES
)
4150 zombies
[nzombies
] = obj
;
4159 /* If P points to Lisp data, mark that as live if it isn't already
4163 mark_maybe_pointer (void *p
)
4167 /* Quickly rule out some values which can't point to Lisp data. */
4170 8 /* USE_LSB_TAG needs Lisp data to be aligned on multiples of 8. */
4172 2 /* We assume that Lisp data is aligned on even addresses. */
4180 Lisp_Object obj
= Qnil
;
4184 case MEM_TYPE_NON_LISP
:
4185 /* Nothing to do; not a pointer to Lisp memory. */
4188 case MEM_TYPE_BUFFER
:
4189 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4190 XSETVECTOR (obj
, p
);
4194 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4198 case MEM_TYPE_STRING
:
4199 if (live_string_p (m
, p
)
4200 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4201 XSETSTRING (obj
, p
);
4205 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4209 case MEM_TYPE_SYMBOL
:
4210 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4211 XSETSYMBOL (obj
, p
);
4214 case MEM_TYPE_FLOAT
:
4215 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4219 case MEM_TYPE_VECTORLIKE
:
4220 if (live_vector_p (m
, p
))
4223 XSETVECTOR (tem
, p
);
4224 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4239 /* Alignment of Lisp_Object and pointer values. Use offsetof, as it
4240 sometimes returns a smaller alignment than GCC's __alignof__ and
4241 mark_memory might miss objects if __alignof__ were used. For
4242 example, on x86 with WIDE_EMACS_INT, __alignof__ (Lisp_Object) is 8
4243 but GC_LISP_OBJECT_ALIGNMENT should be 4. */
4244 #ifndef GC_LISP_OBJECT_ALIGNMENT
4245 # define GC_LISP_OBJECT_ALIGNMENT offsetof (struct {char a; Lisp_Object b;}, b)
4247 #define GC_POINTER_ALIGNMENT offsetof (struct {char a; void *b;}, b)
4249 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4250 or END+OFFSET..START. */
4253 mark_memory (void *start
, void *end
)
4259 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4263 /* Make START the pointer to the start of the memory region,
4264 if it isn't already. */
4272 /* Mark Lisp_Objects. */
4273 for (p
= start
; (void *) p
< end
; p
++)
4274 for (i
= 0; i
< sizeof *p
; i
+= GC_LISP_OBJECT_ALIGNMENT
)
4275 mark_maybe_object (*(Lisp_Object
*) ((char *) p
+ i
));
4277 /* Mark Lisp data pointed to. This is necessary because, in some
4278 situations, the C compiler optimizes Lisp objects away, so that
4279 only a pointer to them remains. Example:
4281 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4284 Lisp_Object obj = build_string ("test");
4285 struct Lisp_String *s = XSTRING (obj);
4286 Fgarbage_collect ();
4287 fprintf (stderr, "test `%s'\n", s->data);
4291 Here, `obj' isn't really used, and the compiler optimizes it
4292 away. The only reference to the life string is through the
4295 for (pp
= start
; (void *) pp
< end
; pp
++)
4296 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4297 mark_maybe_pointer (*(void **) ((char *) pp
+ i
));
4300 /* setjmp will work with GCC unless NON_SAVING_SETJMP is defined in
4301 the GCC system configuration. In gcc 3.2, the only systems for
4302 which this is so are i386-sco5 non-ELF, i386-sysv3 (maybe included
4303 by others?) and ns32k-pc532-min. */
4305 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4307 static int setjmp_tested_p
, longjmps_done
;
4309 #define SETJMP_WILL_LIKELY_WORK "\
4311 Emacs garbage collector has been changed to use conservative stack\n\
4312 marking. Emacs has determined that the method it uses to do the\n\
4313 marking will likely work on your system, but this isn't sure.\n\
4315 If you are a system-programmer, or can get the help of a local wizard\n\
4316 who is, please take a look at the function mark_stack in alloc.c, and\n\
4317 verify that the methods used are appropriate for your system.\n\
4319 Please mail the result to <emacs-devel@gnu.org>.\n\
4322 #define SETJMP_WILL_NOT_WORK "\
4324 Emacs garbage collector has been changed to use conservative stack\n\
4325 marking. Emacs has determined that the default method it uses to do the\n\
4326 marking will not work on your system. We will need a system-dependent\n\
4327 solution for your system.\n\
4329 Please take a look at the function mark_stack in alloc.c, and\n\
4330 try to find a way to make it work on your system.\n\
4332 Note that you may get false negatives, depending on the compiler.\n\
4333 In particular, you need to use -O with GCC for this test.\n\
4335 Please mail the result to <emacs-devel@gnu.org>.\n\
4339 /* Perform a quick check if it looks like setjmp saves registers in a
4340 jmp_buf. Print a message to stderr saying so. When this test
4341 succeeds, this is _not_ a proof that setjmp is sufficient for
4342 conservative stack marking. Only the sources or a disassembly
4353 /* Arrange for X to be put in a register. */
4359 if (longjmps_done
== 1)
4361 /* Came here after the longjmp at the end of the function.
4363 If x == 1, the longjmp has restored the register to its
4364 value before the setjmp, and we can hope that setjmp
4365 saves all such registers in the jmp_buf, although that
4368 For other values of X, either something really strange is
4369 taking place, or the setjmp just didn't save the register. */
4372 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4375 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4382 if (longjmps_done
== 1)
4386 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4389 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4391 /* Abort if anything GCPRO'd doesn't survive the GC. */
4399 for (p
= gcprolist
; p
; p
= p
->next
)
4400 for (i
= 0; i
< p
->nvars
; ++i
)
4401 if (!survives_gc_p (p
->var
[i
]))
4402 /* FIXME: It's not necessarily a bug. It might just be that the
4403 GCPRO is unnecessary or should release the object sooner. */
4407 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4414 fprintf (stderr
, "\nZombies kept alive = %"pI
"d:\n", nzombies
);
4415 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4417 fprintf (stderr
, " %d = ", i
);
4418 debug_print (zombies
[i
]);
4422 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4425 /* Mark live Lisp objects on the C stack.
4427 There are several system-dependent problems to consider when
4428 porting this to new architectures:
4432 We have to mark Lisp objects in CPU registers that can hold local
4433 variables or are used to pass parameters.
4435 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4436 something that either saves relevant registers on the stack, or
4437 calls mark_maybe_object passing it each register's contents.
4439 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4440 implementation assumes that calling setjmp saves registers we need
4441 to see in a jmp_buf which itself lies on the stack. This doesn't
4442 have to be true! It must be verified for each system, possibly
4443 by taking a look at the source code of setjmp.
4445 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4446 can use it as a machine independent method to store all registers
4447 to the stack. In this case the macros described in the previous
4448 two paragraphs are not used.
4452 Architectures differ in the way their processor stack is organized.
4453 For example, the stack might look like this
4456 | Lisp_Object | size = 4
4458 | something else | size = 2
4460 | Lisp_Object | size = 4
4464 In such a case, not every Lisp_Object will be aligned equally. To
4465 find all Lisp_Object on the stack it won't be sufficient to walk
4466 the stack in steps of 4 bytes. Instead, two passes will be
4467 necessary, one starting at the start of the stack, and a second
4468 pass starting at the start of the stack + 2. Likewise, if the
4469 minimal alignment of Lisp_Objects on the stack is 1, four passes
4470 would be necessary, each one starting with one byte more offset
4471 from the stack start. */
4478 #ifdef HAVE___BUILTIN_UNWIND_INIT
4479 /* Force callee-saved registers and register windows onto the stack.
4480 This is the preferred method if available, obviating the need for
4481 machine dependent methods. */
4482 __builtin_unwind_init ();
4484 #else /* not HAVE___BUILTIN_UNWIND_INIT */
4485 #ifndef GC_SAVE_REGISTERS_ON_STACK
4486 /* jmp_buf may not be aligned enough on darwin-ppc64 */
4487 union aligned_jmpbuf
{
4491 volatile int stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4493 /* This trick flushes the register windows so that all the state of
4494 the process is contained in the stack. */
4495 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4496 needed on ia64 too. See mach_dep.c, where it also says inline
4497 assembler doesn't work with relevant proprietary compilers. */
4499 #if defined (__sparc64__) && defined (__FreeBSD__)
4500 /* FreeBSD does not have a ta 3 handler. */
4507 /* Save registers that we need to see on the stack. We need to see
4508 registers used to hold register variables and registers used to
4510 #ifdef GC_SAVE_REGISTERS_ON_STACK
4511 GC_SAVE_REGISTERS_ON_STACK (end
);
4512 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4514 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4515 setjmp will definitely work, test it
4516 and print a message with the result
4518 if (!setjmp_tested_p
)
4520 setjmp_tested_p
= 1;
4523 #endif /* GC_SETJMP_WORKS */
4526 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4527 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4528 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
4530 /* This assumes that the stack is a contiguous region in memory. If
4531 that's not the case, something has to be done here to iterate
4532 over the stack segments. */
4533 mark_memory (stack_base
, end
);
4535 /* Allow for marking a secondary stack, like the register stack on the
4537 #ifdef GC_MARK_SECONDARY_STACK
4538 GC_MARK_SECONDARY_STACK ();
4541 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4546 #endif /* GC_MARK_STACK != 0 */
4549 /* Determine whether it is safe to access memory at address P. */
4551 valid_pointer_p (void *p
)
4554 return w32_valid_pointer_p (p
, 16);
4558 /* Obviously, we cannot just access it (we would SEGV trying), so we
4559 trick the o/s to tell us whether p is a valid pointer.
4560 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4561 not validate p in that case. */
4565 int valid
= (emacs_write (fd
[1], (char *) p
, 16) == 16);
4566 emacs_close (fd
[1]);
4567 emacs_close (fd
[0]);
4575 /* Return 1 if OBJ is a valid lisp object.
4576 Return 0 if OBJ is NOT a valid lisp object.
4577 Return -1 if we cannot validate OBJ.
4578 This function can be quite slow,
4579 so it should only be used in code for manual debugging. */
4582 valid_lisp_object_p (Lisp_Object obj
)
4592 p
= (void *) XPNTR (obj
);
4593 if (PURE_POINTER_P (p
))
4597 return valid_pointer_p (p
);
4604 int valid
= valid_pointer_p (p
);
4616 case MEM_TYPE_NON_LISP
:
4619 case MEM_TYPE_BUFFER
:
4620 return live_buffer_p (m
, p
);
4623 return live_cons_p (m
, p
);
4625 case MEM_TYPE_STRING
:
4626 return live_string_p (m
, p
);
4629 return live_misc_p (m
, p
);
4631 case MEM_TYPE_SYMBOL
:
4632 return live_symbol_p (m
, p
);
4634 case MEM_TYPE_FLOAT
:
4635 return live_float_p (m
, p
);
4637 case MEM_TYPE_VECTORLIKE
:
4638 return live_vector_p (m
, p
);
4651 /***********************************************************************
4652 Pure Storage Management
4653 ***********************************************************************/
4655 /* Allocate room for SIZE bytes from pure Lisp storage and return a
4656 pointer to it. TYPE is the Lisp type for which the memory is
4657 allocated. TYPE < 0 means it's not used for a Lisp object. */
4659 static POINTER_TYPE
*
4660 pure_alloc (size_t size
, int type
)
4662 POINTER_TYPE
*result
;
4664 size_t alignment
= (1 << GCTYPEBITS
);
4666 size_t alignment
= sizeof (EMACS_INT
);
4668 /* Give Lisp_Floats an extra alignment. */
4669 if (type
== Lisp_Float
)
4671 #if defined __GNUC__ && __GNUC__ >= 2
4672 alignment
= __alignof (struct Lisp_Float
);
4674 alignment
= sizeof (struct Lisp_Float
);
4682 /* Allocate space for a Lisp object from the beginning of the free
4683 space with taking account of alignment. */
4684 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
4685 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
4689 /* Allocate space for a non-Lisp object from the end of the free
4691 pure_bytes_used_non_lisp
+= size
;
4692 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4694 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
4696 if (pure_bytes_used
<= pure_size
)
4699 /* Don't allocate a large amount here,
4700 because it might get mmap'd and then its address
4701 might not be usable. */
4702 purebeg
= (char *) xmalloc (10000);
4704 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
4705 pure_bytes_used
= 0;
4706 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
4711 /* Print a warning if PURESIZE is too small. */
4714 check_pure_size (void)
4716 if (pure_bytes_used_before_overflow
)
4717 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
4719 pure_bytes_used
+ pure_bytes_used_before_overflow
);
4723 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
4724 the non-Lisp data pool of the pure storage, and return its start
4725 address. Return NULL if not found. */
4728 find_string_data_in_pure (const char *data
, EMACS_INT nbytes
)
4731 EMACS_INT skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
4732 const unsigned char *p
;
4735 if (pure_bytes_used_non_lisp
< nbytes
+ 1)
4738 /* Set up the Boyer-Moore table. */
4740 for (i
= 0; i
< 256; i
++)
4743 p
= (const unsigned char *) data
;
4745 bm_skip
[*p
++] = skip
;
4747 last_char_skip
= bm_skip
['\0'];
4749 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4750 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
4752 /* See the comments in the function `boyer_moore' (search.c) for the
4753 use of `infinity'. */
4754 infinity
= pure_bytes_used_non_lisp
+ 1;
4755 bm_skip
['\0'] = infinity
;
4757 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
4761 /* Check the last character (== '\0'). */
4764 start
+= bm_skip
[*(p
+ start
)];
4766 while (start
<= start_max
);
4768 if (start
< infinity
)
4769 /* Couldn't find the last character. */
4772 /* No less than `infinity' means we could find the last
4773 character at `p[start - infinity]'. */
4776 /* Check the remaining characters. */
4777 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
4779 return non_lisp_beg
+ start
;
4781 start
+= last_char_skip
;
4783 while (start
<= start_max
);
4789 /* Return a string allocated in pure space. DATA is a buffer holding
4790 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
4791 non-zero means make the result string multibyte.
4793 Must get an error if pure storage is full, since if it cannot hold
4794 a large string it may be able to hold conses that point to that
4795 string; then the string is not protected from gc. */
4798 make_pure_string (const char *data
,
4799 EMACS_INT nchars
, EMACS_INT nbytes
, int multibyte
)
4802 struct Lisp_String
*s
;
4804 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
4805 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
4806 if (s
->data
== NULL
)
4808 s
->data
= (unsigned char *) pure_alloc (nbytes
+ 1, -1);
4809 memcpy (s
->data
, data
, nbytes
);
4810 s
->data
[nbytes
] = '\0';
4813 s
->size_byte
= multibyte
? nbytes
: -1;
4814 s
->intervals
= NULL_INTERVAL
;
4815 XSETSTRING (string
, s
);
4819 /* Return a string a string allocated in pure space. Do not allocate
4820 the string data, just point to DATA. */
4823 make_pure_c_string (const char *data
)
4826 struct Lisp_String
*s
;
4827 EMACS_INT nchars
= strlen (data
);
4829 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
4832 s
->data
= (unsigned char *) data
;
4833 s
->intervals
= NULL_INTERVAL
;
4834 XSETSTRING (string
, s
);
4838 /* Return a cons allocated from pure space. Give it pure copies
4839 of CAR as car and CDR as cdr. */
4842 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
4844 register Lisp_Object
new;
4845 struct Lisp_Cons
*p
;
4847 p
= (struct Lisp_Cons
*) pure_alloc (sizeof *p
, Lisp_Cons
);
4849 XSETCAR (new, Fpurecopy (car
));
4850 XSETCDR (new, Fpurecopy (cdr
));
4855 /* Value is a float object with value NUM allocated from pure space. */
4858 make_pure_float (double num
)
4860 register Lisp_Object
new;
4861 struct Lisp_Float
*p
;
4863 p
= (struct Lisp_Float
*) pure_alloc (sizeof *p
, Lisp_Float
);
4865 XFLOAT_INIT (new, num
);
4870 /* Return a vector with room for LEN Lisp_Objects allocated from
4874 make_pure_vector (EMACS_INT len
)
4877 struct Lisp_Vector
*p
;
4878 size_t size
= (offsetof (struct Lisp_Vector
, contents
)
4879 + len
* sizeof (Lisp_Object
));
4881 p
= (struct Lisp_Vector
*) pure_alloc (size
, Lisp_Vectorlike
);
4882 XSETVECTOR (new, p
);
4883 XVECTOR (new)->header
.size
= len
;
4888 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
4889 doc
: /* Make a copy of object OBJ in pure storage.
4890 Recursively copies contents of vectors and cons cells.
4891 Does not copy symbols. Copies strings without text properties. */)
4892 (register Lisp_Object obj
)
4894 if (NILP (Vpurify_flag
))
4897 if (PURE_POINTER_P (XPNTR (obj
)))
4900 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
4902 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
4908 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
4909 else if (FLOATP (obj
))
4910 obj
= make_pure_float (XFLOAT_DATA (obj
));
4911 else if (STRINGP (obj
))
4912 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
4914 STRING_MULTIBYTE (obj
));
4915 else if (COMPILEDP (obj
) || VECTORP (obj
))
4917 register struct Lisp_Vector
*vec
;
4918 register EMACS_INT i
;
4922 if (size
& PSEUDOVECTOR_FLAG
)
4923 size
&= PSEUDOVECTOR_SIZE_MASK
;
4924 vec
= XVECTOR (make_pure_vector (size
));
4925 for (i
= 0; i
< size
; i
++)
4926 vec
->contents
[i
] = Fpurecopy (XVECTOR (obj
)->contents
[i
]);
4927 if (COMPILEDP (obj
))
4929 XSETPVECTYPE (vec
, PVEC_COMPILED
);
4930 XSETCOMPILED (obj
, vec
);
4933 XSETVECTOR (obj
, vec
);
4935 else if (MARKERP (obj
))
4936 error ("Attempt to copy a marker to pure storage");
4938 /* Not purified, don't hash-cons. */
4941 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
4942 Fputhash (obj
, obj
, Vpurify_flag
);
4949 /***********************************************************************
4951 ***********************************************************************/
4953 /* Put an entry in staticvec, pointing at the variable with address
4957 staticpro (Lisp_Object
*varaddress
)
4959 staticvec
[staticidx
++] = varaddress
;
4960 if (staticidx
>= NSTATICS
)
4965 /***********************************************************************
4967 ***********************************************************************/
4969 /* Temporarily prevent garbage collection. */
4972 inhibit_garbage_collection (void)
4974 int count
= SPECPDL_INDEX ();
4976 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
4981 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
4982 doc
: /* Reclaim storage for Lisp objects no longer needed.
4983 Garbage collection happens automatically if you cons more than
4984 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
4985 `garbage-collect' normally returns a list with info on amount of space in use:
4986 ((USED-CONSES . FREE-CONSES) (USED-SYMS . FREE-SYMS)
4987 (USED-MARKERS . FREE-MARKERS) USED-STRING-CHARS USED-VECTOR-SLOTS
4988 (USED-FLOATS . FREE-FLOATS) (USED-INTERVALS . FREE-INTERVALS)
4989 (USED-STRINGS . FREE-STRINGS))
4990 However, if there was overflow in pure space, `garbage-collect'
4991 returns nil, because real GC can't be done. */)
4994 register struct specbinding
*bind
;
4995 char stack_top_variable
;
4998 Lisp_Object total
[8];
4999 int count
= SPECPDL_INDEX ();
5000 EMACS_TIME t1
, t2
, t3
;
5005 /* Can't GC if pure storage overflowed because we can't determine
5006 if something is a pure object or not. */
5007 if (pure_bytes_used_before_overflow
)
5012 /* Don't keep undo information around forever.
5013 Do this early on, so it is no problem if the user quits. */
5015 register struct buffer
*nextb
= all_buffers
;
5019 /* If a buffer's undo list is Qt, that means that undo is
5020 turned off in that buffer. Calling truncate_undo_list on
5021 Qt tends to return NULL, which effectively turns undo back on.
5022 So don't call truncate_undo_list if undo_list is Qt. */
5023 if (! NILP (nextb
->BUFFER_INTERNAL_FIELD (name
)) && ! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
5024 truncate_undo_list (nextb
);
5026 /* Shrink buffer gaps, but skip indirect and dead buffers. */
5027 if (nextb
->base_buffer
== 0 && !NILP (nextb
->BUFFER_INTERNAL_FIELD (name
))
5028 && ! nextb
->text
->inhibit_shrinking
)
5030 /* If a buffer's gap size is more than 10% of the buffer
5031 size, or larger than 2000 bytes, then shrink it
5032 accordingly. Keep a minimum size of 20 bytes. */
5033 int size
= min (2000, max (20, (nextb
->text
->z_byte
/ 10)));
5035 if (nextb
->text
->gap_size
> size
)
5037 struct buffer
*save_current
= current_buffer
;
5038 current_buffer
= nextb
;
5039 make_gap (-(nextb
->text
->gap_size
- size
));
5040 current_buffer
= save_current
;
5044 nextb
= nextb
->header
.next
.buffer
;
5048 EMACS_GET_TIME (t1
);
5050 /* In case user calls debug_print during GC,
5051 don't let that cause a recursive GC. */
5052 consing_since_gc
= 0;
5054 /* Save what's currently displayed in the echo area. */
5055 message_p
= push_message ();
5056 record_unwind_protect (pop_message_unwind
, Qnil
);
5058 /* Save a copy of the contents of the stack, for debugging. */
5059 #if MAX_SAVE_STACK > 0
5060 if (NILP (Vpurify_flag
))
5063 ptrdiff_t stack_size
;
5064 if (&stack_top_variable
< stack_bottom
)
5066 stack
= &stack_top_variable
;
5067 stack_size
= stack_bottom
- &stack_top_variable
;
5071 stack
= stack_bottom
;
5072 stack_size
= &stack_top_variable
- stack_bottom
;
5074 if (stack_size
<= MAX_SAVE_STACK
)
5076 if (stack_copy_size
< stack_size
)
5078 stack_copy
= (char *) xrealloc (stack_copy
, stack_size
);
5079 stack_copy_size
= stack_size
;
5081 memcpy (stack_copy
, stack
, stack_size
);
5084 #endif /* MAX_SAVE_STACK > 0 */
5086 if (garbage_collection_messages
)
5087 message1_nolog ("Garbage collecting...");
5091 shrink_regexp_cache ();
5095 /* clear_marks (); */
5097 /* Mark all the special slots that serve as the roots of accessibility. */
5099 for (i
= 0; i
< staticidx
; i
++)
5100 mark_object (*staticvec
[i
]);
5102 for (bind
= specpdl
; bind
!= specpdl_ptr
; bind
++)
5104 mark_object (bind
->symbol
);
5105 mark_object (bind
->old_value
);
5113 extern void xg_mark_data (void);
5118 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5119 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5123 register struct gcpro
*tail
;
5124 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5125 for (i
= 0; i
< tail
->nvars
; i
++)
5126 mark_object (tail
->var
[i
]);
5130 struct catchtag
*catch;
5131 struct handler
*handler
;
5133 for (catch = catchlist
; catch; catch = catch->next
)
5135 mark_object (catch->tag
);
5136 mark_object (catch->val
);
5138 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5140 mark_object (handler
->handler
);
5141 mark_object (handler
->var
);
5147 #ifdef HAVE_WINDOW_SYSTEM
5148 mark_fringe_data ();
5151 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5155 /* Everything is now marked, except for the things that require special
5156 finalization, i.e. the undo_list.
5157 Look thru every buffer's undo list
5158 for elements that update markers that were not marked,
5161 register struct buffer
*nextb
= all_buffers
;
5165 /* If a buffer's undo list is Qt, that means that undo is
5166 turned off in that buffer. Calling truncate_undo_list on
5167 Qt tends to return NULL, which effectively turns undo back on.
5168 So don't call truncate_undo_list if undo_list is Qt. */
5169 if (! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
5171 Lisp_Object tail
, prev
;
5172 tail
= nextb
->BUFFER_INTERNAL_FIELD (undo_list
);
5174 while (CONSP (tail
))
5176 if (CONSP (XCAR (tail
))
5177 && MARKERP (XCAR (XCAR (tail
)))
5178 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5181 nextb
->BUFFER_INTERNAL_FIELD (undo_list
) = tail
= XCDR (tail
);
5185 XSETCDR (prev
, tail
);
5195 /* Now that we have stripped the elements that need not be in the
5196 undo_list any more, we can finally mark the list. */
5197 mark_object (nextb
->BUFFER_INTERNAL_FIELD (undo_list
));
5199 nextb
= nextb
->header
.next
.buffer
;
5205 /* Clear the mark bits that we set in certain root slots. */
5207 unmark_byte_stack ();
5208 VECTOR_UNMARK (&buffer_defaults
);
5209 VECTOR_UNMARK (&buffer_local_symbols
);
5211 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5219 /* clear_marks (); */
5222 consing_since_gc
= 0;
5223 if (gc_cons_threshold
< 10000)
5224 gc_cons_threshold
= 10000;
5226 gc_relative_threshold
= 0;
5227 if (FLOATP (Vgc_cons_percentage
))
5228 { /* Set gc_cons_combined_threshold. */
5231 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5232 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5233 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5234 tot
+= total_string_size
;
5235 tot
+= total_vector_size
* sizeof (Lisp_Object
);
5236 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5237 tot
+= total_intervals
* sizeof (struct interval
);
5238 tot
+= total_strings
* sizeof (struct Lisp_String
);
5240 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5243 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5244 gc_relative_threshold
= tot
;
5246 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5250 if (garbage_collection_messages
)
5252 if (message_p
|| minibuf_level
> 0)
5255 message1_nolog ("Garbage collecting...done");
5258 unbind_to (count
, Qnil
);
5260 total
[0] = Fcons (make_number (total_conses
),
5261 make_number (total_free_conses
));
5262 total
[1] = Fcons (make_number (total_symbols
),
5263 make_number (total_free_symbols
));
5264 total
[2] = Fcons (make_number (total_markers
),
5265 make_number (total_free_markers
));
5266 total
[3] = make_number (total_string_size
);
5267 total
[4] = make_number (total_vector_size
);
5268 total
[5] = Fcons (make_number (total_floats
),
5269 make_number (total_free_floats
));
5270 total
[6] = Fcons (make_number (total_intervals
),
5271 make_number (total_free_intervals
));
5272 total
[7] = Fcons (make_number (total_strings
),
5273 make_number (total_free_strings
));
5275 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5277 /* Compute average percentage of zombies. */
5280 for (i
= 0; i
< 7; ++i
)
5281 if (CONSP (total
[i
]))
5282 nlive
+= XFASTINT (XCAR (total
[i
]));
5284 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5285 max_live
= max (nlive
, max_live
);
5286 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5287 max_zombies
= max (nzombies
, max_zombies
);
5292 if (!NILP (Vpost_gc_hook
))
5294 int gc_count
= inhibit_garbage_collection ();
5295 safe_run_hooks (Qpost_gc_hook
);
5296 unbind_to (gc_count
, Qnil
);
5299 /* Accumulate statistics. */
5300 EMACS_GET_TIME (t2
);
5301 EMACS_SUB_TIME (t3
, t2
, t1
);
5302 if (FLOATP (Vgc_elapsed
))
5303 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
) +
5305 EMACS_USECS (t3
) * 1.0e-6);
5308 return Flist (sizeof total
/ sizeof *total
, total
);
5312 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5313 only interesting objects referenced from glyphs are strings. */
5316 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5318 struct glyph_row
*row
= matrix
->rows
;
5319 struct glyph_row
*end
= row
+ matrix
->nrows
;
5321 for (; row
< end
; ++row
)
5325 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5327 struct glyph
*glyph
= row
->glyphs
[area
];
5328 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5330 for (; glyph
< end_glyph
; ++glyph
)
5331 if (STRINGP (glyph
->object
)
5332 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5333 mark_object (glyph
->object
);
5339 /* Mark Lisp faces in the face cache C. */
5342 mark_face_cache (struct face_cache
*c
)
5347 for (i
= 0; i
< c
->used
; ++i
)
5349 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5353 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5354 mark_object (face
->lface
[j
]);
5362 /* Mark reference to a Lisp_Object.
5363 If the object referred to has not been seen yet, recursively mark
5364 all the references contained in it. */
5366 #define LAST_MARKED_SIZE 500
5367 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5368 static int last_marked_index
;
5370 /* For debugging--call abort when we cdr down this many
5371 links of a list, in mark_object. In debugging,
5372 the call to abort will hit a breakpoint.
5373 Normally this is zero and the check never goes off. */
5374 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5377 mark_vectorlike (struct Lisp_Vector
*ptr
)
5379 EMACS_INT size
= ptr
->header
.size
;
5382 eassert (!VECTOR_MARKED_P (ptr
));
5383 VECTOR_MARK (ptr
); /* Else mark it */
5384 if (size
& PSEUDOVECTOR_FLAG
)
5385 size
&= PSEUDOVECTOR_SIZE_MASK
;
5387 /* Note that this size is not the memory-footprint size, but only
5388 the number of Lisp_Object fields that we should trace.
5389 The distinction is used e.g. by Lisp_Process which places extra
5390 non-Lisp_Object fields at the end of the structure. */
5391 for (i
= 0; i
< size
; i
++) /* and then mark its elements */
5392 mark_object (ptr
->contents
[i
]);
5395 /* Like mark_vectorlike but optimized for char-tables (and
5396 sub-char-tables) assuming that the contents are mostly integers or
5400 mark_char_table (struct Lisp_Vector
*ptr
)
5402 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5405 eassert (!VECTOR_MARKED_P (ptr
));
5407 for (i
= 0; i
< size
; i
++)
5409 Lisp_Object val
= ptr
->contents
[i
];
5411 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5413 if (SUB_CHAR_TABLE_P (val
))
5415 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5416 mark_char_table (XVECTOR (val
));
5424 mark_object (Lisp_Object arg
)
5426 register Lisp_Object obj
= arg
;
5427 #ifdef GC_CHECK_MARKED_OBJECTS
5431 ptrdiff_t cdr_count
= 0;
5435 if (PURE_POINTER_P (XPNTR (obj
)))
5438 last_marked
[last_marked_index
++] = obj
;
5439 if (last_marked_index
== LAST_MARKED_SIZE
)
5440 last_marked_index
= 0;
5442 /* Perform some sanity checks on the objects marked here. Abort if
5443 we encounter an object we know is bogus. This increases GC time
5444 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5445 #ifdef GC_CHECK_MARKED_OBJECTS
5447 po
= (void *) XPNTR (obj
);
5449 /* Check that the object pointed to by PO is known to be a Lisp
5450 structure allocated from the heap. */
5451 #define CHECK_ALLOCATED() \
5453 m = mem_find (po); \
5458 /* Check that the object pointed to by PO is live, using predicate
5460 #define CHECK_LIVE(LIVEP) \
5462 if (!LIVEP (m, po)) \
5466 /* Check both of the above conditions. */
5467 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5469 CHECK_ALLOCATED (); \
5470 CHECK_LIVE (LIVEP); \
5473 #else /* not GC_CHECK_MARKED_OBJECTS */
5475 #define CHECK_LIVE(LIVEP) (void) 0
5476 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5478 #endif /* not GC_CHECK_MARKED_OBJECTS */
5480 switch (SWITCH_ENUM_CAST (XTYPE (obj
)))
5484 register struct Lisp_String
*ptr
= XSTRING (obj
);
5485 if (STRING_MARKED_P (ptr
))
5487 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
5488 MARK_INTERVAL_TREE (ptr
->intervals
);
5490 #ifdef GC_CHECK_STRING_BYTES
5491 /* Check that the string size recorded in the string is the
5492 same as the one recorded in the sdata structure. */
5493 CHECK_STRING_BYTES (ptr
);
5494 #endif /* GC_CHECK_STRING_BYTES */
5498 case Lisp_Vectorlike
:
5499 if (VECTOR_MARKED_P (XVECTOR (obj
)))
5501 #ifdef GC_CHECK_MARKED_OBJECTS
5503 if (m
== MEM_NIL
&& !SUBRP (obj
)
5504 && po
!= &buffer_defaults
5505 && po
!= &buffer_local_symbols
)
5507 #endif /* GC_CHECK_MARKED_OBJECTS */
5511 #ifdef GC_CHECK_MARKED_OBJECTS
5512 if (po
!= &buffer_defaults
&& po
!= &buffer_local_symbols
)
5515 for (b
= all_buffers
; b
&& b
!= po
; b
= b
->header
.next
.buffer
)
5520 #endif /* GC_CHECK_MARKED_OBJECTS */
5523 else if (SUBRP (obj
))
5525 else if (COMPILEDP (obj
))
5526 /* We could treat this just like a vector, but it is better to
5527 save the COMPILED_CONSTANTS element for last and avoid
5530 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5531 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5534 CHECK_LIVE (live_vector_p
);
5535 VECTOR_MARK (ptr
); /* Else mark it */
5536 for (i
= 0; i
< size
; i
++) /* and then mark its elements */
5538 if (i
!= COMPILED_CONSTANTS
)
5539 mark_object (ptr
->contents
[i
]);
5541 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
5544 else if (FRAMEP (obj
))
5546 register struct frame
*ptr
= XFRAME (obj
);
5547 mark_vectorlike (XVECTOR (obj
));
5548 mark_face_cache (ptr
->face_cache
);
5550 else if (WINDOWP (obj
))
5552 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5553 struct window
*w
= XWINDOW (obj
);
5554 mark_vectorlike (ptr
);
5555 /* Mark glyphs for leaf windows. Marking window matrices is
5556 sufficient because frame matrices use the same glyph
5558 if (NILP (w
->hchild
)
5560 && w
->current_matrix
)
5562 mark_glyph_matrix (w
->current_matrix
);
5563 mark_glyph_matrix (w
->desired_matrix
);
5566 else if (HASH_TABLE_P (obj
))
5568 struct Lisp_Hash_Table
*h
= XHASH_TABLE (obj
);
5569 mark_vectorlike ((struct Lisp_Vector
*)h
);
5570 /* If hash table is not weak, mark all keys and values.
5571 For weak tables, mark only the vector. */
5573 mark_object (h
->key_and_value
);
5575 VECTOR_MARK (XVECTOR (h
->key_and_value
));
5577 else if (CHAR_TABLE_P (obj
))
5578 mark_char_table (XVECTOR (obj
));
5580 mark_vectorlike (XVECTOR (obj
));
5585 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
5586 struct Lisp_Symbol
*ptrx
;
5590 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
5592 mark_object (ptr
->function
);
5593 mark_object (ptr
->plist
);
5594 switch (ptr
->redirect
)
5596 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
5597 case SYMBOL_VARALIAS
:
5600 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
5604 case SYMBOL_LOCALIZED
:
5606 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
5607 /* If the value is forwarded to a buffer or keyboard field,
5608 these are marked when we see the corresponding object.
5609 And if it's forwarded to a C variable, either it's not
5610 a Lisp_Object var, or it's staticpro'd already. */
5611 mark_object (blv
->where
);
5612 mark_object (blv
->valcell
);
5613 mark_object (blv
->defcell
);
5616 case SYMBOL_FORWARDED
:
5617 /* If the value is forwarded to a buffer or keyboard field,
5618 these are marked when we see the corresponding object.
5619 And if it's forwarded to a C variable, either it's not
5620 a Lisp_Object var, or it's staticpro'd already. */
5624 if (!PURE_POINTER_P (XSTRING (ptr
->xname
)))
5625 MARK_STRING (XSTRING (ptr
->xname
));
5626 MARK_INTERVAL_TREE (STRING_INTERVALS (ptr
->xname
));
5631 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun */
5632 XSETSYMBOL (obj
, ptrx
);
5639 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
5640 if (XMISCANY (obj
)->gcmarkbit
)
5642 XMISCANY (obj
)->gcmarkbit
= 1;
5644 switch (XMISCTYPE (obj
))
5647 case Lisp_Misc_Marker
:
5648 /* DO NOT mark thru the marker's chain.
5649 The buffer's markers chain does not preserve markers from gc;
5650 instead, markers are removed from the chain when freed by gc. */
5653 case Lisp_Misc_Save_Value
:
5656 register struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
5657 /* If DOGC is set, POINTER is the address of a memory
5658 area containing INTEGER potential Lisp_Objects. */
5661 Lisp_Object
*p
= (Lisp_Object
*) ptr
->pointer
;
5663 for (nelt
= ptr
->integer
; nelt
> 0; nelt
--, p
++)
5664 mark_maybe_object (*p
);
5670 case Lisp_Misc_Overlay
:
5672 struct Lisp_Overlay
*ptr
= XOVERLAY (obj
);
5673 mark_object (ptr
->start
);
5674 mark_object (ptr
->end
);
5675 mark_object (ptr
->plist
);
5678 XSETMISC (obj
, ptr
->next
);
5691 register struct Lisp_Cons
*ptr
= XCONS (obj
);
5692 if (CONS_MARKED_P (ptr
))
5694 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
5696 /* If the cdr is nil, avoid recursion for the car. */
5697 if (EQ (ptr
->u
.cdr
, Qnil
))
5703 mark_object (ptr
->car
);
5706 if (cdr_count
== mark_object_loop_halt
)
5712 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
5713 FLOAT_MARK (XFLOAT (obj
));
5724 #undef CHECK_ALLOCATED
5725 #undef CHECK_ALLOCATED_AND_LIVE
5728 /* Mark the pointers in a buffer structure. */
5731 mark_buffer (Lisp_Object buf
)
5733 register struct buffer
*buffer
= XBUFFER (buf
);
5734 register Lisp_Object
*ptr
, tmp
;
5735 Lisp_Object base_buffer
;
5737 eassert (!VECTOR_MARKED_P (buffer
));
5738 VECTOR_MARK (buffer
);
5740 MARK_INTERVAL_TREE (BUF_INTERVALS (buffer
));
5742 /* For now, we just don't mark the undo_list. It's done later in
5743 a special way just before the sweep phase, and after stripping
5744 some of its elements that are not needed any more. */
5746 if (buffer
->overlays_before
)
5748 XSETMISC (tmp
, buffer
->overlays_before
);
5751 if (buffer
->overlays_after
)
5753 XSETMISC (tmp
, buffer
->overlays_after
);
5757 /* buffer-local Lisp variables start at `undo_list',
5758 tho only the ones from `name' on are GC'd normally. */
5759 for (ptr
= &buffer
->BUFFER_INTERNAL_FIELD (name
);
5760 ptr
<= &PER_BUFFER_VALUE (buffer
,
5761 PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER
));
5765 /* If this is an indirect buffer, mark its base buffer. */
5766 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5768 XSETBUFFER (base_buffer
, buffer
->base_buffer
);
5769 mark_buffer (base_buffer
);
5773 /* Mark the Lisp pointers in the terminal objects.
5774 Called by the Fgarbage_collector. */
5777 mark_terminals (void)
5780 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5782 eassert (t
->name
!= NULL
);
5783 #ifdef HAVE_WINDOW_SYSTEM
5784 /* If a terminal object is reachable from a stacpro'ed object,
5785 it might have been marked already. Make sure the image cache
5787 mark_image_cache (t
->image_cache
);
5788 #endif /* HAVE_WINDOW_SYSTEM */
5789 if (!VECTOR_MARKED_P (t
))
5790 mark_vectorlike ((struct Lisp_Vector
*)t
);
5796 /* Value is non-zero if OBJ will survive the current GC because it's
5797 either marked or does not need to be marked to survive. */
5800 survives_gc_p (Lisp_Object obj
)
5804 switch (XTYPE (obj
))
5811 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
5815 survives_p
= XMISCANY (obj
)->gcmarkbit
;
5819 survives_p
= STRING_MARKED_P (XSTRING (obj
));
5822 case Lisp_Vectorlike
:
5823 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
5827 survives_p
= CONS_MARKED_P (XCONS (obj
));
5831 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
5838 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
5843 /* Sweep: find all structures not marked, and free them. */
5848 /* Remove or mark entries in weak hash tables.
5849 This must be done before any object is unmarked. */
5850 sweep_weak_hash_tables ();
5853 #ifdef GC_CHECK_STRING_BYTES
5854 if (!noninteractive
)
5855 check_string_bytes (1);
5858 /* Put all unmarked conses on free list */
5860 register struct cons_block
*cblk
;
5861 struct cons_block
**cprev
= &cons_block
;
5862 register int lim
= cons_block_index
;
5863 EMACS_INT num_free
= 0, num_used
= 0;
5867 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
5871 int ilim
= (lim
+ BITS_PER_INT
- 1) / BITS_PER_INT
;
5873 /* Scan the mark bits an int at a time. */
5874 for (i
= 0; i
< ilim
; i
++)
5876 if (cblk
->gcmarkbits
[i
] == -1)
5878 /* Fast path - all cons cells for this int are marked. */
5879 cblk
->gcmarkbits
[i
] = 0;
5880 num_used
+= BITS_PER_INT
;
5884 /* Some cons cells for this int are not marked.
5885 Find which ones, and free them. */
5886 int start
, pos
, stop
;
5888 start
= i
* BITS_PER_INT
;
5890 if (stop
> BITS_PER_INT
)
5891 stop
= BITS_PER_INT
;
5894 for (pos
= start
; pos
< stop
; pos
++)
5896 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
5899 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
5900 cons_free_list
= &cblk
->conses
[pos
];
5902 cons_free_list
->car
= Vdead
;
5908 CONS_UNMARK (&cblk
->conses
[pos
]);
5914 lim
= CONS_BLOCK_SIZE
;
5915 /* If this block contains only free conses and we have already
5916 seen more than two blocks worth of free conses then deallocate
5918 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
5920 *cprev
= cblk
->next
;
5921 /* Unhook from the free list. */
5922 cons_free_list
= cblk
->conses
[0].u
.chain
;
5923 lisp_align_free (cblk
);
5927 num_free
+= this_free
;
5928 cprev
= &cblk
->next
;
5931 total_conses
= num_used
;
5932 total_free_conses
= num_free
;
5935 /* Put all unmarked floats on free list */
5937 register struct float_block
*fblk
;
5938 struct float_block
**fprev
= &float_block
;
5939 register int lim
= float_block_index
;
5940 EMACS_INT num_free
= 0, num_used
= 0;
5942 float_free_list
= 0;
5944 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
5948 for (i
= 0; i
< lim
; i
++)
5949 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
5952 fblk
->floats
[i
].u
.chain
= float_free_list
;
5953 float_free_list
= &fblk
->floats
[i
];
5958 FLOAT_UNMARK (&fblk
->floats
[i
]);
5960 lim
= FLOAT_BLOCK_SIZE
;
5961 /* If this block contains only free floats and we have already
5962 seen more than two blocks worth of free floats then deallocate
5964 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
5966 *fprev
= fblk
->next
;
5967 /* Unhook from the free list. */
5968 float_free_list
= fblk
->floats
[0].u
.chain
;
5969 lisp_align_free (fblk
);
5973 num_free
+= this_free
;
5974 fprev
= &fblk
->next
;
5977 total_floats
= num_used
;
5978 total_free_floats
= num_free
;
5981 /* Put all unmarked intervals on free list */
5983 register struct interval_block
*iblk
;
5984 struct interval_block
**iprev
= &interval_block
;
5985 register int lim
= interval_block_index
;
5986 EMACS_INT num_free
= 0, num_used
= 0;
5988 interval_free_list
= 0;
5990 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
5995 for (i
= 0; i
< lim
; i
++)
5997 if (!iblk
->intervals
[i
].gcmarkbit
)
5999 SET_INTERVAL_PARENT (&iblk
->intervals
[i
], interval_free_list
);
6000 interval_free_list
= &iblk
->intervals
[i
];
6006 iblk
->intervals
[i
].gcmarkbit
= 0;
6009 lim
= INTERVAL_BLOCK_SIZE
;
6010 /* If this block contains only free intervals and we have already
6011 seen more than two blocks worth of free intervals then
6012 deallocate this block. */
6013 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6015 *iprev
= iblk
->next
;
6016 /* Unhook from the free list. */
6017 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6022 num_free
+= this_free
;
6023 iprev
= &iblk
->next
;
6026 total_intervals
= num_used
;
6027 total_free_intervals
= num_free
;
6030 /* Put all unmarked symbols on free list */
6032 register struct symbol_block
*sblk
;
6033 struct symbol_block
**sprev
= &symbol_block
;
6034 register int lim
= symbol_block_index
;
6035 EMACS_INT num_free
= 0, num_used
= 0;
6037 symbol_free_list
= NULL
;
6039 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6042 struct Lisp_Symbol
*sym
= sblk
->symbols
;
6043 struct Lisp_Symbol
*end
= sym
+ lim
;
6045 for (; sym
< end
; ++sym
)
6047 /* Check if the symbol was created during loadup. In such a case
6048 it might be pointed to by pure bytecode which we don't trace,
6049 so we conservatively assume that it is live. */
6050 int pure_p
= PURE_POINTER_P (XSTRING (sym
->xname
));
6052 if (!sym
->gcmarkbit
&& !pure_p
)
6054 if (sym
->redirect
== SYMBOL_LOCALIZED
)
6055 xfree (SYMBOL_BLV (sym
));
6056 sym
->next
= symbol_free_list
;
6057 symbol_free_list
= sym
;
6059 symbol_free_list
->function
= Vdead
;
6067 UNMARK_STRING (XSTRING (sym
->xname
));
6072 lim
= SYMBOL_BLOCK_SIZE
;
6073 /* If this block contains only free symbols and we have already
6074 seen more than two blocks worth of free symbols then deallocate
6076 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6078 *sprev
= sblk
->next
;
6079 /* Unhook from the free list. */
6080 symbol_free_list
= sblk
->symbols
[0].next
;
6085 num_free
+= this_free
;
6086 sprev
= &sblk
->next
;
6089 total_symbols
= num_used
;
6090 total_free_symbols
= num_free
;
6093 /* Put all unmarked misc's on free list.
6094 For a marker, first unchain it from the buffer it points into. */
6096 register struct marker_block
*mblk
;
6097 struct marker_block
**mprev
= &marker_block
;
6098 register int lim
= marker_block_index
;
6099 EMACS_INT num_free
= 0, num_used
= 0;
6101 marker_free_list
= 0;
6103 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6108 for (i
= 0; i
< lim
; i
++)
6110 if (!mblk
->markers
[i
].u_any
.gcmarkbit
)
6112 if (mblk
->markers
[i
].u_any
.type
== Lisp_Misc_Marker
)
6113 unchain_marker (&mblk
->markers
[i
].u_marker
);
6114 /* Set the type of the freed object to Lisp_Misc_Free.
6115 We could leave the type alone, since nobody checks it,
6116 but this might catch bugs faster. */
6117 mblk
->markers
[i
].u_marker
.type
= Lisp_Misc_Free
;
6118 mblk
->markers
[i
].u_free
.chain
= marker_free_list
;
6119 marker_free_list
= &mblk
->markers
[i
];
6125 mblk
->markers
[i
].u_any
.gcmarkbit
= 0;
6128 lim
= MARKER_BLOCK_SIZE
;
6129 /* If this block contains only free markers and we have already
6130 seen more than two blocks worth of free markers then deallocate
6132 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6134 *mprev
= mblk
->next
;
6135 /* Unhook from the free list. */
6136 marker_free_list
= mblk
->markers
[0].u_free
.chain
;
6141 num_free
+= this_free
;
6142 mprev
= &mblk
->next
;
6146 total_markers
= num_used
;
6147 total_free_markers
= num_free
;
6150 /* Free all unmarked buffers */
6152 register struct buffer
*buffer
= all_buffers
, *prev
= 0, *next
;
6155 if (!VECTOR_MARKED_P (buffer
))
6158 prev
->header
.next
= buffer
->header
.next
;
6160 all_buffers
= buffer
->header
.next
.buffer
;
6161 next
= buffer
->header
.next
.buffer
;
6167 VECTOR_UNMARK (buffer
);
6168 UNMARK_BALANCE_INTERVALS (BUF_INTERVALS (buffer
));
6169 prev
= buffer
, buffer
= buffer
->header
.next
.buffer
;
6173 /* Free all unmarked vectors */
6175 register struct Lisp_Vector
*vector
= all_vectors
, *prev
= 0, *next
;
6176 total_vector_size
= 0;
6179 if (!VECTOR_MARKED_P (vector
))
6182 prev
->header
.next
= vector
->header
.next
;
6184 all_vectors
= vector
->header
.next
.vector
;
6185 next
= vector
->header
.next
.vector
;
6192 VECTOR_UNMARK (vector
);
6193 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
6194 total_vector_size
+= PSEUDOVECTOR_SIZE_MASK
& vector
->header
.size
;
6196 total_vector_size
+= vector
->header
.size
;
6197 prev
= vector
, vector
= vector
->header
.next
.vector
;
6201 #ifdef GC_CHECK_STRING_BYTES
6202 if (!noninteractive
)
6203 check_string_bytes (1);
6210 /* Debugging aids. */
6212 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6213 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6214 This may be helpful in debugging Emacs's memory usage.
6215 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6220 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6225 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6226 doc
: /* Return a list of counters that measure how much consing there has been.
6227 Each of these counters increments for a certain kind of object.
6228 The counters wrap around from the largest positive integer to zero.
6229 Garbage collection does not decrease them.
6230 The elements of the value are as follows:
6231 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6232 All are in units of 1 = one object consed
6233 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6235 MISCS include overlays, markers, and some internal types.
6236 Frames, windows, buffers, and subprocesses count as vectors
6237 (but the contents of a buffer's text do not count here). */)
6240 Lisp_Object consed
[8];
6242 consed
[0] = make_number (min (MOST_POSITIVE_FIXNUM
, cons_cells_consed
));
6243 consed
[1] = make_number (min (MOST_POSITIVE_FIXNUM
, floats_consed
));
6244 consed
[2] = make_number (min (MOST_POSITIVE_FIXNUM
, vector_cells_consed
));
6245 consed
[3] = make_number (min (MOST_POSITIVE_FIXNUM
, symbols_consed
));
6246 consed
[4] = make_number (min (MOST_POSITIVE_FIXNUM
, string_chars_consed
));
6247 consed
[5] = make_number (min (MOST_POSITIVE_FIXNUM
, misc_objects_consed
));
6248 consed
[6] = make_number (min (MOST_POSITIVE_FIXNUM
, intervals_consed
));
6249 consed
[7] = make_number (min (MOST_POSITIVE_FIXNUM
, strings_consed
));
6251 return Flist (8, consed
);
6254 /* Find at most FIND_MAX symbols which have OBJ as their value or
6255 function. This is used in gdbinit's `xwhichsymbols' command. */
6258 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6260 struct symbol_block
*sblk
;
6261 int gc_count
= inhibit_garbage_collection ();
6262 Lisp_Object found
= Qnil
;
6264 if (!EQ (obj
, Vdead
))
6266 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6268 struct Lisp_Symbol
*sym
= sblk
->symbols
;
6271 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, sym
++)
6276 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6279 XSETSYMBOL (tem
, sym
);
6280 val
= find_symbol_value (tem
);
6282 || EQ (sym
->function
, obj
)
6283 || (!NILP (sym
->function
)
6284 && COMPILEDP (sym
->function
)
6285 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
6288 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)))
6290 found
= Fcons (tem
, found
);
6291 if (--find_max
== 0)
6299 unbind_to (gc_count
, Qnil
);
6303 #ifdef ENABLE_CHECKING
6304 int suppress_checking
;
6307 die (const char *msg
, const char *file
, int line
)
6309 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: %s\r\n",
6315 /* Initialization */
6318 init_alloc_once (void)
6320 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6322 pure_size
= PURESIZE
;
6323 pure_bytes_used
= 0;
6324 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
6325 pure_bytes_used_before_overflow
= 0;
6327 /* Initialize the list of free aligned blocks. */
6330 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6332 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6336 ignore_warnings
= 1;
6337 #ifdef DOUG_LEA_MALLOC
6338 mallopt (M_TRIM_THRESHOLD
, 128*1024); /* trim threshold */
6339 mallopt (M_MMAP_THRESHOLD
, 64*1024); /* mmap threshold */
6340 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* max. number of mmap'ed areas */
6348 init_weak_hash_tables ();
6351 malloc_hysteresis
= 32;
6353 malloc_hysteresis
= 0;
6356 refill_memory_reserve ();
6358 ignore_warnings
= 0;
6360 byte_stack_list
= 0;
6362 consing_since_gc
= 0;
6363 gc_cons_threshold
= 100000 * sizeof (Lisp_Object
);
6364 gc_relative_threshold
= 0;
6371 byte_stack_list
= 0;
6373 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6374 setjmp_tested_p
= longjmps_done
= 0;
6377 Vgc_elapsed
= make_float (0.0);
6382 syms_of_alloc (void)
6384 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6385 doc
: /* *Number of bytes of consing between garbage collections.
6386 Garbage collection can happen automatically once this many bytes have been
6387 allocated since the last garbage collection. All data types count.
6389 Garbage collection happens automatically only when `eval' is called.
6391 By binding this temporarily to a large number, you can effectively
6392 prevent garbage collection during a part of the program.
6393 See also `gc-cons-percentage'. */);
6395 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6396 doc
: /* *Portion of the heap used for allocation.
6397 Garbage collection can happen automatically once this portion of the heap
6398 has been allocated since the last garbage collection.
6399 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6400 Vgc_cons_percentage
= make_float (0.1);
6402 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6403 doc
: /* Number of bytes of sharable Lisp data allocated so far. */);
6405 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6406 doc
: /* Number of cons cells that have been consed so far. */);
6408 DEFVAR_INT ("floats-consed", floats_consed
,
6409 doc
: /* Number of floats that have been consed so far. */);
6411 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
6412 doc
: /* Number of vector cells that have been consed so far. */);
6414 DEFVAR_INT ("symbols-consed", symbols_consed
,
6415 doc
: /* Number of symbols that have been consed so far. */);
6417 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
6418 doc
: /* Number of string characters that have been consed so far. */);
6420 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
6421 doc
: /* Number of miscellaneous objects that have been consed so far. */);
6423 DEFVAR_INT ("intervals-consed", intervals_consed
,
6424 doc
: /* Number of intervals that have been consed so far. */);
6426 DEFVAR_INT ("strings-consed", strings_consed
,
6427 doc
: /* Number of strings that have been consed so far. */);
6429 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
6430 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
6431 This means that certain objects should be allocated in shared (pure) space.
6432 It can also be set to a hash-table, in which case this table is used to
6433 do hash-consing of the objects allocated to pure space. */);
6435 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
6436 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
6437 garbage_collection_messages
= 0;
6439 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
6440 doc
: /* Hook run after garbage collection has finished. */);
6441 Vpost_gc_hook
= Qnil
;
6442 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
6444 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
6445 doc
: /* Precomputed `signal' argument for memory-full error. */);
6446 /* We build this in advance because if we wait until we need it, we might
6447 not be able to allocate the memory to hold it. */
6449 = pure_cons (Qerror
,
6450 pure_cons (make_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"), Qnil
));
6452 DEFVAR_LISP ("memory-full", Vmemory_full
,
6453 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
6454 Vmemory_full
= Qnil
;
6456 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
6457 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
6459 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
6460 doc
: /* Accumulated time elapsed in garbage collections.
6461 The time is in seconds as a floating point value. */);
6462 DEFVAR_INT ("gcs-done", gcs_done
,
6463 doc
: /* Accumulated number of garbage collections done. */);
6468 defsubr (&Smake_byte_code
);
6469 defsubr (&Smake_list
);
6470 defsubr (&Smake_vector
);
6471 defsubr (&Smake_string
);
6472 defsubr (&Smake_bool_vector
);
6473 defsubr (&Smake_symbol
);
6474 defsubr (&Smake_marker
);
6475 defsubr (&Spurecopy
);
6476 defsubr (&Sgarbage_collect
);
6477 defsubr (&Smemory_limit
);
6478 defsubr (&Smemory_use_counts
);
6480 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
6481 defsubr (&Sgc_status
);