1 /* Storage allocation and gc for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2012
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
23 #define LISP_INLINE EXTERN_INLINE
26 #include <limits.h> /* For CHAR_BIT. */
37 #include "intervals.h"
39 #include "character.h"
44 #include "blockinput.h"
45 #include "syssignal.h"
46 #include "termhooks.h" /* For struct terminal. */
50 /* GC_CHECK_MARKED_OBJECTS means do sanity checks on allocated objects.
51 Doable only if GC_MARK_STACK. */
53 # undef GC_CHECK_MARKED_OBJECTS
56 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
57 memory. Can do this only if using gmalloc.c and if not checking
60 #if (defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC \
61 || defined GC_CHECK_MARKED_OBJECTS)
62 #undef GC_MALLOC_CHECK
76 #ifdef DOUG_LEA_MALLOC
80 /* Specify maximum number of areas to mmap. It would be nice to use a
81 value that explicitly means "no limit". */
83 #define MMAP_MAX_AREAS 100000000
85 #else /* not DOUG_LEA_MALLOC */
87 /* The following come from gmalloc.c. */
89 extern size_t _bytes_used
;
90 extern size_t __malloc_extra_blocks
;
91 extern void *_malloc_internal (size_t);
92 extern void _free_internal (void *);
94 #endif /* not DOUG_LEA_MALLOC */
96 #if ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT
99 /* When GTK uses the file chooser dialog, different backends can be loaded
100 dynamically. One such a backend is the Gnome VFS backend that gets loaded
101 if you run Gnome. That backend creates several threads and also allocates
104 Also, gconf and gsettings may create several threads.
106 If Emacs sets malloc hooks (! SYSTEM_MALLOC) and the emacs_blocked_*
107 functions below are called from malloc, there is a chance that one
108 of these threads preempts the Emacs main thread and the hook variables
109 end up in an inconsistent state. So we have a mutex to prevent that (note
110 that the backend handles concurrent access to malloc within its own threads
111 but Emacs code running in the main thread is not included in that control).
113 When UNBLOCK_INPUT is called, reinvoke_input_signal may be called. If this
114 happens in one of the backend threads we will have two threads that tries
115 to run Emacs code at once, and the code is not prepared for that.
116 To prevent that, we only call BLOCK/UNBLOCK from the main thread. */
118 static pthread_mutex_t alloc_mutex
;
120 #define BLOCK_INPUT_ALLOC \
123 if (pthread_equal (pthread_self (), main_thread)) \
125 pthread_mutex_lock (&alloc_mutex); \
128 #define UNBLOCK_INPUT_ALLOC \
131 pthread_mutex_unlock (&alloc_mutex); \
132 if (pthread_equal (pthread_self (), main_thread)) \
137 #else /* ! defined HAVE_PTHREAD */
139 #define BLOCK_INPUT_ALLOC BLOCK_INPUT
140 #define UNBLOCK_INPUT_ALLOC UNBLOCK_INPUT
142 #endif /* ! defined HAVE_PTHREAD */
143 #endif /* ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT */
145 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
146 to a struct Lisp_String. */
148 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
149 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
150 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
152 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
153 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
154 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
156 /* Default value of gc_cons_threshold (see below). */
158 #define GC_DEFAULT_THRESHOLD (100000 * sizeof (Lisp_Object))
160 /* Global variables. */
161 struct emacs_globals globals
;
163 /* Number of bytes of consing done since the last gc. */
165 EMACS_INT consing_since_gc
;
167 /* Similar minimum, computed from Vgc_cons_percentage. */
169 EMACS_INT gc_relative_threshold
;
171 /* Minimum number of bytes of consing since GC before next GC,
172 when memory is full. */
174 EMACS_INT memory_full_cons_threshold
;
176 /* Nonzero during GC. */
180 /* Nonzero means abort if try to GC.
181 This is for code which is written on the assumption that
182 no GC will happen, so as to verify that assumption. */
186 /* Number of live and free conses etc. */
188 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_buffers
;
189 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
190 static EMACS_INT total_free_floats
, total_floats
;
192 /* Points to memory space allocated as "spare", to be freed if we run
193 out of memory. We keep one large block, four cons-blocks, and
194 two string blocks. */
196 static char *spare_memory
[7];
198 /* Amount of spare memory to keep in large reserve block, or to see
199 whether this much is available when malloc fails on a larger request. */
201 #define SPARE_MEMORY (1 << 14)
203 /* Number of extra blocks malloc should get when it needs more core. */
205 static int malloc_hysteresis
;
207 /* Initialize it to a nonzero value to force it into data space
208 (rather than bss space). That way unexec will remap it into text
209 space (pure), on some systems. We have not implemented the
210 remapping on more recent systems because this is less important
211 nowadays than in the days of small memories and timesharing. */
213 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
214 #define PUREBEG (char *) pure
216 /* Pointer to the pure area, and its size. */
218 static char *purebeg
;
219 static ptrdiff_t pure_size
;
221 /* Number of bytes of pure storage used before pure storage overflowed.
222 If this is non-zero, this implies that an overflow occurred. */
224 static ptrdiff_t pure_bytes_used_before_overflow
;
226 /* Value is non-zero if P points into pure space. */
228 #define PURE_POINTER_P(P) \
229 ((uintptr_t) (P) - (uintptr_t) purebeg <= pure_size)
231 /* Index in pure at which next pure Lisp object will be allocated.. */
233 static ptrdiff_t pure_bytes_used_lisp
;
235 /* Number of bytes allocated for non-Lisp objects in pure storage. */
237 static ptrdiff_t pure_bytes_used_non_lisp
;
239 /* If nonzero, this is a warning delivered by malloc and not yet
242 const char *pending_malloc_warning
;
244 /* Maximum amount of C stack to save when a GC happens. */
246 #ifndef MAX_SAVE_STACK
247 #define MAX_SAVE_STACK 16000
250 /* Buffer in which we save a copy of the C stack at each GC. */
252 #if MAX_SAVE_STACK > 0
253 static char *stack_copy
;
254 static ptrdiff_t stack_copy_size
;
257 static Lisp_Object Qstring_bytes
, Qvector_slots
, Qheap
;
258 static Lisp_Object Qgc_cons_threshold
;
259 Lisp_Object Qchar_table_extra_slots
;
261 /* Hook run after GC has finished. */
263 static Lisp_Object Qpost_gc_hook
;
265 static void mark_terminals (void);
266 static void gc_sweep (void);
267 static Lisp_Object
make_pure_vector (ptrdiff_t);
268 static void mark_glyph_matrix (struct glyph_matrix
*);
269 static void mark_face_cache (struct face_cache
*);
271 #if !defined REL_ALLOC || defined SYSTEM_MALLOC
272 static void refill_memory_reserve (void);
274 static struct Lisp_String
*allocate_string (void);
275 static void compact_small_strings (void);
276 static void free_large_strings (void);
277 static void sweep_strings (void);
278 static void free_misc (Lisp_Object
);
279 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
281 /* Handy constants for vectorlike objects. */
284 header_size
= offsetof (struct Lisp_Vector
, contents
),
285 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
286 word_size
= sizeof (Lisp_Object
)
289 /* When scanning the C stack for live Lisp objects, Emacs keeps track
290 of what memory allocated via lisp_malloc is intended for what
291 purpose. This enumeration specifies the type of memory. */
302 /* We used to keep separate mem_types for subtypes of vectors such as
303 process, hash_table, frame, terminal, and window, but we never made
304 use of the distinction, so it only caused source-code complexity
305 and runtime slowdown. Minor but pointless. */
307 /* Special type to denote vector blocks. */
308 MEM_TYPE_VECTOR_BLOCK
311 static void *lisp_malloc (size_t, enum mem_type
);
314 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
316 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
317 #include <stdio.h> /* For fprintf. */
320 /* A unique object in pure space used to make some Lisp objects
321 on free lists recognizable in O(1). */
323 static Lisp_Object Vdead
;
324 #define DEADP(x) EQ (x, Vdead)
326 #ifdef GC_MALLOC_CHECK
328 enum mem_type allocated_mem_type
;
330 #endif /* GC_MALLOC_CHECK */
332 /* A node in the red-black tree describing allocated memory containing
333 Lisp data. Each such block is recorded with its start and end
334 address when it is allocated, and removed from the tree when it
337 A red-black tree is a balanced binary tree with the following
340 1. Every node is either red or black.
341 2. Every leaf is black.
342 3. If a node is red, then both of its children are black.
343 4. Every simple path from a node to a descendant leaf contains
344 the same number of black nodes.
345 5. The root is always black.
347 When nodes are inserted into the tree, or deleted from the tree,
348 the tree is "fixed" so that these properties are always true.
350 A red-black tree with N internal nodes has height at most 2
351 log(N+1). Searches, insertions and deletions are done in O(log N).
352 Please see a text book about data structures for a detailed
353 description of red-black trees. Any book worth its salt should
358 /* Children of this node. These pointers are never NULL. When there
359 is no child, the value is MEM_NIL, which points to a dummy node. */
360 struct mem_node
*left
, *right
;
362 /* The parent of this node. In the root node, this is NULL. */
363 struct mem_node
*parent
;
365 /* Start and end of allocated region. */
369 enum {MEM_BLACK
, MEM_RED
} color
;
375 /* Base address of stack. Set in main. */
377 Lisp_Object
*stack_base
;
379 /* Root of the tree describing allocated Lisp memory. */
381 static struct mem_node
*mem_root
;
383 /* Lowest and highest known address in the heap. */
385 static void *min_heap_address
, *max_heap_address
;
387 /* Sentinel node of the tree. */
389 static struct mem_node mem_z
;
390 #define MEM_NIL &mem_z
392 static struct Lisp_Vector
*allocate_vectorlike (ptrdiff_t);
393 static void lisp_free (void *);
394 static void mark_stack (void);
395 static int live_vector_p (struct mem_node
*, void *);
396 static int live_buffer_p (struct mem_node
*, void *);
397 static int live_string_p (struct mem_node
*, void *);
398 static int live_cons_p (struct mem_node
*, void *);
399 static int live_symbol_p (struct mem_node
*, void *);
400 static int live_float_p (struct mem_node
*, void *);
401 static int live_misc_p (struct mem_node
*, void *);
402 static void mark_maybe_object (Lisp_Object
);
403 static void mark_memory (void *, void *);
404 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
405 static void mem_init (void);
406 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
407 static void mem_insert_fixup (struct mem_node
*);
409 static void mem_rotate_left (struct mem_node
*);
410 static void mem_rotate_right (struct mem_node
*);
411 static void mem_delete (struct mem_node
*);
412 static void mem_delete_fixup (struct mem_node
*);
413 static inline struct mem_node
*mem_find (void *);
416 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
417 static void check_gcpros (void);
420 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
426 /* Recording what needs to be marked for gc. */
428 struct gcpro
*gcprolist
;
430 /* Addresses of staticpro'd variables. Initialize it to a nonzero
431 value; otherwise some compilers put it into BSS. */
433 #define NSTATICS 0x650
434 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
436 /* Index of next unused slot in staticvec. */
438 static int staticidx
;
440 static void *pure_alloc (size_t, int);
443 /* Value is SZ rounded up to the next multiple of ALIGNMENT.
444 ALIGNMENT must be a power of 2. */
446 #define ALIGN(ptr, ALIGNMENT) \
447 ((void *) (((uintptr_t) (ptr) + (ALIGNMENT) - 1) \
448 & ~ ((ALIGNMENT) - 1)))
452 /************************************************************************
454 ************************************************************************/
456 /* Function malloc calls this if it finds we are near exhausting storage. */
459 malloc_warning (const char *str
)
461 pending_malloc_warning
= str
;
465 /* Display an already-pending malloc warning. */
468 display_malloc_warning (void)
470 call3 (intern ("display-warning"),
472 build_string (pending_malloc_warning
),
473 intern ("emergency"));
474 pending_malloc_warning
= 0;
477 /* Called if we can't allocate relocatable space for a buffer. */
480 buffer_memory_full (ptrdiff_t nbytes
)
482 /* If buffers use the relocating allocator, no need to free
483 spare_memory, because we may have plenty of malloc space left
484 that we could get, and if we don't, the malloc that fails will
485 itself cause spare_memory to be freed. If buffers don't use the
486 relocating allocator, treat this like any other failing
490 memory_full (nbytes
);
493 /* This used to call error, but if we've run out of memory, we could
494 get infinite recursion trying to build the string. */
495 xsignal (Qnil
, Vmemory_signal_data
);
498 /* A common multiple of the positive integers A and B. Ideally this
499 would be the least common multiple, but there's no way to do that
500 as a constant expression in C, so do the best that we can easily do. */
501 #define COMMON_MULTIPLE(a, b) \
502 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
504 #ifndef XMALLOC_OVERRUN_CHECK
505 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
508 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
511 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
512 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
513 block size in little-endian order. The trailer consists of
514 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
516 The header is used to detect whether this block has been allocated
517 through these functions, as some low-level libc functions may
518 bypass the malloc hooks. */
520 #define XMALLOC_OVERRUN_CHECK_SIZE 16
521 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
522 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
524 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
525 hold a size_t value and (2) the header size is a multiple of the
526 alignment that Emacs needs for C types and for USE_LSB_TAG. */
527 #define XMALLOC_BASE_ALIGNMENT \
528 alignof (union { long double d; intmax_t i; void *p; })
531 # define XMALLOC_HEADER_ALIGNMENT \
532 COMMON_MULTIPLE (1 << GCTYPEBITS, XMALLOC_BASE_ALIGNMENT)
534 # define XMALLOC_HEADER_ALIGNMENT XMALLOC_BASE_ALIGNMENT
536 #define XMALLOC_OVERRUN_SIZE_SIZE \
537 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
538 + XMALLOC_HEADER_ALIGNMENT - 1) \
539 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
540 - XMALLOC_OVERRUN_CHECK_SIZE)
542 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
543 { '\x9a', '\x9b', '\xae', '\xaf',
544 '\xbf', '\xbe', '\xce', '\xcf',
545 '\xea', '\xeb', '\xec', '\xed',
546 '\xdf', '\xde', '\x9c', '\x9d' };
548 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
549 { '\xaa', '\xab', '\xac', '\xad',
550 '\xba', '\xbb', '\xbc', '\xbd',
551 '\xca', '\xcb', '\xcc', '\xcd',
552 '\xda', '\xdb', '\xdc', '\xdd' };
554 /* Insert and extract the block size in the header. */
557 xmalloc_put_size (unsigned char *ptr
, size_t size
)
560 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
562 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
568 xmalloc_get_size (unsigned char *ptr
)
572 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
573 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
582 /* The call depth in overrun_check functions. For example, this might happen:
584 overrun_check_malloc()
585 -> malloc -> (via hook)_-> emacs_blocked_malloc
586 -> overrun_check_malloc
587 call malloc (hooks are NULL, so real malloc is called).
588 malloc returns 10000.
589 add overhead, return 10016.
590 <- (back in overrun_check_malloc)
591 add overhead again, return 10032
592 xmalloc returns 10032.
597 overrun_check_free(10032)
599 free(10016) <- crash, because 10000 is the original pointer. */
601 static ptrdiff_t check_depth
;
603 /* Like malloc, but wraps allocated block with header and trailer. */
606 overrun_check_malloc (size_t size
)
608 register unsigned char *val
;
609 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
610 if (SIZE_MAX
- overhead
< size
)
613 val
= malloc (size
+ overhead
);
614 if (val
&& check_depth
== 1)
616 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
617 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
618 xmalloc_put_size (val
, size
);
619 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
620 XMALLOC_OVERRUN_CHECK_SIZE
);
627 /* Like realloc, but checks old block for overrun, and wraps new block
628 with header and trailer. */
631 overrun_check_realloc (void *block
, size_t size
)
633 register unsigned char *val
= (unsigned char *) block
;
634 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
635 if (SIZE_MAX
- overhead
< size
)
640 && memcmp (xmalloc_overrun_check_header
,
641 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
642 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
644 size_t osize
= xmalloc_get_size (val
);
645 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
646 XMALLOC_OVERRUN_CHECK_SIZE
))
648 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
649 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
650 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
653 val
= realloc (val
, size
+ overhead
);
655 if (val
&& check_depth
== 1)
657 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
658 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
659 xmalloc_put_size (val
, size
);
660 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
661 XMALLOC_OVERRUN_CHECK_SIZE
);
667 /* Like free, but checks block for overrun. */
670 overrun_check_free (void *block
)
672 unsigned char *val
= (unsigned char *) block
;
677 && memcmp (xmalloc_overrun_check_header
,
678 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
679 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
681 size_t osize
= xmalloc_get_size (val
);
682 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
683 XMALLOC_OVERRUN_CHECK_SIZE
))
685 #ifdef XMALLOC_CLEAR_FREE_MEMORY
686 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
687 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
689 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
690 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
691 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
702 #define malloc overrun_check_malloc
703 #define realloc overrun_check_realloc
704 #define free overrun_check_free
708 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
709 there's no need to block input around malloc. */
710 #define MALLOC_BLOCK_INPUT ((void)0)
711 #define MALLOC_UNBLOCK_INPUT ((void)0)
713 #define MALLOC_BLOCK_INPUT BLOCK_INPUT
714 #define MALLOC_UNBLOCK_INPUT UNBLOCK_INPUT
717 /* Like malloc but check for no memory and block interrupt input.. */
720 xmalloc (size_t size
)
726 MALLOC_UNBLOCK_INPUT
;
733 /* Like the above, but zeroes out the memory just allocated. */
736 xzalloc (size_t size
)
742 MALLOC_UNBLOCK_INPUT
;
746 memset (val
, 0, size
);
750 /* Like realloc but check for no memory and block interrupt input.. */
753 xrealloc (void *block
, size_t size
)
758 /* We must call malloc explicitly when BLOCK is 0, since some
759 reallocs don't do this. */
763 val
= realloc (block
, size
);
764 MALLOC_UNBLOCK_INPUT
;
772 /* Like free but block interrupt input. */
781 MALLOC_UNBLOCK_INPUT
;
782 /* We don't call refill_memory_reserve here
783 because that duplicates doing so in emacs_blocked_free
784 and the criterion should go there. */
788 /* Other parts of Emacs pass large int values to allocator functions
789 expecting ptrdiff_t. This is portable in practice, but check it to
791 verify (INT_MAX
<= PTRDIFF_MAX
);
794 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
795 Signal an error on memory exhaustion, and block interrupt input. */
798 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
800 eassert (0 <= nitems
&& 0 < item_size
);
801 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
802 memory_full (SIZE_MAX
);
803 return xmalloc (nitems
* item_size
);
807 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
808 Signal an error on memory exhaustion, and block interrupt input. */
811 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
813 eassert (0 <= nitems
&& 0 < item_size
);
814 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
815 memory_full (SIZE_MAX
);
816 return xrealloc (pa
, nitems
* item_size
);
820 /* Grow PA, which points to an array of *NITEMS items, and return the
821 location of the reallocated array, updating *NITEMS to reflect its
822 new size. The new array will contain at least NITEMS_INCR_MIN more
823 items, but will not contain more than NITEMS_MAX items total.
824 ITEM_SIZE is the size of each item, in bytes.
826 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
827 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
830 If PA is null, then allocate a new array instead of reallocating
831 the old one. Thus, to grow an array A without saving its old
832 contents, invoke xfree (A) immediately followed by xgrowalloc (0,
835 Block interrupt input as needed. If memory exhaustion occurs, set
836 *NITEMS to zero if PA is null, and signal an error (i.e., do not
840 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
841 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
843 /* The approximate size to use for initial small allocation
844 requests. This is the largest "small" request for the GNU C
846 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
848 /* If the array is tiny, grow it to about (but no greater than)
849 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
850 ptrdiff_t n
= *nitems
;
851 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
852 ptrdiff_t half_again
= n
>> 1;
853 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
855 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
856 NITEMS_MAX, and what the C language can represent safely. */
857 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
858 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
859 ? nitems_max
: C_language_max
);
860 ptrdiff_t nitems_incr_max
= n_max
- n
;
861 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
863 eassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
866 if (nitems_incr_max
< incr
)
867 memory_full (SIZE_MAX
);
869 pa
= xrealloc (pa
, n
* item_size
);
875 /* Like strdup, but uses xmalloc. */
878 xstrdup (const char *s
)
880 size_t len
= strlen (s
) + 1;
881 char *p
= xmalloc (len
);
887 /* Unwind for SAFE_ALLOCA */
890 safe_alloca_unwind (Lisp_Object arg
)
892 register struct Lisp_Save_Value
*p
= XSAVE_VALUE (arg
);
902 /* Like malloc but used for allocating Lisp data. NBYTES is the
903 number of bytes to allocate, TYPE describes the intended use of the
904 allocated memory block (for strings, for conses, ...). */
907 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
911 lisp_malloc (size_t nbytes
, enum mem_type type
)
917 #ifdef GC_MALLOC_CHECK
918 allocated_mem_type
= type
;
921 val
= malloc (nbytes
);
924 /* If the memory just allocated cannot be addressed thru a Lisp
925 object's pointer, and it needs to be,
926 that's equivalent to running out of memory. */
927 if (val
&& type
!= MEM_TYPE_NON_LISP
)
930 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
931 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
933 lisp_malloc_loser
= val
;
940 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
941 if (val
&& type
!= MEM_TYPE_NON_LISP
)
942 mem_insert (val
, (char *) val
+ nbytes
, type
);
945 MALLOC_UNBLOCK_INPUT
;
947 memory_full (nbytes
);
951 /* Free BLOCK. This must be called to free memory allocated with a
952 call to lisp_malloc. */
955 lisp_free (void *block
)
959 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
960 mem_delete (mem_find (block
));
962 MALLOC_UNBLOCK_INPUT
;
965 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
967 /* The entry point is lisp_align_malloc which returns blocks of at most
968 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
970 #if defined (HAVE_POSIX_MEMALIGN) && defined (SYSTEM_MALLOC)
971 #define USE_POSIX_MEMALIGN 1
974 /* BLOCK_ALIGN has to be a power of 2. */
975 #define BLOCK_ALIGN (1 << 10)
977 /* Padding to leave at the end of a malloc'd block. This is to give
978 malloc a chance to minimize the amount of memory wasted to alignment.
979 It should be tuned to the particular malloc library used.
980 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
981 posix_memalign on the other hand would ideally prefer a value of 4
982 because otherwise, there's 1020 bytes wasted between each ablocks.
983 In Emacs, testing shows that those 1020 can most of the time be
984 efficiently used by malloc to place other objects, so a value of 0 can
985 still preferable unless you have a lot of aligned blocks and virtually
987 #define BLOCK_PADDING 0
988 #define BLOCK_BYTES \
989 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
991 /* Internal data structures and constants. */
993 #define ABLOCKS_SIZE 16
995 /* An aligned block of memory. */
1000 char payload
[BLOCK_BYTES
];
1001 struct ablock
*next_free
;
1003 /* `abase' is the aligned base of the ablocks. */
1004 /* It is overloaded to hold the virtual `busy' field that counts
1005 the number of used ablock in the parent ablocks.
1006 The first ablock has the `busy' field, the others have the `abase'
1007 field. To tell the difference, we assume that pointers will have
1008 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1009 is used to tell whether the real base of the parent ablocks is `abase'
1010 (if not, the word before the first ablock holds a pointer to the
1012 struct ablocks
*abase
;
1013 /* The padding of all but the last ablock is unused. The padding of
1014 the last ablock in an ablocks is not allocated. */
1016 char padding
[BLOCK_PADDING
];
1020 /* A bunch of consecutive aligned blocks. */
1023 struct ablock blocks
[ABLOCKS_SIZE
];
1026 /* Size of the block requested from malloc or posix_memalign. */
1027 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1029 #define ABLOCK_ABASE(block) \
1030 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1031 ? (struct ablocks *)(block) \
1034 /* Virtual `busy' field. */
1035 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1037 /* Pointer to the (not necessarily aligned) malloc block. */
1038 #ifdef USE_POSIX_MEMALIGN
1039 #define ABLOCKS_BASE(abase) (abase)
1041 #define ABLOCKS_BASE(abase) \
1042 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void**)abase)[-1])
1045 /* The list of free ablock. */
1046 static struct ablock
*free_ablock
;
1048 /* Allocate an aligned block of nbytes.
1049 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1050 smaller or equal to BLOCK_BYTES. */
1052 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1055 struct ablocks
*abase
;
1057 eassert (nbytes
<= BLOCK_BYTES
);
1061 #ifdef GC_MALLOC_CHECK
1062 allocated_mem_type
= type
;
1068 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1070 #ifdef DOUG_LEA_MALLOC
1071 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1072 because mapped region contents are not preserved in
1074 mallopt (M_MMAP_MAX
, 0);
1077 #ifdef USE_POSIX_MEMALIGN
1079 int err
= posix_memalign (&base
, BLOCK_ALIGN
, ABLOCKS_BYTES
);
1085 base
= malloc (ABLOCKS_BYTES
);
1086 abase
= ALIGN (base
, BLOCK_ALIGN
);
1091 MALLOC_UNBLOCK_INPUT
;
1092 memory_full (ABLOCKS_BYTES
);
1095 aligned
= (base
== abase
);
1097 ((void**)abase
)[-1] = base
;
1099 #ifdef DOUG_LEA_MALLOC
1100 /* Back to a reasonable maximum of mmap'ed areas. */
1101 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1105 /* If the memory just allocated cannot be addressed thru a Lisp
1106 object's pointer, and it needs to be, that's equivalent to
1107 running out of memory. */
1108 if (type
!= MEM_TYPE_NON_LISP
)
1111 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1112 XSETCONS (tem
, end
);
1113 if ((char *) XCONS (tem
) != end
)
1115 lisp_malloc_loser
= base
;
1117 MALLOC_UNBLOCK_INPUT
;
1118 memory_full (SIZE_MAX
);
1123 /* Initialize the blocks and put them on the free list.
1124 If `base' was not properly aligned, we can't use the last block. */
1125 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1127 abase
->blocks
[i
].abase
= abase
;
1128 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1129 free_ablock
= &abase
->blocks
[i
];
1131 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1133 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1134 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1135 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1136 eassert (ABLOCKS_BASE (abase
) == base
);
1137 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1140 abase
= ABLOCK_ABASE (free_ablock
);
1141 ABLOCKS_BUSY (abase
) =
1142 (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1144 free_ablock
= free_ablock
->x
.next_free
;
1146 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1147 if (type
!= MEM_TYPE_NON_LISP
)
1148 mem_insert (val
, (char *) val
+ nbytes
, type
);
1151 MALLOC_UNBLOCK_INPUT
;
1153 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1158 lisp_align_free (void *block
)
1160 struct ablock
*ablock
= block
;
1161 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1164 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1165 mem_delete (mem_find (block
));
1167 /* Put on free list. */
1168 ablock
->x
.next_free
= free_ablock
;
1169 free_ablock
= ablock
;
1170 /* Update busy count. */
1171 ABLOCKS_BUSY (abase
)
1172 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1174 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1175 { /* All the blocks are free. */
1176 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1177 struct ablock
**tem
= &free_ablock
;
1178 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1182 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1185 *tem
= (*tem
)->x
.next_free
;
1188 tem
= &(*tem
)->x
.next_free
;
1190 eassert ((aligned
& 1) == aligned
);
1191 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1192 #ifdef USE_POSIX_MEMALIGN
1193 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1195 free (ABLOCKS_BASE (abase
));
1197 MALLOC_UNBLOCK_INPUT
;
1201 #ifndef SYSTEM_MALLOC
1203 /* Arranging to disable input signals while we're in malloc.
1205 This only works with GNU malloc. To help out systems which can't
1206 use GNU malloc, all the calls to malloc, realloc, and free
1207 elsewhere in the code should be inside a BLOCK_INPUT/UNBLOCK_INPUT
1208 pair; unfortunately, we have no idea what C library functions
1209 might call malloc, so we can't really protect them unless you're
1210 using GNU malloc. Fortunately, most of the major operating systems
1211 can use GNU malloc. */
1214 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
1215 there's no need to block input around malloc. */
1217 #ifndef DOUG_LEA_MALLOC
1218 extern void * (*__malloc_hook
) (size_t, const void *);
1219 extern void * (*__realloc_hook
) (void *, size_t, const void *);
1220 extern void (*__free_hook
) (void *, const void *);
1221 /* Else declared in malloc.h, perhaps with an extra arg. */
1222 #endif /* DOUG_LEA_MALLOC */
1223 static void * (*old_malloc_hook
) (size_t, const void *);
1224 static void * (*old_realloc_hook
) (void *, size_t, const void*);
1225 static void (*old_free_hook
) (void*, const void*);
1227 #ifdef DOUG_LEA_MALLOC
1228 # define BYTES_USED (mallinfo ().uordblks)
1230 # define BYTES_USED _bytes_used
1233 #ifdef GC_MALLOC_CHECK
1234 static int dont_register_blocks
;
1237 static size_t bytes_used_when_reconsidered
;
1239 /* Value of _bytes_used, when spare_memory was freed. */
1241 static size_t bytes_used_when_full
;
1243 /* This function is used as the hook for free to call. */
1246 emacs_blocked_free (void *ptr
, const void *ptr2
)
1250 #ifdef GC_MALLOC_CHECK
1256 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1259 "Freeing `%p' which wasn't allocated with malloc\n", ptr
);
1264 /* fprintf (stderr, "free %p...%p (%p)\n", m->start, m->end, ptr); */
1268 #endif /* GC_MALLOC_CHECK */
1270 __free_hook
= old_free_hook
;
1273 /* If we released our reserve (due to running out of memory),
1274 and we have a fair amount free once again,
1275 try to set aside another reserve in case we run out once more. */
1276 if (! NILP (Vmemory_full
)
1277 /* Verify there is enough space that even with the malloc
1278 hysteresis this call won't run out again.
1279 The code here is correct as long as SPARE_MEMORY
1280 is substantially larger than the block size malloc uses. */
1281 && (bytes_used_when_full
1282 > ((bytes_used_when_reconsidered
= BYTES_USED
)
1283 + max (malloc_hysteresis
, 4) * SPARE_MEMORY
)))
1284 refill_memory_reserve ();
1286 __free_hook
= emacs_blocked_free
;
1287 UNBLOCK_INPUT_ALLOC
;
1291 /* This function is the malloc hook that Emacs uses. */
1294 emacs_blocked_malloc (size_t size
, const void *ptr
)
1299 __malloc_hook
= old_malloc_hook
;
1300 #ifdef DOUG_LEA_MALLOC
1301 /* Segfaults on my system. --lorentey */
1302 /* mallopt (M_TOP_PAD, malloc_hysteresis * 4096); */
1304 __malloc_extra_blocks
= malloc_hysteresis
;
1307 value
= malloc (size
);
1309 #ifdef GC_MALLOC_CHECK
1311 struct mem_node
*m
= mem_find (value
);
1314 fprintf (stderr
, "Malloc returned %p which is already in use\n",
1316 fprintf (stderr
, "Region in use is %p...%p, %td bytes, type %d\n",
1317 m
->start
, m
->end
, (char *) m
->end
- (char *) m
->start
,
1322 if (!dont_register_blocks
)
1324 mem_insert (value
, (char *) value
+ max (1, size
), allocated_mem_type
);
1325 allocated_mem_type
= MEM_TYPE_NON_LISP
;
1328 #endif /* GC_MALLOC_CHECK */
1330 __malloc_hook
= emacs_blocked_malloc
;
1331 UNBLOCK_INPUT_ALLOC
;
1333 /* fprintf (stderr, "%p malloc\n", value); */
1338 /* This function is the realloc hook that Emacs uses. */
1341 emacs_blocked_realloc (void *ptr
, size_t size
, const void *ptr2
)
1346 __realloc_hook
= old_realloc_hook
;
1348 #ifdef GC_MALLOC_CHECK
1351 struct mem_node
*m
= mem_find (ptr
);
1352 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1355 "Realloc of %p which wasn't allocated with malloc\n",
1363 /* fprintf (stderr, "%p -> realloc\n", ptr); */
1365 /* Prevent malloc from registering blocks. */
1366 dont_register_blocks
= 1;
1367 #endif /* GC_MALLOC_CHECK */
1369 value
= realloc (ptr
, size
);
1371 #ifdef GC_MALLOC_CHECK
1372 dont_register_blocks
= 0;
1375 struct mem_node
*m
= mem_find (value
);
1378 fprintf (stderr
, "Realloc returns memory that is already in use\n");
1382 /* Can't handle zero size regions in the red-black tree. */
1383 mem_insert (value
, (char *) value
+ max (size
, 1), MEM_TYPE_NON_LISP
);
1386 /* fprintf (stderr, "%p <- realloc\n", value); */
1387 #endif /* GC_MALLOC_CHECK */
1389 __realloc_hook
= emacs_blocked_realloc
;
1390 UNBLOCK_INPUT_ALLOC
;
1397 /* Called from Fdump_emacs so that when the dumped Emacs starts, it has a
1398 normal malloc. Some thread implementations need this as they call
1399 malloc before main. The pthread_self call in BLOCK_INPUT_ALLOC then
1400 calls malloc because it is the first call, and we have an endless loop. */
1403 reset_malloc_hooks (void)
1405 __free_hook
= old_free_hook
;
1406 __malloc_hook
= old_malloc_hook
;
1407 __realloc_hook
= old_realloc_hook
;
1409 #endif /* HAVE_PTHREAD */
1412 /* Called from main to set up malloc to use our hooks. */
1415 uninterrupt_malloc (void)
1418 #ifdef DOUG_LEA_MALLOC
1419 pthread_mutexattr_t attr
;
1421 /* GLIBC has a faster way to do this, but let's keep it portable.
1422 This is according to the Single UNIX Specification. */
1423 pthread_mutexattr_init (&attr
);
1424 pthread_mutexattr_settype (&attr
, PTHREAD_MUTEX_RECURSIVE
);
1425 pthread_mutex_init (&alloc_mutex
, &attr
);
1426 #else /* !DOUG_LEA_MALLOC */
1427 /* Some systems such as Solaris 2.6 don't have a recursive mutex,
1428 and the bundled gmalloc.c doesn't require it. */
1429 pthread_mutex_init (&alloc_mutex
, NULL
);
1430 #endif /* !DOUG_LEA_MALLOC */
1431 #endif /* HAVE_PTHREAD */
1433 if (__free_hook
!= emacs_blocked_free
)
1434 old_free_hook
= __free_hook
;
1435 __free_hook
= emacs_blocked_free
;
1437 if (__malloc_hook
!= emacs_blocked_malloc
)
1438 old_malloc_hook
= __malloc_hook
;
1439 __malloc_hook
= emacs_blocked_malloc
;
1441 if (__realloc_hook
!= emacs_blocked_realloc
)
1442 old_realloc_hook
= __realloc_hook
;
1443 __realloc_hook
= emacs_blocked_realloc
;
1446 #endif /* not SYNC_INPUT */
1447 #endif /* not SYSTEM_MALLOC */
1451 /***********************************************************************
1453 ***********************************************************************/
1455 /* Number of intervals allocated in an interval_block structure.
1456 The 1020 is 1024 minus malloc overhead. */
1458 #define INTERVAL_BLOCK_SIZE \
1459 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1461 /* Intervals are allocated in chunks in form of an interval_block
1464 struct interval_block
1466 /* Place `intervals' first, to preserve alignment. */
1467 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1468 struct interval_block
*next
;
1471 /* Current interval block. Its `next' pointer points to older
1474 static struct interval_block
*interval_block
;
1476 /* Index in interval_block above of the next unused interval
1479 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1481 /* Number of free and live intervals. */
1483 static EMACS_INT total_free_intervals
, total_intervals
;
1485 /* List of free intervals. */
1487 static INTERVAL interval_free_list
;
1489 /* Return a new interval. */
1492 make_interval (void)
1496 /* eassert (!handling_signal); */
1500 if (interval_free_list
)
1502 val
= interval_free_list
;
1503 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1507 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1509 struct interval_block
*newi
1510 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1512 newi
->next
= interval_block
;
1513 interval_block
= newi
;
1514 interval_block_index
= 0;
1515 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1517 val
= &interval_block
->intervals
[interval_block_index
++];
1520 MALLOC_UNBLOCK_INPUT
;
1522 consing_since_gc
+= sizeof (struct interval
);
1524 total_free_intervals
--;
1525 RESET_INTERVAL (val
);
1531 /* Mark Lisp objects in interval I. */
1534 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1536 /* Intervals should never be shared. So, if extra internal checking is
1537 enabled, GC aborts if it seems to have visited an interval twice. */
1538 eassert (!i
->gcmarkbit
);
1540 mark_object (i
->plist
);
1544 /* Mark the interval tree rooted in TREE. Don't call this directly;
1545 use the macro MARK_INTERVAL_TREE instead. */
1548 mark_interval_tree (register INTERVAL tree
)
1550 /* No need to test if this tree has been marked already; this
1551 function is always called through the MARK_INTERVAL_TREE macro,
1552 which takes care of that. */
1554 traverse_intervals_noorder (tree
, mark_interval
, Qnil
);
1558 /* Mark the interval tree rooted in I. */
1560 #define MARK_INTERVAL_TREE(i) \
1562 if (!NULL_INTERVAL_P (i) && !i->gcmarkbit) \
1563 mark_interval_tree (i); \
1567 #define UNMARK_BALANCE_INTERVALS(i) \
1569 if (! NULL_INTERVAL_P (i)) \
1570 (i) = balance_intervals (i); \
1573 /***********************************************************************
1575 ***********************************************************************/
1577 /* Lisp_Strings are allocated in string_block structures. When a new
1578 string_block is allocated, all the Lisp_Strings it contains are
1579 added to a free-list string_free_list. When a new Lisp_String is
1580 needed, it is taken from that list. During the sweep phase of GC,
1581 string_blocks that are entirely free are freed, except two which
1584 String data is allocated from sblock structures. Strings larger
1585 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1586 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1588 Sblocks consist internally of sdata structures, one for each
1589 Lisp_String. The sdata structure points to the Lisp_String it
1590 belongs to. The Lisp_String points back to the `u.data' member of
1591 its sdata structure.
1593 When a Lisp_String is freed during GC, it is put back on
1594 string_free_list, and its `data' member and its sdata's `string'
1595 pointer is set to null. The size of the string is recorded in the
1596 `u.nbytes' member of the sdata. So, sdata structures that are no
1597 longer used, can be easily recognized, and it's easy to compact the
1598 sblocks of small strings which we do in compact_small_strings. */
1600 /* Size in bytes of an sblock structure used for small strings. This
1601 is 8192 minus malloc overhead. */
1603 #define SBLOCK_SIZE 8188
1605 /* Strings larger than this are considered large strings. String data
1606 for large strings is allocated from individual sblocks. */
1608 #define LARGE_STRING_BYTES 1024
1610 /* Structure describing string memory sub-allocated from an sblock.
1611 This is where the contents of Lisp strings are stored. */
1615 /* Back-pointer to the string this sdata belongs to. If null, this
1616 structure is free, and the NBYTES member of the union below
1617 contains the string's byte size (the same value that STRING_BYTES
1618 would return if STRING were non-null). If non-null, STRING_BYTES
1619 (STRING) is the size of the data, and DATA contains the string's
1621 struct Lisp_String
*string
;
1623 #ifdef GC_CHECK_STRING_BYTES
1626 unsigned char data
[1];
1628 #define SDATA_NBYTES(S) (S)->nbytes
1629 #define SDATA_DATA(S) (S)->data
1630 #define SDATA_SELECTOR(member) member
1632 #else /* not GC_CHECK_STRING_BYTES */
1636 /* When STRING is non-null. */
1637 unsigned char data
[1];
1639 /* When STRING is null. */
1643 #define SDATA_NBYTES(S) (S)->u.nbytes
1644 #define SDATA_DATA(S) (S)->u.data
1645 #define SDATA_SELECTOR(member) u.member
1647 #endif /* not GC_CHECK_STRING_BYTES */
1649 #define SDATA_DATA_OFFSET offsetof (struct sdata, SDATA_SELECTOR (data))
1653 /* Structure describing a block of memory which is sub-allocated to
1654 obtain string data memory for strings. Blocks for small strings
1655 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1656 as large as needed. */
1661 struct sblock
*next
;
1663 /* Pointer to the next free sdata block. This points past the end
1664 of the sblock if there isn't any space left in this block. */
1665 struct sdata
*next_free
;
1667 /* Start of data. */
1668 struct sdata first_data
;
1671 /* Number of Lisp strings in a string_block structure. The 1020 is
1672 1024 minus malloc overhead. */
1674 #define STRING_BLOCK_SIZE \
1675 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1677 /* Structure describing a block from which Lisp_String structures
1682 /* Place `strings' first, to preserve alignment. */
1683 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1684 struct string_block
*next
;
1687 /* Head and tail of the list of sblock structures holding Lisp string
1688 data. We always allocate from current_sblock. The NEXT pointers
1689 in the sblock structures go from oldest_sblock to current_sblock. */
1691 static struct sblock
*oldest_sblock
, *current_sblock
;
1693 /* List of sblocks for large strings. */
1695 static struct sblock
*large_sblocks
;
1697 /* List of string_block structures. */
1699 static struct string_block
*string_blocks
;
1701 /* Free-list of Lisp_Strings. */
1703 static struct Lisp_String
*string_free_list
;
1705 /* Number of live and free Lisp_Strings. */
1707 static EMACS_INT total_strings
, total_free_strings
;
1709 /* Number of bytes used by live strings. */
1711 static EMACS_INT total_string_bytes
;
1713 /* Given a pointer to a Lisp_String S which is on the free-list
1714 string_free_list, return a pointer to its successor in the
1717 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1719 /* Return a pointer to the sdata structure belonging to Lisp string S.
1720 S must be live, i.e. S->data must not be null. S->data is actually
1721 a pointer to the `u.data' member of its sdata structure; the
1722 structure starts at a constant offset in front of that. */
1724 #define SDATA_OF_STRING(S) ((struct sdata *) ((S)->data - SDATA_DATA_OFFSET))
1727 #ifdef GC_CHECK_STRING_OVERRUN
1729 /* We check for overrun in string data blocks by appending a small
1730 "cookie" after each allocated string data block, and check for the
1731 presence of this cookie during GC. */
1733 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1734 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1735 { '\xde', '\xad', '\xbe', '\xef' };
1738 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1741 /* Value is the size of an sdata structure large enough to hold NBYTES
1742 bytes of string data. The value returned includes a terminating
1743 NUL byte, the size of the sdata structure, and padding. */
1745 #ifdef GC_CHECK_STRING_BYTES
1747 #define SDATA_SIZE(NBYTES) \
1748 ((SDATA_DATA_OFFSET \
1750 + sizeof (ptrdiff_t) - 1) \
1751 & ~(sizeof (ptrdiff_t) - 1))
1753 #else /* not GC_CHECK_STRING_BYTES */
1755 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1756 less than the size of that member. The 'max' is not needed when
1757 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1758 alignment code reserves enough space. */
1760 #define SDATA_SIZE(NBYTES) \
1761 ((SDATA_DATA_OFFSET \
1762 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1764 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1766 + sizeof (ptrdiff_t) - 1) \
1767 & ~(sizeof (ptrdiff_t) - 1))
1769 #endif /* not GC_CHECK_STRING_BYTES */
1771 /* Extra bytes to allocate for each string. */
1773 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1775 /* Exact bound on the number of bytes in a string, not counting the
1776 terminating null. A string cannot contain more bytes than
1777 STRING_BYTES_BOUND, nor can it be so long that the size_t
1778 arithmetic in allocate_string_data would overflow while it is
1779 calculating a value to be passed to malloc. */
1780 static ptrdiff_t const STRING_BYTES_MAX
=
1781 min (STRING_BYTES_BOUND
,
1782 ((SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
1784 - offsetof (struct sblock
, first_data
)
1785 - SDATA_DATA_OFFSET
)
1786 & ~(sizeof (EMACS_INT
) - 1)));
1788 /* Initialize string allocation. Called from init_alloc_once. */
1793 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1794 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1798 #ifdef GC_CHECK_STRING_BYTES
1800 static int check_string_bytes_count
;
1802 /* Like STRING_BYTES, but with debugging check. Can be
1803 called during GC, so pay attention to the mark bit. */
1806 string_bytes (struct Lisp_String
*s
)
1809 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1811 if (!PURE_POINTER_P (s
)
1813 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1818 /* Check validity of Lisp strings' string_bytes member in B. */
1821 check_sblock (struct sblock
*b
)
1823 struct sdata
*from
, *end
, *from_end
;
1827 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1829 /* Compute the next FROM here because copying below may
1830 overwrite data we need to compute it. */
1833 /* Check that the string size recorded in the string is the
1834 same as the one recorded in the sdata structure. */
1835 nbytes
= SDATA_SIZE (from
->string
? string_bytes (from
->string
)
1836 : SDATA_NBYTES (from
));
1837 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1842 /* Check validity of Lisp strings' string_bytes member. ALL_P
1843 non-zero means check all strings, otherwise check only most
1844 recently allocated strings. Used for hunting a bug. */
1847 check_string_bytes (int all_p
)
1853 for (b
= large_sblocks
; b
; b
= b
->next
)
1855 struct Lisp_String
*s
= b
->first_data
.string
;
1860 for (b
= oldest_sblock
; b
; b
= b
->next
)
1863 else if (current_sblock
)
1864 check_sblock (current_sblock
);
1867 #else /* not GC_CHECK_STRING_BYTES */
1869 #define check_string_bytes(all) ((void) 0)
1871 #endif /* GC_CHECK_STRING_BYTES */
1873 #ifdef GC_CHECK_STRING_FREE_LIST
1875 /* Walk through the string free list looking for bogus next pointers.
1876 This may catch buffer overrun from a previous string. */
1879 check_string_free_list (void)
1881 struct Lisp_String
*s
;
1883 /* Pop a Lisp_String off the free-list. */
1884 s
= string_free_list
;
1887 if ((uintptr_t) s
< 1024)
1889 s
= NEXT_FREE_LISP_STRING (s
);
1893 #define check_string_free_list()
1896 /* Return a new Lisp_String. */
1898 static struct Lisp_String
*
1899 allocate_string (void)
1901 struct Lisp_String
*s
;
1903 /* eassert (!handling_signal); */
1907 /* If the free-list is empty, allocate a new string_block, and
1908 add all the Lisp_Strings in it to the free-list. */
1909 if (string_free_list
== NULL
)
1911 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1914 b
->next
= string_blocks
;
1917 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1920 /* Every string on a free list should have NULL data pointer. */
1922 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1923 string_free_list
= s
;
1926 total_free_strings
+= STRING_BLOCK_SIZE
;
1929 check_string_free_list ();
1931 /* Pop a Lisp_String off the free-list. */
1932 s
= string_free_list
;
1933 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1935 MALLOC_UNBLOCK_INPUT
;
1937 --total_free_strings
;
1940 consing_since_gc
+= sizeof *s
;
1942 #ifdef GC_CHECK_STRING_BYTES
1943 if (!noninteractive
)
1945 if (++check_string_bytes_count
== 200)
1947 check_string_bytes_count
= 0;
1948 check_string_bytes (1);
1951 check_string_bytes (0);
1953 #endif /* GC_CHECK_STRING_BYTES */
1959 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1960 plus a NUL byte at the end. Allocate an sdata structure for S, and
1961 set S->data to its `u.data' member. Store a NUL byte at the end of
1962 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1963 S->data if it was initially non-null. */
1966 allocate_string_data (struct Lisp_String
*s
,
1967 EMACS_INT nchars
, EMACS_INT nbytes
)
1969 struct sdata
*data
, *old_data
;
1971 ptrdiff_t needed
, old_nbytes
;
1973 if (STRING_BYTES_MAX
< nbytes
)
1976 /* Determine the number of bytes needed to store NBYTES bytes
1978 needed
= SDATA_SIZE (nbytes
);
1981 old_data
= SDATA_OF_STRING (s
);
1982 old_nbytes
= STRING_BYTES (s
);
1989 if (nbytes
> LARGE_STRING_BYTES
)
1991 size_t size
= offsetof (struct sblock
, first_data
) + needed
;
1993 #ifdef DOUG_LEA_MALLOC
1994 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1995 because mapped region contents are not preserved in
1998 In case you think of allowing it in a dumped Emacs at the
1999 cost of not being able to re-dump, there's another reason:
2000 mmap'ed data typically have an address towards the top of the
2001 address space, which won't fit into an EMACS_INT (at least on
2002 32-bit systems with the current tagging scheme). --fx */
2003 mallopt (M_MMAP_MAX
, 0);
2006 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
2008 #ifdef DOUG_LEA_MALLOC
2009 /* Back to a reasonable maximum of mmap'ed areas. */
2010 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2013 b
->next_free
= &b
->first_data
;
2014 b
->first_data
.string
= NULL
;
2015 b
->next
= large_sblocks
;
2018 else if (current_sblock
== NULL
2019 || (((char *) current_sblock
+ SBLOCK_SIZE
2020 - (char *) current_sblock
->next_free
)
2021 < (needed
+ GC_STRING_EXTRA
)))
2023 /* Not enough room in the current sblock. */
2024 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
2025 b
->next_free
= &b
->first_data
;
2026 b
->first_data
.string
= NULL
;
2030 current_sblock
->next
= b
;
2038 data
= b
->next_free
;
2039 b
->next_free
= (struct sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
2041 MALLOC_UNBLOCK_INPUT
;
2044 s
->data
= SDATA_DATA (data
);
2045 #ifdef GC_CHECK_STRING_BYTES
2046 SDATA_NBYTES (data
) = nbytes
;
2049 s
->size_byte
= nbytes
;
2050 s
->data
[nbytes
] = '\0';
2051 #ifdef GC_CHECK_STRING_OVERRUN
2052 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
2053 GC_STRING_OVERRUN_COOKIE_SIZE
);
2056 /* Note that Faset may call to this function when S has already data
2057 assigned. In this case, mark data as free by setting it's string
2058 back-pointer to null, and record the size of the data in it. */
2061 SDATA_NBYTES (old_data
) = old_nbytes
;
2062 old_data
->string
= NULL
;
2065 consing_since_gc
+= needed
;
2069 /* Sweep and compact strings. */
2072 sweep_strings (void)
2074 struct string_block
*b
, *next
;
2075 struct string_block
*live_blocks
= NULL
;
2077 string_free_list
= NULL
;
2078 total_strings
= total_free_strings
= 0;
2079 total_string_bytes
= 0;
2081 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
2082 for (b
= string_blocks
; b
; b
= next
)
2085 struct Lisp_String
*free_list_before
= string_free_list
;
2089 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
2091 struct Lisp_String
*s
= b
->strings
+ i
;
2095 /* String was not on free-list before. */
2096 if (STRING_MARKED_P (s
))
2098 /* String is live; unmark it and its intervals. */
2101 if (!NULL_INTERVAL_P (s
->intervals
))
2102 UNMARK_BALANCE_INTERVALS (s
->intervals
);
2105 total_string_bytes
+= STRING_BYTES (s
);
2109 /* String is dead. Put it on the free-list. */
2110 struct sdata
*data
= SDATA_OF_STRING (s
);
2112 /* Save the size of S in its sdata so that we know
2113 how large that is. Reset the sdata's string
2114 back-pointer so that we know it's free. */
2115 #ifdef GC_CHECK_STRING_BYTES
2116 if (string_bytes (s
) != SDATA_NBYTES (data
))
2119 data
->u
.nbytes
= STRING_BYTES (s
);
2121 data
->string
= NULL
;
2123 /* Reset the strings's `data' member so that we
2127 /* Put the string on the free-list. */
2128 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2129 string_free_list
= s
;
2135 /* S was on the free-list before. Put it there again. */
2136 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2137 string_free_list
= s
;
2142 /* Free blocks that contain free Lisp_Strings only, except
2143 the first two of them. */
2144 if (nfree
== STRING_BLOCK_SIZE
2145 && total_free_strings
> STRING_BLOCK_SIZE
)
2148 string_free_list
= free_list_before
;
2152 total_free_strings
+= nfree
;
2153 b
->next
= live_blocks
;
2158 check_string_free_list ();
2160 string_blocks
= live_blocks
;
2161 free_large_strings ();
2162 compact_small_strings ();
2164 check_string_free_list ();
2168 /* Free dead large strings. */
2171 free_large_strings (void)
2173 struct sblock
*b
, *next
;
2174 struct sblock
*live_blocks
= NULL
;
2176 for (b
= large_sblocks
; b
; b
= next
)
2180 if (b
->first_data
.string
== NULL
)
2184 b
->next
= live_blocks
;
2189 large_sblocks
= live_blocks
;
2193 /* Compact data of small strings. Free sblocks that don't contain
2194 data of live strings after compaction. */
2197 compact_small_strings (void)
2199 struct sblock
*b
, *tb
, *next
;
2200 struct sdata
*from
, *to
, *end
, *tb_end
;
2201 struct sdata
*to_end
, *from_end
;
2203 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2204 to, and TB_END is the end of TB. */
2206 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2207 to
= &tb
->first_data
;
2209 /* Step through the blocks from the oldest to the youngest. We
2210 expect that old blocks will stabilize over time, so that less
2211 copying will happen this way. */
2212 for (b
= oldest_sblock
; b
; b
= b
->next
)
2215 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2217 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
2219 /* Compute the next FROM here because copying below may
2220 overwrite data we need to compute it. */
2222 struct Lisp_String
*s
= from
->string
;
2224 #ifdef GC_CHECK_STRING_BYTES
2225 /* Check that the string size recorded in the string is the
2226 same as the one recorded in the sdata structure. */
2227 if (s
&& string_bytes (s
) != SDATA_NBYTES (from
))
2229 #endif /* GC_CHECK_STRING_BYTES */
2231 nbytes
= s
? STRING_BYTES (s
) : SDATA_NBYTES (from
);
2232 eassert (nbytes
<= LARGE_STRING_BYTES
);
2234 nbytes
= SDATA_SIZE (nbytes
);
2235 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2237 #ifdef GC_CHECK_STRING_OVERRUN
2238 if (memcmp (string_overrun_cookie
,
2239 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2240 GC_STRING_OVERRUN_COOKIE_SIZE
))
2244 /* Non-NULL S means it's alive. Copy its data. */
2247 /* If TB is full, proceed with the next sblock. */
2248 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2249 if (to_end
> tb_end
)
2253 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2254 to
= &tb
->first_data
;
2255 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2258 /* Copy, and update the string's `data' pointer. */
2261 eassert (tb
!= b
|| to
< from
);
2262 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2263 to
->string
->data
= SDATA_DATA (to
);
2266 /* Advance past the sdata we copied to. */
2272 /* The rest of the sblocks following TB don't contain live data, so
2273 we can free them. */
2274 for (b
= tb
->next
; b
; b
= next
)
2282 current_sblock
= tb
;
2286 string_overflow (void)
2288 error ("Maximum string size exceeded");
2291 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2292 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2293 LENGTH must be an integer.
2294 INIT must be an integer that represents a character. */)
2295 (Lisp_Object length
, Lisp_Object init
)
2297 register Lisp_Object val
;
2298 register unsigned char *p
, *end
;
2302 CHECK_NATNUM (length
);
2303 CHECK_CHARACTER (init
);
2305 c
= XFASTINT (init
);
2306 if (ASCII_CHAR_P (c
))
2308 nbytes
= XINT (length
);
2309 val
= make_uninit_string (nbytes
);
2311 end
= p
+ SCHARS (val
);
2317 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2318 int len
= CHAR_STRING (c
, str
);
2319 EMACS_INT string_len
= XINT (length
);
2321 if (string_len
> STRING_BYTES_MAX
/ len
)
2323 nbytes
= len
* string_len
;
2324 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2329 memcpy (p
, str
, len
);
2339 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2340 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2341 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2342 (Lisp_Object length
, Lisp_Object init
)
2344 register Lisp_Object val
;
2345 struct Lisp_Bool_Vector
*p
;
2346 ptrdiff_t length_in_chars
;
2347 EMACS_INT length_in_elts
;
2349 int extra_bool_elts
= ((bool_header_size
- header_size
+ word_size
- 1)
2352 CHECK_NATNUM (length
);
2354 bits_per_value
= sizeof (EMACS_INT
) * BOOL_VECTOR_BITS_PER_CHAR
;
2356 length_in_elts
= (XFASTINT (length
) + bits_per_value
- 1) / bits_per_value
;
2358 val
= Fmake_vector (make_number (length_in_elts
+ extra_bool_elts
), Qnil
);
2360 /* No Lisp_Object to trace in there. */
2361 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0);
2363 p
= XBOOL_VECTOR (val
);
2364 p
->size
= XFASTINT (length
);
2366 length_in_chars
= ((XFASTINT (length
) + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2367 / BOOL_VECTOR_BITS_PER_CHAR
);
2368 if (length_in_chars
)
2370 memset (p
->data
, ! NILP (init
) ? -1 : 0, length_in_chars
);
2372 /* Clear any extraneous bits in the last byte. */
2373 p
->data
[length_in_chars
- 1]
2374 &= (1 << ((XFASTINT (length
) - 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1)) - 1;
2381 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2382 of characters from the contents. This string may be unibyte or
2383 multibyte, depending on the contents. */
2386 make_string (const char *contents
, ptrdiff_t nbytes
)
2388 register Lisp_Object val
;
2389 ptrdiff_t nchars
, multibyte_nbytes
;
2391 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2392 &nchars
, &multibyte_nbytes
);
2393 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2394 /* CONTENTS contains no multibyte sequences or contains an invalid
2395 multibyte sequence. We must make unibyte string. */
2396 val
= make_unibyte_string (contents
, nbytes
);
2398 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2403 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2406 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2408 register Lisp_Object val
;
2409 val
= make_uninit_string (length
);
2410 memcpy (SDATA (val
), contents
, length
);
2415 /* Make a multibyte string from NCHARS characters occupying NBYTES
2416 bytes at CONTENTS. */
2419 make_multibyte_string (const char *contents
,
2420 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2422 register Lisp_Object val
;
2423 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2424 memcpy (SDATA (val
), contents
, nbytes
);
2429 /* Make a string from NCHARS characters occupying NBYTES bytes at
2430 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2433 make_string_from_bytes (const char *contents
,
2434 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2436 register Lisp_Object val
;
2437 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2438 memcpy (SDATA (val
), contents
, nbytes
);
2439 if (SBYTES (val
) == SCHARS (val
))
2440 STRING_SET_UNIBYTE (val
);
2445 /* Make a string from NCHARS characters occupying NBYTES bytes at
2446 CONTENTS. The argument MULTIBYTE controls whether to label the
2447 string as multibyte. If NCHARS is negative, it counts the number of
2448 characters by itself. */
2451 make_specified_string (const char *contents
,
2452 ptrdiff_t nchars
, ptrdiff_t nbytes
, int multibyte
)
2454 register Lisp_Object val
;
2459 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2464 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2465 memcpy (SDATA (val
), contents
, nbytes
);
2467 STRING_SET_UNIBYTE (val
);
2472 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2473 occupying LENGTH bytes. */
2476 make_uninit_string (EMACS_INT length
)
2481 return empty_unibyte_string
;
2482 val
= make_uninit_multibyte_string (length
, length
);
2483 STRING_SET_UNIBYTE (val
);
2488 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2489 which occupy NBYTES bytes. */
2492 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2495 struct Lisp_String
*s
;
2500 return empty_multibyte_string
;
2502 s
= allocate_string ();
2503 s
->intervals
= NULL_INTERVAL
;
2504 allocate_string_data (s
, nchars
, nbytes
);
2505 XSETSTRING (string
, s
);
2506 string_chars_consed
+= nbytes
;
2510 /* Print arguments to BUF according to a FORMAT, then return
2511 a Lisp_String initialized with the data from BUF. */
2514 make_formatted_string (char *buf
, const char *format
, ...)
2519 va_start (ap
, format
);
2520 length
= vsprintf (buf
, format
, ap
);
2522 return make_string (buf
, length
);
2526 /***********************************************************************
2528 ***********************************************************************/
2530 /* We store float cells inside of float_blocks, allocating a new
2531 float_block with malloc whenever necessary. Float cells reclaimed
2532 by GC are put on a free list to be reallocated before allocating
2533 any new float cells from the latest float_block. */
2535 #define FLOAT_BLOCK_SIZE \
2536 (((BLOCK_BYTES - sizeof (struct float_block *) \
2537 /* The compiler might add padding at the end. */ \
2538 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2539 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2541 #define GETMARKBIT(block,n) \
2542 (((block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2543 >> ((n) % (sizeof (int) * CHAR_BIT))) \
2546 #define SETMARKBIT(block,n) \
2547 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2548 |= 1 << ((n) % (sizeof (int) * CHAR_BIT))
2550 #define UNSETMARKBIT(block,n) \
2551 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2552 &= ~(1 << ((n) % (sizeof (int) * CHAR_BIT)))
2554 #define FLOAT_BLOCK(fptr) \
2555 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2557 #define FLOAT_INDEX(fptr) \
2558 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2562 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2563 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2564 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2565 struct float_block
*next
;
2568 #define FLOAT_MARKED_P(fptr) \
2569 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2571 #define FLOAT_MARK(fptr) \
2572 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2574 #define FLOAT_UNMARK(fptr) \
2575 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2577 /* Current float_block. */
2579 static struct float_block
*float_block
;
2581 /* Index of first unused Lisp_Float in the current float_block. */
2583 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2585 /* Free-list of Lisp_Floats. */
2587 static struct Lisp_Float
*float_free_list
;
2589 /* Return a new float object with value FLOAT_VALUE. */
2592 make_float (double float_value
)
2594 register Lisp_Object val
;
2596 /* eassert (!handling_signal); */
2600 if (float_free_list
)
2602 /* We use the data field for chaining the free list
2603 so that we won't use the same field that has the mark bit. */
2604 XSETFLOAT (val
, float_free_list
);
2605 float_free_list
= float_free_list
->u
.chain
;
2609 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2611 struct float_block
*new
2612 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2613 new->next
= float_block
;
2614 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2616 float_block_index
= 0;
2617 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2619 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2620 float_block_index
++;
2623 MALLOC_UNBLOCK_INPUT
;
2625 XFLOAT_INIT (val
, float_value
);
2626 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2627 consing_since_gc
+= sizeof (struct Lisp_Float
);
2629 total_free_floats
--;
2635 /***********************************************************************
2637 ***********************************************************************/
2639 /* We store cons cells inside of cons_blocks, allocating a new
2640 cons_block with malloc whenever necessary. Cons cells reclaimed by
2641 GC are put on a free list to be reallocated before allocating
2642 any new cons cells from the latest cons_block. */
2644 #define CONS_BLOCK_SIZE \
2645 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2646 /* The compiler might add padding at the end. */ \
2647 - (sizeof (struct Lisp_Cons) - sizeof (int))) * CHAR_BIT) \
2648 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2650 #define CONS_BLOCK(fptr) \
2651 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2653 #define CONS_INDEX(fptr) \
2654 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2658 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2659 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2660 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2661 struct cons_block
*next
;
2664 #define CONS_MARKED_P(fptr) \
2665 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2667 #define CONS_MARK(fptr) \
2668 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2670 #define CONS_UNMARK(fptr) \
2671 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2673 /* Current cons_block. */
2675 static struct cons_block
*cons_block
;
2677 /* Index of first unused Lisp_Cons in the current block. */
2679 static int cons_block_index
= CONS_BLOCK_SIZE
;
2681 /* Free-list of Lisp_Cons structures. */
2683 static struct Lisp_Cons
*cons_free_list
;
2685 /* Explicitly free a cons cell by putting it on the free-list. */
2688 free_cons (struct Lisp_Cons
*ptr
)
2690 ptr
->u
.chain
= cons_free_list
;
2692 CVAR (ptr
, car
) = Vdead
;
2694 cons_free_list
= ptr
;
2695 consing_since_gc
-= sizeof *ptr
;
2696 total_free_conses
++;
2699 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2700 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2701 (Lisp_Object car
, Lisp_Object cdr
)
2703 register Lisp_Object val
;
2705 /* eassert (!handling_signal); */
2711 /* We use the cdr for chaining the free list
2712 so that we won't use the same field that has the mark bit. */
2713 XSETCONS (val
, cons_free_list
);
2714 cons_free_list
= cons_free_list
->u
.chain
;
2718 if (cons_block_index
== CONS_BLOCK_SIZE
)
2720 struct cons_block
*new
2721 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2722 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2723 new->next
= cons_block
;
2725 cons_block_index
= 0;
2726 total_free_conses
+= CONS_BLOCK_SIZE
;
2728 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2732 MALLOC_UNBLOCK_INPUT
;
2736 eassert (!CONS_MARKED_P (XCONS (val
)));
2737 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2738 total_free_conses
--;
2739 cons_cells_consed
++;
2743 #ifdef GC_CHECK_CONS_LIST
2744 /* Get an error now if there's any junk in the cons free list. */
2746 check_cons_list (void)
2748 struct Lisp_Cons
*tail
= cons_free_list
;
2751 tail
= tail
->u
.chain
;
2755 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2758 list1 (Lisp_Object arg1
)
2760 return Fcons (arg1
, Qnil
);
2764 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2766 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2771 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2773 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2778 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2780 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2785 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2787 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2788 Fcons (arg5
, Qnil
)))));
2791 /* Make a list of COUNT Lisp_Objects, where ARG is the
2792 first one. Allocate conses from pure space if TYPE
2793 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2796 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2800 Lisp_Object val
, *objp
;
2802 /* Change to SAFE_ALLOCA if you hit this eassert. */
2803 eassert (count
<= MAX_ALLOCA
/ sizeof (Lisp_Object
));
2805 objp
= alloca (count
* sizeof (Lisp_Object
));
2808 for (i
= 1; i
< count
; i
++)
2809 objp
[i
] = va_arg (ap
, Lisp_Object
);
2812 for (val
= Qnil
, i
= count
- 1; i
>= 0; i
--)
2814 if (type
== CONSTYPE_PURE
)
2815 val
= pure_cons (objp
[i
], val
);
2816 else if (type
== CONSTYPE_HEAP
)
2817 val
= Fcons (objp
[i
], val
);
2824 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2825 doc
: /* Return a newly created list with specified arguments as elements.
2826 Any number of arguments, even zero arguments, are allowed.
2827 usage: (list &rest OBJECTS) */)
2828 (ptrdiff_t nargs
, Lisp_Object
*args
)
2830 register Lisp_Object val
;
2836 val
= Fcons (args
[nargs
], val
);
2842 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2843 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2844 (register Lisp_Object length
, Lisp_Object init
)
2846 register Lisp_Object val
;
2847 register EMACS_INT size
;
2849 CHECK_NATNUM (length
);
2850 size
= XFASTINT (length
);
2855 val
= Fcons (init
, val
);
2860 val
= Fcons (init
, val
);
2865 val
= Fcons (init
, val
);
2870 val
= Fcons (init
, val
);
2875 val
= Fcons (init
, val
);
2890 /***********************************************************************
2892 ***********************************************************************/
2894 /* This value is balanced well enough to avoid too much internal overhead
2895 for the most common cases; it's not required to be a power of two, but
2896 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2898 #define VECTOR_BLOCK_SIZE 4096
2900 /* Align allocation request sizes to be a multiple of ROUNDUP_SIZE. */
2903 roundup_size
= COMMON_MULTIPLE (word_size
,
2904 USE_LSB_TAG
? 1 << GCTYPEBITS
: 1)
2907 /* ROUNDUP_SIZE must be a power of 2. */
2908 verify ((roundup_size
& (roundup_size
- 1)) == 0);
2910 /* Verify assumptions described above. */
2911 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2912 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2914 /* Round up X to nearest mult-of-ROUNDUP_SIZE. */
2916 #define vroundup(x) (((x) + (roundup_size - 1)) & ~(roundup_size - 1))
2918 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2920 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup (sizeof (void *)))
2922 /* Size of the minimal vector allocated from block. */
2924 #define VBLOCK_BYTES_MIN vroundup (sizeof (struct Lisp_Vector))
2926 /* Size of the largest vector allocated from block. */
2928 #define VBLOCK_BYTES_MAX \
2929 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2931 /* We maintain one free list for each possible block-allocated
2932 vector size, and this is the number of free lists we have. */
2934 #define VECTOR_MAX_FREE_LIST_INDEX \
2935 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2937 /* Common shortcut to advance vector pointer over a block data. */
2939 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2941 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2943 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2945 /* Common shortcut to setup vector on a free list. */
2947 #define SETUP_ON_FREE_LIST(v, nbytes, index) \
2949 XSETPVECTYPESIZE (v, PVEC_FREE, nbytes); \
2950 eassert ((nbytes) % roundup_size == 0); \
2951 (index) = VINDEX (nbytes); \
2952 eassert ((index) < VECTOR_MAX_FREE_LIST_INDEX); \
2953 (v)->header.next.vector = vector_free_lists[index]; \
2954 vector_free_lists[index] = (v); \
2955 total_free_vector_slots += (nbytes) / word_size; \
2960 char data
[VECTOR_BLOCK_BYTES
];
2961 struct vector_block
*next
;
2964 /* Chain of vector blocks. */
2966 static struct vector_block
*vector_blocks
;
2968 /* Vector free lists, where NTH item points to a chain of free
2969 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2971 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2973 /* Singly-linked list of large vectors. */
2975 static struct Lisp_Vector
*large_vectors
;
2977 /* The only vector with 0 slots, allocated from pure space. */
2979 Lisp_Object zero_vector
;
2981 /* Number of live vectors. */
2983 static EMACS_INT total_vectors
;
2985 /* Total size of live and free vectors, in Lisp_Object units. */
2987 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
2989 /* Get a new vector block. */
2991 static struct vector_block
*
2992 allocate_vector_block (void)
2994 struct vector_block
*block
= xmalloc (sizeof *block
);
2996 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
2997 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
2998 MEM_TYPE_VECTOR_BLOCK
);
3001 block
->next
= vector_blocks
;
3002 vector_blocks
= block
;
3006 /* Called once to initialize vector allocation. */
3011 zero_vector
= make_pure_vector (0);
3014 /* Allocate vector from a vector block. */
3016 static struct Lisp_Vector
*
3017 allocate_vector_from_block (size_t nbytes
)
3019 struct Lisp_Vector
*vector
, *rest
;
3020 struct vector_block
*block
;
3021 size_t index
, restbytes
;
3023 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
3024 eassert (nbytes
% roundup_size
== 0);
3026 /* First, try to allocate from a free list
3027 containing vectors of the requested size. */
3028 index
= VINDEX (nbytes
);
3029 if (vector_free_lists
[index
])
3031 vector
= vector_free_lists
[index
];
3032 vector_free_lists
[index
] = vector
->header
.next
.vector
;
3033 vector
->header
.next
.nbytes
= nbytes
;
3034 total_free_vector_slots
-= nbytes
/ word_size
;
3038 /* Next, check free lists containing larger vectors. Since
3039 we will split the result, we should have remaining space
3040 large enough to use for one-slot vector at least. */
3041 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
3042 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
3043 if (vector_free_lists
[index
])
3045 /* This vector is larger than requested. */
3046 vector
= vector_free_lists
[index
];
3047 vector_free_lists
[index
] = vector
->header
.next
.vector
;
3048 vector
->header
.next
.nbytes
= nbytes
;
3049 total_free_vector_slots
-= nbytes
/ word_size
;
3051 /* Excess bytes are used for the smaller vector,
3052 which should be set on an appropriate free list. */
3053 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
3054 eassert (restbytes
% roundup_size
== 0);
3055 rest
= ADVANCE (vector
, nbytes
);
3056 SETUP_ON_FREE_LIST (rest
, restbytes
, index
);
3060 /* Finally, need a new vector block. */
3061 block
= allocate_vector_block ();
3063 /* New vector will be at the beginning of this block. */
3064 vector
= (struct Lisp_Vector
*) block
->data
;
3065 vector
->header
.next
.nbytes
= nbytes
;
3067 /* If the rest of space from this block is large enough
3068 for one-slot vector at least, set up it on a free list. */
3069 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
3070 if (restbytes
>= VBLOCK_BYTES_MIN
)
3072 eassert (restbytes
% roundup_size
== 0);
3073 rest
= ADVANCE (vector
, nbytes
);
3074 SETUP_ON_FREE_LIST (rest
, restbytes
, index
);
3079 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
3081 #define VECTOR_IN_BLOCK(vector, block) \
3082 ((char *) (vector) <= (block)->data \
3083 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
3085 /* Number of bytes used by vector-block-allocated object. This is the only
3086 place where we actually use the `nbytes' field of the vector-header.
3087 I.e. we could get rid of the `nbytes' field by computing it based on the
3090 #define PSEUDOVECTOR_NBYTES(vector) \
3091 (PSEUDOVECTOR_TYPEP (&vector->header, PVEC_FREE) \
3092 ? vector->header.size & PSEUDOVECTOR_SIZE_MASK \
3093 : vector->header.next.nbytes)
3095 /* Reclaim space used by unmarked vectors. */
3098 sweep_vectors (void)
3100 struct vector_block
*block
= vector_blocks
, **bprev
= &vector_blocks
;
3101 struct Lisp_Vector
*vector
, *next
, **vprev
= &large_vectors
;
3103 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
3104 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
3106 /* Looking through vector blocks. */
3108 for (block
= vector_blocks
; block
; block
= *bprev
)
3110 int free_this_block
= 0;
3112 for (vector
= (struct Lisp_Vector
*) block
->data
;
3113 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
3115 if (VECTOR_MARKED_P (vector
))
3117 VECTOR_UNMARK (vector
);
3119 total_vector_slots
+= vector
->header
.next
.nbytes
/ word_size
;
3120 next
= ADVANCE (vector
, vector
->header
.next
.nbytes
);
3124 ptrdiff_t nbytes
= PSEUDOVECTOR_NBYTES (vector
);
3125 ptrdiff_t total_bytes
= nbytes
;
3127 next
= ADVANCE (vector
, nbytes
);
3129 /* While NEXT is not marked, try to coalesce with VECTOR,
3130 thus making VECTOR of the largest possible size. */
3132 while (VECTOR_IN_BLOCK (next
, block
))
3134 if (VECTOR_MARKED_P (next
))
3136 nbytes
= PSEUDOVECTOR_NBYTES (next
);
3137 total_bytes
+= nbytes
;
3138 next
= ADVANCE (next
, nbytes
);
3141 eassert (total_bytes
% roundup_size
== 0);
3143 if (vector
== (struct Lisp_Vector
*) block
->data
3144 && !VECTOR_IN_BLOCK (next
, block
))
3145 /* This block should be freed because all of it's
3146 space was coalesced into the only free vector. */
3147 free_this_block
= 1;
3151 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
3156 if (free_this_block
)
3158 *bprev
= block
->next
;
3159 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
3160 mem_delete (mem_find (block
->data
));
3165 bprev
= &block
->next
;
3168 /* Sweep large vectors. */
3170 for (vector
= large_vectors
; vector
; vector
= *vprev
)
3172 if (VECTOR_MARKED_P (vector
))
3174 VECTOR_UNMARK (vector
);
3176 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
3178 struct Lisp_Bool_Vector
*b
= (struct Lisp_Bool_Vector
*) vector
;
3180 /* All non-bool pseudovectors are small enough to be allocated
3181 from vector blocks. This code should be redesigned if some
3182 pseudovector type grows beyond VBLOCK_BYTES_MAX. */
3183 eassert (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_BOOL_VECTOR
));
3186 += (bool_header_size
3187 + ((b
->size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1)
3188 / BOOL_VECTOR_BITS_PER_CHAR
)) / word_size
;
3192 += header_size
/ word_size
+ vector
->header
.size
;
3193 vprev
= &vector
->header
.next
.vector
;
3197 *vprev
= vector
->header
.next
.vector
;
3203 /* Value is a pointer to a newly allocated Lisp_Vector structure
3204 with room for LEN Lisp_Objects. */
3206 static struct Lisp_Vector
*
3207 allocate_vectorlike (ptrdiff_t len
)
3209 struct Lisp_Vector
*p
;
3213 /* This gets triggered by code which I haven't bothered to fix. --Stef */
3214 /* eassert (!handling_signal); */
3217 p
= XVECTOR (zero_vector
);
3220 size_t nbytes
= header_size
+ len
* word_size
;
3222 #ifdef DOUG_LEA_MALLOC
3223 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
3224 because mapped region contents are not preserved in
3226 mallopt (M_MMAP_MAX
, 0);
3229 if (nbytes
<= VBLOCK_BYTES_MAX
)
3230 p
= allocate_vector_from_block (vroundup (nbytes
));
3233 p
= lisp_malloc (nbytes
, MEM_TYPE_VECTORLIKE
);
3234 p
->header
.next
.vector
= large_vectors
;
3238 #ifdef DOUG_LEA_MALLOC
3239 /* Back to a reasonable maximum of mmap'ed areas. */
3240 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3243 consing_since_gc
+= nbytes
;
3244 vector_cells_consed
+= len
;
3247 MALLOC_UNBLOCK_INPUT
;
3253 /* Allocate a vector with LEN slots. */
3255 struct Lisp_Vector
*
3256 allocate_vector (EMACS_INT len
)
3258 struct Lisp_Vector
*v
;
3259 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3261 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3262 memory_full (SIZE_MAX
);
3263 v
= allocate_vectorlike (len
);
3264 v
->header
.size
= len
;
3269 /* Allocate other vector-like structures. */
3271 struct Lisp_Vector
*
3272 allocate_pseudovector (int memlen
, int lisplen
, int tag
)
3274 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3277 /* Only the first lisplen slots will be traced normally by the GC. */
3278 for (i
= 0; i
< lisplen
; ++i
)
3279 v
->contents
[i
] = Qnil
;
3281 XSETPVECTYPESIZE (v
, tag
, lisplen
);
3286 allocate_buffer (void)
3288 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3290 XSETPVECTYPESIZE (b
, PVEC_BUFFER
, (offsetof (struct buffer
, own_text
)
3291 - header_size
) / word_size
);
3292 /* Note that the fields of B are not initialized. */
3296 struct Lisp_Hash_Table
*
3297 allocate_hash_table (void)
3299 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
3303 allocate_window (void)
3307 w
= ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
3308 /* Users assumes that non-Lisp data is zeroed. */
3309 memset (&w
->current_matrix
, 0,
3310 sizeof (*w
) - offsetof (struct window
, current_matrix
));
3315 allocate_terminal (void)
3319 t
= ALLOCATE_PSEUDOVECTOR (struct terminal
, next_terminal
, PVEC_TERMINAL
);
3320 /* Users assumes that non-Lisp data is zeroed. */
3321 memset (&t
->next_terminal
, 0,
3322 sizeof (*t
) - offsetof (struct terminal
, next_terminal
));
3327 allocate_frame (void)
3331 f
= ALLOCATE_PSEUDOVECTOR (struct frame
, face_cache
, PVEC_FRAME
);
3332 /* Users assumes that non-Lisp data is zeroed. */
3333 memset (&f
->face_cache
, 0,
3334 sizeof (*f
) - offsetof (struct frame
, face_cache
));
3338 struct Lisp_Process
*
3339 allocate_process (void)
3341 struct Lisp_Process
*p
;
3343 p
= ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3344 /* Users assumes that non-Lisp data is zeroed. */
3346 sizeof (*p
) - offsetof (struct Lisp_Process
, pid
));
3350 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3351 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3352 See also the function `vector'. */)
3353 (register Lisp_Object length
, Lisp_Object init
)
3356 register ptrdiff_t sizei
;
3357 register ptrdiff_t i
;
3358 register struct Lisp_Vector
*p
;
3360 CHECK_NATNUM (length
);
3362 p
= allocate_vector (XFASTINT (length
));
3363 sizei
= XFASTINT (length
);
3364 for (i
= 0; i
< sizei
; i
++)
3365 p
->contents
[i
] = init
;
3367 XSETVECTOR (vector
, p
);
3372 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3373 doc
: /* Return a newly created vector with specified arguments as elements.
3374 Any number of arguments, even zero arguments, are allowed.
3375 usage: (vector &rest OBJECTS) */)
3376 (ptrdiff_t nargs
, Lisp_Object
*args
)
3378 register Lisp_Object len
, val
;
3380 register struct Lisp_Vector
*p
;
3382 XSETFASTINT (len
, nargs
);
3383 val
= Fmake_vector (len
, Qnil
);
3385 for (i
= 0; i
< nargs
; i
++)
3386 p
->contents
[i
] = args
[i
];
3391 make_byte_code (struct Lisp_Vector
*v
)
3393 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3394 && STRING_MULTIBYTE (v
->contents
[1]))
3395 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3396 earlier because they produced a raw 8-bit string for byte-code
3397 and now such a byte-code string is loaded as multibyte while
3398 raw 8-bit characters converted to multibyte form. Thus, now we
3399 must convert them back to the original unibyte form. */
3400 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3401 XSETPVECTYPE (v
, PVEC_COMPILED
);
3404 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3405 doc
: /* Create a byte-code object with specified arguments as elements.
3406 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3407 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3408 and (optional) INTERACTIVE-SPEC.
3409 The first four arguments are required; at most six have any
3411 The ARGLIST can be either like the one of `lambda', in which case the arguments
3412 will be dynamically bound before executing the byte code, or it can be an
3413 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3414 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3415 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3416 argument to catch the left-over arguments. If such an integer is used, the
3417 arguments will not be dynamically bound but will be instead pushed on the
3418 stack before executing the byte-code.
3419 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3420 (ptrdiff_t nargs
, Lisp_Object
*args
)
3422 register Lisp_Object len
, val
;
3424 register struct Lisp_Vector
*p
;
3426 /* We used to purecopy everything here, if purify-flga was set. This worked
3427 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3428 dangerous, since make-byte-code is used during execution to build
3429 closures, so any closure built during the preload phase would end up
3430 copied into pure space, including its free variables, which is sometimes
3431 just wasteful and other times plainly wrong (e.g. those free vars may want
3434 XSETFASTINT (len
, nargs
);
3435 val
= Fmake_vector (len
, Qnil
);
3438 for (i
= 0; i
< nargs
; i
++)
3439 p
->contents
[i
] = args
[i
];
3441 XSETCOMPILED (val
, p
);
3447 /***********************************************************************
3449 ***********************************************************************/
3451 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3452 of the required alignment if LSB tags are used. */
3454 union aligned_Lisp_Symbol
3456 struct Lisp_Symbol s
;
3458 unsigned char c
[(sizeof (struct Lisp_Symbol
) + (1 << GCTYPEBITS
) - 1)
3459 & -(1 << GCTYPEBITS
)];
3463 /* Each symbol_block is just under 1020 bytes long, since malloc
3464 really allocates in units of powers of two and uses 4 bytes for its
3467 #define SYMBOL_BLOCK_SIZE \
3468 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3472 /* Place `symbols' first, to preserve alignment. */
3473 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3474 struct symbol_block
*next
;
3477 /* Current symbol block and index of first unused Lisp_Symbol
3480 static struct symbol_block
*symbol_block
;
3481 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3483 /* List of free symbols. */
3485 static struct Lisp_Symbol
*symbol_free_list
;
3487 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3488 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3489 Its value and function definition are void, and its property list is nil. */)
3492 register Lisp_Object val
;
3493 register struct Lisp_Symbol
*p
;
3495 CHECK_STRING (name
);
3497 /* eassert (!handling_signal); */
3501 if (symbol_free_list
)
3503 XSETSYMBOL (val
, symbol_free_list
);
3504 symbol_free_list
= symbol_free_list
->next
;
3508 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3510 struct symbol_block
*new
3511 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3512 new->next
= symbol_block
;
3514 symbol_block_index
= 0;
3515 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3517 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3518 symbol_block_index
++;
3521 MALLOC_UNBLOCK_INPUT
;
3524 SVAR (p
, xname
) = name
;
3525 SVAR (p
, plist
) = Qnil
;
3526 p
->redirect
= SYMBOL_PLAINVAL
;
3527 SET_SYMBOL_VAL (p
, Qunbound
);
3528 SVAR (p
, function
) = Qunbound
;
3531 p
->interned
= SYMBOL_UNINTERNED
;
3533 p
->declared_special
= 0;
3534 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3536 total_free_symbols
--;
3542 /***********************************************************************
3543 Marker (Misc) Allocation
3544 ***********************************************************************/
3546 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3547 the required alignment when LSB tags are used. */
3549 union aligned_Lisp_Misc
3553 unsigned char c
[(sizeof (union Lisp_Misc
) + (1 << GCTYPEBITS
) - 1)
3554 & -(1 << GCTYPEBITS
)];
3558 /* Allocation of markers and other objects that share that structure.
3559 Works like allocation of conses. */
3561 #define MARKER_BLOCK_SIZE \
3562 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3566 /* Place `markers' first, to preserve alignment. */
3567 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3568 struct marker_block
*next
;
3571 static struct marker_block
*marker_block
;
3572 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3574 static union Lisp_Misc
*marker_free_list
;
3576 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3579 allocate_misc (enum Lisp_Misc_Type type
)
3583 /* eassert (!handling_signal); */
3587 if (marker_free_list
)
3589 XSETMISC (val
, marker_free_list
);
3590 marker_free_list
= marker_free_list
->u_free
.chain
;
3594 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3596 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3597 new->next
= marker_block
;
3599 marker_block_index
= 0;
3600 total_free_markers
+= MARKER_BLOCK_SIZE
;
3602 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3603 marker_block_index
++;
3606 MALLOC_UNBLOCK_INPUT
;
3608 --total_free_markers
;
3609 consing_since_gc
+= sizeof (union Lisp_Misc
);
3610 misc_objects_consed
++;
3611 XMISCTYPE (val
) = type
;
3612 XMISCANY (val
)->gcmarkbit
= 0;
3616 /* Free a Lisp_Misc object */
3619 free_misc (Lisp_Object misc
)
3621 XMISCTYPE (misc
) = Lisp_Misc_Free
;
3622 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3623 marker_free_list
= XMISC (misc
);
3624 consing_since_gc
-= sizeof (union Lisp_Misc
);
3625 total_free_markers
++;
3628 /* Return a Lisp_Misc_Save_Value object containing POINTER and
3629 INTEGER. This is used to package C values to call record_unwind_protect.
3630 The unwind function can get the C values back using XSAVE_VALUE. */
3633 make_save_value (void *pointer
, ptrdiff_t integer
)
3635 register Lisp_Object val
;
3636 register struct Lisp_Save_Value
*p
;
3638 val
= allocate_misc (Lisp_Misc_Save_Value
);
3639 p
= XSAVE_VALUE (val
);
3640 p
->pointer
= pointer
;
3641 p
->integer
= integer
;
3646 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3649 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3651 register Lisp_Object overlay
;
3653 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3654 OVERLAY_START (overlay
) = start
;
3655 OVERLAY_END (overlay
) = end
;
3656 OVERLAY_PLIST (overlay
) = plist
;
3657 XOVERLAY (overlay
)->next
= NULL
;
3661 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3662 doc
: /* Return a newly allocated marker which does not point at any place. */)
3665 register Lisp_Object val
;
3666 register struct Lisp_Marker
*p
;
3668 val
= allocate_misc (Lisp_Misc_Marker
);
3674 p
->insertion_type
= 0;
3678 /* Return a newly allocated marker which points into BUF
3679 at character position CHARPOS and byte position BYTEPOS. */
3682 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3685 struct Lisp_Marker
*m
;
3687 /* No dead buffers here. */
3688 eassert (!NILP (BVAR (buf
, name
)));
3690 /* Every character is at least one byte. */
3691 eassert (charpos
<= bytepos
);
3693 obj
= allocate_misc (Lisp_Misc_Marker
);
3696 m
->charpos
= charpos
;
3697 m
->bytepos
= bytepos
;
3698 m
->insertion_type
= 0;
3699 m
->next
= BUF_MARKERS (buf
);
3700 BUF_MARKERS (buf
) = m
;
3704 /* Put MARKER back on the free list after using it temporarily. */
3707 free_marker (Lisp_Object marker
)
3709 unchain_marker (XMARKER (marker
));
3714 /* Return a newly created vector or string with specified arguments as
3715 elements. If all the arguments are characters that can fit
3716 in a string of events, make a string; otherwise, make a vector.
3718 Any number of arguments, even zero arguments, are allowed. */
3721 make_event_array (register int nargs
, Lisp_Object
*args
)
3725 for (i
= 0; i
< nargs
; i
++)
3726 /* The things that fit in a string
3727 are characters that are in 0...127,
3728 after discarding the meta bit and all the bits above it. */
3729 if (!INTEGERP (args
[i
])
3730 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3731 return Fvector (nargs
, args
);
3733 /* Since the loop exited, we know that all the things in it are
3734 characters, so we can make a string. */
3738 result
= Fmake_string (make_number (nargs
), make_number (0));
3739 for (i
= 0; i
< nargs
; i
++)
3741 SSET (result
, i
, XINT (args
[i
]));
3742 /* Move the meta bit to the right place for a string char. */
3743 if (XINT (args
[i
]) & CHAR_META
)
3744 SSET (result
, i
, SREF (result
, i
) | 0x80);
3753 /************************************************************************
3754 Memory Full Handling
3755 ************************************************************************/
3758 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3759 there may have been size_t overflow so that malloc was never
3760 called, or perhaps malloc was invoked successfully but the
3761 resulting pointer had problems fitting into a tagged EMACS_INT. In
3762 either case this counts as memory being full even though malloc did
3766 memory_full (size_t nbytes
)
3768 /* Do not go into hysterics merely because a large request failed. */
3769 int enough_free_memory
= 0;
3770 if (SPARE_MEMORY
< nbytes
)
3775 p
= malloc (SPARE_MEMORY
);
3779 enough_free_memory
= 1;
3781 MALLOC_UNBLOCK_INPUT
;
3784 if (! enough_free_memory
)
3790 memory_full_cons_threshold
= sizeof (struct cons_block
);
3792 /* The first time we get here, free the spare memory. */
3793 for (i
= 0; i
< sizeof (spare_memory
) / sizeof (char *); i
++)
3794 if (spare_memory
[i
])
3797 free (spare_memory
[i
]);
3798 else if (i
>= 1 && i
<= 4)
3799 lisp_align_free (spare_memory
[i
]);
3801 lisp_free (spare_memory
[i
]);
3802 spare_memory
[i
] = 0;
3805 /* Record the space now used. When it decreases substantially,
3806 we can refill the memory reserve. */
3807 #if !defined SYSTEM_MALLOC && !defined SYNC_INPUT
3808 bytes_used_when_full
= BYTES_USED
;
3812 /* This used to call error, but if we've run out of memory, we could
3813 get infinite recursion trying to build the string. */
3814 xsignal (Qnil
, Vmemory_signal_data
);
3817 /* If we released our reserve (due to running out of memory),
3818 and we have a fair amount free once again,
3819 try to set aside another reserve in case we run out once more.
3821 This is called when a relocatable block is freed in ralloc.c,
3822 and also directly from this file, in case we're not using ralloc.c. */
3825 refill_memory_reserve (void)
3827 #ifndef SYSTEM_MALLOC
3828 if (spare_memory
[0] == 0)
3829 spare_memory
[0] = malloc (SPARE_MEMORY
);
3830 if (spare_memory
[1] == 0)
3831 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
3833 if (spare_memory
[2] == 0)
3834 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
3836 if (spare_memory
[3] == 0)
3837 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
3839 if (spare_memory
[4] == 0)
3840 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
3842 if (spare_memory
[5] == 0)
3843 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
3845 if (spare_memory
[6] == 0)
3846 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
3848 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3849 Vmemory_full
= Qnil
;
3853 /************************************************************************
3855 ************************************************************************/
3857 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3859 /* Conservative C stack marking requires a method to identify possibly
3860 live Lisp objects given a pointer value. We do this by keeping
3861 track of blocks of Lisp data that are allocated in a red-black tree
3862 (see also the comment of mem_node which is the type of nodes in
3863 that tree). Function lisp_malloc adds information for an allocated
3864 block to the red-black tree with calls to mem_insert, and function
3865 lisp_free removes it with mem_delete. Functions live_string_p etc
3866 call mem_find to lookup information about a given pointer in the
3867 tree, and use that to determine if the pointer points to a Lisp
3870 /* Initialize this part of alloc.c. */
3875 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3876 mem_z
.parent
= NULL
;
3877 mem_z
.color
= MEM_BLACK
;
3878 mem_z
.start
= mem_z
.end
= NULL
;
3883 /* Value is a pointer to the mem_node containing START. Value is
3884 MEM_NIL if there is no node in the tree containing START. */
3886 static inline struct mem_node
*
3887 mem_find (void *start
)
3891 if (start
< min_heap_address
|| start
> max_heap_address
)
3894 /* Make the search always successful to speed up the loop below. */
3895 mem_z
.start
= start
;
3896 mem_z
.end
= (char *) start
+ 1;
3899 while (start
< p
->start
|| start
>= p
->end
)
3900 p
= start
< p
->start
? p
->left
: p
->right
;
3905 /* Insert a new node into the tree for a block of memory with start
3906 address START, end address END, and type TYPE. Value is a
3907 pointer to the node that was inserted. */
3909 static struct mem_node
*
3910 mem_insert (void *start
, void *end
, enum mem_type type
)
3912 struct mem_node
*c
, *parent
, *x
;
3914 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3915 min_heap_address
= start
;
3916 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3917 max_heap_address
= end
;
3919 /* See where in the tree a node for START belongs. In this
3920 particular application, it shouldn't happen that a node is already
3921 present. For debugging purposes, let's check that. */
3925 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3927 while (c
!= MEM_NIL
)
3929 if (start
>= c
->start
&& start
< c
->end
)
3932 c
= start
< c
->start
? c
->left
: c
->right
;
3935 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3937 while (c
!= MEM_NIL
)
3940 c
= start
< c
->start
? c
->left
: c
->right
;
3943 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3945 /* Create a new node. */
3946 #ifdef GC_MALLOC_CHECK
3947 x
= _malloc_internal (sizeof *x
);
3951 x
= xmalloc (sizeof *x
);
3957 x
->left
= x
->right
= MEM_NIL
;
3960 /* Insert it as child of PARENT or install it as root. */
3963 if (start
< parent
->start
)
3971 /* Re-establish red-black tree properties. */
3972 mem_insert_fixup (x
);
3978 /* Re-establish the red-black properties of the tree, and thereby
3979 balance the tree, after node X has been inserted; X is always red. */
3982 mem_insert_fixup (struct mem_node
*x
)
3984 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3986 /* X is red and its parent is red. This is a violation of
3987 red-black tree property #3. */
3989 if (x
->parent
== x
->parent
->parent
->left
)
3991 /* We're on the left side of our grandparent, and Y is our
3993 struct mem_node
*y
= x
->parent
->parent
->right
;
3995 if (y
->color
== MEM_RED
)
3997 /* Uncle and parent are red but should be black because
3998 X is red. Change the colors accordingly and proceed
3999 with the grandparent. */
4000 x
->parent
->color
= MEM_BLACK
;
4001 y
->color
= MEM_BLACK
;
4002 x
->parent
->parent
->color
= MEM_RED
;
4003 x
= x
->parent
->parent
;
4007 /* Parent and uncle have different colors; parent is
4008 red, uncle is black. */
4009 if (x
== x
->parent
->right
)
4012 mem_rotate_left (x
);
4015 x
->parent
->color
= MEM_BLACK
;
4016 x
->parent
->parent
->color
= MEM_RED
;
4017 mem_rotate_right (x
->parent
->parent
);
4022 /* This is the symmetrical case of above. */
4023 struct mem_node
*y
= x
->parent
->parent
->left
;
4025 if (y
->color
== MEM_RED
)
4027 x
->parent
->color
= MEM_BLACK
;
4028 y
->color
= MEM_BLACK
;
4029 x
->parent
->parent
->color
= MEM_RED
;
4030 x
= x
->parent
->parent
;
4034 if (x
== x
->parent
->left
)
4037 mem_rotate_right (x
);
4040 x
->parent
->color
= MEM_BLACK
;
4041 x
->parent
->parent
->color
= MEM_RED
;
4042 mem_rotate_left (x
->parent
->parent
);
4047 /* The root may have been changed to red due to the algorithm. Set
4048 it to black so that property #5 is satisfied. */
4049 mem_root
->color
= MEM_BLACK
;
4060 mem_rotate_left (struct mem_node
*x
)
4064 /* Turn y's left sub-tree into x's right sub-tree. */
4067 if (y
->left
!= MEM_NIL
)
4068 y
->left
->parent
= x
;
4070 /* Y's parent was x's parent. */
4072 y
->parent
= x
->parent
;
4074 /* Get the parent to point to y instead of x. */
4077 if (x
== x
->parent
->left
)
4078 x
->parent
->left
= y
;
4080 x
->parent
->right
= y
;
4085 /* Put x on y's left. */
4099 mem_rotate_right (struct mem_node
*x
)
4101 struct mem_node
*y
= x
->left
;
4104 if (y
->right
!= MEM_NIL
)
4105 y
->right
->parent
= x
;
4108 y
->parent
= x
->parent
;
4111 if (x
== x
->parent
->right
)
4112 x
->parent
->right
= y
;
4114 x
->parent
->left
= y
;
4125 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4128 mem_delete (struct mem_node
*z
)
4130 struct mem_node
*x
, *y
;
4132 if (!z
|| z
== MEM_NIL
)
4135 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4140 while (y
->left
!= MEM_NIL
)
4144 if (y
->left
!= MEM_NIL
)
4149 x
->parent
= y
->parent
;
4152 if (y
== y
->parent
->left
)
4153 y
->parent
->left
= x
;
4155 y
->parent
->right
= x
;
4162 z
->start
= y
->start
;
4167 if (y
->color
== MEM_BLACK
)
4168 mem_delete_fixup (x
);
4170 #ifdef GC_MALLOC_CHECK
4178 /* Re-establish the red-black properties of the tree, after a
4182 mem_delete_fixup (struct mem_node
*x
)
4184 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4186 if (x
== x
->parent
->left
)
4188 struct mem_node
*w
= x
->parent
->right
;
4190 if (w
->color
== MEM_RED
)
4192 w
->color
= MEM_BLACK
;
4193 x
->parent
->color
= MEM_RED
;
4194 mem_rotate_left (x
->parent
);
4195 w
= x
->parent
->right
;
4198 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4205 if (w
->right
->color
== MEM_BLACK
)
4207 w
->left
->color
= MEM_BLACK
;
4209 mem_rotate_right (w
);
4210 w
= x
->parent
->right
;
4212 w
->color
= x
->parent
->color
;
4213 x
->parent
->color
= MEM_BLACK
;
4214 w
->right
->color
= MEM_BLACK
;
4215 mem_rotate_left (x
->parent
);
4221 struct mem_node
*w
= x
->parent
->left
;
4223 if (w
->color
== MEM_RED
)
4225 w
->color
= MEM_BLACK
;
4226 x
->parent
->color
= MEM_RED
;
4227 mem_rotate_right (x
->parent
);
4228 w
= x
->parent
->left
;
4231 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4238 if (w
->left
->color
== MEM_BLACK
)
4240 w
->right
->color
= MEM_BLACK
;
4242 mem_rotate_left (w
);
4243 w
= x
->parent
->left
;
4246 w
->color
= x
->parent
->color
;
4247 x
->parent
->color
= MEM_BLACK
;
4248 w
->left
->color
= MEM_BLACK
;
4249 mem_rotate_right (x
->parent
);
4255 x
->color
= MEM_BLACK
;
4259 /* Value is non-zero if P is a pointer to a live Lisp string on
4260 the heap. M is a pointer to the mem_block for P. */
4263 live_string_p (struct mem_node
*m
, void *p
)
4265 if (m
->type
== MEM_TYPE_STRING
)
4267 struct string_block
*b
= (struct string_block
*) m
->start
;
4268 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4270 /* P must point to the start of a Lisp_String structure, and it
4271 must not be on the free-list. */
4273 && offset
% sizeof b
->strings
[0] == 0
4274 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4275 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4282 /* Value is non-zero if P is a pointer to a live Lisp cons on
4283 the heap. M is a pointer to the mem_block for P. */
4286 live_cons_p (struct mem_node
*m
, void *p
)
4288 if (m
->type
== MEM_TYPE_CONS
)
4290 struct cons_block
*b
= (struct cons_block
*) m
->start
;
4291 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4293 /* P must point to the start of a Lisp_Cons, not be
4294 one of the unused cells in the current cons block,
4295 and not be on the free-list. */
4297 && offset
% sizeof b
->conses
[0] == 0
4298 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4300 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4301 && !EQ (CVAR ((struct Lisp_Cons
*) p
, car
), Vdead
));
4308 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4309 the heap. M is a pointer to the mem_block for P. */
4312 live_symbol_p (struct mem_node
*m
, void *p
)
4314 if (m
->type
== MEM_TYPE_SYMBOL
)
4316 struct symbol_block
*b
= (struct symbol_block
*) m
->start
;
4317 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4319 /* P must point to the start of a Lisp_Symbol, not be
4320 one of the unused cells in the current symbol block,
4321 and not be on the free-list. */
4323 && offset
% sizeof b
->symbols
[0] == 0
4324 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4325 && (b
!= symbol_block
4326 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4327 && !EQ (SVAR (((struct Lisp_Symbol
*)p
), function
), Vdead
));
4334 /* Value is non-zero if P is a pointer to a live Lisp float on
4335 the heap. M is a pointer to the mem_block for P. */
4338 live_float_p (struct mem_node
*m
, void *p
)
4340 if (m
->type
== MEM_TYPE_FLOAT
)
4342 struct float_block
*b
= (struct float_block
*) m
->start
;
4343 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4345 /* P must point to the start of a Lisp_Float and not be
4346 one of the unused cells in the current float block. */
4348 && offset
% sizeof b
->floats
[0] == 0
4349 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4350 && (b
!= float_block
4351 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4358 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4359 the heap. M is a pointer to the mem_block for P. */
4362 live_misc_p (struct mem_node
*m
, void *p
)
4364 if (m
->type
== MEM_TYPE_MISC
)
4366 struct marker_block
*b
= (struct marker_block
*) m
->start
;
4367 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4369 /* P must point to the start of a Lisp_Misc, not be
4370 one of the unused cells in the current misc block,
4371 and not be on the free-list. */
4373 && offset
% sizeof b
->markers
[0] == 0
4374 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4375 && (b
!= marker_block
4376 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4377 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4384 /* Value is non-zero if P is a pointer to a live vector-like object.
4385 M is a pointer to the mem_block for P. */
4388 live_vector_p (struct mem_node
*m
, void *p
)
4390 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4392 /* This memory node corresponds to a vector block. */
4393 struct vector_block
*block
= (struct vector_block
*) m
->start
;
4394 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4396 /* P is in the block's allocation range. Scan the block
4397 up to P and see whether P points to the start of some
4398 vector which is not on a free list. FIXME: check whether
4399 some allocation patterns (probably a lot of short vectors)
4400 may cause a substantial overhead of this loop. */
4401 while (VECTOR_IN_BLOCK (vector
, block
)
4402 && vector
<= (struct Lisp_Vector
*) p
)
4404 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
))
4405 vector
= ADVANCE (vector
, (vector
->header
.size
4406 & PSEUDOVECTOR_SIZE_MASK
));
4407 else if (vector
== p
)
4410 vector
= ADVANCE (vector
, vector
->header
.next
.nbytes
);
4413 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== m
->start
)
4414 /* This memory node corresponds to a large vector. */
4420 /* Value is non-zero if P is a pointer to a live buffer. M is a
4421 pointer to the mem_block for P. */
4424 live_buffer_p (struct mem_node
*m
, void *p
)
4426 /* P must point to the start of the block, and the buffer
4427 must not have been killed. */
4428 return (m
->type
== MEM_TYPE_BUFFER
4430 && !NILP (((struct buffer
*) p
)->INTERNAL_FIELD (name
)));
4433 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4437 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4439 /* Array of objects that are kept alive because the C stack contains
4440 a pattern that looks like a reference to them . */
4442 #define MAX_ZOMBIES 10
4443 static Lisp_Object zombies
[MAX_ZOMBIES
];
4445 /* Number of zombie objects. */
4447 static EMACS_INT nzombies
;
4449 /* Number of garbage collections. */
4451 static EMACS_INT ngcs
;
4453 /* Average percentage of zombies per collection. */
4455 static double avg_zombies
;
4457 /* Max. number of live and zombie objects. */
4459 static EMACS_INT max_live
, max_zombies
;
4461 /* Average number of live objects per GC. */
4463 static double avg_live
;
4465 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4466 doc
: /* Show information about live and zombie objects. */)
4469 Lisp_Object args
[8], zombie_list
= Qnil
;
4471 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); i
++)
4472 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4473 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4474 args
[1] = make_number (ngcs
);
4475 args
[2] = make_float (avg_live
);
4476 args
[3] = make_float (avg_zombies
);
4477 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4478 args
[5] = make_number (max_live
);
4479 args
[6] = make_number (max_zombies
);
4480 args
[7] = zombie_list
;
4481 return Fmessage (8, args
);
4484 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4487 /* Mark OBJ if we can prove it's a Lisp_Object. */
4490 mark_maybe_object (Lisp_Object obj
)
4498 po
= (void *) XPNTR (obj
);
4505 switch (XTYPE (obj
))
4508 mark_p
= (live_string_p (m
, po
)
4509 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4513 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4517 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4521 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4524 case Lisp_Vectorlike
:
4525 /* Note: can't check BUFFERP before we know it's a
4526 buffer because checking that dereferences the pointer
4527 PO which might point anywhere. */
4528 if (live_vector_p (m
, po
))
4529 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4530 else if (live_buffer_p (m
, po
))
4531 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4535 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4544 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4545 if (nzombies
< MAX_ZOMBIES
)
4546 zombies
[nzombies
] = obj
;
4555 /* If P points to Lisp data, mark that as live if it isn't already
4559 mark_maybe_pointer (void *p
)
4563 /* Quickly rule out some values which can't point to Lisp data.
4564 USE_LSB_TAG needs Lisp data to be aligned on multiples of 1 << GCTYPEBITS.
4565 Otherwise, assume that Lisp data is aligned on even addresses. */
4566 if ((intptr_t) p
% (USE_LSB_TAG
? 1 << GCTYPEBITS
: 2))
4572 Lisp_Object obj
= Qnil
;
4576 case MEM_TYPE_NON_LISP
:
4577 /* Nothing to do; not a pointer to Lisp memory. */
4580 case MEM_TYPE_BUFFER
:
4581 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4582 XSETVECTOR (obj
, p
);
4586 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4590 case MEM_TYPE_STRING
:
4591 if (live_string_p (m
, p
)
4592 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4593 XSETSTRING (obj
, p
);
4597 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4601 case MEM_TYPE_SYMBOL
:
4602 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4603 XSETSYMBOL (obj
, p
);
4606 case MEM_TYPE_FLOAT
:
4607 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4611 case MEM_TYPE_VECTORLIKE
:
4612 case MEM_TYPE_VECTOR_BLOCK
:
4613 if (live_vector_p (m
, p
))
4616 XSETVECTOR (tem
, p
);
4617 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4632 /* Alignment of pointer values. Use alignof, as it sometimes returns
4633 a smaller alignment than GCC's __alignof__ and mark_memory might
4634 miss objects if __alignof__ were used. */
4635 #define GC_POINTER_ALIGNMENT alignof (void *)
4637 /* Define POINTERS_MIGHT_HIDE_IN_OBJECTS to 1 if marking via C pointers does
4638 not suffice, which is the typical case. A host where a Lisp_Object is
4639 wider than a pointer might allocate a Lisp_Object in non-adjacent halves.
4640 If USE_LSB_TAG, the bottom half is not a valid pointer, but it should
4641 suffice to widen it to to a Lisp_Object and check it that way. */
4642 #if USE_LSB_TAG || VAL_MAX < UINTPTR_MAX
4643 # if !USE_LSB_TAG && VAL_MAX < UINTPTR_MAX >> GCTYPEBITS
4644 /* If tag bits straddle pointer-word boundaries, neither mark_maybe_pointer
4645 nor mark_maybe_object can follow the pointers. This should not occur on
4646 any practical porting target. */
4647 # error "MSB type bits straddle pointer-word boundaries"
4649 /* Marking via C pointers does not suffice, because Lisp_Objects contain
4650 pointer words that hold pointers ORed with type bits. */
4651 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 1
4653 /* Marking via C pointers suffices, because Lisp_Objects contain pointer
4654 words that hold unmodified pointers. */
4655 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 0
4658 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4659 or END+OFFSET..START. */
4662 mark_memory (void *start
, void *end
)
4663 #if defined (__clang__) && defined (__has_feature)
4664 #if __has_feature(address_sanitizer)
4665 /* Do not allow -faddress-sanitizer to check this function, since it
4666 crosses the function stack boundary, and thus would yield many
4668 __attribute__((no_address_safety_analysis
))
4675 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4679 /* Make START the pointer to the start of the memory region,
4680 if it isn't already. */
4688 /* Mark Lisp data pointed to. This is necessary because, in some
4689 situations, the C compiler optimizes Lisp objects away, so that
4690 only a pointer to them remains. Example:
4692 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4695 Lisp_Object obj = build_string ("test");
4696 struct Lisp_String *s = XSTRING (obj);
4697 Fgarbage_collect ();
4698 fprintf (stderr, "test `%s'\n", s->data);
4702 Here, `obj' isn't really used, and the compiler optimizes it
4703 away. The only reference to the life string is through the
4706 for (pp
= start
; (void *) pp
< end
; pp
++)
4707 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4709 void *p
= *(void **) ((char *) pp
+ i
);
4710 mark_maybe_pointer (p
);
4711 if (POINTERS_MIGHT_HIDE_IN_OBJECTS
)
4712 mark_maybe_object (XIL ((intptr_t) p
));
4716 /* setjmp will work with GCC unless NON_SAVING_SETJMP is defined in
4717 the GCC system configuration. In gcc 3.2, the only systems for
4718 which this is so are i386-sco5 non-ELF, i386-sysv3 (maybe included
4719 by others?) and ns32k-pc532-min. */
4721 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4723 static int setjmp_tested_p
, longjmps_done
;
4725 #define SETJMP_WILL_LIKELY_WORK "\
4727 Emacs garbage collector has been changed to use conservative stack\n\
4728 marking. Emacs has determined that the method it uses to do the\n\
4729 marking will likely work on your system, but this isn't sure.\n\
4731 If you are a system-programmer, or can get the help of a local wizard\n\
4732 who is, please take a look at the function mark_stack in alloc.c, and\n\
4733 verify that the methods used are appropriate for your system.\n\
4735 Please mail the result to <emacs-devel@gnu.org>.\n\
4738 #define SETJMP_WILL_NOT_WORK "\
4740 Emacs garbage collector has been changed to use conservative stack\n\
4741 marking. Emacs has determined that the default method it uses to do the\n\
4742 marking will not work on your system. We will need a system-dependent\n\
4743 solution for your system.\n\
4745 Please take a look at the function mark_stack in alloc.c, and\n\
4746 try to find a way to make it work on your system.\n\
4748 Note that you may get false negatives, depending on the compiler.\n\
4749 In particular, you need to use -O with GCC for this test.\n\
4751 Please mail the result to <emacs-devel@gnu.org>.\n\
4755 /* Perform a quick check if it looks like setjmp saves registers in a
4756 jmp_buf. Print a message to stderr saying so. When this test
4757 succeeds, this is _not_ a proof that setjmp is sufficient for
4758 conservative stack marking. Only the sources or a disassembly
4769 /* Arrange for X to be put in a register. */
4775 if (longjmps_done
== 1)
4777 /* Came here after the longjmp at the end of the function.
4779 If x == 1, the longjmp has restored the register to its
4780 value before the setjmp, and we can hope that setjmp
4781 saves all such registers in the jmp_buf, although that
4784 For other values of X, either something really strange is
4785 taking place, or the setjmp just didn't save the register. */
4788 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4791 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4798 if (longjmps_done
== 1)
4802 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4805 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4807 /* Abort if anything GCPRO'd doesn't survive the GC. */
4815 for (p
= gcprolist
; p
; p
= p
->next
)
4816 for (i
= 0; i
< p
->nvars
; ++i
)
4817 if (!survives_gc_p (p
->var
[i
]))
4818 /* FIXME: It's not necessarily a bug. It might just be that the
4819 GCPRO is unnecessary or should release the object sooner. */
4823 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4830 fprintf (stderr
, "\nZombies kept alive = %"pI
"d:\n", nzombies
);
4831 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4833 fprintf (stderr
, " %d = ", i
);
4834 debug_print (zombies
[i
]);
4838 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4841 /* Mark live Lisp objects on the C stack.
4843 There are several system-dependent problems to consider when
4844 porting this to new architectures:
4848 We have to mark Lisp objects in CPU registers that can hold local
4849 variables or are used to pass parameters.
4851 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4852 something that either saves relevant registers on the stack, or
4853 calls mark_maybe_object passing it each register's contents.
4855 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4856 implementation assumes that calling setjmp saves registers we need
4857 to see in a jmp_buf which itself lies on the stack. This doesn't
4858 have to be true! It must be verified for each system, possibly
4859 by taking a look at the source code of setjmp.
4861 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4862 can use it as a machine independent method to store all registers
4863 to the stack. In this case the macros described in the previous
4864 two paragraphs are not used.
4868 Architectures differ in the way their processor stack is organized.
4869 For example, the stack might look like this
4872 | Lisp_Object | size = 4
4874 | something else | size = 2
4876 | Lisp_Object | size = 4
4880 In such a case, not every Lisp_Object will be aligned equally. To
4881 find all Lisp_Object on the stack it won't be sufficient to walk
4882 the stack in steps of 4 bytes. Instead, two passes will be
4883 necessary, one starting at the start of the stack, and a second
4884 pass starting at the start of the stack + 2. Likewise, if the
4885 minimal alignment of Lisp_Objects on the stack is 1, four passes
4886 would be necessary, each one starting with one byte more offset
4887 from the stack start. */
4894 #ifdef HAVE___BUILTIN_UNWIND_INIT
4895 /* Force callee-saved registers and register windows onto the stack.
4896 This is the preferred method if available, obviating the need for
4897 machine dependent methods. */
4898 __builtin_unwind_init ();
4900 #else /* not HAVE___BUILTIN_UNWIND_INIT */
4901 #ifndef GC_SAVE_REGISTERS_ON_STACK
4902 /* jmp_buf may not be aligned enough on darwin-ppc64 */
4903 union aligned_jmpbuf
{
4907 volatile int stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4909 /* This trick flushes the register windows so that all the state of
4910 the process is contained in the stack. */
4911 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4912 needed on ia64 too. See mach_dep.c, where it also says inline
4913 assembler doesn't work with relevant proprietary compilers. */
4915 #if defined (__sparc64__) && defined (__FreeBSD__)
4916 /* FreeBSD does not have a ta 3 handler. */
4923 /* Save registers that we need to see on the stack. We need to see
4924 registers used to hold register variables and registers used to
4926 #ifdef GC_SAVE_REGISTERS_ON_STACK
4927 GC_SAVE_REGISTERS_ON_STACK (end
);
4928 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4930 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4931 setjmp will definitely work, test it
4932 and print a message with the result
4934 if (!setjmp_tested_p
)
4936 setjmp_tested_p
= 1;
4939 #endif /* GC_SETJMP_WORKS */
4942 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4943 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4944 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
4946 /* This assumes that the stack is a contiguous region in memory. If
4947 that's not the case, something has to be done here to iterate
4948 over the stack segments. */
4949 mark_memory (stack_base
, end
);
4951 /* Allow for marking a secondary stack, like the register stack on the
4953 #ifdef GC_MARK_SECONDARY_STACK
4954 GC_MARK_SECONDARY_STACK ();
4957 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4962 #endif /* GC_MARK_STACK != 0 */
4965 /* Determine whether it is safe to access memory at address P. */
4967 valid_pointer_p (void *p
)
4970 return w32_valid_pointer_p (p
, 16);
4974 /* Obviously, we cannot just access it (we would SEGV trying), so we
4975 trick the o/s to tell us whether p is a valid pointer.
4976 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4977 not validate p in that case. */
4981 int valid
= (emacs_write (fd
[1], (char *) p
, 16) == 16);
4982 emacs_close (fd
[1]);
4983 emacs_close (fd
[0]);
4991 /* Return 1 if OBJ is a valid lisp object.
4992 Return 0 if OBJ is NOT a valid lisp object.
4993 Return -1 if we cannot validate OBJ.
4994 This function can be quite slow,
4995 so it should only be used in code for manual debugging. */
4998 valid_lisp_object_p (Lisp_Object obj
)
5008 p
= (void *) XPNTR (obj
);
5009 if (PURE_POINTER_P (p
))
5013 return valid_pointer_p (p
);
5020 int valid
= valid_pointer_p (p
);
5032 case MEM_TYPE_NON_LISP
:
5035 case MEM_TYPE_BUFFER
:
5036 return live_buffer_p (m
, p
);
5039 return live_cons_p (m
, p
);
5041 case MEM_TYPE_STRING
:
5042 return live_string_p (m
, p
);
5045 return live_misc_p (m
, p
);
5047 case MEM_TYPE_SYMBOL
:
5048 return live_symbol_p (m
, p
);
5050 case MEM_TYPE_FLOAT
:
5051 return live_float_p (m
, p
);
5053 case MEM_TYPE_VECTORLIKE
:
5054 case MEM_TYPE_VECTOR_BLOCK
:
5055 return live_vector_p (m
, p
);
5068 /***********************************************************************
5069 Pure Storage Management
5070 ***********************************************************************/
5072 /* Allocate room for SIZE bytes from pure Lisp storage and return a
5073 pointer to it. TYPE is the Lisp type for which the memory is
5074 allocated. TYPE < 0 means it's not used for a Lisp object. */
5077 pure_alloc (size_t size
, int type
)
5081 size_t alignment
= (1 << GCTYPEBITS
);
5083 size_t alignment
= alignof (EMACS_INT
);
5085 /* Give Lisp_Floats an extra alignment. */
5086 if (type
== Lisp_Float
)
5087 alignment
= alignof (struct Lisp_Float
);
5093 /* Allocate space for a Lisp object from the beginning of the free
5094 space with taking account of alignment. */
5095 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
5096 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
5100 /* Allocate space for a non-Lisp object from the end of the free
5102 pure_bytes_used_non_lisp
+= size
;
5103 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5105 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
5107 if (pure_bytes_used
<= pure_size
)
5110 /* Don't allocate a large amount here,
5111 because it might get mmap'd and then its address
5112 might not be usable. */
5113 purebeg
= xmalloc (10000);
5115 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
5116 pure_bytes_used
= 0;
5117 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
5122 /* Print a warning if PURESIZE is too small. */
5125 check_pure_size (void)
5127 if (pure_bytes_used_before_overflow
)
5128 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
5130 pure_bytes_used
+ pure_bytes_used_before_overflow
);
5134 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
5135 the non-Lisp data pool of the pure storage, and return its start
5136 address. Return NULL if not found. */
5139 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5142 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5143 const unsigned char *p
;
5146 if (pure_bytes_used_non_lisp
<= nbytes
)
5149 /* Set up the Boyer-Moore table. */
5151 for (i
= 0; i
< 256; i
++)
5154 p
= (const unsigned char *) data
;
5156 bm_skip
[*p
++] = skip
;
5158 last_char_skip
= bm_skip
['\0'];
5160 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5161 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5163 /* See the comments in the function `boyer_moore' (search.c) for the
5164 use of `infinity'. */
5165 infinity
= pure_bytes_used_non_lisp
+ 1;
5166 bm_skip
['\0'] = infinity
;
5168 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5172 /* Check the last character (== '\0'). */
5175 start
+= bm_skip
[*(p
+ start
)];
5177 while (start
<= start_max
);
5179 if (start
< infinity
)
5180 /* Couldn't find the last character. */
5183 /* No less than `infinity' means we could find the last
5184 character at `p[start - infinity]'. */
5187 /* Check the remaining characters. */
5188 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5190 return non_lisp_beg
+ start
;
5192 start
+= last_char_skip
;
5194 while (start
<= start_max
);
5200 /* Return a string allocated in pure space. DATA is a buffer holding
5201 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5202 non-zero means make the result string multibyte.
5204 Must get an error if pure storage is full, since if it cannot hold
5205 a large string it may be able to hold conses that point to that
5206 string; then the string is not protected from gc. */
5209 make_pure_string (const char *data
,
5210 ptrdiff_t nchars
, ptrdiff_t nbytes
, int multibyte
)
5213 struct Lisp_String
*s
;
5215 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
5216 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5217 if (s
->data
== NULL
)
5219 s
->data
= (unsigned char *) pure_alloc (nbytes
+ 1, -1);
5220 memcpy (s
->data
, data
, nbytes
);
5221 s
->data
[nbytes
] = '\0';
5224 s
->size_byte
= multibyte
? nbytes
: -1;
5225 s
->intervals
= NULL_INTERVAL
;
5226 XSETSTRING (string
, s
);
5230 /* Return a string allocated in pure space. Do not
5231 allocate the string data, just point to DATA. */
5234 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5237 struct Lisp_String
*s
;
5239 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
5242 s
->data
= (unsigned char *) data
;
5243 s
->intervals
= NULL_INTERVAL
;
5244 XSETSTRING (string
, s
);
5248 /* Return a cons allocated from pure space. Give it pure copies
5249 of CAR as car and CDR as cdr. */
5252 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5254 register Lisp_Object
new;
5255 struct Lisp_Cons
*p
;
5257 p
= (struct Lisp_Cons
*) pure_alloc (sizeof *p
, Lisp_Cons
);
5259 XSETCAR (new, Fpurecopy (car
));
5260 XSETCDR (new, Fpurecopy (cdr
));
5265 /* Value is a float object with value NUM allocated from pure space. */
5268 make_pure_float (double num
)
5270 register Lisp_Object
new;
5271 struct Lisp_Float
*p
;
5273 p
= (struct Lisp_Float
*) pure_alloc (sizeof *p
, Lisp_Float
);
5275 XFLOAT_INIT (new, num
);
5280 /* Return a vector with room for LEN Lisp_Objects allocated from
5284 make_pure_vector (ptrdiff_t len
)
5287 struct Lisp_Vector
*p
;
5288 size_t size
= header_size
+ len
* word_size
;
5290 p
= (struct Lisp_Vector
*) pure_alloc (size
, Lisp_Vectorlike
);
5291 XSETVECTOR (new, p
);
5292 XVECTOR (new)->header
.size
= len
;
5297 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5298 doc
: /* Make a copy of object OBJ in pure storage.
5299 Recursively copies contents of vectors and cons cells.
5300 Does not copy symbols. Copies strings without text properties. */)
5301 (register Lisp_Object obj
)
5303 if (NILP (Vpurify_flag
))
5306 if (PURE_POINTER_P (XPNTR (obj
)))
5309 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5311 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5317 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5318 else if (FLOATP (obj
))
5319 obj
= make_pure_float (XFLOAT_DATA (obj
));
5320 else if (STRINGP (obj
))
5321 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5323 STRING_MULTIBYTE (obj
));
5324 else if (COMPILEDP (obj
) || VECTORP (obj
))
5326 register struct Lisp_Vector
*vec
;
5327 register ptrdiff_t i
;
5331 if (size
& PSEUDOVECTOR_FLAG
)
5332 size
&= PSEUDOVECTOR_SIZE_MASK
;
5333 vec
= XVECTOR (make_pure_vector (size
));
5334 for (i
= 0; i
< size
; i
++)
5335 vec
->contents
[i
] = Fpurecopy (AREF (obj
, i
));
5336 if (COMPILEDP (obj
))
5338 XSETPVECTYPE (vec
, PVEC_COMPILED
);
5339 XSETCOMPILED (obj
, vec
);
5342 XSETVECTOR (obj
, vec
);
5344 else if (MARKERP (obj
))
5345 error ("Attempt to copy a marker to pure storage");
5347 /* Not purified, don't hash-cons. */
5350 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5351 Fputhash (obj
, obj
, Vpurify_flag
);
5358 /***********************************************************************
5360 ***********************************************************************/
5362 /* Put an entry in staticvec, pointing at the variable with address
5366 staticpro (Lisp_Object
*varaddress
)
5368 staticvec
[staticidx
++] = varaddress
;
5369 if (staticidx
>= NSTATICS
)
5374 /***********************************************************************
5376 ***********************************************************************/
5378 /* Temporarily prevent garbage collection. */
5381 inhibit_garbage_collection (void)
5383 ptrdiff_t count
= SPECPDL_INDEX ();
5385 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5389 /* Used to avoid possible overflows when
5390 converting from C to Lisp integers. */
5392 static inline Lisp_Object
5393 bounded_number (EMACS_INT number
)
5395 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5398 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5399 doc
: /* Reclaim storage for Lisp objects no longer needed.
5400 Garbage collection happens automatically if you cons more than
5401 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5402 `garbage-collect' normally returns a list with info on amount of space in use,
5403 where each entry has the form (NAME SIZE USED FREE), where:
5404 - NAME is a symbol describing the kind of objects this entry represents,
5405 - SIZE is the number of bytes used by each one,
5406 - USED is the number of those objects that were found live in the heap,
5407 - FREE is the number of those objects that are not live but that Emacs
5408 keeps around for future allocations (maybe because it does not know how
5409 to return them to the OS).
5410 However, if there was overflow in pure space, `garbage-collect'
5411 returns nil, because real GC can't be done.
5412 See Info node `(elisp)Garbage Collection'. */)
5415 register struct specbinding
*bind
;
5416 register struct buffer
*nextb
;
5417 char stack_top_variable
;
5420 Lisp_Object total
[11];
5421 ptrdiff_t count
= SPECPDL_INDEX ();
5427 /* Can't GC if pure storage overflowed because we can't determine
5428 if something is a pure object or not. */
5429 if (pure_bytes_used_before_overflow
)
5434 /* Don't keep undo information around forever.
5435 Do this early on, so it is no problem if the user quits. */
5436 FOR_EACH_BUFFER (nextb
)
5437 compact_buffer (nextb
);
5439 start
= current_emacs_time ();
5441 /* In case user calls debug_print during GC,
5442 don't let that cause a recursive GC. */
5443 consing_since_gc
= 0;
5445 /* Save what's currently displayed in the echo area. */
5446 message_p
= push_message ();
5447 record_unwind_protect (pop_message_unwind
, Qnil
);
5449 /* Save a copy of the contents of the stack, for debugging. */
5450 #if MAX_SAVE_STACK > 0
5451 if (NILP (Vpurify_flag
))
5454 ptrdiff_t stack_size
;
5455 if (&stack_top_variable
< stack_bottom
)
5457 stack
= &stack_top_variable
;
5458 stack_size
= stack_bottom
- &stack_top_variable
;
5462 stack
= stack_bottom
;
5463 stack_size
= &stack_top_variable
- stack_bottom
;
5465 if (stack_size
<= MAX_SAVE_STACK
)
5467 if (stack_copy_size
< stack_size
)
5469 stack_copy
= xrealloc (stack_copy
, stack_size
);
5470 stack_copy_size
= stack_size
;
5472 memcpy (stack_copy
, stack
, stack_size
);
5475 #endif /* MAX_SAVE_STACK > 0 */
5477 if (garbage_collection_messages
)
5478 message1_nolog ("Garbage collecting...");
5482 shrink_regexp_cache ();
5486 /* Mark all the special slots that serve as the roots of accessibility. */
5488 for (i
= 0; i
< staticidx
; i
++)
5489 mark_object (*staticvec
[i
]);
5491 for (bind
= specpdl
; bind
!= specpdl_ptr
; bind
++)
5493 mark_object (bind
->symbol
);
5494 mark_object (bind
->old_value
);
5502 extern void xg_mark_data (void);
5507 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5508 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5512 register struct gcpro
*tail
;
5513 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5514 for (i
= 0; i
< tail
->nvars
; i
++)
5515 mark_object (tail
->var
[i
]);
5519 struct catchtag
*catch;
5520 struct handler
*handler
;
5522 for (catch = catchlist
; catch; catch = catch->next
)
5524 mark_object (catch->tag
);
5525 mark_object (catch->val
);
5527 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5529 mark_object (handler
->handler
);
5530 mark_object (handler
->var
);
5536 #ifdef HAVE_WINDOW_SYSTEM
5537 mark_fringe_data ();
5540 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5544 /* Everything is now marked, except for the things that require special
5545 finalization, i.e. the undo_list.
5546 Look thru every buffer's undo list
5547 for elements that update markers that were not marked,
5549 FOR_EACH_BUFFER (nextb
)
5551 /* If a buffer's undo list is Qt, that means that undo is
5552 turned off in that buffer. Calling truncate_undo_list on
5553 Qt tends to return NULL, which effectively turns undo back on.
5554 So don't call truncate_undo_list if undo_list is Qt. */
5555 if (! EQ (nextb
->INTERNAL_FIELD (undo_list
), Qt
))
5557 Lisp_Object tail
, prev
;
5558 tail
= nextb
->INTERNAL_FIELD (undo_list
);
5560 while (CONSP (tail
))
5562 if (CONSP (XCAR (tail
))
5563 && MARKERP (XCAR (XCAR (tail
)))
5564 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5567 nextb
->INTERNAL_FIELD (undo_list
) = tail
= XCDR (tail
);
5571 XSETCDR (prev
, tail
);
5581 /* Now that we have stripped the elements that need not be in the
5582 undo_list any more, we can finally mark the list. */
5583 mark_object (nextb
->INTERNAL_FIELD (undo_list
));
5588 /* Clear the mark bits that we set in certain root slots. */
5590 unmark_byte_stack ();
5591 VECTOR_UNMARK (&buffer_defaults
);
5592 VECTOR_UNMARK (&buffer_local_symbols
);
5594 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5604 consing_since_gc
= 0;
5605 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
5606 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
5608 gc_relative_threshold
= 0;
5609 if (FLOATP (Vgc_cons_percentage
))
5610 { /* Set gc_cons_combined_threshold. */
5613 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5614 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5615 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5616 tot
+= total_string_bytes
;
5617 tot
+= total_vector_slots
* word_size
;
5618 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5619 tot
+= total_intervals
* sizeof (struct interval
);
5620 tot
+= total_strings
* sizeof (struct Lisp_String
);
5622 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5625 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5626 gc_relative_threshold
= tot
;
5628 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5632 if (garbage_collection_messages
)
5634 if (message_p
|| minibuf_level
> 0)
5637 message1_nolog ("Garbage collecting...done");
5640 unbind_to (count
, Qnil
);
5642 total
[0] = list4 (Qcons
, make_number (sizeof (struct Lisp_Cons
)),
5643 bounded_number (total_conses
),
5644 bounded_number (total_free_conses
));
5646 total
[1] = list4 (Qsymbol
, make_number (sizeof (struct Lisp_Symbol
)),
5647 bounded_number (total_symbols
),
5648 bounded_number (total_free_symbols
));
5650 total
[2] = list4 (Qmisc
, make_number (sizeof (union Lisp_Misc
)),
5651 bounded_number (total_markers
),
5652 bounded_number (total_free_markers
));
5654 total
[3] = list4 (Qstring
, make_number (sizeof (struct Lisp_String
)),
5655 bounded_number (total_strings
),
5656 bounded_number (total_free_strings
));
5658 total
[4] = list3 (Qstring_bytes
, make_number (1),
5659 bounded_number (total_string_bytes
));
5661 total
[5] = list3 (Qvector
, make_number (sizeof (struct Lisp_Vector
)),
5662 bounded_number (total_vectors
));
5664 total
[6] = list4 (Qvector_slots
, make_number (word_size
),
5665 bounded_number (total_vector_slots
),
5666 bounded_number (total_free_vector_slots
));
5668 total
[7] = list4 (Qfloat
, make_number (sizeof (struct Lisp_Float
)),
5669 bounded_number (total_floats
),
5670 bounded_number (total_free_floats
));
5672 total
[8] = list4 (Qinterval
, make_number (sizeof (struct interval
)),
5673 bounded_number (total_intervals
),
5674 bounded_number (total_free_intervals
));
5676 total
[9] = list3 (Qbuffer
, make_number (sizeof (struct buffer
)),
5677 bounded_number (total_buffers
));
5679 total
[10] = list4 (Qheap
, make_number (1024),
5680 #ifdef DOUG_LEA_MALLOC
5681 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
5682 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10)
5688 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5690 /* Compute average percentage of zombies. */
5692 (total_conses
+ total_symbols
+ total_markers
+ total_strings
5693 + total_vectors
+ total_floats
+ total_intervals
+ total_buffers
);
5695 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5696 max_live
= max (nlive
, max_live
);
5697 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5698 max_zombies
= max (nzombies
, max_zombies
);
5703 if (!NILP (Vpost_gc_hook
))
5705 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5706 safe_run_hooks (Qpost_gc_hook
);
5707 unbind_to (gc_count
, Qnil
);
5710 /* Accumulate statistics. */
5711 if (FLOATP (Vgc_elapsed
))
5713 EMACS_TIME since_start
= sub_emacs_time (current_emacs_time (), start
);
5714 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5715 + EMACS_TIME_TO_DOUBLE (since_start
));
5720 return Flist (sizeof total
/ sizeof *total
, total
);
5724 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5725 only interesting objects referenced from glyphs are strings. */
5728 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5730 struct glyph_row
*row
= matrix
->rows
;
5731 struct glyph_row
*end
= row
+ matrix
->nrows
;
5733 for (; row
< end
; ++row
)
5737 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5739 struct glyph
*glyph
= row
->glyphs
[area
];
5740 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5742 for (; glyph
< end_glyph
; ++glyph
)
5743 if (STRINGP (glyph
->object
)
5744 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5745 mark_object (glyph
->object
);
5751 /* Mark Lisp faces in the face cache C. */
5754 mark_face_cache (struct face_cache
*c
)
5759 for (i
= 0; i
< c
->used
; ++i
)
5761 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5765 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5766 mark_object (face
->lface
[j
]);
5774 /* Mark reference to a Lisp_Object.
5775 If the object referred to has not been seen yet, recursively mark
5776 all the references contained in it. */
5778 #define LAST_MARKED_SIZE 500
5779 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5780 static int last_marked_index
;
5782 /* For debugging--call abort when we cdr down this many
5783 links of a list, in mark_object. In debugging,
5784 the call to abort will hit a breakpoint.
5785 Normally this is zero and the check never goes off. */
5786 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5789 mark_vectorlike (struct Lisp_Vector
*ptr
)
5791 ptrdiff_t size
= ptr
->header
.size
;
5794 eassert (!VECTOR_MARKED_P (ptr
));
5795 VECTOR_MARK (ptr
); /* Else mark it. */
5796 if (size
& PSEUDOVECTOR_FLAG
)
5797 size
&= PSEUDOVECTOR_SIZE_MASK
;
5799 /* Note that this size is not the memory-footprint size, but only
5800 the number of Lisp_Object fields that we should trace.
5801 The distinction is used e.g. by Lisp_Process which places extra
5802 non-Lisp_Object fields at the end of the structure... */
5803 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
5804 mark_object (ptr
->contents
[i
]);
5807 /* Like mark_vectorlike but optimized for char-tables (and
5808 sub-char-tables) assuming that the contents are mostly integers or
5812 mark_char_table (struct Lisp_Vector
*ptr
)
5814 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5817 eassert (!VECTOR_MARKED_P (ptr
));
5819 for (i
= 0; i
< size
; i
++)
5821 Lisp_Object val
= ptr
->contents
[i
];
5823 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5825 if (SUB_CHAR_TABLE_P (val
))
5827 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5828 mark_char_table (XVECTOR (val
));
5835 /* Mark the chain of overlays starting at PTR. */
5838 mark_overlay (struct Lisp_Overlay
*ptr
)
5840 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
5843 mark_object (MVAR (ptr
, start
));
5844 mark_object (MVAR (ptr
, end
));
5845 mark_object (MVAR (ptr
, plist
));
5849 /* Mark Lisp_Objects and special pointers in BUFFER. */
5852 mark_buffer (struct buffer
*buffer
)
5854 /* This is handled much like other pseudovectors... */
5855 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
5857 /* ...but there are some buffer-specific things. */
5859 MARK_INTERVAL_TREE (BUF_INTERVALS (buffer
));
5861 /* For now, we just don't mark the undo_list. It's done later in
5862 a special way just before the sweep phase, and after stripping
5863 some of its elements that are not needed any more. */
5865 mark_overlay (buffer
->overlays_before
);
5866 mark_overlay (buffer
->overlays_after
);
5868 /* If this is an indirect buffer, mark its base buffer. */
5869 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5870 mark_buffer (buffer
->base_buffer
);
5873 /* Determine type of generic Lisp_Object and mark it accordingly. */
5876 mark_object (Lisp_Object arg
)
5878 register Lisp_Object obj
= arg
;
5879 #ifdef GC_CHECK_MARKED_OBJECTS
5883 ptrdiff_t cdr_count
= 0;
5887 if (PURE_POINTER_P (XPNTR (obj
)))
5890 last_marked
[last_marked_index
++] = obj
;
5891 if (last_marked_index
== LAST_MARKED_SIZE
)
5892 last_marked_index
= 0;
5894 /* Perform some sanity checks on the objects marked here. Abort if
5895 we encounter an object we know is bogus. This increases GC time
5896 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5897 #ifdef GC_CHECK_MARKED_OBJECTS
5899 po
= (void *) XPNTR (obj
);
5901 /* Check that the object pointed to by PO is known to be a Lisp
5902 structure allocated from the heap. */
5903 #define CHECK_ALLOCATED() \
5905 m = mem_find (po); \
5910 /* Check that the object pointed to by PO is live, using predicate
5912 #define CHECK_LIVE(LIVEP) \
5914 if (!LIVEP (m, po)) \
5918 /* Check both of the above conditions. */
5919 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5921 CHECK_ALLOCATED (); \
5922 CHECK_LIVE (LIVEP); \
5925 #else /* not GC_CHECK_MARKED_OBJECTS */
5927 #define CHECK_LIVE(LIVEP) (void) 0
5928 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5930 #endif /* not GC_CHECK_MARKED_OBJECTS */
5932 switch (XTYPE (obj
))
5936 register struct Lisp_String
*ptr
= XSTRING (obj
);
5937 if (STRING_MARKED_P (ptr
))
5939 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
5941 MARK_INTERVAL_TREE (ptr
->intervals
);
5942 #ifdef GC_CHECK_STRING_BYTES
5943 /* Check that the string size recorded in the string is the
5944 same as the one recorded in the sdata structure. */
5946 #endif /* GC_CHECK_STRING_BYTES */
5950 case Lisp_Vectorlike
:
5952 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5953 register ptrdiff_t pvectype
;
5955 if (VECTOR_MARKED_P (ptr
))
5958 #ifdef GC_CHECK_MARKED_OBJECTS
5960 if (m
== MEM_NIL
&& !SUBRP (obj
)
5961 && po
!= &buffer_defaults
5962 && po
!= &buffer_local_symbols
)
5964 #endif /* GC_CHECK_MARKED_OBJECTS */
5966 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
5967 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
5968 >> PSEUDOVECTOR_SIZE_BITS
);
5972 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
5973 CHECK_LIVE (live_vector_p
);
5978 #ifdef GC_CHECK_MARKED_OBJECTS
5979 if (po
!= &buffer_defaults
&& po
!= &buffer_local_symbols
)
5988 #endif /* GC_CHECK_MARKED_OBJECTS */
5989 mark_buffer ((struct buffer
*) ptr
);
5993 { /* We could treat this just like a vector, but it is better
5994 to save the COMPILED_CONSTANTS element for last and avoid
5996 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
6000 for (i
= 0; i
< size
; i
++)
6001 if (i
!= COMPILED_CONSTANTS
)
6002 mark_object (ptr
->contents
[i
]);
6003 if (size
> COMPILED_CONSTANTS
)
6005 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
6013 mark_vectorlike (ptr
);
6014 mark_face_cache (((struct frame
*) ptr
)->face_cache
);
6020 struct window
*w
= (struct window
*) ptr
;
6022 mark_vectorlike (ptr
);
6023 /* Mark glyphs for leaf windows. Marking window
6024 matrices is sufficient because frame matrices
6025 use the same glyph memory. */
6026 if (NILP (WVAR (w
, hchild
)) && NILP (WVAR (w
, vchild
))
6027 && w
->current_matrix
)
6029 mark_glyph_matrix (w
->current_matrix
);
6030 mark_glyph_matrix (w
->desired_matrix
);
6035 case PVEC_HASH_TABLE
:
6037 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6039 mark_vectorlike (ptr
);
6040 /* If hash table is not weak, mark all keys and values.
6041 For weak tables, mark only the vector. */
6043 mark_object (h
->key_and_value
);
6045 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6049 case PVEC_CHAR_TABLE
:
6050 mark_char_table (ptr
);
6053 case PVEC_BOOL_VECTOR
:
6054 /* No Lisp_Objects to mark in a bool vector. */
6065 mark_vectorlike (ptr
);
6072 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6073 struct Lisp_Symbol
*ptrx
;
6077 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
6079 mark_object (SVAR (ptr
, function
));
6080 mark_object (SVAR (ptr
, plist
));
6081 switch (ptr
->redirect
)
6083 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6084 case SYMBOL_VARALIAS
:
6087 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6091 case SYMBOL_LOCALIZED
:
6093 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
6094 /* If the value is forwarded to a buffer or keyboard field,
6095 these are marked when we see the corresponding object.
6096 And if it's forwarded to a C variable, either it's not
6097 a Lisp_Object var, or it's staticpro'd already. */
6098 mark_object (blv
->where
);
6099 mark_object (blv
->valcell
);
6100 mark_object (blv
->defcell
);
6103 case SYMBOL_FORWARDED
:
6104 /* If the value is forwarded to a buffer or keyboard field,
6105 these are marked when we see the corresponding object.
6106 And if it's forwarded to a C variable, either it's not
6107 a Lisp_Object var, or it's staticpro'd already. */
6111 if (!PURE_POINTER_P (XSTRING (SVAR (ptr
, xname
))))
6112 MARK_STRING (XSTRING (SVAR (ptr
, xname
)));
6113 MARK_INTERVAL_TREE (STRING_INTERVALS (SVAR (ptr
, xname
)));
6118 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun. */
6119 XSETSYMBOL (obj
, ptrx
);
6126 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6128 if (XMISCANY (obj
)->gcmarkbit
)
6131 switch (XMISCTYPE (obj
))
6133 case Lisp_Misc_Marker
:
6134 /* DO NOT mark thru the marker's chain.
6135 The buffer's markers chain does not preserve markers from gc;
6136 instead, markers are removed from the chain when freed by gc. */
6137 XMISCANY (obj
)->gcmarkbit
= 1;
6140 case Lisp_Misc_Save_Value
:
6141 XMISCANY (obj
)->gcmarkbit
= 1;
6144 register struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
6145 /* If DOGC is set, POINTER is the address of a memory
6146 area containing INTEGER potential Lisp_Objects. */
6149 Lisp_Object
*p
= (Lisp_Object
*) ptr
->pointer
;
6151 for (nelt
= ptr
->integer
; nelt
> 0; nelt
--, p
++)
6152 mark_maybe_object (*p
);
6158 case Lisp_Misc_Overlay
:
6159 mark_overlay (XOVERLAY (obj
));
6169 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6170 if (CONS_MARKED_P (ptr
))
6172 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6174 /* If the cdr is nil, avoid recursion for the car. */
6175 if (EQ (CVAR (ptr
, u
.cdr
), Qnil
))
6177 obj
= CVAR (ptr
, car
);
6181 mark_object (CVAR (ptr
, car
));
6182 obj
= CVAR (ptr
, u
.cdr
);
6184 if (cdr_count
== mark_object_loop_halt
)
6190 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6191 FLOAT_MARK (XFLOAT (obj
));
6202 #undef CHECK_ALLOCATED
6203 #undef CHECK_ALLOCATED_AND_LIVE
6205 /* Mark the Lisp pointers in the terminal objects.
6206 Called by Fgarbage_collect. */
6209 mark_terminals (void)
6212 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6214 eassert (t
->name
!= NULL
);
6215 #ifdef HAVE_WINDOW_SYSTEM
6216 /* If a terminal object is reachable from a stacpro'ed object,
6217 it might have been marked already. Make sure the image cache
6219 mark_image_cache (t
->image_cache
);
6220 #endif /* HAVE_WINDOW_SYSTEM */
6221 if (!VECTOR_MARKED_P (t
))
6222 mark_vectorlike ((struct Lisp_Vector
*)t
);
6228 /* Value is non-zero if OBJ will survive the current GC because it's
6229 either marked or does not need to be marked to survive. */
6232 survives_gc_p (Lisp_Object obj
)
6236 switch (XTYPE (obj
))
6243 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6247 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6251 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6254 case Lisp_Vectorlike
:
6255 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6259 survives_p
= CONS_MARKED_P (XCONS (obj
));
6263 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6270 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
6275 /* Sweep: find all structures not marked, and free them. */
6280 /* Remove or mark entries in weak hash tables.
6281 This must be done before any object is unmarked. */
6282 sweep_weak_hash_tables ();
6285 check_string_bytes (!noninteractive
);
6287 /* Put all unmarked conses on free list */
6289 register struct cons_block
*cblk
;
6290 struct cons_block
**cprev
= &cons_block
;
6291 register int lim
= cons_block_index
;
6292 EMACS_INT num_free
= 0, num_used
= 0;
6296 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6300 int ilim
= (lim
+ BITS_PER_INT
- 1) / BITS_PER_INT
;
6302 /* Scan the mark bits an int at a time. */
6303 for (i
= 0; i
< ilim
; i
++)
6305 if (cblk
->gcmarkbits
[i
] == -1)
6307 /* Fast path - all cons cells for this int are marked. */
6308 cblk
->gcmarkbits
[i
] = 0;
6309 num_used
+= BITS_PER_INT
;
6313 /* Some cons cells for this int are not marked.
6314 Find which ones, and free them. */
6315 int start
, pos
, stop
;
6317 start
= i
* BITS_PER_INT
;
6319 if (stop
> BITS_PER_INT
)
6320 stop
= BITS_PER_INT
;
6323 for (pos
= start
; pos
< stop
; pos
++)
6325 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6328 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6329 cons_free_list
= &cblk
->conses
[pos
];
6331 CVAR (cons_free_list
, car
) = Vdead
;
6337 CONS_UNMARK (&cblk
->conses
[pos
]);
6343 lim
= CONS_BLOCK_SIZE
;
6344 /* If this block contains only free conses and we have already
6345 seen more than two blocks worth of free conses then deallocate
6347 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6349 *cprev
= cblk
->next
;
6350 /* Unhook from the free list. */
6351 cons_free_list
= cblk
->conses
[0].u
.chain
;
6352 lisp_align_free (cblk
);
6356 num_free
+= this_free
;
6357 cprev
= &cblk
->next
;
6360 total_conses
= num_used
;
6361 total_free_conses
= num_free
;
6364 /* Put all unmarked floats on free list */
6366 register struct float_block
*fblk
;
6367 struct float_block
**fprev
= &float_block
;
6368 register int lim
= float_block_index
;
6369 EMACS_INT num_free
= 0, num_used
= 0;
6371 float_free_list
= 0;
6373 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6377 for (i
= 0; i
< lim
; i
++)
6378 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6381 fblk
->floats
[i
].u
.chain
= float_free_list
;
6382 float_free_list
= &fblk
->floats
[i
];
6387 FLOAT_UNMARK (&fblk
->floats
[i
]);
6389 lim
= FLOAT_BLOCK_SIZE
;
6390 /* If this block contains only free floats and we have already
6391 seen more than two blocks worth of free floats then deallocate
6393 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6395 *fprev
= fblk
->next
;
6396 /* Unhook from the free list. */
6397 float_free_list
= fblk
->floats
[0].u
.chain
;
6398 lisp_align_free (fblk
);
6402 num_free
+= this_free
;
6403 fprev
= &fblk
->next
;
6406 total_floats
= num_used
;
6407 total_free_floats
= num_free
;
6410 /* Put all unmarked intervals on free list */
6412 register struct interval_block
*iblk
;
6413 struct interval_block
**iprev
= &interval_block
;
6414 register int lim
= interval_block_index
;
6415 EMACS_INT num_free
= 0, num_used
= 0;
6417 interval_free_list
= 0;
6419 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6424 for (i
= 0; i
< lim
; i
++)
6426 if (!iblk
->intervals
[i
].gcmarkbit
)
6428 SET_INTERVAL_PARENT (&iblk
->intervals
[i
], interval_free_list
);
6429 interval_free_list
= &iblk
->intervals
[i
];
6435 iblk
->intervals
[i
].gcmarkbit
= 0;
6438 lim
= INTERVAL_BLOCK_SIZE
;
6439 /* If this block contains only free intervals and we have already
6440 seen more than two blocks worth of free intervals then
6441 deallocate this block. */
6442 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6444 *iprev
= iblk
->next
;
6445 /* Unhook from the free list. */
6446 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6451 num_free
+= this_free
;
6452 iprev
= &iblk
->next
;
6455 total_intervals
= num_used
;
6456 total_free_intervals
= num_free
;
6459 /* Put all unmarked symbols on free list */
6461 register struct symbol_block
*sblk
;
6462 struct symbol_block
**sprev
= &symbol_block
;
6463 register int lim
= symbol_block_index
;
6464 EMACS_INT num_free
= 0, num_used
= 0;
6466 symbol_free_list
= NULL
;
6468 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6471 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6472 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6474 for (; sym
< end
; ++sym
)
6476 /* Check if the symbol was created during loadup. In such a case
6477 it might be pointed to by pure bytecode which we don't trace,
6478 so we conservatively assume that it is live. */
6479 int pure_p
= PURE_POINTER_P (XSTRING (sym
->s
.INTERNAL_FIELD (xname
)));
6481 if (!sym
->s
.gcmarkbit
&& !pure_p
)
6483 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6484 xfree (SYMBOL_BLV (&sym
->s
));
6485 sym
->s
.next
= symbol_free_list
;
6486 symbol_free_list
= &sym
->s
;
6488 SVAR (symbol_free_list
, function
) = Vdead
;
6496 UNMARK_STRING (XSTRING (sym
->s
.INTERNAL_FIELD (xname
)));
6497 sym
->s
.gcmarkbit
= 0;
6501 lim
= SYMBOL_BLOCK_SIZE
;
6502 /* If this block contains only free symbols and we have already
6503 seen more than two blocks worth of free symbols then deallocate
6505 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6507 *sprev
= sblk
->next
;
6508 /* Unhook from the free list. */
6509 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6514 num_free
+= this_free
;
6515 sprev
= &sblk
->next
;
6518 total_symbols
= num_used
;
6519 total_free_symbols
= num_free
;
6522 /* Put all unmarked misc's on free list.
6523 For a marker, first unchain it from the buffer it points into. */
6525 register struct marker_block
*mblk
;
6526 struct marker_block
**mprev
= &marker_block
;
6527 register int lim
= marker_block_index
;
6528 EMACS_INT num_free
= 0, num_used
= 0;
6530 marker_free_list
= 0;
6532 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6537 for (i
= 0; i
< lim
; i
++)
6539 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6541 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6542 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6543 /* Set the type of the freed object to Lisp_Misc_Free.
6544 We could leave the type alone, since nobody checks it,
6545 but this might catch bugs faster. */
6546 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6547 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6548 marker_free_list
= &mblk
->markers
[i
].m
;
6554 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6557 lim
= MARKER_BLOCK_SIZE
;
6558 /* If this block contains only free markers and we have already
6559 seen more than two blocks worth of free markers then deallocate
6561 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6563 *mprev
= mblk
->next
;
6564 /* Unhook from the free list. */
6565 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6570 num_free
+= this_free
;
6571 mprev
= &mblk
->next
;
6575 total_markers
= num_used
;
6576 total_free_markers
= num_free
;
6579 /* Free all unmarked buffers */
6581 register struct buffer
*buffer
= all_buffers
, *prev
= 0, *next
;
6585 if (!VECTOR_MARKED_P (buffer
))
6588 prev
->header
.next
= buffer
->header
.next
;
6590 all_buffers
= buffer
->header
.next
.buffer
;
6591 next
= buffer
->header
.next
.buffer
;
6597 VECTOR_UNMARK (buffer
);
6598 UNMARK_BALANCE_INTERVALS (BUF_INTERVALS (buffer
));
6600 prev
= buffer
, buffer
= buffer
->header
.next
.buffer
;
6605 check_string_bytes (!noninteractive
);
6611 /* Debugging aids. */
6613 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6614 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6615 This may be helpful in debugging Emacs's memory usage.
6616 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6621 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6626 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6627 doc
: /* Return a list of counters that measure how much consing there has been.
6628 Each of these counters increments for a certain kind of object.
6629 The counters wrap around from the largest positive integer to zero.
6630 Garbage collection does not decrease them.
6631 The elements of the value are as follows:
6632 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6633 All are in units of 1 = one object consed
6634 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6636 MISCS include overlays, markers, and some internal types.
6637 Frames, windows, buffers, and subprocesses count as vectors
6638 (but the contents of a buffer's text do not count here). */)
6641 return listn (CONSTYPE_HEAP
, 8,
6642 bounded_number (cons_cells_consed
),
6643 bounded_number (floats_consed
),
6644 bounded_number (vector_cells_consed
),
6645 bounded_number (symbols_consed
),
6646 bounded_number (string_chars_consed
),
6647 bounded_number (misc_objects_consed
),
6648 bounded_number (intervals_consed
),
6649 bounded_number (strings_consed
));
6652 /* Find at most FIND_MAX symbols which have OBJ as their value or
6653 function. This is used in gdbinit's `xwhichsymbols' command. */
6656 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6658 struct symbol_block
*sblk
;
6659 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6660 Lisp_Object found
= Qnil
;
6664 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6666 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
6669 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
6671 struct Lisp_Symbol
*sym
= &aligned_sym
->s
;
6675 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6678 XSETSYMBOL (tem
, sym
);
6679 val
= find_symbol_value (tem
);
6681 || EQ (SVAR (sym
, function
), obj
)
6682 || (!NILP (SVAR (sym
, function
))
6683 && COMPILEDP (SVAR (sym
, function
))
6684 && EQ (AREF (SVAR (sym
, function
), COMPILED_BYTECODE
), obj
))
6687 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)))
6689 found
= Fcons (tem
, found
);
6690 if (--find_max
== 0)
6698 unbind_to (gc_count
, Qnil
);
6702 #ifdef ENABLE_CHECKING
6703 int suppress_checking
;
6706 die (const char *msg
, const char *file
, int line
)
6708 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: %s\r\n",
6714 /* Initialization */
6717 init_alloc_once (void)
6719 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6721 pure_size
= PURESIZE
;
6723 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6725 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6728 #ifdef DOUG_LEA_MALLOC
6729 mallopt (M_TRIM_THRESHOLD
, 128*1024); /* trim threshold */
6730 mallopt (M_MMAP_THRESHOLD
, 64*1024); /* mmap threshold */
6731 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* max. number of mmap'ed areas */
6737 malloc_hysteresis
= 32;
6739 malloc_hysteresis
= 0;
6742 refill_memory_reserve ();
6743 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
6750 byte_stack_list
= 0;
6752 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6753 setjmp_tested_p
= longjmps_done
= 0;
6756 Vgc_elapsed
= make_float (0.0);
6761 syms_of_alloc (void)
6763 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6764 doc
: /* Number of bytes of consing between garbage collections.
6765 Garbage collection can happen automatically once this many bytes have been
6766 allocated since the last garbage collection. All data types count.
6768 Garbage collection happens automatically only when `eval' is called.
6770 By binding this temporarily to a large number, you can effectively
6771 prevent garbage collection during a part of the program.
6772 See also `gc-cons-percentage'. */);
6774 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6775 doc
: /* Portion of the heap used for allocation.
6776 Garbage collection can happen automatically once this portion of the heap
6777 has been allocated since the last garbage collection.
6778 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6779 Vgc_cons_percentage
= make_float (0.1);
6781 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6782 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
6784 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6785 doc
: /* Number of cons cells that have been consed so far. */);
6787 DEFVAR_INT ("floats-consed", floats_consed
,
6788 doc
: /* Number of floats that have been consed so far. */);
6790 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
6791 doc
: /* Number of vector cells that have been consed so far. */);
6793 DEFVAR_INT ("symbols-consed", symbols_consed
,
6794 doc
: /* Number of symbols that have been consed so far. */);
6796 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
6797 doc
: /* Number of string characters that have been consed so far. */);
6799 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
6800 doc
: /* Number of miscellaneous objects that have been consed so far.
6801 These include markers and overlays, plus certain objects not visible
6804 DEFVAR_INT ("intervals-consed", intervals_consed
,
6805 doc
: /* Number of intervals that have been consed so far. */);
6807 DEFVAR_INT ("strings-consed", strings_consed
,
6808 doc
: /* Number of strings that have been consed so far. */);
6810 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
6811 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
6812 This means that certain objects should be allocated in shared (pure) space.
6813 It can also be set to a hash-table, in which case this table is used to
6814 do hash-consing of the objects allocated to pure space. */);
6816 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
6817 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
6818 garbage_collection_messages
= 0;
6820 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
6821 doc
: /* Hook run after garbage collection has finished. */);
6822 Vpost_gc_hook
= Qnil
;
6823 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
6825 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
6826 doc
: /* Precomputed `signal' argument for memory-full error. */);
6827 /* We build this in advance because if we wait until we need it, we might
6828 not be able to allocate the memory to hold it. */
6830 = listn (CONSTYPE_PURE
, 2, Qerror
,
6831 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
6833 DEFVAR_LISP ("memory-full", Vmemory_full
,
6834 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
6835 Vmemory_full
= Qnil
;
6837 DEFSYM (Qstring_bytes
, "string-bytes");
6838 DEFSYM (Qvector_slots
, "vector-slots");
6839 DEFSYM (Qheap
, "heap");
6841 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
6842 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
6844 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
6845 doc
: /* Accumulated time elapsed in garbage collections.
6846 The time is in seconds as a floating point value. */);
6847 DEFVAR_INT ("gcs-done", gcs_done
,
6848 doc
: /* Accumulated number of garbage collections done. */);
6853 defsubr (&Smake_byte_code
);
6854 defsubr (&Smake_list
);
6855 defsubr (&Smake_vector
);
6856 defsubr (&Smake_string
);
6857 defsubr (&Smake_bool_vector
);
6858 defsubr (&Smake_symbol
);
6859 defsubr (&Smake_marker
);
6860 defsubr (&Spurecopy
);
6861 defsubr (&Sgarbage_collect
);
6862 defsubr (&Smemory_limit
);
6863 defsubr (&Smemory_use_counts
);
6865 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
6866 defsubr (&Sgc_status
);
6870 /* When compiled with GCC, GDB might say "No enum type named
6871 pvec_type" if we don't have at least one symbol with that type, and
6872 then xbacktrace could fail. Similarly for the other enums and
6876 enum CHARTAB_SIZE_BITS CHARTAB_SIZE_BITS
;
6877 enum CHAR_TABLE_STANDARD_SLOTS CHAR_TABLE_STANDARD_SLOTS
;
6878 enum char_bits char_bits
;
6879 enum CHECK_LISP_OBJECT_TYPE CHECK_LISP_OBJECT_TYPE
;
6880 enum DEFAULT_HASH_SIZE DEFAULT_HASH_SIZE
;
6881 enum enum_USE_LSB_TAG enum_USE_LSB_TAG
;
6882 enum FLOAT_TO_STRING_BUFSIZE FLOAT_TO_STRING_BUFSIZE
;
6883 enum Lisp_Bits Lisp_Bits
;
6884 enum Lisp_Compiled Lisp_Compiled
;
6885 enum maxargs maxargs
;
6886 enum MAX_ALLOCA MAX_ALLOCA
;
6887 enum More_Lisp_Bits More_Lisp_Bits
;
6888 enum pvec_type pvec_type
;
6890 enum lsb_bits lsb_bits
;
6892 } const EXTERNALLY_VISIBLE gdb_make_enums_visible
= {0};