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
79 #ifdef DOUG_LEA_MALLOC
83 /* Specify maximum number of areas to mmap. It would be nice to use a
84 value that explicitly means "no limit". */
86 #define MMAP_MAX_AREAS 100000000
88 #else /* not DOUG_LEA_MALLOC */
90 /* The following come from gmalloc.c. */
92 extern size_t _bytes_used
;
93 extern size_t __malloc_extra_blocks
;
94 extern void *_malloc_internal (size_t);
95 extern void _free_internal (void *);
97 #endif /* not DOUG_LEA_MALLOC */
99 #if ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT
102 /* When GTK uses the file chooser dialog, different backends can be loaded
103 dynamically. One such a backend is the Gnome VFS backend that gets loaded
104 if you run Gnome. That backend creates several threads and also allocates
107 Also, gconf and gsettings may create several threads.
109 If Emacs sets malloc hooks (! SYSTEM_MALLOC) and the emacs_blocked_*
110 functions below are called from malloc, there is a chance that one
111 of these threads preempts the Emacs main thread and the hook variables
112 end up in an inconsistent state. So we have a mutex to prevent that (note
113 that the backend handles concurrent access to malloc within its own threads
114 but Emacs code running in the main thread is not included in that control).
116 When UNBLOCK_INPUT is called, reinvoke_input_signal may be called. If this
117 happens in one of the backend threads we will have two threads that tries
118 to run Emacs code at once, and the code is not prepared for that.
119 To prevent that, we only call BLOCK/UNBLOCK from the main thread. */
121 static pthread_mutex_t alloc_mutex
;
123 #define BLOCK_INPUT_ALLOC \
126 if (pthread_equal (pthread_self (), main_thread)) \
128 pthread_mutex_lock (&alloc_mutex); \
131 #define UNBLOCK_INPUT_ALLOC \
134 pthread_mutex_unlock (&alloc_mutex); \
135 if (pthread_equal (pthread_self (), main_thread)) \
140 #else /* ! defined HAVE_PTHREAD */
142 #define BLOCK_INPUT_ALLOC BLOCK_INPUT
143 #define UNBLOCK_INPUT_ALLOC UNBLOCK_INPUT
145 #endif /* ! defined HAVE_PTHREAD */
146 #endif /* ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT */
148 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
149 to a struct Lisp_String. */
151 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
152 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
153 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
155 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
156 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
157 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
159 /* Default value of gc_cons_threshold (see below). */
161 #define GC_DEFAULT_THRESHOLD (100000 * word_size)
163 /* Global variables. */
164 struct emacs_globals globals
;
166 /* Number of bytes of consing done since the last gc. */
168 EMACS_INT consing_since_gc
;
170 /* Similar minimum, computed from Vgc_cons_percentage. */
172 EMACS_INT gc_relative_threshold
;
174 /* Minimum number of bytes of consing since GC before next GC,
175 when memory is full. */
177 EMACS_INT memory_full_cons_threshold
;
179 /* True during GC. */
183 /* True means abort if try to GC.
184 This is for code which is written on the assumption that
185 no GC will happen, so as to verify that assumption. */
189 /* Number of live and free conses etc. */
191 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_buffers
;
192 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
193 static EMACS_INT total_free_floats
, total_floats
;
195 /* Points to memory space allocated as "spare", to be freed if we run
196 out of memory. We keep one large block, four cons-blocks, and
197 two string blocks. */
199 static char *spare_memory
[7];
201 /* Amount of spare memory to keep in large reserve block, or to see
202 whether this much is available when malloc fails on a larger request. */
204 #define SPARE_MEMORY (1 << 14)
206 /* Number of extra blocks malloc should get when it needs more core. */
208 static int malloc_hysteresis
;
210 /* Initialize it to a nonzero value to force it into data space
211 (rather than bss space). That way unexec will remap it into text
212 space (pure), on some systems. We have not implemented the
213 remapping on more recent systems because this is less important
214 nowadays than in the days of small memories and timesharing. */
216 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
217 #define PUREBEG (char *) pure
219 /* Pointer to the pure area, and its size. */
221 static char *purebeg
;
222 static ptrdiff_t pure_size
;
224 /* Number of bytes of pure storage used before pure storage overflowed.
225 If this is non-zero, this implies that an overflow occurred. */
227 static ptrdiff_t pure_bytes_used_before_overflow
;
229 /* True if P points into pure space. */
231 #define PURE_POINTER_P(P) \
232 ((uintptr_t) (P) - (uintptr_t) purebeg <= pure_size)
234 /* Index in pure at which next pure Lisp object will be allocated.. */
236 static ptrdiff_t pure_bytes_used_lisp
;
238 /* Number of bytes allocated for non-Lisp objects in pure storage. */
240 static ptrdiff_t pure_bytes_used_non_lisp
;
242 /* If nonzero, this is a warning delivered by malloc and not yet
245 const char *pending_malloc_warning
;
247 /* Maximum amount of C stack to save when a GC happens. */
249 #ifndef MAX_SAVE_STACK
250 #define MAX_SAVE_STACK 16000
253 /* Buffer in which we save a copy of the C stack at each GC. */
255 #if MAX_SAVE_STACK > 0
256 static char *stack_copy
;
257 static ptrdiff_t stack_copy_size
;
260 static Lisp_Object Qconses
;
261 static Lisp_Object Qsymbols
;
262 static Lisp_Object Qmiscs
;
263 static Lisp_Object Qstrings
;
264 static Lisp_Object Qvectors
;
265 static Lisp_Object Qfloats
;
266 static Lisp_Object Qintervals
;
267 static Lisp_Object Qbuffers
;
268 static Lisp_Object Qstring_bytes
, Qvector_slots
, Qheap
;
269 static Lisp_Object Qgc_cons_threshold
;
270 Lisp_Object Qchar_table_extra_slots
;
272 /* Hook run after GC has finished. */
274 static Lisp_Object Qpost_gc_hook
;
276 static void mark_terminals (void);
277 static void gc_sweep (void);
278 static Lisp_Object
make_pure_vector (ptrdiff_t);
279 static void mark_glyph_matrix (struct glyph_matrix
*);
280 static void mark_face_cache (struct face_cache
*);
282 #if !defined REL_ALLOC || defined SYSTEM_MALLOC
283 static void refill_memory_reserve (void);
285 static struct Lisp_String
*allocate_string (void);
286 static void compact_small_strings (void);
287 static void free_large_strings (void);
288 static void sweep_strings (void);
289 static void free_misc (Lisp_Object
);
290 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
292 /* When scanning the C stack for live Lisp objects, Emacs keeps track
293 of what memory allocated via lisp_malloc is intended for what
294 purpose. This enumeration specifies the type of memory. */
305 /* We used to keep separate mem_types for subtypes of vectors such as
306 process, hash_table, frame, terminal, and window, but we never made
307 use of the distinction, so it only caused source-code complexity
308 and runtime slowdown. Minor but pointless. */
310 /* Special type to denote vector blocks. */
311 MEM_TYPE_VECTOR_BLOCK
,
312 /* Special type to denote reserved memory. */
316 static void *lisp_malloc (size_t, enum mem_type
);
319 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
321 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
322 #include <stdio.h> /* For fprintf. */
325 /* A unique object in pure space used to make some Lisp objects
326 on free lists recognizable in O(1). */
328 static Lisp_Object Vdead
;
329 #define DEADP(x) EQ (x, Vdead)
331 #ifdef GC_MALLOC_CHECK
333 enum mem_type allocated_mem_type
;
335 #endif /* GC_MALLOC_CHECK */
337 /* A node in the red-black tree describing allocated memory containing
338 Lisp data. Each such block is recorded with its start and end
339 address when it is allocated, and removed from the tree when it
342 A red-black tree is a balanced binary tree with the following
345 1. Every node is either red or black.
346 2. Every leaf is black.
347 3. If a node is red, then both of its children are black.
348 4. Every simple path from a node to a descendant leaf contains
349 the same number of black nodes.
350 5. The root is always black.
352 When nodes are inserted into the tree, or deleted from the tree,
353 the tree is "fixed" so that these properties are always true.
355 A red-black tree with N internal nodes has height at most 2
356 log(N+1). Searches, insertions and deletions are done in O(log N).
357 Please see a text book about data structures for a detailed
358 description of red-black trees. Any book worth its salt should
363 /* Children of this node. These pointers are never NULL. When there
364 is no child, the value is MEM_NIL, which points to a dummy node. */
365 struct mem_node
*left
, *right
;
367 /* The parent of this node. In the root node, this is NULL. */
368 struct mem_node
*parent
;
370 /* Start and end of allocated region. */
374 enum {MEM_BLACK
, MEM_RED
} color
;
380 /* Base address of stack. Set in main. */
382 Lisp_Object
*stack_base
;
384 /* Root of the tree describing allocated Lisp memory. */
386 static struct mem_node
*mem_root
;
388 /* Lowest and highest known address in the heap. */
390 static void *min_heap_address
, *max_heap_address
;
392 /* Sentinel node of the tree. */
394 static struct mem_node mem_z
;
395 #define MEM_NIL &mem_z
397 static struct Lisp_Vector
*allocate_vectorlike (ptrdiff_t);
398 static void lisp_free (void *);
399 static void mark_stack (void);
400 static bool live_vector_p (struct mem_node
*, void *);
401 static bool live_buffer_p (struct mem_node
*, void *);
402 static bool live_string_p (struct mem_node
*, void *);
403 static bool live_cons_p (struct mem_node
*, void *);
404 static bool live_symbol_p (struct mem_node
*, void *);
405 static bool live_float_p (struct mem_node
*, void *);
406 static bool live_misc_p (struct mem_node
*, void *);
407 static void mark_maybe_object (Lisp_Object
);
408 static void mark_memory (void *, void *);
409 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
410 static void mem_init (void);
411 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
412 static void mem_insert_fixup (struct mem_node
*);
414 static void mem_rotate_left (struct mem_node
*);
415 static void mem_rotate_right (struct mem_node
*);
416 static void mem_delete (struct mem_node
*);
417 static void mem_delete_fixup (struct mem_node
*);
418 static inline struct mem_node
*mem_find (void *);
421 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
422 static void check_gcpros (void);
425 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
431 /* Recording what needs to be marked for gc. */
433 struct gcpro
*gcprolist
;
435 /* Addresses of staticpro'd variables. Initialize it to a nonzero
436 value; otherwise some compilers put it into BSS. */
438 #define NSTATICS 0x650
439 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
441 /* Index of next unused slot in staticvec. */
443 static int staticidx
;
445 static void *pure_alloc (size_t, int);
448 /* Value is SZ rounded up to the next multiple of ALIGNMENT.
449 ALIGNMENT must be a power of 2. */
451 #define ALIGN(ptr, ALIGNMENT) \
452 ((void *) (((uintptr_t) (ptr) + (ALIGNMENT) - 1) \
453 & ~ ((ALIGNMENT) - 1)))
457 /************************************************************************
459 ************************************************************************/
461 /* Function malloc calls this if it finds we are near exhausting storage. */
464 malloc_warning (const char *str
)
466 pending_malloc_warning
= str
;
470 /* Display an already-pending malloc warning. */
473 display_malloc_warning (void)
475 call3 (intern ("display-warning"),
477 build_string (pending_malloc_warning
),
478 intern ("emergency"));
479 pending_malloc_warning
= 0;
482 /* Called if we can't allocate relocatable space for a buffer. */
485 buffer_memory_full (ptrdiff_t nbytes
)
487 /* If buffers use the relocating allocator, no need to free
488 spare_memory, because we may have plenty of malloc space left
489 that we could get, and if we don't, the malloc that fails will
490 itself cause spare_memory to be freed. If buffers don't use the
491 relocating allocator, treat this like any other failing
495 memory_full (nbytes
);
498 /* This used to call error, but if we've run out of memory, we could
499 get infinite recursion trying to build the string. */
500 xsignal (Qnil
, Vmemory_signal_data
);
503 /* A common multiple of the positive integers A and B. Ideally this
504 would be the least common multiple, but there's no way to do that
505 as a constant expression in C, so do the best that we can easily do. */
506 #define COMMON_MULTIPLE(a, b) \
507 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
509 #ifndef XMALLOC_OVERRUN_CHECK
510 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
513 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
516 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
517 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
518 block size in little-endian order. The trailer consists of
519 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
521 The header is used to detect whether this block has been allocated
522 through these functions, as some low-level libc functions may
523 bypass the malloc hooks. */
525 #define XMALLOC_OVERRUN_CHECK_SIZE 16
526 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
527 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
529 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
530 hold a size_t value and (2) the header size is a multiple of the
531 alignment that Emacs needs for C types and for USE_LSB_TAG. */
532 #define XMALLOC_BASE_ALIGNMENT \
533 alignof (union { long double d; intmax_t i; void *p; })
536 # define XMALLOC_HEADER_ALIGNMENT \
537 COMMON_MULTIPLE (GCALIGNMENT, XMALLOC_BASE_ALIGNMENT)
539 # define XMALLOC_HEADER_ALIGNMENT XMALLOC_BASE_ALIGNMENT
541 #define XMALLOC_OVERRUN_SIZE_SIZE \
542 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
543 + XMALLOC_HEADER_ALIGNMENT - 1) \
544 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
545 - XMALLOC_OVERRUN_CHECK_SIZE)
547 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
548 { '\x9a', '\x9b', '\xae', '\xaf',
549 '\xbf', '\xbe', '\xce', '\xcf',
550 '\xea', '\xeb', '\xec', '\xed',
551 '\xdf', '\xde', '\x9c', '\x9d' };
553 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
554 { '\xaa', '\xab', '\xac', '\xad',
555 '\xba', '\xbb', '\xbc', '\xbd',
556 '\xca', '\xcb', '\xcc', '\xcd',
557 '\xda', '\xdb', '\xdc', '\xdd' };
559 /* Insert and extract the block size in the header. */
562 xmalloc_put_size (unsigned char *ptr
, size_t size
)
565 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
567 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
573 xmalloc_get_size (unsigned char *ptr
)
577 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
578 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
587 /* The call depth in overrun_check functions. For example, this might happen:
589 overrun_check_malloc()
590 -> malloc -> (via hook)_-> emacs_blocked_malloc
591 -> overrun_check_malloc
592 call malloc (hooks are NULL, so real malloc is called).
593 malloc returns 10000.
594 add overhead, return 10016.
595 <- (back in overrun_check_malloc)
596 add overhead again, return 10032
597 xmalloc returns 10032.
602 overrun_check_free(10032)
604 free(10016) <- crash, because 10000 is the original pointer. */
606 static ptrdiff_t check_depth
;
608 /* Like malloc, but wraps allocated block with header and trailer. */
611 overrun_check_malloc (size_t size
)
613 register unsigned char *val
;
614 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
615 if (SIZE_MAX
- overhead
< size
)
618 val
= malloc (size
+ overhead
);
619 if (val
&& check_depth
== 1)
621 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
622 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
623 xmalloc_put_size (val
, size
);
624 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
625 XMALLOC_OVERRUN_CHECK_SIZE
);
632 /* Like realloc, but checks old block for overrun, and wraps new block
633 with header and trailer. */
636 overrun_check_realloc (void *block
, size_t size
)
638 register unsigned char *val
= (unsigned char *) block
;
639 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
640 if (SIZE_MAX
- overhead
< size
)
645 && memcmp (xmalloc_overrun_check_header
,
646 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
647 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
649 size_t osize
= xmalloc_get_size (val
);
650 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
651 XMALLOC_OVERRUN_CHECK_SIZE
))
653 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
654 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
655 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
658 val
= realloc (val
, size
+ overhead
);
660 if (val
&& check_depth
== 1)
662 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
663 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
664 xmalloc_put_size (val
, size
);
665 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
666 XMALLOC_OVERRUN_CHECK_SIZE
);
672 /* Like free, but checks block for overrun. */
675 overrun_check_free (void *block
)
677 unsigned char *val
= (unsigned char *) block
;
682 && memcmp (xmalloc_overrun_check_header
,
683 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
684 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
686 size_t osize
= xmalloc_get_size (val
);
687 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
688 XMALLOC_OVERRUN_CHECK_SIZE
))
690 #ifdef XMALLOC_CLEAR_FREE_MEMORY
691 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
692 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
694 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
695 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
696 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
707 #define malloc overrun_check_malloc
708 #define realloc overrun_check_realloc
709 #define free overrun_check_free
713 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
714 there's no need to block input around malloc. */
715 #define MALLOC_BLOCK_INPUT ((void)0)
716 #define MALLOC_UNBLOCK_INPUT ((void)0)
718 #define MALLOC_BLOCK_INPUT BLOCK_INPUT
719 #define MALLOC_UNBLOCK_INPUT UNBLOCK_INPUT
722 /* Like malloc but check for no memory and block interrupt input.. */
725 xmalloc (size_t size
)
731 MALLOC_UNBLOCK_INPUT
;
738 /* Like the above, but zeroes out the memory just allocated. */
741 xzalloc (size_t size
)
747 MALLOC_UNBLOCK_INPUT
;
751 memset (val
, 0, size
);
755 /* Like realloc but check for no memory and block interrupt input.. */
758 xrealloc (void *block
, size_t size
)
763 /* We must call malloc explicitly when BLOCK is 0, since some
764 reallocs don't do this. */
768 val
= realloc (block
, size
);
769 MALLOC_UNBLOCK_INPUT
;
777 /* Like free but block interrupt input. */
786 MALLOC_UNBLOCK_INPUT
;
787 /* We don't call refill_memory_reserve here
788 because that duplicates doing so in emacs_blocked_free
789 and the criterion should go there. */
793 /* Other parts of Emacs pass large int values to allocator functions
794 expecting ptrdiff_t. This is portable in practice, but check it to
796 verify (INT_MAX
<= PTRDIFF_MAX
);
799 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
800 Signal an error on memory exhaustion, and block interrupt input. */
803 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
805 eassert (0 <= nitems
&& 0 < item_size
);
806 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
807 memory_full (SIZE_MAX
);
808 return xmalloc (nitems
* item_size
);
812 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
813 Signal an error on memory exhaustion, and block interrupt input. */
816 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
818 eassert (0 <= nitems
&& 0 < item_size
);
819 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
820 memory_full (SIZE_MAX
);
821 return xrealloc (pa
, nitems
* item_size
);
825 /* Grow PA, which points to an array of *NITEMS items, and return the
826 location of the reallocated array, updating *NITEMS to reflect its
827 new size. The new array will contain at least NITEMS_INCR_MIN more
828 items, but will not contain more than NITEMS_MAX items total.
829 ITEM_SIZE is the size of each item, in bytes.
831 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
832 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
835 If PA is null, then allocate a new array instead of reallocating
836 the old one. Thus, to grow an array A without saving its old
837 contents, invoke xfree (A) immediately followed by xgrowalloc (0,
840 Block interrupt input as needed. If memory exhaustion occurs, set
841 *NITEMS to zero if PA is null, and signal an error (i.e., do not
845 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
846 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
848 /* The approximate size to use for initial small allocation
849 requests. This is the largest "small" request for the GNU C
851 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
853 /* If the array is tiny, grow it to about (but no greater than)
854 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
855 ptrdiff_t n
= *nitems
;
856 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
857 ptrdiff_t half_again
= n
>> 1;
858 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
860 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
861 NITEMS_MAX, and what the C language can represent safely. */
862 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
863 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
864 ? nitems_max
: C_language_max
);
865 ptrdiff_t nitems_incr_max
= n_max
- n
;
866 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
868 eassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
871 if (nitems_incr_max
< incr
)
872 memory_full (SIZE_MAX
);
874 pa
= xrealloc (pa
, n
* item_size
);
880 /* Like strdup, but uses xmalloc. */
883 xstrdup (const char *s
)
885 size_t len
= strlen (s
) + 1;
886 char *p
= xmalloc (len
);
892 /* Unwind for SAFE_ALLOCA */
895 safe_alloca_unwind (Lisp_Object arg
)
897 register struct Lisp_Save_Value
*p
= XSAVE_VALUE (arg
);
906 /* Return a newly allocated memory block of SIZE bytes, remembering
907 to free it when unwinding. */
909 record_xmalloc (size_t size
)
911 void *p
= xmalloc (size
);
912 record_unwind_protect (safe_alloca_unwind
, make_save_value (p
, 0));
917 /* Like malloc but used for allocating Lisp data. NBYTES is the
918 number of bytes to allocate, TYPE describes the intended use of the
919 allocated memory block (for strings, for conses, ...). */
922 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
926 lisp_malloc (size_t nbytes
, enum mem_type type
)
932 #ifdef GC_MALLOC_CHECK
933 allocated_mem_type
= type
;
936 val
= malloc (nbytes
);
939 /* If the memory just allocated cannot be addressed thru a Lisp
940 object's pointer, and it needs to be,
941 that's equivalent to running out of memory. */
942 if (val
&& type
!= MEM_TYPE_NON_LISP
)
945 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
946 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
948 lisp_malloc_loser
= val
;
955 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
956 if (val
&& type
!= MEM_TYPE_NON_LISP
)
957 mem_insert (val
, (char *) val
+ nbytes
, type
);
960 MALLOC_UNBLOCK_INPUT
;
962 memory_full (nbytes
);
966 /* Free BLOCK. This must be called to free memory allocated with a
967 call to lisp_malloc. */
970 lisp_free (void *block
)
974 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
975 mem_delete (mem_find (block
));
977 MALLOC_UNBLOCK_INPUT
;
980 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
982 /* The entry point is lisp_align_malloc which returns blocks of at most
983 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
985 #if defined (HAVE_POSIX_MEMALIGN) && defined (SYSTEM_MALLOC)
986 #define USE_POSIX_MEMALIGN 1
989 /* BLOCK_ALIGN has to be a power of 2. */
990 #define BLOCK_ALIGN (1 << 10)
992 /* Padding to leave at the end of a malloc'd block. This is to give
993 malloc a chance to minimize the amount of memory wasted to alignment.
994 It should be tuned to the particular malloc library used.
995 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
996 posix_memalign on the other hand would ideally prefer a value of 4
997 because otherwise, there's 1020 bytes wasted between each ablocks.
998 In Emacs, testing shows that those 1020 can most of the time be
999 efficiently used by malloc to place other objects, so a value of 0 can
1000 still preferable unless you have a lot of aligned blocks and virtually
1002 #define BLOCK_PADDING 0
1003 #define BLOCK_BYTES \
1004 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
1006 /* Internal data structures and constants. */
1008 #define ABLOCKS_SIZE 16
1010 /* An aligned block of memory. */
1015 char payload
[BLOCK_BYTES
];
1016 struct ablock
*next_free
;
1018 /* `abase' is the aligned base of the ablocks. */
1019 /* It is overloaded to hold the virtual `busy' field that counts
1020 the number of used ablock in the parent ablocks.
1021 The first ablock has the `busy' field, the others have the `abase'
1022 field. To tell the difference, we assume that pointers will have
1023 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1024 is used to tell whether the real base of the parent ablocks is `abase'
1025 (if not, the word before the first ablock holds a pointer to the
1027 struct ablocks
*abase
;
1028 /* The padding of all but the last ablock is unused. The padding of
1029 the last ablock in an ablocks is not allocated. */
1031 char padding
[BLOCK_PADDING
];
1035 /* A bunch of consecutive aligned blocks. */
1038 struct ablock blocks
[ABLOCKS_SIZE
];
1041 /* Size of the block requested from malloc or posix_memalign. */
1042 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1044 #define ABLOCK_ABASE(block) \
1045 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1046 ? (struct ablocks *)(block) \
1049 /* Virtual `busy' field. */
1050 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1052 /* Pointer to the (not necessarily aligned) malloc block. */
1053 #ifdef USE_POSIX_MEMALIGN
1054 #define ABLOCKS_BASE(abase) (abase)
1056 #define ABLOCKS_BASE(abase) \
1057 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void**)abase)[-1])
1060 /* The list of free ablock. */
1061 static struct ablock
*free_ablock
;
1063 /* Allocate an aligned block of nbytes.
1064 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1065 smaller or equal to BLOCK_BYTES. */
1067 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1070 struct ablocks
*abase
;
1072 eassert (nbytes
<= BLOCK_BYTES
);
1076 #ifdef GC_MALLOC_CHECK
1077 allocated_mem_type
= type
;
1083 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1085 #ifdef DOUG_LEA_MALLOC
1086 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1087 because mapped region contents are not preserved in
1089 mallopt (M_MMAP_MAX
, 0);
1092 #ifdef USE_POSIX_MEMALIGN
1094 int err
= posix_memalign (&base
, BLOCK_ALIGN
, ABLOCKS_BYTES
);
1100 base
= malloc (ABLOCKS_BYTES
);
1101 abase
= ALIGN (base
, BLOCK_ALIGN
);
1106 MALLOC_UNBLOCK_INPUT
;
1107 memory_full (ABLOCKS_BYTES
);
1110 aligned
= (base
== abase
);
1112 ((void**)abase
)[-1] = base
;
1114 #ifdef DOUG_LEA_MALLOC
1115 /* Back to a reasonable maximum of mmap'ed areas. */
1116 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1120 /* If the memory just allocated cannot be addressed thru a Lisp
1121 object's pointer, and it needs to be, that's equivalent to
1122 running out of memory. */
1123 if (type
!= MEM_TYPE_NON_LISP
)
1126 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1127 XSETCONS (tem
, end
);
1128 if ((char *) XCONS (tem
) != end
)
1130 lisp_malloc_loser
= base
;
1132 MALLOC_UNBLOCK_INPUT
;
1133 memory_full (SIZE_MAX
);
1138 /* Initialize the blocks and put them on the free list.
1139 If `base' was not properly aligned, we can't use the last block. */
1140 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1142 abase
->blocks
[i
].abase
= abase
;
1143 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1144 free_ablock
= &abase
->blocks
[i
];
1146 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1148 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1149 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1150 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1151 eassert (ABLOCKS_BASE (abase
) == base
);
1152 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1155 abase
= ABLOCK_ABASE (free_ablock
);
1156 ABLOCKS_BUSY (abase
) =
1157 (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1159 free_ablock
= free_ablock
->x
.next_free
;
1161 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1162 if (type
!= MEM_TYPE_NON_LISP
)
1163 mem_insert (val
, (char *) val
+ nbytes
, type
);
1166 MALLOC_UNBLOCK_INPUT
;
1168 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1173 lisp_align_free (void *block
)
1175 struct ablock
*ablock
= block
;
1176 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1179 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1180 mem_delete (mem_find (block
));
1182 /* Put on free list. */
1183 ablock
->x
.next_free
= free_ablock
;
1184 free_ablock
= ablock
;
1185 /* Update busy count. */
1186 ABLOCKS_BUSY (abase
)
1187 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1189 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1190 { /* All the blocks are free. */
1191 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1192 struct ablock
**tem
= &free_ablock
;
1193 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1197 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1200 *tem
= (*tem
)->x
.next_free
;
1203 tem
= &(*tem
)->x
.next_free
;
1205 eassert ((aligned
& 1) == aligned
);
1206 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1207 #ifdef USE_POSIX_MEMALIGN
1208 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1210 free (ABLOCKS_BASE (abase
));
1212 MALLOC_UNBLOCK_INPUT
;
1216 #ifndef SYSTEM_MALLOC
1218 /* Arranging to disable input signals while we're in malloc.
1220 This only works with GNU malloc. To help out systems which can't
1221 use GNU malloc, all the calls to malloc, realloc, and free
1222 elsewhere in the code should be inside a BLOCK_INPUT/UNBLOCK_INPUT
1223 pair; unfortunately, we have no idea what C library functions
1224 might call malloc, so we can't really protect them unless you're
1225 using GNU malloc. Fortunately, most of the major operating systems
1226 can use GNU malloc. */
1229 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
1230 there's no need to block input around malloc. */
1232 #ifndef DOUG_LEA_MALLOC
1233 extern void * (*__malloc_hook
) (size_t, const void *);
1234 extern void * (*__realloc_hook
) (void *, size_t, const void *);
1235 extern void (*__free_hook
) (void *, const void *);
1236 /* Else declared in malloc.h, perhaps with an extra arg. */
1237 #endif /* DOUG_LEA_MALLOC */
1238 static void * (*old_malloc_hook
) (size_t, const void *);
1239 static void * (*old_realloc_hook
) (void *, size_t, const void*);
1240 static void (*old_free_hook
) (void*, const void*);
1242 #ifdef DOUG_LEA_MALLOC
1243 # define BYTES_USED (mallinfo ().uordblks)
1245 # define BYTES_USED _bytes_used
1248 #ifdef GC_MALLOC_CHECK
1249 static bool dont_register_blocks
;
1252 static size_t bytes_used_when_reconsidered
;
1254 /* Value of _bytes_used, when spare_memory was freed. */
1256 static size_t bytes_used_when_full
;
1258 /* This function is used as the hook for free to call. */
1261 emacs_blocked_free (void *ptr
, const void *ptr2
)
1265 #ifdef GC_MALLOC_CHECK
1271 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1274 "Freeing `%p' which wasn't allocated with malloc\n", ptr
);
1279 /* fprintf (stderr, "free %p...%p (%p)\n", m->start, m->end, ptr); */
1283 #endif /* GC_MALLOC_CHECK */
1285 __free_hook
= old_free_hook
;
1288 /* If we released our reserve (due to running out of memory),
1289 and we have a fair amount free once again,
1290 try to set aside another reserve in case we run out once more. */
1291 if (! NILP (Vmemory_full
)
1292 /* Verify there is enough space that even with the malloc
1293 hysteresis this call won't run out again.
1294 The code here is correct as long as SPARE_MEMORY
1295 is substantially larger than the block size malloc uses. */
1296 && (bytes_used_when_full
1297 > ((bytes_used_when_reconsidered
= BYTES_USED
)
1298 + max (malloc_hysteresis
, 4) * SPARE_MEMORY
)))
1299 refill_memory_reserve ();
1301 __free_hook
= emacs_blocked_free
;
1302 UNBLOCK_INPUT_ALLOC
;
1306 /* This function is the malloc hook that Emacs uses. */
1309 emacs_blocked_malloc (size_t size
, const void *ptr
)
1314 __malloc_hook
= old_malloc_hook
;
1315 #ifdef DOUG_LEA_MALLOC
1316 /* Segfaults on my system. --lorentey */
1317 /* mallopt (M_TOP_PAD, malloc_hysteresis * 4096); */
1319 __malloc_extra_blocks
= malloc_hysteresis
;
1322 value
= malloc (size
);
1324 #ifdef GC_MALLOC_CHECK
1326 struct mem_node
*m
= mem_find (value
);
1329 fprintf (stderr
, "Malloc returned %p which is already in use\n",
1331 fprintf (stderr
, "Region in use is %p...%p, %td bytes, type %d\n",
1332 m
->start
, m
->end
, (char *) m
->end
- (char *) m
->start
,
1337 if (!dont_register_blocks
)
1339 mem_insert (value
, (char *) value
+ max (1, size
), allocated_mem_type
);
1340 allocated_mem_type
= MEM_TYPE_NON_LISP
;
1343 #endif /* GC_MALLOC_CHECK */
1345 __malloc_hook
= emacs_blocked_malloc
;
1346 UNBLOCK_INPUT_ALLOC
;
1348 /* fprintf (stderr, "%p malloc\n", value); */
1353 /* This function is the realloc hook that Emacs uses. */
1356 emacs_blocked_realloc (void *ptr
, size_t size
, const void *ptr2
)
1361 __realloc_hook
= old_realloc_hook
;
1363 #ifdef GC_MALLOC_CHECK
1366 struct mem_node
*m
= mem_find (ptr
);
1367 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1370 "Realloc of %p which wasn't allocated with malloc\n",
1378 /* fprintf (stderr, "%p -> realloc\n", ptr); */
1380 /* Prevent malloc from registering blocks. */
1381 dont_register_blocks
= 1;
1382 #endif /* GC_MALLOC_CHECK */
1384 value
= realloc (ptr
, size
);
1386 #ifdef GC_MALLOC_CHECK
1387 dont_register_blocks
= 0;
1390 struct mem_node
*m
= mem_find (value
);
1393 fprintf (stderr
, "Realloc returns memory that is already in use\n");
1397 /* Can't handle zero size regions in the red-black tree. */
1398 mem_insert (value
, (char *) value
+ max (size
, 1), MEM_TYPE_NON_LISP
);
1401 /* fprintf (stderr, "%p <- realloc\n", value); */
1402 #endif /* GC_MALLOC_CHECK */
1404 __realloc_hook
= emacs_blocked_realloc
;
1405 UNBLOCK_INPUT_ALLOC
;
1412 /* Called from Fdump_emacs so that when the dumped Emacs starts, it has a
1413 normal malloc. Some thread implementations need this as they call
1414 malloc before main. The pthread_self call in BLOCK_INPUT_ALLOC then
1415 calls malloc because it is the first call, and we have an endless loop. */
1418 reset_malloc_hooks (void)
1420 __free_hook
= old_free_hook
;
1421 __malloc_hook
= old_malloc_hook
;
1422 __realloc_hook
= old_realloc_hook
;
1424 #endif /* HAVE_PTHREAD */
1427 /* Called from main to set up malloc to use our hooks. */
1430 uninterrupt_malloc (void)
1433 #ifdef DOUG_LEA_MALLOC
1434 pthread_mutexattr_t attr
;
1436 /* GLIBC has a faster way to do this, but let's keep it portable.
1437 This is according to the Single UNIX Specification. */
1438 pthread_mutexattr_init (&attr
);
1439 pthread_mutexattr_settype (&attr
, PTHREAD_MUTEX_RECURSIVE
);
1440 pthread_mutex_init (&alloc_mutex
, &attr
);
1441 #else /* !DOUG_LEA_MALLOC */
1442 /* Some systems such as Solaris 2.6 don't have a recursive mutex,
1443 and the bundled gmalloc.c doesn't require it. */
1444 pthread_mutex_init (&alloc_mutex
, NULL
);
1445 #endif /* !DOUG_LEA_MALLOC */
1446 #endif /* HAVE_PTHREAD */
1448 if (__free_hook
!= emacs_blocked_free
)
1449 old_free_hook
= __free_hook
;
1450 __free_hook
= emacs_blocked_free
;
1452 if (__malloc_hook
!= emacs_blocked_malloc
)
1453 old_malloc_hook
= __malloc_hook
;
1454 __malloc_hook
= emacs_blocked_malloc
;
1456 if (__realloc_hook
!= emacs_blocked_realloc
)
1457 old_realloc_hook
= __realloc_hook
;
1458 __realloc_hook
= emacs_blocked_realloc
;
1461 #endif /* not SYNC_INPUT */
1462 #endif /* not SYSTEM_MALLOC */
1466 /***********************************************************************
1468 ***********************************************************************/
1470 /* Number of intervals allocated in an interval_block structure.
1471 The 1020 is 1024 minus malloc overhead. */
1473 #define INTERVAL_BLOCK_SIZE \
1474 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1476 /* Intervals are allocated in chunks in form of an interval_block
1479 struct interval_block
1481 /* Place `intervals' first, to preserve alignment. */
1482 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1483 struct interval_block
*next
;
1486 /* Current interval block. Its `next' pointer points to older
1489 static struct interval_block
*interval_block
;
1491 /* Index in interval_block above of the next unused interval
1494 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1496 /* Number of free and live intervals. */
1498 static EMACS_INT total_free_intervals
, total_intervals
;
1500 /* List of free intervals. */
1502 static INTERVAL interval_free_list
;
1504 /* Return a new interval. */
1507 make_interval (void)
1511 /* eassert (!handling_signal); */
1515 if (interval_free_list
)
1517 val
= interval_free_list
;
1518 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1522 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1524 struct interval_block
*newi
1525 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1527 newi
->next
= interval_block
;
1528 interval_block
= newi
;
1529 interval_block_index
= 0;
1530 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1532 val
= &interval_block
->intervals
[interval_block_index
++];
1535 MALLOC_UNBLOCK_INPUT
;
1537 consing_since_gc
+= sizeof (struct interval
);
1539 total_free_intervals
--;
1540 RESET_INTERVAL (val
);
1546 /* Mark Lisp objects in interval I. */
1549 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1551 /* Intervals should never be shared. So, if extra internal checking is
1552 enabled, GC aborts if it seems to have visited an interval twice. */
1553 eassert (!i
->gcmarkbit
);
1555 mark_object (i
->plist
);
1558 /* Mark the interval tree rooted in I. */
1560 #define MARK_INTERVAL_TREE(i) \
1562 if (i && !i->gcmarkbit) \
1563 traverse_intervals_noorder (i, mark_interval, Qnil); \
1566 /***********************************************************************
1568 ***********************************************************************/
1570 /* Lisp_Strings are allocated in string_block structures. When a new
1571 string_block is allocated, all the Lisp_Strings it contains are
1572 added to a free-list string_free_list. When a new Lisp_String is
1573 needed, it is taken from that list. During the sweep phase of GC,
1574 string_blocks that are entirely free are freed, except two which
1577 String data is allocated from sblock structures. Strings larger
1578 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1579 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1581 Sblocks consist internally of sdata structures, one for each
1582 Lisp_String. The sdata structure points to the Lisp_String it
1583 belongs to. The Lisp_String points back to the `u.data' member of
1584 its sdata structure.
1586 When a Lisp_String is freed during GC, it is put back on
1587 string_free_list, and its `data' member and its sdata's `string'
1588 pointer is set to null. The size of the string is recorded in the
1589 `u.nbytes' member of the sdata. So, sdata structures that are no
1590 longer used, can be easily recognized, and it's easy to compact the
1591 sblocks of small strings which we do in compact_small_strings. */
1593 /* Size in bytes of an sblock structure used for small strings. This
1594 is 8192 minus malloc overhead. */
1596 #define SBLOCK_SIZE 8188
1598 /* Strings larger than this are considered large strings. String data
1599 for large strings is allocated from individual sblocks. */
1601 #define LARGE_STRING_BYTES 1024
1603 /* Structure describing string memory sub-allocated from an sblock.
1604 This is where the contents of Lisp strings are stored. */
1608 /* Back-pointer to the string this sdata belongs to. If null, this
1609 structure is free, and the NBYTES member of the union below
1610 contains the string's byte size (the same value that STRING_BYTES
1611 would return if STRING were non-null). If non-null, STRING_BYTES
1612 (STRING) is the size of the data, and DATA contains the string's
1614 struct Lisp_String
*string
;
1616 #ifdef GC_CHECK_STRING_BYTES
1619 unsigned char data
[1];
1621 #define SDATA_NBYTES(S) (S)->nbytes
1622 #define SDATA_DATA(S) (S)->data
1623 #define SDATA_SELECTOR(member) member
1625 #else /* not GC_CHECK_STRING_BYTES */
1629 /* When STRING is non-null. */
1630 unsigned char data
[1];
1632 /* When STRING is null. */
1636 #define SDATA_NBYTES(S) (S)->u.nbytes
1637 #define SDATA_DATA(S) (S)->u.data
1638 #define SDATA_SELECTOR(member) u.member
1640 #endif /* not GC_CHECK_STRING_BYTES */
1642 #define SDATA_DATA_OFFSET offsetof (struct sdata, SDATA_SELECTOR (data))
1646 /* Structure describing a block of memory which is sub-allocated to
1647 obtain string data memory for strings. Blocks for small strings
1648 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1649 as large as needed. */
1654 struct sblock
*next
;
1656 /* Pointer to the next free sdata block. This points past the end
1657 of the sblock if there isn't any space left in this block. */
1658 struct sdata
*next_free
;
1660 /* Start of data. */
1661 struct sdata first_data
;
1664 /* Number of Lisp strings in a string_block structure. The 1020 is
1665 1024 minus malloc overhead. */
1667 #define STRING_BLOCK_SIZE \
1668 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1670 /* Structure describing a block from which Lisp_String structures
1675 /* Place `strings' first, to preserve alignment. */
1676 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1677 struct string_block
*next
;
1680 /* Head and tail of the list of sblock structures holding Lisp string
1681 data. We always allocate from current_sblock. The NEXT pointers
1682 in the sblock structures go from oldest_sblock to current_sblock. */
1684 static struct sblock
*oldest_sblock
, *current_sblock
;
1686 /* List of sblocks for large strings. */
1688 static struct sblock
*large_sblocks
;
1690 /* List of string_block structures. */
1692 static struct string_block
*string_blocks
;
1694 /* Free-list of Lisp_Strings. */
1696 static struct Lisp_String
*string_free_list
;
1698 /* Number of live and free Lisp_Strings. */
1700 static EMACS_INT total_strings
, total_free_strings
;
1702 /* Number of bytes used by live strings. */
1704 static EMACS_INT total_string_bytes
;
1706 /* Given a pointer to a Lisp_String S which is on the free-list
1707 string_free_list, return a pointer to its successor in the
1710 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1712 /* Return a pointer to the sdata structure belonging to Lisp string S.
1713 S must be live, i.e. S->data must not be null. S->data is actually
1714 a pointer to the `u.data' member of its sdata structure; the
1715 structure starts at a constant offset in front of that. */
1717 #define SDATA_OF_STRING(S) ((struct sdata *) ((S)->data - SDATA_DATA_OFFSET))
1720 #ifdef GC_CHECK_STRING_OVERRUN
1722 /* We check for overrun in string data blocks by appending a small
1723 "cookie" after each allocated string data block, and check for the
1724 presence of this cookie during GC. */
1726 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1727 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1728 { '\xde', '\xad', '\xbe', '\xef' };
1731 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1734 /* Value is the size of an sdata structure large enough to hold NBYTES
1735 bytes of string data. The value returned includes a terminating
1736 NUL byte, the size of the sdata structure, and padding. */
1738 #ifdef GC_CHECK_STRING_BYTES
1740 #define SDATA_SIZE(NBYTES) \
1741 ((SDATA_DATA_OFFSET \
1743 + sizeof (ptrdiff_t) - 1) \
1744 & ~(sizeof (ptrdiff_t) - 1))
1746 #else /* not GC_CHECK_STRING_BYTES */
1748 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1749 less than the size of that member. The 'max' is not needed when
1750 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1751 alignment code reserves enough space. */
1753 #define SDATA_SIZE(NBYTES) \
1754 ((SDATA_DATA_OFFSET \
1755 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1757 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1759 + sizeof (ptrdiff_t) - 1) \
1760 & ~(sizeof (ptrdiff_t) - 1))
1762 #endif /* not GC_CHECK_STRING_BYTES */
1764 /* Extra bytes to allocate for each string. */
1766 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1768 /* Exact bound on the number of bytes in a string, not counting the
1769 terminating null. A string cannot contain more bytes than
1770 STRING_BYTES_BOUND, nor can it be so long that the size_t
1771 arithmetic in allocate_string_data would overflow while it is
1772 calculating a value to be passed to malloc. */
1773 static ptrdiff_t const STRING_BYTES_MAX
=
1774 min (STRING_BYTES_BOUND
,
1775 ((SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
1777 - offsetof (struct sblock
, first_data
)
1778 - SDATA_DATA_OFFSET
)
1779 & ~(sizeof (EMACS_INT
) - 1)));
1781 /* Initialize string allocation. Called from init_alloc_once. */
1786 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1787 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1791 #ifdef GC_CHECK_STRING_BYTES
1793 static int check_string_bytes_count
;
1795 /* Like STRING_BYTES, but with debugging check. Can be
1796 called during GC, so pay attention to the mark bit. */
1799 string_bytes (struct Lisp_String
*s
)
1802 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1804 if (!PURE_POINTER_P (s
)
1806 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1811 /* Check validity of Lisp strings' string_bytes member in B. */
1814 check_sblock (struct sblock
*b
)
1816 struct sdata
*from
, *end
, *from_end
;
1820 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1822 /* Compute the next FROM here because copying below may
1823 overwrite data we need to compute it. */
1826 /* Check that the string size recorded in the string is the
1827 same as the one recorded in the sdata structure. */
1828 nbytes
= SDATA_SIZE (from
->string
? string_bytes (from
->string
)
1829 : SDATA_NBYTES (from
));
1830 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1835 /* Check validity of Lisp strings' string_bytes member. ALL_P
1836 means check all strings, otherwise check only most
1837 recently allocated strings. Used for hunting a bug. */
1840 check_string_bytes (bool all_p
)
1846 for (b
= large_sblocks
; b
; b
= b
->next
)
1848 struct Lisp_String
*s
= b
->first_data
.string
;
1853 for (b
= oldest_sblock
; b
; b
= b
->next
)
1856 else if (current_sblock
)
1857 check_sblock (current_sblock
);
1860 #else /* not GC_CHECK_STRING_BYTES */
1862 #define check_string_bytes(all) ((void) 0)
1864 #endif /* GC_CHECK_STRING_BYTES */
1866 #ifdef GC_CHECK_STRING_FREE_LIST
1868 /* Walk through the string free list looking for bogus next pointers.
1869 This may catch buffer overrun from a previous string. */
1872 check_string_free_list (void)
1874 struct Lisp_String
*s
;
1876 /* Pop a Lisp_String off the free-list. */
1877 s
= string_free_list
;
1880 if ((uintptr_t) s
< 1024)
1882 s
= NEXT_FREE_LISP_STRING (s
);
1886 #define check_string_free_list()
1889 /* Return a new Lisp_String. */
1891 static struct Lisp_String
*
1892 allocate_string (void)
1894 struct Lisp_String
*s
;
1896 /* eassert (!handling_signal); */
1900 /* If the free-list is empty, allocate a new string_block, and
1901 add all the Lisp_Strings in it to the free-list. */
1902 if (string_free_list
== NULL
)
1904 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1907 b
->next
= string_blocks
;
1910 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1913 /* Every string on a free list should have NULL data pointer. */
1915 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1916 string_free_list
= s
;
1919 total_free_strings
+= STRING_BLOCK_SIZE
;
1922 check_string_free_list ();
1924 /* Pop a Lisp_String off the free-list. */
1925 s
= string_free_list
;
1926 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1928 MALLOC_UNBLOCK_INPUT
;
1930 --total_free_strings
;
1933 consing_since_gc
+= sizeof *s
;
1935 #ifdef GC_CHECK_STRING_BYTES
1936 if (!noninteractive
)
1938 if (++check_string_bytes_count
== 200)
1940 check_string_bytes_count
= 0;
1941 check_string_bytes (1);
1944 check_string_bytes (0);
1946 #endif /* GC_CHECK_STRING_BYTES */
1952 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1953 plus a NUL byte at the end. Allocate an sdata structure for S, and
1954 set S->data to its `u.data' member. Store a NUL byte at the end of
1955 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1956 S->data if it was initially non-null. */
1959 allocate_string_data (struct Lisp_String
*s
,
1960 EMACS_INT nchars
, EMACS_INT nbytes
)
1962 struct sdata
*data
, *old_data
;
1964 ptrdiff_t needed
, old_nbytes
;
1966 if (STRING_BYTES_MAX
< nbytes
)
1969 /* Determine the number of bytes needed to store NBYTES bytes
1971 needed
= SDATA_SIZE (nbytes
);
1974 old_data
= SDATA_OF_STRING (s
);
1975 old_nbytes
= STRING_BYTES (s
);
1982 if (nbytes
> LARGE_STRING_BYTES
)
1984 size_t size
= offsetof (struct sblock
, first_data
) + needed
;
1986 #ifdef DOUG_LEA_MALLOC
1987 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1988 because mapped region contents are not preserved in
1991 In case you think of allowing it in a dumped Emacs at the
1992 cost of not being able to re-dump, there's another reason:
1993 mmap'ed data typically have an address towards the top of the
1994 address space, which won't fit into an EMACS_INT (at least on
1995 32-bit systems with the current tagging scheme). --fx */
1996 mallopt (M_MMAP_MAX
, 0);
1999 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
2001 #ifdef DOUG_LEA_MALLOC
2002 /* Back to a reasonable maximum of mmap'ed areas. */
2003 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2006 b
->next_free
= &b
->first_data
;
2007 b
->first_data
.string
= NULL
;
2008 b
->next
= large_sblocks
;
2011 else if (current_sblock
== NULL
2012 || (((char *) current_sblock
+ SBLOCK_SIZE
2013 - (char *) current_sblock
->next_free
)
2014 < (needed
+ GC_STRING_EXTRA
)))
2016 /* Not enough room in the current sblock. */
2017 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
2018 b
->next_free
= &b
->first_data
;
2019 b
->first_data
.string
= NULL
;
2023 current_sblock
->next
= b
;
2031 data
= b
->next_free
;
2032 b
->next_free
= (struct sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
2034 MALLOC_UNBLOCK_INPUT
;
2037 s
->data
= SDATA_DATA (data
);
2038 #ifdef GC_CHECK_STRING_BYTES
2039 SDATA_NBYTES (data
) = nbytes
;
2042 s
->size_byte
= nbytes
;
2043 s
->data
[nbytes
] = '\0';
2044 #ifdef GC_CHECK_STRING_OVERRUN
2045 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
2046 GC_STRING_OVERRUN_COOKIE_SIZE
);
2049 /* Note that Faset may call to this function when S has already data
2050 assigned. In this case, mark data as free by setting it's string
2051 back-pointer to null, and record the size of the data in it. */
2054 SDATA_NBYTES (old_data
) = old_nbytes
;
2055 old_data
->string
= NULL
;
2058 consing_since_gc
+= needed
;
2062 /* Sweep and compact strings. */
2065 sweep_strings (void)
2067 struct string_block
*b
, *next
;
2068 struct string_block
*live_blocks
= NULL
;
2070 string_free_list
= NULL
;
2071 total_strings
= total_free_strings
= 0;
2072 total_string_bytes
= 0;
2074 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
2075 for (b
= string_blocks
; b
; b
= next
)
2078 struct Lisp_String
*free_list_before
= string_free_list
;
2082 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
2084 struct Lisp_String
*s
= b
->strings
+ i
;
2088 /* String was not on free-list before. */
2089 if (STRING_MARKED_P (s
))
2091 /* String is live; unmark it and its intervals. */
2094 /* Do not use string_(set|get)_intervals here. */
2095 s
->intervals
= balance_intervals (s
->intervals
);
2098 total_string_bytes
+= STRING_BYTES (s
);
2102 /* String is dead. Put it on the free-list. */
2103 struct sdata
*data
= SDATA_OF_STRING (s
);
2105 /* Save the size of S in its sdata so that we know
2106 how large that is. Reset the sdata's string
2107 back-pointer so that we know it's free. */
2108 #ifdef GC_CHECK_STRING_BYTES
2109 if (string_bytes (s
) != SDATA_NBYTES (data
))
2112 data
->u
.nbytes
= STRING_BYTES (s
);
2114 data
->string
= NULL
;
2116 /* Reset the strings's `data' member so that we
2120 /* Put the string on the free-list. */
2121 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2122 string_free_list
= s
;
2128 /* S was on the free-list before. Put it there again. */
2129 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2130 string_free_list
= s
;
2135 /* Free blocks that contain free Lisp_Strings only, except
2136 the first two of them. */
2137 if (nfree
== STRING_BLOCK_SIZE
2138 && total_free_strings
> STRING_BLOCK_SIZE
)
2141 string_free_list
= free_list_before
;
2145 total_free_strings
+= nfree
;
2146 b
->next
= live_blocks
;
2151 check_string_free_list ();
2153 string_blocks
= live_blocks
;
2154 free_large_strings ();
2155 compact_small_strings ();
2157 check_string_free_list ();
2161 /* Free dead large strings. */
2164 free_large_strings (void)
2166 struct sblock
*b
, *next
;
2167 struct sblock
*live_blocks
= NULL
;
2169 for (b
= large_sblocks
; b
; b
= next
)
2173 if (b
->first_data
.string
== NULL
)
2177 b
->next
= live_blocks
;
2182 large_sblocks
= live_blocks
;
2186 /* Compact data of small strings. Free sblocks that don't contain
2187 data of live strings after compaction. */
2190 compact_small_strings (void)
2192 struct sblock
*b
, *tb
, *next
;
2193 struct sdata
*from
, *to
, *end
, *tb_end
;
2194 struct sdata
*to_end
, *from_end
;
2196 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2197 to, and TB_END is the end of TB. */
2199 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2200 to
= &tb
->first_data
;
2202 /* Step through the blocks from the oldest to the youngest. We
2203 expect that old blocks will stabilize over time, so that less
2204 copying will happen this way. */
2205 for (b
= oldest_sblock
; b
; b
= b
->next
)
2208 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2210 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
2212 /* Compute the next FROM here because copying below may
2213 overwrite data we need to compute it. */
2215 struct Lisp_String
*s
= from
->string
;
2217 #ifdef GC_CHECK_STRING_BYTES
2218 /* Check that the string size recorded in the string is the
2219 same as the one recorded in the sdata structure. */
2220 if (s
&& string_bytes (s
) != SDATA_NBYTES (from
))
2222 #endif /* GC_CHECK_STRING_BYTES */
2224 nbytes
= s
? STRING_BYTES (s
) : SDATA_NBYTES (from
);
2225 eassert (nbytes
<= LARGE_STRING_BYTES
);
2227 nbytes
= SDATA_SIZE (nbytes
);
2228 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2230 #ifdef GC_CHECK_STRING_OVERRUN
2231 if (memcmp (string_overrun_cookie
,
2232 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2233 GC_STRING_OVERRUN_COOKIE_SIZE
))
2237 /* Non-NULL S means it's alive. Copy its data. */
2240 /* If TB is full, proceed with the next sblock. */
2241 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2242 if (to_end
> tb_end
)
2246 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2247 to
= &tb
->first_data
;
2248 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2251 /* Copy, and update the string's `data' pointer. */
2254 eassert (tb
!= b
|| to
< from
);
2255 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2256 to
->string
->data
= SDATA_DATA (to
);
2259 /* Advance past the sdata we copied to. */
2265 /* The rest of the sblocks following TB don't contain live data, so
2266 we can free them. */
2267 for (b
= tb
->next
; b
; b
= next
)
2275 current_sblock
= tb
;
2279 string_overflow (void)
2281 error ("Maximum string size exceeded");
2284 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2285 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2286 LENGTH must be an integer.
2287 INIT must be an integer that represents a character. */)
2288 (Lisp_Object length
, Lisp_Object init
)
2290 register Lisp_Object val
;
2291 register unsigned char *p
, *end
;
2295 CHECK_NATNUM (length
);
2296 CHECK_CHARACTER (init
);
2298 c
= XFASTINT (init
);
2299 if (ASCII_CHAR_P (c
))
2301 nbytes
= XINT (length
);
2302 val
= make_uninit_string (nbytes
);
2304 end
= p
+ SCHARS (val
);
2310 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2311 int len
= CHAR_STRING (c
, str
);
2312 EMACS_INT string_len
= XINT (length
);
2314 if (string_len
> STRING_BYTES_MAX
/ len
)
2316 nbytes
= len
* string_len
;
2317 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2322 memcpy (p
, str
, len
);
2332 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2333 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2334 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2335 (Lisp_Object length
, Lisp_Object init
)
2337 register Lisp_Object val
;
2338 struct Lisp_Bool_Vector
*p
;
2339 ptrdiff_t length_in_chars
;
2340 EMACS_INT length_in_elts
;
2342 int extra_bool_elts
= ((bool_header_size
- header_size
+ word_size
- 1)
2345 CHECK_NATNUM (length
);
2347 bits_per_value
= sizeof (EMACS_INT
) * BOOL_VECTOR_BITS_PER_CHAR
;
2349 length_in_elts
= (XFASTINT (length
) + bits_per_value
- 1) / bits_per_value
;
2351 val
= Fmake_vector (make_number (length_in_elts
+ extra_bool_elts
), Qnil
);
2353 /* No Lisp_Object to trace in there. */
2354 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0);
2356 p
= XBOOL_VECTOR (val
);
2357 p
->size
= XFASTINT (length
);
2359 length_in_chars
= ((XFASTINT (length
) + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2360 / BOOL_VECTOR_BITS_PER_CHAR
);
2361 if (length_in_chars
)
2363 memset (p
->data
, ! NILP (init
) ? -1 : 0, length_in_chars
);
2365 /* Clear any extraneous bits in the last byte. */
2366 p
->data
[length_in_chars
- 1]
2367 &= (1 << ((XFASTINT (length
) - 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1)) - 1;
2374 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2375 of characters from the contents. This string may be unibyte or
2376 multibyte, depending on the contents. */
2379 make_string (const char *contents
, ptrdiff_t nbytes
)
2381 register Lisp_Object val
;
2382 ptrdiff_t nchars
, multibyte_nbytes
;
2384 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2385 &nchars
, &multibyte_nbytes
);
2386 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2387 /* CONTENTS contains no multibyte sequences or contains an invalid
2388 multibyte sequence. We must make unibyte string. */
2389 val
= make_unibyte_string (contents
, nbytes
);
2391 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2396 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2399 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2401 register Lisp_Object val
;
2402 val
= make_uninit_string (length
);
2403 memcpy (SDATA (val
), contents
, length
);
2408 /* Make a multibyte string from NCHARS characters occupying NBYTES
2409 bytes at CONTENTS. */
2412 make_multibyte_string (const char *contents
,
2413 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2415 register Lisp_Object val
;
2416 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2417 memcpy (SDATA (val
), contents
, nbytes
);
2422 /* Make a string from NCHARS characters occupying NBYTES bytes at
2423 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2426 make_string_from_bytes (const char *contents
,
2427 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2429 register Lisp_Object val
;
2430 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2431 memcpy (SDATA (val
), contents
, nbytes
);
2432 if (SBYTES (val
) == SCHARS (val
))
2433 STRING_SET_UNIBYTE (val
);
2438 /* Make a string from NCHARS characters occupying NBYTES bytes at
2439 CONTENTS. The argument MULTIBYTE controls whether to label the
2440 string as multibyte. If NCHARS is negative, it counts the number of
2441 characters by itself. */
2444 make_specified_string (const char *contents
,
2445 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
2452 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2457 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2458 memcpy (SDATA (val
), contents
, nbytes
);
2460 STRING_SET_UNIBYTE (val
);
2465 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2466 occupying LENGTH bytes. */
2469 make_uninit_string (EMACS_INT length
)
2474 return empty_unibyte_string
;
2475 val
= make_uninit_multibyte_string (length
, length
);
2476 STRING_SET_UNIBYTE (val
);
2481 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2482 which occupy NBYTES bytes. */
2485 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2488 struct Lisp_String
*s
;
2493 return empty_multibyte_string
;
2495 s
= allocate_string ();
2496 s
->intervals
= NULL
;
2497 allocate_string_data (s
, nchars
, nbytes
);
2498 XSETSTRING (string
, s
);
2499 string_chars_consed
+= nbytes
;
2503 /* Print arguments to BUF according to a FORMAT, then return
2504 a Lisp_String initialized with the data from BUF. */
2507 make_formatted_string (char *buf
, const char *format
, ...)
2512 va_start (ap
, format
);
2513 length
= vsprintf (buf
, format
, ap
);
2515 return make_string (buf
, length
);
2519 /***********************************************************************
2521 ***********************************************************************/
2523 /* We store float cells inside of float_blocks, allocating a new
2524 float_block with malloc whenever necessary. Float cells reclaimed
2525 by GC are put on a free list to be reallocated before allocating
2526 any new float cells from the latest float_block. */
2528 #define FLOAT_BLOCK_SIZE \
2529 (((BLOCK_BYTES - sizeof (struct float_block *) \
2530 /* The compiler might add padding at the end. */ \
2531 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2532 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2534 #define GETMARKBIT(block,n) \
2535 (((block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2536 >> ((n) % (sizeof (int) * CHAR_BIT))) \
2539 #define SETMARKBIT(block,n) \
2540 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2541 |= 1 << ((n) % (sizeof (int) * CHAR_BIT))
2543 #define UNSETMARKBIT(block,n) \
2544 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2545 &= ~(1 << ((n) % (sizeof (int) * CHAR_BIT)))
2547 #define FLOAT_BLOCK(fptr) \
2548 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2550 #define FLOAT_INDEX(fptr) \
2551 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2555 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2556 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2557 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2558 struct float_block
*next
;
2561 #define FLOAT_MARKED_P(fptr) \
2562 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2564 #define FLOAT_MARK(fptr) \
2565 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2567 #define FLOAT_UNMARK(fptr) \
2568 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2570 /* Current float_block. */
2572 static struct float_block
*float_block
;
2574 /* Index of first unused Lisp_Float in the current float_block. */
2576 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2578 /* Free-list of Lisp_Floats. */
2580 static struct Lisp_Float
*float_free_list
;
2582 /* Return a new float object with value FLOAT_VALUE. */
2585 make_float (double float_value
)
2587 register Lisp_Object val
;
2589 /* eassert (!handling_signal); */
2593 if (float_free_list
)
2595 /* We use the data field for chaining the free list
2596 so that we won't use the same field that has the mark bit. */
2597 XSETFLOAT (val
, float_free_list
);
2598 float_free_list
= float_free_list
->u
.chain
;
2602 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2604 struct float_block
*new
2605 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2606 new->next
= float_block
;
2607 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2609 float_block_index
= 0;
2610 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2612 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2613 float_block_index
++;
2616 MALLOC_UNBLOCK_INPUT
;
2618 XFLOAT_INIT (val
, float_value
);
2619 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2620 consing_since_gc
+= sizeof (struct Lisp_Float
);
2622 total_free_floats
--;
2628 /***********************************************************************
2630 ***********************************************************************/
2632 /* We store cons cells inside of cons_blocks, allocating a new
2633 cons_block with malloc whenever necessary. Cons cells reclaimed by
2634 GC are put on a free list to be reallocated before allocating
2635 any new cons cells from the latest cons_block. */
2637 #define CONS_BLOCK_SIZE \
2638 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2639 /* The compiler might add padding at the end. */ \
2640 - (sizeof (struct Lisp_Cons) - sizeof (int))) * CHAR_BIT) \
2641 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2643 #define CONS_BLOCK(fptr) \
2644 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2646 #define CONS_INDEX(fptr) \
2647 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2651 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2652 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2653 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2654 struct cons_block
*next
;
2657 #define CONS_MARKED_P(fptr) \
2658 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2660 #define CONS_MARK(fptr) \
2661 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2663 #define CONS_UNMARK(fptr) \
2664 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2666 /* Current cons_block. */
2668 static struct cons_block
*cons_block
;
2670 /* Index of first unused Lisp_Cons in the current block. */
2672 static int cons_block_index
= CONS_BLOCK_SIZE
;
2674 /* Free-list of Lisp_Cons structures. */
2676 static struct Lisp_Cons
*cons_free_list
;
2678 /* Explicitly free a cons cell by putting it on the free-list. */
2681 free_cons (struct Lisp_Cons
*ptr
)
2683 ptr
->u
.chain
= cons_free_list
;
2687 cons_free_list
= ptr
;
2688 consing_since_gc
-= sizeof *ptr
;
2689 total_free_conses
++;
2692 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2693 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2694 (Lisp_Object car
, Lisp_Object cdr
)
2696 register Lisp_Object val
;
2698 /* eassert (!handling_signal); */
2704 /* We use the cdr for chaining the free list
2705 so that we won't use the same field that has the mark bit. */
2706 XSETCONS (val
, cons_free_list
);
2707 cons_free_list
= cons_free_list
->u
.chain
;
2711 if (cons_block_index
== CONS_BLOCK_SIZE
)
2713 struct cons_block
*new
2714 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2715 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2716 new->next
= cons_block
;
2718 cons_block_index
= 0;
2719 total_free_conses
+= CONS_BLOCK_SIZE
;
2721 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2725 MALLOC_UNBLOCK_INPUT
;
2729 eassert (!CONS_MARKED_P (XCONS (val
)));
2730 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2731 total_free_conses
--;
2732 cons_cells_consed
++;
2736 #ifdef GC_CHECK_CONS_LIST
2737 /* Get an error now if there's any junk in the cons free list. */
2739 check_cons_list (void)
2741 struct Lisp_Cons
*tail
= cons_free_list
;
2744 tail
= tail
->u
.chain
;
2748 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2751 list1 (Lisp_Object arg1
)
2753 return Fcons (arg1
, Qnil
);
2757 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2759 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2764 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2766 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2771 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2773 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2778 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2780 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2781 Fcons (arg5
, Qnil
)))));
2784 /* Make a list of COUNT Lisp_Objects, where ARG is the
2785 first one. Allocate conses from pure space if TYPE
2786 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2789 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2793 Lisp_Object val
, *objp
;
2795 /* Change to SAFE_ALLOCA if you hit this eassert. */
2796 eassert (count
<= MAX_ALLOCA
/ word_size
);
2798 objp
= alloca (count
* word_size
);
2801 for (i
= 1; i
< count
; i
++)
2802 objp
[i
] = va_arg (ap
, Lisp_Object
);
2805 for (val
= Qnil
, i
= count
- 1; i
>= 0; i
--)
2807 if (type
== CONSTYPE_PURE
)
2808 val
= pure_cons (objp
[i
], val
);
2809 else if (type
== CONSTYPE_HEAP
)
2810 val
= Fcons (objp
[i
], val
);
2817 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2818 doc
: /* Return a newly created list with specified arguments as elements.
2819 Any number of arguments, even zero arguments, are allowed.
2820 usage: (list &rest OBJECTS) */)
2821 (ptrdiff_t nargs
, Lisp_Object
*args
)
2823 register Lisp_Object val
;
2829 val
= Fcons (args
[nargs
], val
);
2835 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2836 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2837 (register Lisp_Object length
, Lisp_Object init
)
2839 register Lisp_Object val
;
2840 register EMACS_INT size
;
2842 CHECK_NATNUM (length
);
2843 size
= XFASTINT (length
);
2848 val
= Fcons (init
, val
);
2853 val
= Fcons (init
, val
);
2858 val
= Fcons (init
, val
);
2863 val
= Fcons (init
, val
);
2868 val
= Fcons (init
, val
);
2883 /***********************************************************************
2885 ***********************************************************************/
2887 /* This value is balanced well enough to avoid too much internal overhead
2888 for the most common cases; it's not required to be a power of two, but
2889 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2891 #define VECTOR_BLOCK_SIZE 4096
2893 /* Align allocation request sizes to be a multiple of ROUNDUP_SIZE. */
2896 roundup_size
= COMMON_MULTIPLE (word_size
, USE_LSB_TAG
? GCALIGNMENT
: 1)
2899 /* ROUNDUP_SIZE must be a power of 2. */
2900 verify ((roundup_size
& (roundup_size
- 1)) == 0);
2902 /* Verify assumptions described above. */
2903 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2904 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2906 /* Round up X to nearest mult-of-ROUNDUP_SIZE. */
2908 #define vroundup(x) (((x) + (roundup_size - 1)) & ~(roundup_size - 1))
2910 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2912 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup (sizeof (void *)))
2914 /* Size of the minimal vector allocated from block. */
2916 #define VBLOCK_BYTES_MIN vroundup (sizeof (struct Lisp_Vector))
2918 /* Size of the largest vector allocated from block. */
2920 #define VBLOCK_BYTES_MAX \
2921 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2923 /* We maintain one free list for each possible block-allocated
2924 vector size, and this is the number of free lists we have. */
2926 #define VECTOR_MAX_FREE_LIST_INDEX \
2927 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2929 /* Common shortcut to advance vector pointer over a block data. */
2931 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2933 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2935 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2937 /* Common shortcut to setup vector on a free list. */
2939 #define SETUP_ON_FREE_LIST(v, nbytes, index) \
2941 XSETPVECTYPESIZE (v, PVEC_FREE, nbytes); \
2942 eassert ((nbytes) % roundup_size == 0); \
2943 (index) = VINDEX (nbytes); \
2944 eassert ((index) < VECTOR_MAX_FREE_LIST_INDEX); \
2945 (v)->header.next.vector = vector_free_lists[index]; \
2946 vector_free_lists[index] = (v); \
2947 total_free_vector_slots += (nbytes) / word_size; \
2952 char data
[VECTOR_BLOCK_BYTES
];
2953 struct vector_block
*next
;
2956 /* Chain of vector blocks. */
2958 static struct vector_block
*vector_blocks
;
2960 /* Vector free lists, where NTH item points to a chain of free
2961 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2963 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2965 /* Singly-linked list of large vectors. */
2967 static struct Lisp_Vector
*large_vectors
;
2969 /* The only vector with 0 slots, allocated from pure space. */
2971 Lisp_Object zero_vector
;
2973 /* Number of live vectors. */
2975 static EMACS_INT total_vectors
;
2977 /* Total size of live and free vectors, in Lisp_Object units. */
2979 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
2981 /* Get a new vector block. */
2983 static struct vector_block
*
2984 allocate_vector_block (void)
2986 struct vector_block
*block
= xmalloc (sizeof *block
);
2988 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
2989 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
2990 MEM_TYPE_VECTOR_BLOCK
);
2993 block
->next
= vector_blocks
;
2994 vector_blocks
= block
;
2998 /* Called once to initialize vector allocation. */
3003 zero_vector
= make_pure_vector (0);
3006 /* Allocate vector from a vector block. */
3008 static struct Lisp_Vector
*
3009 allocate_vector_from_block (size_t nbytes
)
3011 struct Lisp_Vector
*vector
, *rest
;
3012 struct vector_block
*block
;
3013 size_t index
, restbytes
;
3015 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
3016 eassert (nbytes
% roundup_size
== 0);
3018 /* First, try to allocate from a free list
3019 containing vectors of the requested size. */
3020 index
= VINDEX (nbytes
);
3021 if (vector_free_lists
[index
])
3023 vector
= vector_free_lists
[index
];
3024 vector_free_lists
[index
] = vector
->header
.next
.vector
;
3025 vector
->header
.next
.nbytes
= nbytes
;
3026 total_free_vector_slots
-= nbytes
/ word_size
;
3030 /* Next, check free lists containing larger vectors. Since
3031 we will split the result, we should have remaining space
3032 large enough to use for one-slot vector at least. */
3033 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
3034 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
3035 if (vector_free_lists
[index
])
3037 /* This vector is larger than requested. */
3038 vector
= vector_free_lists
[index
];
3039 vector_free_lists
[index
] = vector
->header
.next
.vector
;
3040 vector
->header
.next
.nbytes
= nbytes
;
3041 total_free_vector_slots
-= nbytes
/ word_size
;
3043 /* Excess bytes are used for the smaller vector,
3044 which should be set on an appropriate free list. */
3045 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
3046 eassert (restbytes
% roundup_size
== 0);
3047 rest
= ADVANCE (vector
, nbytes
);
3048 SETUP_ON_FREE_LIST (rest
, restbytes
, index
);
3052 /* Finally, need a new vector block. */
3053 block
= allocate_vector_block ();
3055 /* New vector will be at the beginning of this block. */
3056 vector
= (struct Lisp_Vector
*) block
->data
;
3057 vector
->header
.next
.nbytes
= nbytes
;
3059 /* If the rest of space from this block is large enough
3060 for one-slot vector at least, set up it on a free list. */
3061 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
3062 if (restbytes
>= VBLOCK_BYTES_MIN
)
3064 eassert (restbytes
% roundup_size
== 0);
3065 rest
= ADVANCE (vector
, nbytes
);
3066 SETUP_ON_FREE_LIST (rest
, restbytes
, index
);
3071 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
3073 #define VECTOR_IN_BLOCK(vector, block) \
3074 ((char *) (vector) <= (block)->data \
3075 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
3077 /* Number of bytes used by vector-block-allocated object. This is the only
3078 place where we actually use the `nbytes' field of the vector-header.
3079 I.e. we could get rid of the `nbytes' field by computing it based on the
3082 #define PSEUDOVECTOR_NBYTES(vector) \
3083 (PSEUDOVECTOR_TYPEP (&vector->header, PVEC_FREE) \
3084 ? vector->header.size & PSEUDOVECTOR_SIZE_MASK \
3085 : vector->header.next.nbytes)
3087 /* Reclaim space used by unmarked vectors. */
3090 sweep_vectors (void)
3092 struct vector_block
*block
= vector_blocks
, **bprev
= &vector_blocks
;
3093 struct Lisp_Vector
*vector
, *next
, **vprev
= &large_vectors
;
3095 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
3096 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
3098 /* Looking through vector blocks. */
3100 for (block
= vector_blocks
; block
; block
= *bprev
)
3102 bool free_this_block
= 0;
3104 for (vector
= (struct Lisp_Vector
*) block
->data
;
3105 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
3107 if (VECTOR_MARKED_P (vector
))
3109 VECTOR_UNMARK (vector
);
3111 total_vector_slots
+= vector
->header
.next
.nbytes
/ word_size
;
3112 next
= ADVANCE (vector
, vector
->header
.next
.nbytes
);
3116 ptrdiff_t nbytes
= PSEUDOVECTOR_NBYTES (vector
);
3117 ptrdiff_t total_bytes
= nbytes
;
3119 next
= ADVANCE (vector
, nbytes
);
3121 /* While NEXT is not marked, try to coalesce with VECTOR,
3122 thus making VECTOR of the largest possible size. */
3124 while (VECTOR_IN_BLOCK (next
, block
))
3126 if (VECTOR_MARKED_P (next
))
3128 nbytes
= PSEUDOVECTOR_NBYTES (next
);
3129 total_bytes
+= nbytes
;
3130 next
= ADVANCE (next
, nbytes
);
3133 eassert (total_bytes
% roundup_size
== 0);
3135 if (vector
== (struct Lisp_Vector
*) block
->data
3136 && !VECTOR_IN_BLOCK (next
, block
))
3137 /* This block should be freed because all of it's
3138 space was coalesced into the only free vector. */
3139 free_this_block
= 1;
3143 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
3148 if (free_this_block
)
3150 *bprev
= block
->next
;
3151 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
3152 mem_delete (mem_find (block
->data
));
3157 bprev
= &block
->next
;
3160 /* Sweep large vectors. */
3162 for (vector
= large_vectors
; vector
; vector
= *vprev
)
3164 if (VECTOR_MARKED_P (vector
))
3166 VECTOR_UNMARK (vector
);
3168 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
3170 struct Lisp_Bool_Vector
*b
= (struct Lisp_Bool_Vector
*) vector
;
3172 /* All non-bool pseudovectors are small enough to be allocated
3173 from vector blocks. This code should be redesigned if some
3174 pseudovector type grows beyond VBLOCK_BYTES_MAX. */
3175 eassert (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_BOOL_VECTOR
));
3178 += (bool_header_size
3179 + ((b
->size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1)
3180 / BOOL_VECTOR_BITS_PER_CHAR
)) / word_size
;
3184 += header_size
/ word_size
+ vector
->header
.size
;
3185 vprev
= &vector
->header
.next
.vector
;
3189 *vprev
= vector
->header
.next
.vector
;
3195 /* Value is a pointer to a newly allocated Lisp_Vector structure
3196 with room for LEN Lisp_Objects. */
3198 static struct Lisp_Vector
*
3199 allocate_vectorlike (ptrdiff_t len
)
3201 struct Lisp_Vector
*p
;
3205 /* This gets triggered by code which I haven't bothered to fix. --Stef */
3206 /* eassert (!handling_signal); */
3209 p
= XVECTOR (zero_vector
);
3212 size_t nbytes
= header_size
+ len
* word_size
;
3214 #ifdef DOUG_LEA_MALLOC
3215 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
3216 because mapped region contents are not preserved in
3218 mallopt (M_MMAP_MAX
, 0);
3221 if (nbytes
<= VBLOCK_BYTES_MAX
)
3222 p
= allocate_vector_from_block (vroundup (nbytes
));
3225 p
= lisp_malloc (nbytes
, MEM_TYPE_VECTORLIKE
);
3226 p
->header
.next
.vector
= large_vectors
;
3230 #ifdef DOUG_LEA_MALLOC
3231 /* Back to a reasonable maximum of mmap'ed areas. */
3232 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3235 consing_since_gc
+= nbytes
;
3236 vector_cells_consed
+= len
;
3239 MALLOC_UNBLOCK_INPUT
;
3245 /* Allocate a vector with LEN slots. */
3247 struct Lisp_Vector
*
3248 allocate_vector (EMACS_INT len
)
3250 struct Lisp_Vector
*v
;
3251 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3253 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3254 memory_full (SIZE_MAX
);
3255 v
= allocate_vectorlike (len
);
3256 v
->header
.size
= len
;
3261 /* Allocate other vector-like structures. */
3263 struct Lisp_Vector
*
3264 allocate_pseudovector (int memlen
, int lisplen
, int tag
)
3266 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3269 /* Only the first lisplen slots will be traced normally by the GC. */
3270 for (i
= 0; i
< lisplen
; ++i
)
3271 v
->contents
[i
] = Qnil
;
3273 XSETPVECTYPESIZE (v
, tag
, lisplen
);
3278 allocate_buffer (void)
3280 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3282 XSETPVECTYPESIZE (b
, PVEC_BUFFER
, (offsetof (struct buffer
, own_text
)
3283 - header_size
) / word_size
);
3284 /* Note that the fields of B are not initialized. */
3288 struct Lisp_Hash_Table
*
3289 allocate_hash_table (void)
3291 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
3295 allocate_window (void)
3299 w
= ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
3300 /* Users assumes that non-Lisp data is zeroed. */
3301 memset (&w
->current_matrix
, 0,
3302 sizeof (*w
) - offsetof (struct window
, current_matrix
));
3307 allocate_terminal (void)
3311 t
= ALLOCATE_PSEUDOVECTOR (struct terminal
, next_terminal
, PVEC_TERMINAL
);
3312 /* Users assumes that non-Lisp data is zeroed. */
3313 memset (&t
->next_terminal
, 0,
3314 sizeof (*t
) - offsetof (struct terminal
, next_terminal
));
3319 allocate_frame (void)
3323 f
= ALLOCATE_PSEUDOVECTOR (struct frame
, face_cache
, PVEC_FRAME
);
3324 /* Users assumes that non-Lisp data is zeroed. */
3325 memset (&f
->face_cache
, 0,
3326 sizeof (*f
) - offsetof (struct frame
, face_cache
));
3330 struct Lisp_Process
*
3331 allocate_process (void)
3333 struct Lisp_Process
*p
;
3335 p
= ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3336 /* Users assumes that non-Lisp data is zeroed. */
3338 sizeof (*p
) - offsetof (struct Lisp_Process
, pid
));
3342 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3343 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3344 See also the function `vector'. */)
3345 (register Lisp_Object length
, Lisp_Object init
)
3348 register ptrdiff_t sizei
;
3349 register ptrdiff_t i
;
3350 register struct Lisp_Vector
*p
;
3352 CHECK_NATNUM (length
);
3354 p
= allocate_vector (XFASTINT (length
));
3355 sizei
= XFASTINT (length
);
3356 for (i
= 0; i
< sizei
; i
++)
3357 p
->contents
[i
] = init
;
3359 XSETVECTOR (vector
, p
);
3364 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3365 doc
: /* Return a newly created vector with specified arguments as elements.
3366 Any number of arguments, even zero arguments, are allowed.
3367 usage: (vector &rest OBJECTS) */)
3368 (ptrdiff_t nargs
, Lisp_Object
*args
)
3370 register Lisp_Object len
, val
;
3372 register struct Lisp_Vector
*p
;
3374 XSETFASTINT (len
, nargs
);
3375 val
= Fmake_vector (len
, Qnil
);
3377 for (i
= 0; i
< nargs
; i
++)
3378 p
->contents
[i
] = args
[i
];
3383 make_byte_code (struct Lisp_Vector
*v
)
3385 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3386 && STRING_MULTIBYTE (v
->contents
[1]))
3387 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3388 earlier because they produced a raw 8-bit string for byte-code
3389 and now such a byte-code string is loaded as multibyte while
3390 raw 8-bit characters converted to multibyte form. Thus, now we
3391 must convert them back to the original unibyte form. */
3392 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3393 XSETPVECTYPE (v
, PVEC_COMPILED
);
3396 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3397 doc
: /* Create a byte-code object with specified arguments as elements.
3398 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3399 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3400 and (optional) INTERACTIVE-SPEC.
3401 The first four arguments are required; at most six have any
3403 The ARGLIST can be either like the one of `lambda', in which case the arguments
3404 will be dynamically bound before executing the byte code, or it can be an
3405 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3406 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3407 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3408 argument to catch the left-over arguments. If such an integer is used, the
3409 arguments will not be dynamically bound but will be instead pushed on the
3410 stack before executing the byte-code.
3411 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3412 (ptrdiff_t nargs
, Lisp_Object
*args
)
3414 register Lisp_Object len
, val
;
3416 register struct Lisp_Vector
*p
;
3418 /* We used to purecopy everything here, if purify-flga was set. This worked
3419 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3420 dangerous, since make-byte-code is used during execution to build
3421 closures, so any closure built during the preload phase would end up
3422 copied into pure space, including its free variables, which is sometimes
3423 just wasteful and other times plainly wrong (e.g. those free vars may want
3426 XSETFASTINT (len
, nargs
);
3427 val
= Fmake_vector (len
, Qnil
);
3430 for (i
= 0; i
< nargs
; i
++)
3431 p
->contents
[i
] = args
[i
];
3433 XSETCOMPILED (val
, p
);
3439 /***********************************************************************
3441 ***********************************************************************/
3443 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3444 of the required alignment if LSB tags are used. */
3446 union aligned_Lisp_Symbol
3448 struct Lisp_Symbol s
;
3450 unsigned char c
[(sizeof (struct Lisp_Symbol
) + GCALIGNMENT
- 1)
3455 /* Each symbol_block is just under 1020 bytes long, since malloc
3456 really allocates in units of powers of two and uses 4 bytes for its
3459 #define SYMBOL_BLOCK_SIZE \
3460 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3464 /* Place `symbols' first, to preserve alignment. */
3465 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3466 struct symbol_block
*next
;
3469 /* Current symbol block and index of first unused Lisp_Symbol
3472 static struct symbol_block
*symbol_block
;
3473 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3475 /* List of free symbols. */
3477 static struct Lisp_Symbol
*symbol_free_list
;
3479 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3480 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3481 Its value and function definition are void, and its property list is nil. */)
3484 register Lisp_Object val
;
3485 register struct Lisp_Symbol
*p
;
3487 CHECK_STRING (name
);
3489 /* eassert (!handling_signal); */
3493 if (symbol_free_list
)
3495 XSETSYMBOL (val
, symbol_free_list
);
3496 symbol_free_list
= symbol_free_list
->next
;
3500 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3502 struct symbol_block
*new
3503 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3504 new->next
= symbol_block
;
3506 symbol_block_index
= 0;
3507 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3509 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3510 symbol_block_index
++;
3513 MALLOC_UNBLOCK_INPUT
;
3516 set_symbol_name (val
, name
);
3517 set_symbol_plist (val
, Qnil
);
3518 p
->redirect
= SYMBOL_PLAINVAL
;
3519 SET_SYMBOL_VAL (p
, Qunbound
);
3520 set_symbol_function (val
, Qunbound
);
3521 set_symbol_next (val
, NULL
);
3523 p
->interned
= SYMBOL_UNINTERNED
;
3525 p
->declared_special
= 0;
3526 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3528 total_free_symbols
--;
3534 /***********************************************************************
3535 Marker (Misc) Allocation
3536 ***********************************************************************/
3538 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3539 the required alignment when LSB tags are used. */
3541 union aligned_Lisp_Misc
3545 unsigned char c
[(sizeof (union Lisp_Misc
) + GCALIGNMENT
- 1)
3550 /* Allocation of markers and other objects that share that structure.
3551 Works like allocation of conses. */
3553 #define MARKER_BLOCK_SIZE \
3554 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3558 /* Place `markers' first, to preserve alignment. */
3559 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3560 struct marker_block
*next
;
3563 static struct marker_block
*marker_block
;
3564 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3566 static union Lisp_Misc
*marker_free_list
;
3568 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3571 allocate_misc (enum Lisp_Misc_Type type
)
3575 /* eassert (!handling_signal); */
3579 if (marker_free_list
)
3581 XSETMISC (val
, marker_free_list
);
3582 marker_free_list
= marker_free_list
->u_free
.chain
;
3586 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3588 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3589 new->next
= marker_block
;
3591 marker_block_index
= 0;
3592 total_free_markers
+= MARKER_BLOCK_SIZE
;
3594 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3595 marker_block_index
++;
3598 MALLOC_UNBLOCK_INPUT
;
3600 --total_free_markers
;
3601 consing_since_gc
+= sizeof (union Lisp_Misc
);
3602 misc_objects_consed
++;
3603 XMISCTYPE (val
) = type
;
3604 XMISCANY (val
)->gcmarkbit
= 0;
3608 /* Free a Lisp_Misc object */
3611 free_misc (Lisp_Object misc
)
3613 XMISCTYPE (misc
) = Lisp_Misc_Free
;
3614 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3615 marker_free_list
= XMISC (misc
);
3616 consing_since_gc
-= sizeof (union Lisp_Misc
);
3617 total_free_markers
++;
3620 /* Return a Lisp_Misc_Save_Value object containing POINTER and
3621 INTEGER. This is used to package C values to call record_unwind_protect.
3622 The unwind function can get the C values back using XSAVE_VALUE. */
3625 make_save_value (void *pointer
, ptrdiff_t integer
)
3627 register Lisp_Object val
;
3628 register struct Lisp_Save_Value
*p
;
3630 val
= allocate_misc (Lisp_Misc_Save_Value
);
3631 p
= XSAVE_VALUE (val
);
3632 p
->pointer
= pointer
;
3633 p
->integer
= integer
;
3638 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3641 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3643 register Lisp_Object overlay
;
3645 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3646 OVERLAY_START (overlay
) = start
;
3647 OVERLAY_END (overlay
) = end
;
3648 set_overlay_plist (overlay
, plist
);
3649 XOVERLAY (overlay
)->next
= NULL
;
3653 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3654 doc
: /* Return a newly allocated marker which does not point at any place. */)
3657 register Lisp_Object val
;
3658 register struct Lisp_Marker
*p
;
3660 val
= allocate_misc (Lisp_Misc_Marker
);
3666 p
->insertion_type
= 0;
3670 /* Return a newly allocated marker which points into BUF
3671 at character position CHARPOS and byte position BYTEPOS. */
3674 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3677 struct Lisp_Marker
*m
;
3679 /* No dead buffers here. */
3680 eassert (!NILP (BVAR (buf
, name
)));
3682 /* Every character is at least one byte. */
3683 eassert (charpos
<= bytepos
);
3685 obj
= allocate_misc (Lisp_Misc_Marker
);
3688 m
->charpos
= charpos
;
3689 m
->bytepos
= bytepos
;
3690 m
->insertion_type
= 0;
3691 m
->next
= BUF_MARKERS (buf
);
3692 BUF_MARKERS (buf
) = m
;
3696 /* Put MARKER back on the free list after using it temporarily. */
3699 free_marker (Lisp_Object marker
)
3701 unchain_marker (XMARKER (marker
));
3706 /* Return a newly created vector or string with specified arguments as
3707 elements. If all the arguments are characters that can fit
3708 in a string of events, make a string; otherwise, make a vector.
3710 Any number of arguments, even zero arguments, are allowed. */
3713 make_event_array (register int nargs
, Lisp_Object
*args
)
3717 for (i
= 0; i
< nargs
; i
++)
3718 /* The things that fit in a string
3719 are characters that are in 0...127,
3720 after discarding the meta bit and all the bits above it. */
3721 if (!INTEGERP (args
[i
])
3722 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3723 return Fvector (nargs
, args
);
3725 /* Since the loop exited, we know that all the things in it are
3726 characters, so we can make a string. */
3730 result
= Fmake_string (make_number (nargs
), make_number (0));
3731 for (i
= 0; i
< nargs
; i
++)
3733 SSET (result
, i
, XINT (args
[i
]));
3734 /* Move the meta bit to the right place for a string char. */
3735 if (XINT (args
[i
]) & CHAR_META
)
3736 SSET (result
, i
, SREF (result
, i
) | 0x80);
3745 /************************************************************************
3746 Memory Full Handling
3747 ************************************************************************/
3750 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3751 there may have been size_t overflow so that malloc was never
3752 called, or perhaps malloc was invoked successfully but the
3753 resulting pointer had problems fitting into a tagged EMACS_INT. In
3754 either case this counts as memory being full even though malloc did
3758 memory_full (size_t nbytes
)
3760 /* Do not go into hysterics merely because a large request failed. */
3761 bool enough_free_memory
= 0;
3762 if (SPARE_MEMORY
< nbytes
)
3767 p
= malloc (SPARE_MEMORY
);
3771 enough_free_memory
= 1;
3773 MALLOC_UNBLOCK_INPUT
;
3776 if (! enough_free_memory
)
3782 memory_full_cons_threshold
= sizeof (struct cons_block
);
3784 /* The first time we get here, free the spare memory. */
3785 for (i
= 0; i
< sizeof (spare_memory
) / sizeof (char *); i
++)
3786 if (spare_memory
[i
])
3789 free (spare_memory
[i
]);
3790 else if (i
>= 1 && i
<= 4)
3791 lisp_align_free (spare_memory
[i
]);
3793 lisp_free (spare_memory
[i
]);
3794 spare_memory
[i
] = 0;
3797 /* Record the space now used. When it decreases substantially,
3798 we can refill the memory reserve. */
3799 #if !defined SYSTEM_MALLOC && !defined SYNC_INPUT
3800 bytes_used_when_full
= BYTES_USED
;
3804 /* This used to call error, but if we've run out of memory, we could
3805 get infinite recursion trying to build the string. */
3806 xsignal (Qnil
, Vmemory_signal_data
);
3809 /* If we released our reserve (due to running out of memory),
3810 and we have a fair amount free once again,
3811 try to set aside another reserve in case we run out once more.
3813 This is called when a relocatable block is freed in ralloc.c,
3814 and also directly from this file, in case we're not using ralloc.c. */
3817 refill_memory_reserve (void)
3819 #ifndef SYSTEM_MALLOC
3820 if (spare_memory
[0] == 0)
3821 spare_memory
[0] = malloc (SPARE_MEMORY
);
3822 if (spare_memory
[1] == 0)
3823 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
3825 if (spare_memory
[2] == 0)
3826 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
3828 if (spare_memory
[3] == 0)
3829 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
3831 if (spare_memory
[4] == 0)
3832 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
3834 if (spare_memory
[5] == 0)
3835 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
3837 if (spare_memory
[6] == 0)
3838 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
3840 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3841 Vmemory_full
= Qnil
;
3845 /************************************************************************
3847 ************************************************************************/
3849 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3851 /* Conservative C stack marking requires a method to identify possibly
3852 live Lisp objects given a pointer value. We do this by keeping
3853 track of blocks of Lisp data that are allocated in a red-black tree
3854 (see also the comment of mem_node which is the type of nodes in
3855 that tree). Function lisp_malloc adds information for an allocated
3856 block to the red-black tree with calls to mem_insert, and function
3857 lisp_free removes it with mem_delete. Functions live_string_p etc
3858 call mem_find to lookup information about a given pointer in the
3859 tree, and use that to determine if the pointer points to a Lisp
3862 /* Initialize this part of alloc.c. */
3867 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3868 mem_z
.parent
= NULL
;
3869 mem_z
.color
= MEM_BLACK
;
3870 mem_z
.start
= mem_z
.end
= NULL
;
3875 /* Value is a pointer to the mem_node containing START. Value is
3876 MEM_NIL if there is no node in the tree containing START. */
3878 static inline struct mem_node
*
3879 mem_find (void *start
)
3883 if (start
< min_heap_address
|| start
> max_heap_address
)
3886 /* Make the search always successful to speed up the loop below. */
3887 mem_z
.start
= start
;
3888 mem_z
.end
= (char *) start
+ 1;
3891 while (start
< p
->start
|| start
>= p
->end
)
3892 p
= start
< p
->start
? p
->left
: p
->right
;
3897 /* Insert a new node into the tree for a block of memory with start
3898 address START, end address END, and type TYPE. Value is a
3899 pointer to the node that was inserted. */
3901 static struct mem_node
*
3902 mem_insert (void *start
, void *end
, enum mem_type type
)
3904 struct mem_node
*c
, *parent
, *x
;
3906 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3907 min_heap_address
= start
;
3908 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3909 max_heap_address
= end
;
3911 /* See where in the tree a node for START belongs. In this
3912 particular application, it shouldn't happen that a node is already
3913 present. For debugging purposes, let's check that. */
3917 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3919 while (c
!= MEM_NIL
)
3921 if (start
>= c
->start
&& start
< c
->end
)
3924 c
= start
< c
->start
? c
->left
: c
->right
;
3927 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3929 while (c
!= MEM_NIL
)
3932 c
= start
< c
->start
? c
->left
: c
->right
;
3935 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3937 /* Create a new node. */
3938 #ifdef GC_MALLOC_CHECK
3939 x
= _malloc_internal (sizeof *x
);
3943 x
= xmalloc (sizeof *x
);
3949 x
->left
= x
->right
= MEM_NIL
;
3952 /* Insert it as child of PARENT or install it as root. */
3955 if (start
< parent
->start
)
3963 /* Re-establish red-black tree properties. */
3964 mem_insert_fixup (x
);
3970 /* Re-establish the red-black properties of the tree, and thereby
3971 balance the tree, after node X has been inserted; X is always red. */
3974 mem_insert_fixup (struct mem_node
*x
)
3976 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3978 /* X is red and its parent is red. This is a violation of
3979 red-black tree property #3. */
3981 if (x
->parent
== x
->parent
->parent
->left
)
3983 /* We're on the left side of our grandparent, and Y is our
3985 struct mem_node
*y
= x
->parent
->parent
->right
;
3987 if (y
->color
== MEM_RED
)
3989 /* Uncle and parent are red but should be black because
3990 X is red. Change the colors accordingly and proceed
3991 with the grandparent. */
3992 x
->parent
->color
= MEM_BLACK
;
3993 y
->color
= MEM_BLACK
;
3994 x
->parent
->parent
->color
= MEM_RED
;
3995 x
= x
->parent
->parent
;
3999 /* Parent and uncle have different colors; parent is
4000 red, uncle is black. */
4001 if (x
== x
->parent
->right
)
4004 mem_rotate_left (x
);
4007 x
->parent
->color
= MEM_BLACK
;
4008 x
->parent
->parent
->color
= MEM_RED
;
4009 mem_rotate_right (x
->parent
->parent
);
4014 /* This is the symmetrical case of above. */
4015 struct mem_node
*y
= x
->parent
->parent
->left
;
4017 if (y
->color
== MEM_RED
)
4019 x
->parent
->color
= MEM_BLACK
;
4020 y
->color
= MEM_BLACK
;
4021 x
->parent
->parent
->color
= MEM_RED
;
4022 x
= x
->parent
->parent
;
4026 if (x
== x
->parent
->left
)
4029 mem_rotate_right (x
);
4032 x
->parent
->color
= MEM_BLACK
;
4033 x
->parent
->parent
->color
= MEM_RED
;
4034 mem_rotate_left (x
->parent
->parent
);
4039 /* The root may have been changed to red due to the algorithm. Set
4040 it to black so that property #5 is satisfied. */
4041 mem_root
->color
= MEM_BLACK
;
4052 mem_rotate_left (struct mem_node
*x
)
4056 /* Turn y's left sub-tree into x's right sub-tree. */
4059 if (y
->left
!= MEM_NIL
)
4060 y
->left
->parent
= x
;
4062 /* Y's parent was x's parent. */
4064 y
->parent
= x
->parent
;
4066 /* Get the parent to point to y instead of x. */
4069 if (x
== x
->parent
->left
)
4070 x
->parent
->left
= y
;
4072 x
->parent
->right
= y
;
4077 /* Put x on y's left. */
4091 mem_rotate_right (struct mem_node
*x
)
4093 struct mem_node
*y
= x
->left
;
4096 if (y
->right
!= MEM_NIL
)
4097 y
->right
->parent
= x
;
4100 y
->parent
= x
->parent
;
4103 if (x
== x
->parent
->right
)
4104 x
->parent
->right
= y
;
4106 x
->parent
->left
= y
;
4117 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4120 mem_delete (struct mem_node
*z
)
4122 struct mem_node
*x
, *y
;
4124 if (!z
|| z
== MEM_NIL
)
4127 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4132 while (y
->left
!= MEM_NIL
)
4136 if (y
->left
!= MEM_NIL
)
4141 x
->parent
= y
->parent
;
4144 if (y
== y
->parent
->left
)
4145 y
->parent
->left
= x
;
4147 y
->parent
->right
= x
;
4154 z
->start
= y
->start
;
4159 if (y
->color
== MEM_BLACK
)
4160 mem_delete_fixup (x
);
4162 #ifdef GC_MALLOC_CHECK
4170 /* Re-establish the red-black properties of the tree, after a
4174 mem_delete_fixup (struct mem_node
*x
)
4176 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4178 if (x
== x
->parent
->left
)
4180 struct mem_node
*w
= x
->parent
->right
;
4182 if (w
->color
== MEM_RED
)
4184 w
->color
= MEM_BLACK
;
4185 x
->parent
->color
= MEM_RED
;
4186 mem_rotate_left (x
->parent
);
4187 w
= x
->parent
->right
;
4190 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4197 if (w
->right
->color
== MEM_BLACK
)
4199 w
->left
->color
= MEM_BLACK
;
4201 mem_rotate_right (w
);
4202 w
= x
->parent
->right
;
4204 w
->color
= x
->parent
->color
;
4205 x
->parent
->color
= MEM_BLACK
;
4206 w
->right
->color
= MEM_BLACK
;
4207 mem_rotate_left (x
->parent
);
4213 struct mem_node
*w
= x
->parent
->left
;
4215 if (w
->color
== MEM_RED
)
4217 w
->color
= MEM_BLACK
;
4218 x
->parent
->color
= MEM_RED
;
4219 mem_rotate_right (x
->parent
);
4220 w
= x
->parent
->left
;
4223 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4230 if (w
->left
->color
== MEM_BLACK
)
4232 w
->right
->color
= MEM_BLACK
;
4234 mem_rotate_left (w
);
4235 w
= x
->parent
->left
;
4238 w
->color
= x
->parent
->color
;
4239 x
->parent
->color
= MEM_BLACK
;
4240 w
->left
->color
= MEM_BLACK
;
4241 mem_rotate_right (x
->parent
);
4247 x
->color
= MEM_BLACK
;
4251 /* Value is non-zero if P is a pointer to a live Lisp string on
4252 the heap. M is a pointer to the mem_block for P. */
4255 live_string_p (struct mem_node
*m
, void *p
)
4257 if (m
->type
== MEM_TYPE_STRING
)
4259 struct string_block
*b
= (struct string_block
*) m
->start
;
4260 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4262 /* P must point to the start of a Lisp_String structure, and it
4263 must not be on the free-list. */
4265 && offset
% sizeof b
->strings
[0] == 0
4266 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4267 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4274 /* Value is non-zero if P is a pointer to a live Lisp cons on
4275 the heap. M is a pointer to the mem_block for P. */
4278 live_cons_p (struct mem_node
*m
, void *p
)
4280 if (m
->type
== MEM_TYPE_CONS
)
4282 struct cons_block
*b
= (struct cons_block
*) m
->start
;
4283 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4285 /* P must point to the start of a Lisp_Cons, not be
4286 one of the unused cells in the current cons block,
4287 and not be on the free-list. */
4289 && offset
% sizeof b
->conses
[0] == 0
4290 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4292 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4293 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
4300 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4301 the heap. M is a pointer to the mem_block for P. */
4304 live_symbol_p (struct mem_node
*m
, void *p
)
4306 if (m
->type
== MEM_TYPE_SYMBOL
)
4308 struct symbol_block
*b
= (struct symbol_block
*) m
->start
;
4309 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4311 /* P must point to the start of a Lisp_Symbol, not be
4312 one of the unused cells in the current symbol block,
4313 and not be on the free-list. */
4315 && offset
% sizeof b
->symbols
[0] == 0
4316 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4317 && (b
!= symbol_block
4318 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4319 && !EQ (((struct Lisp_Symbol
*)p
)->function
, Vdead
));
4326 /* Value is non-zero if P is a pointer to a live Lisp float on
4327 the heap. M is a pointer to the mem_block for P. */
4330 live_float_p (struct mem_node
*m
, void *p
)
4332 if (m
->type
== MEM_TYPE_FLOAT
)
4334 struct float_block
*b
= (struct float_block
*) m
->start
;
4335 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4337 /* P must point to the start of a Lisp_Float and not be
4338 one of the unused cells in the current float block. */
4340 && offset
% sizeof b
->floats
[0] == 0
4341 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4342 && (b
!= float_block
4343 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4350 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4351 the heap. M is a pointer to the mem_block for P. */
4354 live_misc_p (struct mem_node
*m
, void *p
)
4356 if (m
->type
== MEM_TYPE_MISC
)
4358 struct marker_block
*b
= (struct marker_block
*) m
->start
;
4359 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4361 /* P must point to the start of a Lisp_Misc, not be
4362 one of the unused cells in the current misc block,
4363 and not be on the free-list. */
4365 && offset
% sizeof b
->markers
[0] == 0
4366 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4367 && (b
!= marker_block
4368 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4369 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4376 /* Value is non-zero if P is a pointer to a live vector-like object.
4377 M is a pointer to the mem_block for P. */
4380 live_vector_p (struct mem_node
*m
, void *p
)
4382 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4384 /* This memory node corresponds to a vector block. */
4385 struct vector_block
*block
= (struct vector_block
*) m
->start
;
4386 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4388 /* P is in the block's allocation range. Scan the block
4389 up to P and see whether P points to the start of some
4390 vector which is not on a free list. FIXME: check whether
4391 some allocation patterns (probably a lot of short vectors)
4392 may cause a substantial overhead of this loop. */
4393 while (VECTOR_IN_BLOCK (vector
, block
)
4394 && vector
<= (struct Lisp_Vector
*) p
)
4396 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
))
4397 vector
= ADVANCE (vector
, (vector
->header
.size
4398 & PSEUDOVECTOR_SIZE_MASK
));
4399 else if (vector
== p
)
4402 vector
= ADVANCE (vector
, vector
->header
.next
.nbytes
);
4405 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== m
->start
)
4406 /* This memory node corresponds to a large vector. */
4412 /* Value is non-zero if P is a pointer to a live buffer. M is a
4413 pointer to the mem_block for P. */
4416 live_buffer_p (struct mem_node
*m
, void *p
)
4418 /* P must point to the start of the block, and the buffer
4419 must not have been killed. */
4420 return (m
->type
== MEM_TYPE_BUFFER
4422 && !NILP (((struct buffer
*) p
)->INTERNAL_FIELD (name
)));
4425 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4429 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4431 /* Array of objects that are kept alive because the C stack contains
4432 a pattern that looks like a reference to them . */
4434 #define MAX_ZOMBIES 10
4435 static Lisp_Object zombies
[MAX_ZOMBIES
];
4437 /* Number of zombie objects. */
4439 static EMACS_INT nzombies
;
4441 /* Number of garbage collections. */
4443 static EMACS_INT ngcs
;
4445 /* Average percentage of zombies per collection. */
4447 static double avg_zombies
;
4449 /* Max. number of live and zombie objects. */
4451 static EMACS_INT max_live
, max_zombies
;
4453 /* Average number of live objects per GC. */
4455 static double avg_live
;
4457 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4458 doc
: /* Show information about live and zombie objects. */)
4461 Lisp_Object args
[8], zombie_list
= Qnil
;
4463 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); i
++)
4464 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4465 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4466 args
[1] = make_number (ngcs
);
4467 args
[2] = make_float (avg_live
);
4468 args
[3] = make_float (avg_zombies
);
4469 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4470 args
[5] = make_number (max_live
);
4471 args
[6] = make_number (max_zombies
);
4472 args
[7] = zombie_list
;
4473 return Fmessage (8, args
);
4476 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4479 /* Mark OBJ if we can prove it's a Lisp_Object. */
4482 mark_maybe_object (Lisp_Object obj
)
4490 po
= (void *) XPNTR (obj
);
4497 switch (XTYPE (obj
))
4500 mark_p
= (live_string_p (m
, po
)
4501 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4505 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4509 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4513 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4516 case Lisp_Vectorlike
:
4517 /* Note: can't check BUFFERP before we know it's a
4518 buffer because checking that dereferences the pointer
4519 PO which might point anywhere. */
4520 if (live_vector_p (m
, po
))
4521 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4522 else if (live_buffer_p (m
, po
))
4523 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4527 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4536 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4537 if (nzombies
< MAX_ZOMBIES
)
4538 zombies
[nzombies
] = obj
;
4547 /* If P points to Lisp data, mark that as live if it isn't already
4551 mark_maybe_pointer (void *p
)
4555 /* Quickly rule out some values which can't point to Lisp data.
4556 USE_LSB_TAG needs Lisp data to be aligned on multiples of GCALIGNMENT.
4557 Otherwise, assume that Lisp data is aligned on even addresses. */
4558 if ((intptr_t) p
% (USE_LSB_TAG
? GCALIGNMENT
: 2))
4564 Lisp_Object obj
= Qnil
;
4568 case MEM_TYPE_NON_LISP
:
4569 case MEM_TYPE_SPARE
:
4570 /* Nothing to do; not a pointer to Lisp memory. */
4573 case MEM_TYPE_BUFFER
:
4574 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4575 XSETVECTOR (obj
, p
);
4579 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4583 case MEM_TYPE_STRING
:
4584 if (live_string_p (m
, p
)
4585 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4586 XSETSTRING (obj
, p
);
4590 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4594 case MEM_TYPE_SYMBOL
:
4595 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4596 XSETSYMBOL (obj
, p
);
4599 case MEM_TYPE_FLOAT
:
4600 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4604 case MEM_TYPE_VECTORLIKE
:
4605 case MEM_TYPE_VECTOR_BLOCK
:
4606 if (live_vector_p (m
, p
))
4609 XSETVECTOR (tem
, p
);
4610 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4625 /* Alignment of pointer values. Use alignof, as it sometimes returns
4626 a smaller alignment than GCC's __alignof__ and mark_memory might
4627 miss objects if __alignof__ were used. */
4628 #define GC_POINTER_ALIGNMENT alignof (void *)
4630 /* Define POINTERS_MIGHT_HIDE_IN_OBJECTS to 1 if marking via C pointers does
4631 not suffice, which is the typical case. A host where a Lisp_Object is
4632 wider than a pointer might allocate a Lisp_Object in non-adjacent halves.
4633 If USE_LSB_TAG, the bottom half is not a valid pointer, but it should
4634 suffice to widen it to to a Lisp_Object and check it that way. */
4635 #if USE_LSB_TAG || VAL_MAX < UINTPTR_MAX
4636 # if !USE_LSB_TAG && VAL_MAX < UINTPTR_MAX >> GCTYPEBITS
4637 /* If tag bits straddle pointer-word boundaries, neither mark_maybe_pointer
4638 nor mark_maybe_object can follow the pointers. This should not occur on
4639 any practical porting target. */
4640 # error "MSB type bits straddle pointer-word boundaries"
4642 /* Marking via C pointers does not suffice, because Lisp_Objects contain
4643 pointer words that hold pointers ORed with type bits. */
4644 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 1
4646 /* Marking via C pointers suffices, because Lisp_Objects contain pointer
4647 words that hold unmodified pointers. */
4648 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 0
4651 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4652 or END+OFFSET..START. */
4655 mark_memory (void *start
, void *end
)
4656 #if defined (__clang__) && defined (__has_feature)
4657 #if __has_feature(address_sanitizer)
4658 /* Do not allow -faddress-sanitizer to check this function, since it
4659 crosses the function stack boundary, and thus would yield many
4661 __attribute__((no_address_safety_analysis
))
4668 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4672 /* Make START the pointer to the start of the memory region,
4673 if it isn't already. */
4681 /* Mark Lisp data pointed to. This is necessary because, in some
4682 situations, the C compiler optimizes Lisp objects away, so that
4683 only a pointer to them remains. Example:
4685 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4688 Lisp_Object obj = build_string ("test");
4689 struct Lisp_String *s = XSTRING (obj);
4690 Fgarbage_collect ();
4691 fprintf (stderr, "test `%s'\n", s->data);
4695 Here, `obj' isn't really used, and the compiler optimizes it
4696 away. The only reference to the life string is through the
4699 for (pp
= start
; (void *) pp
< end
; pp
++)
4700 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4702 void *p
= *(void **) ((char *) pp
+ i
);
4703 mark_maybe_pointer (p
);
4704 if (POINTERS_MIGHT_HIDE_IN_OBJECTS
)
4705 mark_maybe_object (XIL ((intptr_t) p
));
4709 /* setjmp will work with GCC unless NON_SAVING_SETJMP is defined in
4710 the GCC system configuration. In gcc 3.2, the only systems for
4711 which this is so are i386-sco5 non-ELF, i386-sysv3 (maybe included
4712 by others?) and ns32k-pc532-min. */
4714 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4716 static bool setjmp_tested_p
;
4717 static int longjmps_done
;
4719 #define SETJMP_WILL_LIKELY_WORK "\
4721 Emacs garbage collector has been changed to use conservative stack\n\
4722 marking. Emacs has determined that the method it uses to do the\n\
4723 marking will likely work on your system, but this isn't sure.\n\
4725 If you are a system-programmer, or can get the help of a local wizard\n\
4726 who is, please take a look at the function mark_stack in alloc.c, and\n\
4727 verify that the methods used are appropriate for your system.\n\
4729 Please mail the result to <emacs-devel@gnu.org>.\n\
4732 #define SETJMP_WILL_NOT_WORK "\
4734 Emacs garbage collector has been changed to use conservative stack\n\
4735 marking. Emacs has determined that the default method it uses to do the\n\
4736 marking will not work on your system. We will need a system-dependent\n\
4737 solution for your system.\n\
4739 Please take a look at the function mark_stack in alloc.c, and\n\
4740 try to find a way to make it work on your system.\n\
4742 Note that you may get false negatives, depending on the compiler.\n\
4743 In particular, you need to use -O with GCC for this test.\n\
4745 Please mail the result to <emacs-devel@gnu.org>.\n\
4749 /* Perform a quick check if it looks like setjmp saves registers in a
4750 jmp_buf. Print a message to stderr saying so. When this test
4751 succeeds, this is _not_ a proof that setjmp is sufficient for
4752 conservative stack marking. Only the sources or a disassembly
4762 /* Arrange for X to be put in a register. */
4768 if (longjmps_done
== 1)
4770 /* Came here after the longjmp at the end of the function.
4772 If x == 1, the longjmp has restored the register to its
4773 value before the setjmp, and we can hope that setjmp
4774 saves all such registers in the jmp_buf, although that
4777 For other values of X, either something really strange is
4778 taking place, or the setjmp just didn't save the register. */
4781 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4784 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4791 if (longjmps_done
== 1)
4795 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4798 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4800 /* Abort if anything GCPRO'd doesn't survive the GC. */
4808 for (p
= gcprolist
; p
; p
= p
->next
)
4809 for (i
= 0; i
< p
->nvars
; ++i
)
4810 if (!survives_gc_p (p
->var
[i
]))
4811 /* FIXME: It's not necessarily a bug. It might just be that the
4812 GCPRO is unnecessary or should release the object sooner. */
4816 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4823 fprintf (stderr
, "\nZombies kept alive = %"pI
"d:\n", nzombies
);
4824 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4826 fprintf (stderr
, " %d = ", i
);
4827 debug_print (zombies
[i
]);
4831 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4834 /* Mark live Lisp objects on the C stack.
4836 There are several system-dependent problems to consider when
4837 porting this to new architectures:
4841 We have to mark Lisp objects in CPU registers that can hold local
4842 variables or are used to pass parameters.
4844 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4845 something that either saves relevant registers on the stack, or
4846 calls mark_maybe_object passing it each register's contents.
4848 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4849 implementation assumes that calling setjmp saves registers we need
4850 to see in a jmp_buf which itself lies on the stack. This doesn't
4851 have to be true! It must be verified for each system, possibly
4852 by taking a look at the source code of setjmp.
4854 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4855 can use it as a machine independent method to store all registers
4856 to the stack. In this case the macros described in the previous
4857 two paragraphs are not used.
4861 Architectures differ in the way their processor stack is organized.
4862 For example, the stack might look like this
4865 | Lisp_Object | size = 4
4867 | something else | size = 2
4869 | Lisp_Object | size = 4
4873 In such a case, not every Lisp_Object will be aligned equally. To
4874 find all Lisp_Object on the stack it won't be sufficient to walk
4875 the stack in steps of 4 bytes. Instead, two passes will be
4876 necessary, one starting at the start of the stack, and a second
4877 pass starting at the start of the stack + 2. Likewise, if the
4878 minimal alignment of Lisp_Objects on the stack is 1, four passes
4879 would be necessary, each one starting with one byte more offset
4880 from the stack start. */
4887 #ifdef HAVE___BUILTIN_UNWIND_INIT
4888 /* Force callee-saved registers and register windows onto the stack.
4889 This is the preferred method if available, obviating the need for
4890 machine dependent methods. */
4891 __builtin_unwind_init ();
4893 #else /* not HAVE___BUILTIN_UNWIND_INIT */
4894 #ifndef GC_SAVE_REGISTERS_ON_STACK
4895 /* jmp_buf may not be aligned enough on darwin-ppc64 */
4896 union aligned_jmpbuf
{
4900 volatile bool stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4902 /* This trick flushes the register windows so that all the state of
4903 the process is contained in the stack. */
4904 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4905 needed on ia64 too. See mach_dep.c, where it also says inline
4906 assembler doesn't work with relevant proprietary compilers. */
4908 #if defined (__sparc64__) && defined (__FreeBSD__)
4909 /* FreeBSD does not have a ta 3 handler. */
4916 /* Save registers that we need to see on the stack. We need to see
4917 registers used to hold register variables and registers used to
4919 #ifdef GC_SAVE_REGISTERS_ON_STACK
4920 GC_SAVE_REGISTERS_ON_STACK (end
);
4921 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4923 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4924 setjmp will definitely work, test it
4925 and print a message with the result
4927 if (!setjmp_tested_p
)
4929 setjmp_tested_p
= 1;
4932 #endif /* GC_SETJMP_WORKS */
4935 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4936 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4937 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
4939 /* This assumes that the stack is a contiguous region in memory. If
4940 that's not the case, something has to be done here to iterate
4941 over the stack segments. */
4942 mark_memory (stack_base
, end
);
4944 /* Allow for marking a secondary stack, like the register stack on the
4946 #ifdef GC_MARK_SECONDARY_STACK
4947 GC_MARK_SECONDARY_STACK ();
4950 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4955 #endif /* GC_MARK_STACK != 0 */
4958 /* Determine whether it is safe to access memory at address P. */
4960 valid_pointer_p (void *p
)
4963 return w32_valid_pointer_p (p
, 16);
4967 /* Obviously, we cannot just access it (we would SEGV trying), so we
4968 trick the o/s to tell us whether p is a valid pointer.
4969 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4970 not validate p in that case. */
4974 bool valid
= emacs_write (fd
[1], (char *) p
, 16) == 16;
4975 emacs_close (fd
[1]);
4976 emacs_close (fd
[0]);
4984 /* Return 1 if OBJ is a valid lisp object.
4985 Return 0 if OBJ is NOT a valid lisp object.
4986 Return -1 if we cannot validate OBJ.
4987 This function can be quite slow,
4988 so it should only be used in code for manual debugging. */
4991 valid_lisp_object_p (Lisp_Object obj
)
5001 p
= (void *) XPNTR (obj
);
5002 if (PURE_POINTER_P (p
))
5006 return valid_pointer_p (p
);
5013 int valid
= valid_pointer_p (p
);
5025 case MEM_TYPE_NON_LISP
:
5026 case MEM_TYPE_SPARE
:
5029 case MEM_TYPE_BUFFER
:
5030 return live_buffer_p (m
, p
);
5033 return live_cons_p (m
, p
);
5035 case MEM_TYPE_STRING
:
5036 return live_string_p (m
, p
);
5039 return live_misc_p (m
, p
);
5041 case MEM_TYPE_SYMBOL
:
5042 return live_symbol_p (m
, p
);
5044 case MEM_TYPE_FLOAT
:
5045 return live_float_p (m
, p
);
5047 case MEM_TYPE_VECTORLIKE
:
5048 case MEM_TYPE_VECTOR_BLOCK
:
5049 return live_vector_p (m
, p
);
5062 /***********************************************************************
5063 Pure Storage Management
5064 ***********************************************************************/
5066 /* Allocate room for SIZE bytes from pure Lisp storage and return a
5067 pointer to it. TYPE is the Lisp type for which the memory is
5068 allocated. TYPE < 0 means it's not used for a Lisp object. */
5071 pure_alloc (size_t size
, int type
)
5075 size_t alignment
= GCALIGNMENT
;
5077 size_t alignment
= alignof (EMACS_INT
);
5079 /* Give Lisp_Floats an extra alignment. */
5080 if (type
== Lisp_Float
)
5081 alignment
= alignof (struct Lisp_Float
);
5087 /* Allocate space for a Lisp object from the beginning of the free
5088 space with taking account of alignment. */
5089 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
5090 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
5094 /* Allocate space for a non-Lisp object from the end of the free
5096 pure_bytes_used_non_lisp
+= size
;
5097 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5099 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
5101 if (pure_bytes_used
<= pure_size
)
5104 /* Don't allocate a large amount here,
5105 because it might get mmap'd and then its address
5106 might not be usable. */
5107 purebeg
= xmalloc (10000);
5109 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
5110 pure_bytes_used
= 0;
5111 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
5116 /* Print a warning if PURESIZE is too small. */
5119 check_pure_size (void)
5121 if (pure_bytes_used_before_overflow
)
5122 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
5124 pure_bytes_used
+ pure_bytes_used_before_overflow
);
5128 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
5129 the non-Lisp data pool of the pure storage, and return its start
5130 address. Return NULL if not found. */
5133 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5136 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5137 const unsigned char *p
;
5140 if (pure_bytes_used_non_lisp
<= nbytes
)
5143 /* Set up the Boyer-Moore table. */
5145 for (i
= 0; i
< 256; i
++)
5148 p
= (const unsigned char *) data
;
5150 bm_skip
[*p
++] = skip
;
5152 last_char_skip
= bm_skip
['\0'];
5154 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5155 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5157 /* See the comments in the function `boyer_moore' (search.c) for the
5158 use of `infinity'. */
5159 infinity
= pure_bytes_used_non_lisp
+ 1;
5160 bm_skip
['\0'] = infinity
;
5162 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5166 /* Check the last character (== '\0'). */
5169 start
+= bm_skip
[*(p
+ start
)];
5171 while (start
<= start_max
);
5173 if (start
< infinity
)
5174 /* Couldn't find the last character. */
5177 /* No less than `infinity' means we could find the last
5178 character at `p[start - infinity]'. */
5181 /* Check the remaining characters. */
5182 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5184 return non_lisp_beg
+ start
;
5186 start
+= last_char_skip
;
5188 while (start
<= start_max
);
5194 /* Return a string allocated in pure space. DATA is a buffer holding
5195 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5196 means make the result string multibyte.
5198 Must get an error if pure storage is full, since if it cannot hold
5199 a large string it may be able to hold conses that point to that
5200 string; then the string is not protected from gc. */
5203 make_pure_string (const char *data
,
5204 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
5207 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5208 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5209 if (s
->data
== NULL
)
5211 s
->data
= pure_alloc (nbytes
+ 1, -1);
5212 memcpy (s
->data
, data
, nbytes
);
5213 s
->data
[nbytes
] = '\0';
5216 s
->size_byte
= multibyte
? nbytes
: -1;
5217 s
->intervals
= NULL
;
5218 XSETSTRING (string
, s
);
5222 /* Return a string allocated in pure space. Do not
5223 allocate the string data, just point to DATA. */
5226 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5229 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5232 s
->data
= (unsigned char *) data
;
5233 s
->intervals
= NULL
;
5234 XSETSTRING (string
, s
);
5238 /* Return a cons allocated from pure space. Give it pure copies
5239 of CAR as car and CDR as cdr. */
5242 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5245 struct Lisp_Cons
*p
= pure_alloc (sizeof *p
, Lisp_Cons
);
5247 XSETCAR (new, Fpurecopy (car
));
5248 XSETCDR (new, Fpurecopy (cdr
));
5253 /* Value is a float object with value NUM allocated from pure space. */
5256 make_pure_float (double num
)
5259 struct Lisp_Float
*p
= pure_alloc (sizeof *p
, Lisp_Float
);
5261 XFLOAT_INIT (new, num
);
5266 /* Return a vector with room for LEN Lisp_Objects allocated from
5270 make_pure_vector (ptrdiff_t len
)
5273 size_t size
= header_size
+ len
* word_size
;
5274 struct Lisp_Vector
*p
= pure_alloc (size
, Lisp_Vectorlike
);
5275 XSETVECTOR (new, p
);
5276 XVECTOR (new)->header
.size
= len
;
5281 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5282 doc
: /* Make a copy of object OBJ in pure storage.
5283 Recursively copies contents of vectors and cons cells.
5284 Does not copy symbols. Copies strings without text properties. */)
5285 (register Lisp_Object obj
)
5287 if (NILP (Vpurify_flag
))
5290 if (PURE_POINTER_P (XPNTR (obj
)))
5293 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5295 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5301 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5302 else if (FLOATP (obj
))
5303 obj
= make_pure_float (XFLOAT_DATA (obj
));
5304 else if (STRINGP (obj
))
5305 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5307 STRING_MULTIBYTE (obj
));
5308 else if (COMPILEDP (obj
) || VECTORP (obj
))
5310 register struct Lisp_Vector
*vec
;
5311 register ptrdiff_t i
;
5315 if (size
& PSEUDOVECTOR_FLAG
)
5316 size
&= PSEUDOVECTOR_SIZE_MASK
;
5317 vec
= XVECTOR (make_pure_vector (size
));
5318 for (i
= 0; i
< size
; i
++)
5319 vec
->contents
[i
] = Fpurecopy (AREF (obj
, i
));
5320 if (COMPILEDP (obj
))
5322 XSETPVECTYPE (vec
, PVEC_COMPILED
);
5323 XSETCOMPILED (obj
, vec
);
5326 XSETVECTOR (obj
, vec
);
5328 else if (MARKERP (obj
))
5329 error ("Attempt to copy a marker to pure storage");
5331 /* Not purified, don't hash-cons. */
5334 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5335 Fputhash (obj
, obj
, Vpurify_flag
);
5342 /***********************************************************************
5344 ***********************************************************************/
5346 /* Put an entry in staticvec, pointing at the variable with address
5350 staticpro (Lisp_Object
*varaddress
)
5352 staticvec
[staticidx
++] = varaddress
;
5353 if (staticidx
>= NSTATICS
)
5358 /***********************************************************************
5360 ***********************************************************************/
5362 /* Temporarily prevent garbage collection. */
5365 inhibit_garbage_collection (void)
5367 ptrdiff_t count
= SPECPDL_INDEX ();
5369 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5373 /* Used to avoid possible overflows when
5374 converting from C to Lisp integers. */
5376 static inline Lisp_Object
5377 bounded_number (EMACS_INT number
)
5379 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5382 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5383 doc
: /* Reclaim storage for Lisp objects no longer needed.
5384 Garbage collection happens automatically if you cons more than
5385 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5386 `garbage-collect' normally returns a list with info on amount of space in use,
5387 where each entry has the form (NAME SIZE USED FREE), where:
5388 - NAME is a symbol describing the kind of objects this entry represents,
5389 - SIZE is the number of bytes used by each one,
5390 - USED is the number of those objects that were found live in the heap,
5391 - FREE is the number of those objects that are not live but that Emacs
5392 keeps around for future allocations (maybe because it does not know how
5393 to return them to the OS).
5394 However, if there was overflow in pure space, `garbage-collect'
5395 returns nil, because real GC can't be done.
5396 See Info node `(elisp)Garbage Collection'. */)
5399 struct specbinding
*bind
;
5400 struct buffer
*nextb
;
5401 char stack_top_variable
;
5404 ptrdiff_t count
= SPECPDL_INDEX ();
5406 Lisp_Object retval
= Qnil
;
5411 /* Can't GC if pure storage overflowed because we can't determine
5412 if something is a pure object or not. */
5413 if (pure_bytes_used_before_overflow
)
5418 /* Don't keep undo information around forever.
5419 Do this early on, so it is no problem if the user quits. */
5420 FOR_EACH_BUFFER (nextb
)
5421 compact_buffer (nextb
);
5423 start
= current_emacs_time ();
5425 /* In case user calls debug_print during GC,
5426 don't let that cause a recursive GC. */
5427 consing_since_gc
= 0;
5429 /* Save what's currently displayed in the echo area. */
5430 message_p
= push_message ();
5431 record_unwind_protect (pop_message_unwind
, Qnil
);
5433 /* Save a copy of the contents of the stack, for debugging. */
5434 #if MAX_SAVE_STACK > 0
5435 if (NILP (Vpurify_flag
))
5438 ptrdiff_t stack_size
;
5439 if (&stack_top_variable
< stack_bottom
)
5441 stack
= &stack_top_variable
;
5442 stack_size
= stack_bottom
- &stack_top_variable
;
5446 stack
= stack_bottom
;
5447 stack_size
= &stack_top_variable
- stack_bottom
;
5449 if (stack_size
<= MAX_SAVE_STACK
)
5451 if (stack_copy_size
< stack_size
)
5453 stack_copy
= xrealloc (stack_copy
, stack_size
);
5454 stack_copy_size
= stack_size
;
5456 memcpy (stack_copy
, stack
, stack_size
);
5459 #endif /* MAX_SAVE_STACK > 0 */
5461 if (garbage_collection_messages
)
5462 message1_nolog ("Garbage collecting...");
5466 shrink_regexp_cache ();
5470 /* Mark all the special slots that serve as the roots of accessibility. */
5472 for (i
= 0; i
< staticidx
; i
++)
5473 mark_object (*staticvec
[i
]);
5475 for (bind
= specpdl
; bind
!= specpdl_ptr
; bind
++)
5477 mark_object (bind
->symbol
);
5478 mark_object (bind
->old_value
);
5487 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5488 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5492 register struct gcpro
*tail
;
5493 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5494 for (i
= 0; i
< tail
->nvars
; i
++)
5495 mark_object (tail
->var
[i
]);
5499 struct catchtag
*catch;
5500 struct handler
*handler
;
5502 for (catch = catchlist
; catch; catch = catch->next
)
5504 mark_object (catch->tag
);
5505 mark_object (catch->val
);
5507 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5509 mark_object (handler
->handler
);
5510 mark_object (handler
->var
);
5516 #ifdef HAVE_WINDOW_SYSTEM
5517 mark_fringe_data ();
5520 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5524 /* Everything is now marked, except for the things that require special
5525 finalization, i.e. the undo_list.
5526 Look thru every buffer's undo list
5527 for elements that update markers that were not marked,
5529 FOR_EACH_BUFFER (nextb
)
5531 /* If a buffer's undo list is Qt, that means that undo is
5532 turned off in that buffer. Calling truncate_undo_list on
5533 Qt tends to return NULL, which effectively turns undo back on.
5534 So don't call truncate_undo_list if undo_list is Qt. */
5535 if (! EQ (nextb
->INTERNAL_FIELD (undo_list
), Qt
))
5537 Lisp_Object tail
, prev
;
5538 tail
= nextb
->INTERNAL_FIELD (undo_list
);
5540 while (CONSP (tail
))
5542 if (CONSP (XCAR (tail
))
5543 && MARKERP (XCAR (XCAR (tail
)))
5544 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5547 nextb
->INTERNAL_FIELD (undo_list
) = tail
= XCDR (tail
);
5551 XSETCDR (prev
, tail
);
5561 /* Now that we have stripped the elements that need not be in the
5562 undo_list any more, we can finally mark the list. */
5563 mark_object (nextb
->INTERNAL_FIELD (undo_list
));
5568 /* Clear the mark bits that we set in certain root slots. */
5570 unmark_byte_stack ();
5571 VECTOR_UNMARK (&buffer_defaults
);
5572 VECTOR_UNMARK (&buffer_local_symbols
);
5574 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5584 consing_since_gc
= 0;
5585 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
5586 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
5588 gc_relative_threshold
= 0;
5589 if (FLOATP (Vgc_cons_percentage
))
5590 { /* Set gc_cons_combined_threshold. */
5593 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5594 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5595 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5596 tot
+= total_string_bytes
;
5597 tot
+= total_vector_slots
* word_size
;
5598 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5599 tot
+= total_intervals
* sizeof (struct interval
);
5600 tot
+= total_strings
* sizeof (struct Lisp_String
);
5602 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5605 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5606 gc_relative_threshold
= tot
;
5608 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5612 if (garbage_collection_messages
)
5614 if (message_p
|| minibuf_level
> 0)
5617 message1_nolog ("Garbage collecting...done");
5620 unbind_to (count
, Qnil
);
5622 Lisp_Object total
[11];
5623 int total_size
= 10;
5625 total
[0] = list4 (Qconses
, make_number (sizeof (struct Lisp_Cons
)),
5626 bounded_number (total_conses
),
5627 bounded_number (total_free_conses
));
5629 total
[1] = list4 (Qsymbols
, make_number (sizeof (struct Lisp_Symbol
)),
5630 bounded_number (total_symbols
),
5631 bounded_number (total_free_symbols
));
5633 total
[2] = list4 (Qmiscs
, make_number (sizeof (union Lisp_Misc
)),
5634 bounded_number (total_markers
),
5635 bounded_number (total_free_markers
));
5637 total
[3] = list4 (Qstrings
, make_number (sizeof (struct Lisp_String
)),
5638 bounded_number (total_strings
),
5639 bounded_number (total_free_strings
));
5641 total
[4] = list3 (Qstring_bytes
, make_number (1),
5642 bounded_number (total_string_bytes
));
5644 total
[5] = list3 (Qvectors
, make_number (sizeof (struct Lisp_Vector
)),
5645 bounded_number (total_vectors
));
5647 total
[6] = list4 (Qvector_slots
, make_number (word_size
),
5648 bounded_number (total_vector_slots
),
5649 bounded_number (total_free_vector_slots
));
5651 total
[7] = list4 (Qfloats
, make_number (sizeof (struct Lisp_Float
)),
5652 bounded_number (total_floats
),
5653 bounded_number (total_free_floats
));
5655 total
[8] = list4 (Qintervals
, make_number (sizeof (struct interval
)),
5656 bounded_number (total_intervals
),
5657 bounded_number (total_free_intervals
));
5659 total
[9] = list3 (Qbuffers
, make_number (sizeof (struct buffer
)),
5660 bounded_number (total_buffers
));
5662 #ifdef DOUG_LEA_MALLOC
5664 total
[10] = list4 (Qheap
, make_number (1024),
5665 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
5666 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10));
5668 retval
= Flist (total_size
, total
);
5671 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5673 /* Compute average percentage of zombies. */
5675 = (total_conses
+ total_symbols
+ total_markers
+ total_strings
5676 + total_vectors
+ total_floats
+ total_intervals
+ total_buffers
);
5678 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5679 max_live
= max (nlive
, max_live
);
5680 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5681 max_zombies
= max (nzombies
, max_zombies
);
5686 if (!NILP (Vpost_gc_hook
))
5688 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5689 safe_run_hooks (Qpost_gc_hook
);
5690 unbind_to (gc_count
, Qnil
);
5693 /* Accumulate statistics. */
5694 if (FLOATP (Vgc_elapsed
))
5696 EMACS_TIME since_start
= sub_emacs_time (current_emacs_time (), start
);
5697 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5698 + EMACS_TIME_TO_DOUBLE (since_start
));
5707 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5708 only interesting objects referenced from glyphs are strings. */
5711 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5713 struct glyph_row
*row
= matrix
->rows
;
5714 struct glyph_row
*end
= row
+ matrix
->nrows
;
5716 for (; row
< end
; ++row
)
5720 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5722 struct glyph
*glyph
= row
->glyphs
[area
];
5723 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5725 for (; glyph
< end_glyph
; ++glyph
)
5726 if (STRINGP (glyph
->object
)
5727 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5728 mark_object (glyph
->object
);
5734 /* Mark Lisp faces in the face cache C. */
5737 mark_face_cache (struct face_cache
*c
)
5742 for (i
= 0; i
< c
->used
; ++i
)
5744 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5748 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5749 mark_object (face
->lface
[j
]);
5757 /* Mark reference to a Lisp_Object.
5758 If the object referred to has not been seen yet, recursively mark
5759 all the references contained in it. */
5761 #define LAST_MARKED_SIZE 500
5762 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5763 static int last_marked_index
;
5765 /* For debugging--call abort when we cdr down this many
5766 links of a list, in mark_object. In debugging,
5767 the call to abort will hit a breakpoint.
5768 Normally this is zero and the check never goes off. */
5769 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5772 mark_vectorlike (struct Lisp_Vector
*ptr
)
5774 ptrdiff_t size
= ptr
->header
.size
;
5777 eassert (!VECTOR_MARKED_P (ptr
));
5778 VECTOR_MARK (ptr
); /* Else mark it. */
5779 if (size
& PSEUDOVECTOR_FLAG
)
5780 size
&= PSEUDOVECTOR_SIZE_MASK
;
5782 /* Note that this size is not the memory-footprint size, but only
5783 the number of Lisp_Object fields that we should trace.
5784 The distinction is used e.g. by Lisp_Process which places extra
5785 non-Lisp_Object fields at the end of the structure... */
5786 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
5787 mark_object (ptr
->contents
[i
]);
5790 /* Like mark_vectorlike but optimized for char-tables (and
5791 sub-char-tables) assuming that the contents are mostly integers or
5795 mark_char_table (struct Lisp_Vector
*ptr
)
5797 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5800 eassert (!VECTOR_MARKED_P (ptr
));
5802 for (i
= 0; i
< size
; i
++)
5804 Lisp_Object val
= ptr
->contents
[i
];
5806 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5808 if (SUB_CHAR_TABLE_P (val
))
5810 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5811 mark_char_table (XVECTOR (val
));
5818 /* Mark the chain of overlays starting at PTR. */
5821 mark_overlay (struct Lisp_Overlay
*ptr
)
5823 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
5826 mark_object (ptr
->start
);
5827 mark_object (ptr
->end
);
5828 mark_object (ptr
->plist
);
5832 /* Mark Lisp_Objects and special pointers in BUFFER. */
5835 mark_buffer (struct buffer
*buffer
)
5837 /* This is handled much like other pseudovectors... */
5838 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
5840 /* ...but there are some buffer-specific things. */
5842 MARK_INTERVAL_TREE (buffer_intervals (buffer
));
5844 /* For now, we just don't mark the undo_list. It's done later in
5845 a special way just before the sweep phase, and after stripping
5846 some of its elements that are not needed any more. */
5848 mark_overlay (buffer
->overlays_before
);
5849 mark_overlay (buffer
->overlays_after
);
5851 /* If this is an indirect buffer, mark its base buffer. */
5852 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5853 mark_buffer (buffer
->base_buffer
);
5856 /* Determine type of generic Lisp_Object and mark it accordingly. */
5859 mark_object (Lisp_Object arg
)
5861 register Lisp_Object obj
= arg
;
5862 #ifdef GC_CHECK_MARKED_OBJECTS
5866 ptrdiff_t cdr_count
= 0;
5870 if (PURE_POINTER_P (XPNTR (obj
)))
5873 last_marked
[last_marked_index
++] = obj
;
5874 if (last_marked_index
== LAST_MARKED_SIZE
)
5875 last_marked_index
= 0;
5877 /* Perform some sanity checks on the objects marked here. Abort if
5878 we encounter an object we know is bogus. This increases GC time
5879 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5880 #ifdef GC_CHECK_MARKED_OBJECTS
5882 po
= (void *) XPNTR (obj
);
5884 /* Check that the object pointed to by PO is known to be a Lisp
5885 structure allocated from the heap. */
5886 #define CHECK_ALLOCATED() \
5888 m = mem_find (po); \
5893 /* Check that the object pointed to by PO is live, using predicate
5895 #define CHECK_LIVE(LIVEP) \
5897 if (!LIVEP (m, po)) \
5901 /* Check both of the above conditions. */
5902 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5904 CHECK_ALLOCATED (); \
5905 CHECK_LIVE (LIVEP); \
5908 #else /* not GC_CHECK_MARKED_OBJECTS */
5910 #define CHECK_LIVE(LIVEP) (void) 0
5911 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5913 #endif /* not GC_CHECK_MARKED_OBJECTS */
5915 switch (XTYPE (obj
))
5919 register struct Lisp_String
*ptr
= XSTRING (obj
);
5920 if (STRING_MARKED_P (ptr
))
5922 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
5924 MARK_INTERVAL_TREE (ptr
->intervals
);
5925 #ifdef GC_CHECK_STRING_BYTES
5926 /* Check that the string size recorded in the string is the
5927 same as the one recorded in the sdata structure. */
5929 #endif /* GC_CHECK_STRING_BYTES */
5933 case Lisp_Vectorlike
:
5935 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5936 register ptrdiff_t pvectype
;
5938 if (VECTOR_MARKED_P (ptr
))
5941 #ifdef GC_CHECK_MARKED_OBJECTS
5943 if (m
== MEM_NIL
&& !SUBRP (obj
)
5944 && po
!= &buffer_defaults
5945 && po
!= &buffer_local_symbols
)
5947 #endif /* GC_CHECK_MARKED_OBJECTS */
5949 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
5950 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
5951 >> PSEUDOVECTOR_SIZE_BITS
);
5955 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
5956 CHECK_LIVE (live_vector_p
);
5961 #ifdef GC_CHECK_MARKED_OBJECTS
5962 if (po
!= &buffer_defaults
&& po
!= &buffer_local_symbols
)
5971 #endif /* GC_CHECK_MARKED_OBJECTS */
5972 mark_buffer ((struct buffer
*) ptr
);
5976 { /* We could treat this just like a vector, but it is better
5977 to save the COMPILED_CONSTANTS element for last and avoid
5979 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5983 for (i
= 0; i
< size
; i
++)
5984 if (i
!= COMPILED_CONSTANTS
)
5985 mark_object (ptr
->contents
[i
]);
5986 if (size
> COMPILED_CONSTANTS
)
5988 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
5996 mark_vectorlike (ptr
);
5997 mark_face_cache (((struct frame
*) ptr
)->face_cache
);
6003 struct window
*w
= (struct window
*) ptr
;
6005 mark_vectorlike (ptr
);
6006 /* Mark glyphs for leaf windows. Marking window
6007 matrices is sufficient because frame matrices
6008 use the same glyph memory. */
6009 if (NILP (w
->hchild
) && NILP (w
->vchild
)
6010 && w
->current_matrix
)
6012 mark_glyph_matrix (w
->current_matrix
);
6013 mark_glyph_matrix (w
->desired_matrix
);
6018 case PVEC_HASH_TABLE
:
6020 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6022 mark_vectorlike (ptr
);
6023 /* If hash table is not weak, mark all keys and values.
6024 For weak tables, mark only the vector. */
6026 mark_object (h
->key_and_value
);
6028 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6032 case PVEC_CHAR_TABLE
:
6033 mark_char_table (ptr
);
6036 case PVEC_BOOL_VECTOR
:
6037 /* No Lisp_Objects to mark in a bool vector. */
6048 mark_vectorlike (ptr
);
6055 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6056 struct Lisp_Symbol
*ptrx
;
6060 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
6062 mark_object (ptr
->function
);
6063 mark_object (ptr
->plist
);
6064 switch (ptr
->redirect
)
6066 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6067 case SYMBOL_VARALIAS
:
6070 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6074 case SYMBOL_LOCALIZED
:
6076 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
6077 /* If the value is forwarded to a buffer or keyboard field,
6078 these are marked when we see the corresponding object.
6079 And if it's forwarded to a C variable, either it's not
6080 a Lisp_Object var, or it's staticpro'd already. */
6081 mark_object (blv
->where
);
6082 mark_object (blv
->valcell
);
6083 mark_object (blv
->defcell
);
6086 case SYMBOL_FORWARDED
:
6087 /* If the value is forwarded to a buffer or keyboard field,
6088 these are marked when we see the corresponding object.
6089 And if it's forwarded to a C variable, either it's not
6090 a Lisp_Object var, or it's staticpro'd already. */
6092 default: emacs_abort ();
6094 if (!PURE_POINTER_P (XSTRING (ptr
->name
)))
6095 MARK_STRING (XSTRING (ptr
->name
));
6096 MARK_INTERVAL_TREE (string_intervals (ptr
->name
));
6101 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun. */
6102 XSETSYMBOL (obj
, ptrx
);
6109 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6111 if (XMISCANY (obj
)->gcmarkbit
)
6114 switch (XMISCTYPE (obj
))
6116 case Lisp_Misc_Marker
:
6117 /* DO NOT mark thru the marker's chain.
6118 The buffer's markers chain does not preserve markers from gc;
6119 instead, markers are removed from the chain when freed by gc. */
6120 XMISCANY (obj
)->gcmarkbit
= 1;
6123 case Lisp_Misc_Save_Value
:
6124 XMISCANY (obj
)->gcmarkbit
= 1;
6127 register struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
6128 /* If DOGC is set, POINTER is the address of a memory
6129 area containing INTEGER potential Lisp_Objects. */
6132 Lisp_Object
*p
= (Lisp_Object
*) ptr
->pointer
;
6134 for (nelt
= ptr
->integer
; nelt
> 0; nelt
--, p
++)
6135 mark_maybe_object (*p
);
6141 case Lisp_Misc_Overlay
:
6142 mark_overlay (XOVERLAY (obj
));
6152 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6153 if (CONS_MARKED_P (ptr
))
6155 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6157 /* If the cdr is nil, avoid recursion for the car. */
6158 if (EQ (ptr
->u
.cdr
, Qnil
))
6164 mark_object (ptr
->car
);
6167 if (cdr_count
== mark_object_loop_halt
)
6173 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6174 FLOAT_MARK (XFLOAT (obj
));
6185 #undef CHECK_ALLOCATED
6186 #undef CHECK_ALLOCATED_AND_LIVE
6188 /* Mark the Lisp pointers in the terminal objects.
6189 Called by Fgarbage_collect. */
6192 mark_terminals (void)
6195 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6197 eassert (t
->name
!= NULL
);
6198 #ifdef HAVE_WINDOW_SYSTEM
6199 /* If a terminal object is reachable from a stacpro'ed object,
6200 it might have been marked already. Make sure the image cache
6202 mark_image_cache (t
->image_cache
);
6203 #endif /* HAVE_WINDOW_SYSTEM */
6204 if (!VECTOR_MARKED_P (t
))
6205 mark_vectorlike ((struct Lisp_Vector
*)t
);
6211 /* Value is non-zero if OBJ will survive the current GC because it's
6212 either marked or does not need to be marked to survive. */
6215 survives_gc_p (Lisp_Object obj
)
6219 switch (XTYPE (obj
))
6226 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6230 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6234 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6237 case Lisp_Vectorlike
:
6238 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6242 survives_p
= CONS_MARKED_P (XCONS (obj
));
6246 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6253 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
6258 /* Sweep: find all structures not marked, and free them. */
6263 /* Remove or mark entries in weak hash tables.
6264 This must be done before any object is unmarked. */
6265 sweep_weak_hash_tables ();
6268 check_string_bytes (!noninteractive
);
6270 /* Put all unmarked conses on free list */
6272 register struct cons_block
*cblk
;
6273 struct cons_block
**cprev
= &cons_block
;
6274 register int lim
= cons_block_index
;
6275 EMACS_INT num_free
= 0, num_used
= 0;
6279 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6283 int ilim
= (lim
+ BITS_PER_INT
- 1) / BITS_PER_INT
;
6285 /* Scan the mark bits an int at a time. */
6286 for (i
= 0; i
< ilim
; i
++)
6288 if (cblk
->gcmarkbits
[i
] == -1)
6290 /* Fast path - all cons cells for this int are marked. */
6291 cblk
->gcmarkbits
[i
] = 0;
6292 num_used
+= BITS_PER_INT
;
6296 /* Some cons cells for this int are not marked.
6297 Find which ones, and free them. */
6298 int start
, pos
, stop
;
6300 start
= i
* BITS_PER_INT
;
6302 if (stop
> BITS_PER_INT
)
6303 stop
= BITS_PER_INT
;
6306 for (pos
= start
; pos
< stop
; pos
++)
6308 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6311 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6312 cons_free_list
= &cblk
->conses
[pos
];
6314 cons_free_list
->car
= Vdead
;
6320 CONS_UNMARK (&cblk
->conses
[pos
]);
6326 lim
= CONS_BLOCK_SIZE
;
6327 /* If this block contains only free conses and we have already
6328 seen more than two blocks worth of free conses then deallocate
6330 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6332 *cprev
= cblk
->next
;
6333 /* Unhook from the free list. */
6334 cons_free_list
= cblk
->conses
[0].u
.chain
;
6335 lisp_align_free (cblk
);
6339 num_free
+= this_free
;
6340 cprev
= &cblk
->next
;
6343 total_conses
= num_used
;
6344 total_free_conses
= num_free
;
6347 /* Put all unmarked floats on free list */
6349 register struct float_block
*fblk
;
6350 struct float_block
**fprev
= &float_block
;
6351 register int lim
= float_block_index
;
6352 EMACS_INT num_free
= 0, num_used
= 0;
6354 float_free_list
= 0;
6356 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6360 for (i
= 0; i
< lim
; i
++)
6361 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6364 fblk
->floats
[i
].u
.chain
= float_free_list
;
6365 float_free_list
= &fblk
->floats
[i
];
6370 FLOAT_UNMARK (&fblk
->floats
[i
]);
6372 lim
= FLOAT_BLOCK_SIZE
;
6373 /* If this block contains only free floats and we have already
6374 seen more than two blocks worth of free floats then deallocate
6376 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6378 *fprev
= fblk
->next
;
6379 /* Unhook from the free list. */
6380 float_free_list
= fblk
->floats
[0].u
.chain
;
6381 lisp_align_free (fblk
);
6385 num_free
+= this_free
;
6386 fprev
= &fblk
->next
;
6389 total_floats
= num_used
;
6390 total_free_floats
= num_free
;
6393 /* Put all unmarked intervals on free list */
6395 register struct interval_block
*iblk
;
6396 struct interval_block
**iprev
= &interval_block
;
6397 register int lim
= interval_block_index
;
6398 EMACS_INT num_free
= 0, num_used
= 0;
6400 interval_free_list
= 0;
6402 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6407 for (i
= 0; i
< lim
; i
++)
6409 if (!iblk
->intervals
[i
].gcmarkbit
)
6411 set_interval_parent (&iblk
->intervals
[i
], interval_free_list
);
6412 interval_free_list
= &iblk
->intervals
[i
];
6418 iblk
->intervals
[i
].gcmarkbit
= 0;
6421 lim
= INTERVAL_BLOCK_SIZE
;
6422 /* If this block contains only free intervals and we have already
6423 seen more than two blocks worth of free intervals then
6424 deallocate this block. */
6425 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6427 *iprev
= iblk
->next
;
6428 /* Unhook from the free list. */
6429 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6434 num_free
+= this_free
;
6435 iprev
= &iblk
->next
;
6438 total_intervals
= num_used
;
6439 total_free_intervals
= num_free
;
6442 /* Put all unmarked symbols on free list */
6444 register struct symbol_block
*sblk
;
6445 struct symbol_block
**sprev
= &symbol_block
;
6446 register int lim
= symbol_block_index
;
6447 EMACS_INT num_free
= 0, num_used
= 0;
6449 symbol_free_list
= NULL
;
6451 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6454 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6455 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6457 for (; sym
< end
; ++sym
)
6459 /* Check if the symbol was created during loadup. In such a case
6460 it might be pointed to by pure bytecode which we don't trace,
6461 so we conservatively assume that it is live. */
6462 bool pure_p
= PURE_POINTER_P (XSTRING (sym
->s
.name
));
6464 if (!sym
->s
.gcmarkbit
&& !pure_p
)
6466 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6467 xfree (SYMBOL_BLV (&sym
->s
));
6468 sym
->s
.next
= symbol_free_list
;
6469 symbol_free_list
= &sym
->s
;
6471 symbol_free_list
->function
= Vdead
;
6479 UNMARK_STRING (XSTRING (sym
->s
.name
));
6480 sym
->s
.gcmarkbit
= 0;
6484 lim
= SYMBOL_BLOCK_SIZE
;
6485 /* If this block contains only free symbols and we have already
6486 seen more than two blocks worth of free symbols then deallocate
6488 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6490 *sprev
= sblk
->next
;
6491 /* Unhook from the free list. */
6492 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6497 num_free
+= this_free
;
6498 sprev
= &sblk
->next
;
6501 total_symbols
= num_used
;
6502 total_free_symbols
= num_free
;
6505 /* Put all unmarked misc's on free list.
6506 For a marker, first unchain it from the buffer it points into. */
6508 register struct marker_block
*mblk
;
6509 struct marker_block
**mprev
= &marker_block
;
6510 register int lim
= marker_block_index
;
6511 EMACS_INT num_free
= 0, num_used
= 0;
6513 marker_free_list
= 0;
6515 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6520 for (i
= 0; i
< lim
; i
++)
6522 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6524 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6525 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6526 /* Set the type of the freed object to Lisp_Misc_Free.
6527 We could leave the type alone, since nobody checks it,
6528 but this might catch bugs faster. */
6529 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6530 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6531 marker_free_list
= &mblk
->markers
[i
].m
;
6537 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6540 lim
= MARKER_BLOCK_SIZE
;
6541 /* If this block contains only free markers and we have already
6542 seen more than two blocks worth of free markers then deallocate
6544 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6546 *mprev
= mblk
->next
;
6547 /* Unhook from the free list. */
6548 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6553 num_free
+= this_free
;
6554 mprev
= &mblk
->next
;
6558 total_markers
= num_used
;
6559 total_free_markers
= num_free
;
6562 /* Free all unmarked buffers */
6564 register struct buffer
*buffer
= all_buffers
, *prev
= 0, *next
;
6568 if (!VECTOR_MARKED_P (buffer
))
6571 prev
->header
.next
= buffer
->header
.next
;
6573 all_buffers
= buffer
->header
.next
.buffer
;
6574 next
= buffer
->header
.next
.buffer
;
6580 VECTOR_UNMARK (buffer
);
6581 /* Do not use buffer_(set|get)_intervals here. */
6582 buffer
->text
->intervals
= balance_intervals (buffer
->text
->intervals
);
6584 prev
= buffer
, buffer
= buffer
->header
.next
.buffer
;
6589 check_string_bytes (!noninteractive
);
6595 /* Debugging aids. */
6597 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6598 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6599 This may be helpful in debugging Emacs's memory usage.
6600 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6605 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6610 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6611 doc
: /* Return a list of counters that measure how much consing there has been.
6612 Each of these counters increments for a certain kind of object.
6613 The counters wrap around from the largest positive integer to zero.
6614 Garbage collection does not decrease them.
6615 The elements of the value are as follows:
6616 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6617 All are in units of 1 = one object consed
6618 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6620 MISCS include overlays, markers, and some internal types.
6621 Frames, windows, buffers, and subprocesses count as vectors
6622 (but the contents of a buffer's text do not count here). */)
6625 return listn (CONSTYPE_HEAP
, 8,
6626 bounded_number (cons_cells_consed
),
6627 bounded_number (floats_consed
),
6628 bounded_number (vector_cells_consed
),
6629 bounded_number (symbols_consed
),
6630 bounded_number (string_chars_consed
),
6631 bounded_number (misc_objects_consed
),
6632 bounded_number (intervals_consed
),
6633 bounded_number (strings_consed
));
6636 /* Find at most FIND_MAX symbols which have OBJ as their value or
6637 function. This is used in gdbinit's `xwhichsymbols' command. */
6640 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6642 struct symbol_block
*sblk
;
6643 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6644 Lisp_Object found
= Qnil
;
6648 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6650 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
6653 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
6655 struct Lisp_Symbol
*sym
= &aligned_sym
->s
;
6659 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6662 XSETSYMBOL (tem
, sym
);
6663 val
= find_symbol_value (tem
);
6665 || EQ (sym
->function
, obj
)
6666 || (!NILP (sym
->function
)
6667 && COMPILEDP (sym
->function
)
6668 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
6671 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)))
6673 found
= Fcons (tem
, found
);
6674 if (--find_max
== 0)
6682 unbind_to (gc_count
, Qnil
);
6686 #ifdef ENABLE_CHECKING
6688 # include <execinfo.h>
6690 bool suppress_checking
;
6693 die (const char *msg
, const char *file
, int line
)
6695 enum { NPOINTERS_MAX
= 500 };
6696 void *buffer
[NPOINTERS_MAX
];
6698 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: %s\r\n",
6700 npointers
= backtrace (buffer
, NPOINTERS_MAX
);
6701 backtrace_symbols_fd (buffer
, npointers
, STDERR_FILENO
);
6706 /* Initialization */
6709 init_alloc_once (void)
6711 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6713 pure_size
= PURESIZE
;
6715 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6717 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6720 #ifdef DOUG_LEA_MALLOC
6721 mallopt (M_TRIM_THRESHOLD
, 128*1024); /* trim threshold */
6722 mallopt (M_MMAP_THRESHOLD
, 64*1024); /* mmap threshold */
6723 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* max. number of mmap'ed areas */
6729 malloc_hysteresis
= 32;
6731 malloc_hysteresis
= 0;
6734 refill_memory_reserve ();
6735 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
6742 byte_stack_list
= 0;
6744 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6745 setjmp_tested_p
= longjmps_done
= 0;
6748 Vgc_elapsed
= make_float (0.0);
6753 syms_of_alloc (void)
6755 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6756 doc
: /* Number of bytes of consing between garbage collections.
6757 Garbage collection can happen automatically once this many bytes have been
6758 allocated since the last garbage collection. All data types count.
6760 Garbage collection happens automatically only when `eval' is called.
6762 By binding this temporarily to a large number, you can effectively
6763 prevent garbage collection during a part of the program.
6764 See also `gc-cons-percentage'. */);
6766 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6767 doc
: /* Portion of the heap used for allocation.
6768 Garbage collection can happen automatically once this portion of the heap
6769 has been allocated since the last garbage collection.
6770 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6771 Vgc_cons_percentage
= make_float (0.1);
6773 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6774 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
6776 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6777 doc
: /* Number of cons cells that have been consed so far. */);
6779 DEFVAR_INT ("floats-consed", floats_consed
,
6780 doc
: /* Number of floats that have been consed so far. */);
6782 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
6783 doc
: /* Number of vector cells that have been consed so far. */);
6785 DEFVAR_INT ("symbols-consed", symbols_consed
,
6786 doc
: /* Number of symbols that have been consed so far. */);
6788 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
6789 doc
: /* Number of string characters that have been consed so far. */);
6791 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
6792 doc
: /* Number of miscellaneous objects that have been consed so far.
6793 These include markers and overlays, plus certain objects not visible
6796 DEFVAR_INT ("intervals-consed", intervals_consed
,
6797 doc
: /* Number of intervals that have been consed so far. */);
6799 DEFVAR_INT ("strings-consed", strings_consed
,
6800 doc
: /* Number of strings that have been consed so far. */);
6802 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
6803 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
6804 This means that certain objects should be allocated in shared (pure) space.
6805 It can also be set to a hash-table, in which case this table is used to
6806 do hash-consing of the objects allocated to pure space. */);
6808 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
6809 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
6810 garbage_collection_messages
= 0;
6812 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
6813 doc
: /* Hook run after garbage collection has finished. */);
6814 Vpost_gc_hook
= Qnil
;
6815 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
6817 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
6818 doc
: /* Precomputed `signal' argument for memory-full error. */);
6819 /* We build this in advance because if we wait until we need it, we might
6820 not be able to allocate the memory to hold it. */
6822 = listn (CONSTYPE_PURE
, 2, Qerror
,
6823 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
6825 DEFVAR_LISP ("memory-full", Vmemory_full
,
6826 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
6827 Vmemory_full
= Qnil
;
6829 DEFSYM (Qconses
, "conses");
6830 DEFSYM (Qsymbols
, "symbols");
6831 DEFSYM (Qmiscs
, "miscs");
6832 DEFSYM (Qstrings
, "strings");
6833 DEFSYM (Qvectors
, "vectors");
6834 DEFSYM (Qfloats
, "floats");
6835 DEFSYM (Qintervals
, "intervals");
6836 DEFSYM (Qbuffers
, "buffers");
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};