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. */
35 #include "intervals.h"
37 #include "character.h"
42 #include "blockinput.h"
43 #include "termhooks.h" /* For struct terminal. */
47 /* GC_CHECK_MARKED_OBJECTS means do sanity checks on allocated objects.
48 Doable only if GC_MARK_STACK. */
50 # undef GC_CHECK_MARKED_OBJECTS
53 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
54 memory. Can do this only if using gmalloc.c and if not checking
57 #if (defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC \
58 || defined GC_CHECK_MARKED_OBJECTS)
59 #undef GC_MALLOC_CHECK
76 #ifdef DOUG_LEA_MALLOC
80 /* Specify maximum number of areas to mmap. It would be nice to use a
81 value that explicitly means "no limit". */
83 #define MMAP_MAX_AREAS 100000000
85 #else /* not DOUG_LEA_MALLOC */
87 /* The following come from gmalloc.c. */
89 extern size_t _bytes_used
;
90 extern size_t __malloc_extra_blocks
;
91 extern void *_malloc_internal (size_t);
92 extern void _free_internal (void *);
94 #endif /* not DOUG_LEA_MALLOC */
96 #if ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT
99 /* When GTK uses the file chooser dialog, different backends can be loaded
100 dynamically. One such a backend is the Gnome VFS backend that gets loaded
101 if you run Gnome. That backend creates several threads and also allocates
104 Also, gconf and gsettings may create several threads.
106 If Emacs sets malloc hooks (! SYSTEM_MALLOC) and the emacs_blocked_*
107 functions below are called from malloc, there is a chance that one
108 of these threads preempts the Emacs main thread and the hook variables
109 end up in an inconsistent state. So we have a mutex to prevent that (note
110 that the backend handles concurrent access to malloc within its own threads
111 but Emacs code running in the main thread is not included in that control).
113 When UNBLOCK_INPUT is called, reinvoke_input_signal may be called. If this
114 happens in one of the backend threads we will have two threads that tries
115 to run Emacs code at once, and the code is not prepared for that.
116 To prevent that, we only call BLOCK/UNBLOCK from the main thread. */
118 static pthread_mutex_t alloc_mutex
;
120 #define BLOCK_INPUT_ALLOC \
123 if (pthread_equal (pthread_self (), main_thread)) \
125 pthread_mutex_lock (&alloc_mutex); \
128 #define UNBLOCK_INPUT_ALLOC \
131 pthread_mutex_unlock (&alloc_mutex); \
132 if (pthread_equal (pthread_self (), main_thread)) \
137 #else /* ! defined HAVE_PTHREAD */
139 #define BLOCK_INPUT_ALLOC BLOCK_INPUT
140 #define UNBLOCK_INPUT_ALLOC UNBLOCK_INPUT
142 #endif /* ! defined HAVE_PTHREAD */
143 #endif /* ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT */
145 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
146 to a struct Lisp_String. */
148 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
149 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
150 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
152 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
153 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
154 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
156 /* Default value of gc_cons_threshold (see below). */
158 #define GC_DEFAULT_THRESHOLD (100000 * word_size)
160 /* Global variables. */
161 struct emacs_globals globals
;
163 /* Number of bytes of consing done since the last gc. */
165 EMACS_INT consing_since_gc
;
167 /* Similar minimum, computed from Vgc_cons_percentage. */
169 EMACS_INT gc_relative_threshold
;
171 /* Minimum number of bytes of consing since GC before next GC,
172 when memory is full. */
174 EMACS_INT memory_full_cons_threshold
;
176 /* True during GC. */
180 /* True means abort if try to GC.
181 This is for code which is written on the assumption that
182 no GC will happen, so as to verify that assumption. */
186 /* Number of live and free conses etc. */
188 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_buffers
;
189 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
190 static EMACS_INT total_free_floats
, total_floats
;
192 /* Points to memory space allocated as "spare", to be freed if we run
193 out of memory. We keep one large block, four cons-blocks, and
194 two string blocks. */
196 static char *spare_memory
[7];
198 /* Amount of spare memory to keep in large reserve block, or to see
199 whether this much is available when malloc fails on a larger request. */
201 #define SPARE_MEMORY (1 << 14)
203 /* Number of extra blocks malloc should get when it needs more core. */
205 static int malloc_hysteresis
;
207 /* Initialize it to a nonzero value to force it into data space
208 (rather than bss space). That way unexec will remap it into text
209 space (pure), on some systems. We have not implemented the
210 remapping on more recent systems because this is less important
211 nowadays than in the days of small memories and timesharing. */
213 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
214 #define PUREBEG (char *) pure
216 /* Pointer to the pure area, and its size. */
218 static char *purebeg
;
219 static ptrdiff_t pure_size
;
221 /* Number of bytes of pure storage used before pure storage overflowed.
222 If this is non-zero, this implies that an overflow occurred. */
224 static ptrdiff_t pure_bytes_used_before_overflow
;
226 /* True if P points into pure space. */
228 #define PURE_POINTER_P(P) \
229 ((uintptr_t) (P) - (uintptr_t) purebeg <= pure_size)
231 /* Index in pure at which next pure Lisp object will be allocated.. */
233 static ptrdiff_t pure_bytes_used_lisp
;
235 /* Number of bytes allocated for non-Lisp objects in pure storage. */
237 static ptrdiff_t pure_bytes_used_non_lisp
;
239 /* If nonzero, this is a warning delivered by malloc and not yet
242 const char *pending_malloc_warning
;
244 /* Maximum amount of C stack to save when a GC happens. */
246 #ifndef MAX_SAVE_STACK
247 #define MAX_SAVE_STACK 16000
250 /* Buffer in which we save a copy of the C stack at each GC. */
252 #if MAX_SAVE_STACK > 0
253 static char *stack_copy
;
254 static ptrdiff_t stack_copy_size
;
257 static Lisp_Object Qconses
;
258 static Lisp_Object Qsymbols
;
259 static Lisp_Object Qmiscs
;
260 static Lisp_Object Qstrings
;
261 static Lisp_Object Qvectors
;
262 static Lisp_Object Qfloats
;
263 static Lisp_Object Qintervals
;
264 static Lisp_Object Qbuffers
;
265 static Lisp_Object Qstring_bytes
, Qvector_slots
, Qheap
;
266 static Lisp_Object Qgc_cons_threshold
;
267 Lisp_Object Qchar_table_extra_slots
;
269 /* Hook run after GC has finished. */
271 static Lisp_Object Qpost_gc_hook
;
273 static void mark_terminals (void);
274 static void gc_sweep (void);
275 static Lisp_Object
make_pure_vector (ptrdiff_t);
276 static void mark_glyph_matrix (struct glyph_matrix
*);
277 static void mark_face_cache (struct face_cache
*);
278 static void mark_buffer (struct buffer
*);
280 #if !defined REL_ALLOC || defined SYSTEM_MALLOC
281 static void refill_memory_reserve (void);
283 static struct Lisp_String
*allocate_string (void);
284 static void compact_small_strings (void);
285 static void free_large_strings (void);
286 static void sweep_strings (void);
287 static void free_misc (Lisp_Object
);
288 extern Lisp_Object
which_symbols (Lisp_Object
, EMACS_INT
) EXTERNALLY_VISIBLE
;
290 /* When scanning the C stack for live Lisp objects, Emacs keeps track
291 of what memory allocated via lisp_malloc is intended for what
292 purpose. This enumeration specifies the type of memory. */
303 /* We used to keep separate mem_types for subtypes of vectors such as
304 process, hash_table, frame, terminal, and window, but we never made
305 use of the distinction, so it only caused source-code complexity
306 and runtime slowdown. Minor but pointless. */
308 /* Special type to denote vector blocks. */
309 MEM_TYPE_VECTOR_BLOCK
,
310 /* Special type to denote reserved memory. */
314 static void *lisp_malloc (size_t, enum mem_type
);
317 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
319 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
320 #include <stdio.h> /* For fprintf. */
323 /* A unique object in pure space used to make some Lisp objects
324 on free lists recognizable in O(1). */
326 static Lisp_Object Vdead
;
327 #define DEADP(x) EQ (x, Vdead)
329 #ifdef GC_MALLOC_CHECK
331 enum mem_type allocated_mem_type
;
333 #endif /* GC_MALLOC_CHECK */
335 /* A node in the red-black tree describing allocated memory containing
336 Lisp data. Each such block is recorded with its start and end
337 address when it is allocated, and removed from the tree when it
340 A red-black tree is a balanced binary tree with the following
343 1. Every node is either red or black.
344 2. Every leaf is black.
345 3. If a node is red, then both of its children are black.
346 4. Every simple path from a node to a descendant leaf contains
347 the same number of black nodes.
348 5. The root is always black.
350 When nodes are inserted into the tree, or deleted from the tree,
351 the tree is "fixed" so that these properties are always true.
353 A red-black tree with N internal nodes has height at most 2
354 log(N+1). Searches, insertions and deletions are done in O(log N).
355 Please see a text book about data structures for a detailed
356 description of red-black trees. Any book worth its salt should
361 /* Children of this node. These pointers are never NULL. When there
362 is no child, the value is MEM_NIL, which points to a dummy node. */
363 struct mem_node
*left
, *right
;
365 /* The parent of this node. In the root node, this is NULL. */
366 struct mem_node
*parent
;
368 /* Start and end of allocated region. */
372 enum {MEM_BLACK
, MEM_RED
} color
;
378 /* Base address of stack. Set in main. */
380 Lisp_Object
*stack_base
;
382 /* Root of the tree describing allocated Lisp memory. */
384 static struct mem_node
*mem_root
;
386 /* Lowest and highest known address in the heap. */
388 static void *min_heap_address
, *max_heap_address
;
390 /* Sentinel node of the tree. */
392 static struct mem_node mem_z
;
393 #define MEM_NIL &mem_z
395 static struct Lisp_Vector
*allocate_vectorlike (ptrdiff_t);
396 static void lisp_free (void *);
397 static void mark_stack (void);
398 static bool live_vector_p (struct mem_node
*, void *);
399 static bool live_buffer_p (struct mem_node
*, void *);
400 static bool live_string_p (struct mem_node
*, void *);
401 static bool live_cons_p (struct mem_node
*, void *);
402 static bool live_symbol_p (struct mem_node
*, void *);
403 static bool live_float_p (struct mem_node
*, void *);
404 static bool live_misc_p (struct mem_node
*, void *);
405 static void mark_maybe_object (Lisp_Object
);
406 static void mark_memory (void *, void *);
407 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
408 static void mem_init (void);
409 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
410 static void mem_insert_fixup (struct mem_node
*);
412 static void mem_rotate_left (struct mem_node
*);
413 static void mem_rotate_right (struct mem_node
*);
414 static void mem_delete (struct mem_node
*);
415 static void mem_delete_fixup (struct mem_node
*);
416 static inline struct mem_node
*mem_find (void *);
419 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
420 static void check_gcpros (void);
423 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
429 /* Recording what needs to be marked for gc. */
431 struct gcpro
*gcprolist
;
433 /* Addresses of staticpro'd variables. Initialize it to a nonzero
434 value; otherwise some compilers put it into BSS. */
436 #define NSTATICS 0x650
437 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
439 /* Index of next unused slot in staticvec. */
441 static int staticidx
;
443 static void *pure_alloc (size_t, int);
446 /* Value is SZ rounded up to the next multiple of ALIGNMENT.
447 ALIGNMENT must be a power of 2. */
449 #define ALIGN(ptr, ALIGNMENT) \
450 ((void *) (((uintptr_t) (ptr) + (ALIGNMENT) - 1) \
451 & ~ ((ALIGNMENT) - 1)))
455 /************************************************************************
457 ************************************************************************/
459 /* Function malloc calls this if it finds we are near exhausting storage. */
462 malloc_warning (const char *str
)
464 pending_malloc_warning
= str
;
468 /* Display an already-pending malloc warning. */
471 display_malloc_warning (void)
473 call3 (intern ("display-warning"),
475 build_string (pending_malloc_warning
),
476 intern ("emergency"));
477 pending_malloc_warning
= 0;
480 /* Called if we can't allocate relocatable space for a buffer. */
483 buffer_memory_full (ptrdiff_t nbytes
)
485 /* If buffers use the relocating allocator, no need to free
486 spare_memory, because we may have plenty of malloc space left
487 that we could get, and if we don't, the malloc that fails will
488 itself cause spare_memory to be freed. If buffers don't use the
489 relocating allocator, treat this like any other failing
493 memory_full (nbytes
);
496 /* This used to call error, but if we've run out of memory, we could
497 get infinite recursion trying to build the string. */
498 xsignal (Qnil
, Vmemory_signal_data
);
501 /* A common multiple of the positive integers A and B. Ideally this
502 would be the least common multiple, but there's no way to do that
503 as a constant expression in C, so do the best that we can easily do. */
504 #define COMMON_MULTIPLE(a, b) \
505 ((a) % (b) == 0 ? (a) : (b) % (a) == 0 ? (b) : (a) * (b))
507 #ifndef XMALLOC_OVERRUN_CHECK
508 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
511 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
514 The header consists of XMALLOC_OVERRUN_CHECK_SIZE fixed bytes
515 followed by XMALLOC_OVERRUN_SIZE_SIZE bytes containing the original
516 block size in little-endian order. The trailer consists of
517 XMALLOC_OVERRUN_CHECK_SIZE fixed bytes.
519 The header is used to detect whether this block has been allocated
520 through these functions, as some low-level libc functions may
521 bypass the malloc hooks. */
523 #define XMALLOC_OVERRUN_CHECK_SIZE 16
524 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
525 (2 * XMALLOC_OVERRUN_CHECK_SIZE + XMALLOC_OVERRUN_SIZE_SIZE)
527 /* Define XMALLOC_OVERRUN_SIZE_SIZE so that (1) it's large enough to
528 hold a size_t value and (2) the header size is a multiple of the
529 alignment that Emacs needs for C types and for USE_LSB_TAG. */
530 #define XMALLOC_BASE_ALIGNMENT \
531 alignof (union { long double d; intmax_t i; void *p; })
534 # define XMALLOC_HEADER_ALIGNMENT \
535 COMMON_MULTIPLE (GCALIGNMENT, XMALLOC_BASE_ALIGNMENT)
537 # define XMALLOC_HEADER_ALIGNMENT XMALLOC_BASE_ALIGNMENT
539 #define XMALLOC_OVERRUN_SIZE_SIZE \
540 (((XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t) \
541 + XMALLOC_HEADER_ALIGNMENT - 1) \
542 / XMALLOC_HEADER_ALIGNMENT * XMALLOC_HEADER_ALIGNMENT) \
543 - XMALLOC_OVERRUN_CHECK_SIZE)
545 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
546 { '\x9a', '\x9b', '\xae', '\xaf',
547 '\xbf', '\xbe', '\xce', '\xcf',
548 '\xea', '\xeb', '\xec', '\xed',
549 '\xdf', '\xde', '\x9c', '\x9d' };
551 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
552 { '\xaa', '\xab', '\xac', '\xad',
553 '\xba', '\xbb', '\xbc', '\xbd',
554 '\xca', '\xcb', '\xcc', '\xcd',
555 '\xda', '\xdb', '\xdc', '\xdd' };
557 /* Insert and extract the block size in the header. */
560 xmalloc_put_size (unsigned char *ptr
, size_t size
)
563 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
565 *--ptr
= size
& ((1 << CHAR_BIT
) - 1);
571 xmalloc_get_size (unsigned char *ptr
)
575 ptr
-= XMALLOC_OVERRUN_SIZE_SIZE
;
576 for (i
= 0; i
< XMALLOC_OVERRUN_SIZE_SIZE
; i
++)
585 /* The call depth in overrun_check functions. For example, this might happen:
587 overrun_check_malloc()
588 -> malloc -> (via hook)_-> emacs_blocked_malloc
589 -> overrun_check_malloc
590 call malloc (hooks are NULL, so real malloc is called).
591 malloc returns 10000.
592 add overhead, return 10016.
593 <- (back in overrun_check_malloc)
594 add overhead again, return 10032
595 xmalloc returns 10032.
600 overrun_check_free(10032)
602 free(10016) <- crash, because 10000 is the original pointer. */
604 static ptrdiff_t check_depth
;
606 /* Like malloc, but wraps allocated block with header and trailer. */
609 overrun_check_malloc (size_t size
)
611 register unsigned char *val
;
612 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
613 if (SIZE_MAX
- overhead
< size
)
616 val
= malloc (size
+ overhead
);
617 if (val
&& check_depth
== 1)
619 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
620 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
621 xmalloc_put_size (val
, size
);
622 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
623 XMALLOC_OVERRUN_CHECK_SIZE
);
630 /* Like realloc, but checks old block for overrun, and wraps new block
631 with header and trailer. */
634 overrun_check_realloc (void *block
, size_t size
)
636 register unsigned char *val
= (unsigned char *) block
;
637 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
638 if (SIZE_MAX
- overhead
< size
)
643 && memcmp (xmalloc_overrun_check_header
,
644 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
645 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
647 size_t osize
= xmalloc_get_size (val
);
648 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
649 XMALLOC_OVERRUN_CHECK_SIZE
))
651 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
652 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
653 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
656 val
= realloc (val
, size
+ overhead
);
658 if (val
&& check_depth
== 1)
660 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
661 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
662 xmalloc_put_size (val
, size
);
663 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
664 XMALLOC_OVERRUN_CHECK_SIZE
);
670 /* Like free, but checks block for overrun. */
673 overrun_check_free (void *block
)
675 unsigned char *val
= (unsigned char *) block
;
680 && memcmp (xmalloc_overrun_check_header
,
681 val
- XMALLOC_OVERRUN_CHECK_SIZE
- XMALLOC_OVERRUN_SIZE_SIZE
,
682 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
684 size_t osize
= xmalloc_get_size (val
);
685 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
686 XMALLOC_OVERRUN_CHECK_SIZE
))
688 #ifdef XMALLOC_CLEAR_FREE_MEMORY
689 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
690 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
692 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
693 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
;
694 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ XMALLOC_OVERRUN_SIZE_SIZE
);
705 #define malloc overrun_check_malloc
706 #define realloc overrun_check_realloc
707 #define free overrun_check_free
711 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
712 there's no need to block input around malloc. */
713 #define MALLOC_BLOCK_INPUT ((void)0)
714 #define MALLOC_UNBLOCK_INPUT ((void)0)
716 #define MALLOC_BLOCK_INPUT BLOCK_INPUT
717 #define MALLOC_UNBLOCK_INPUT UNBLOCK_INPUT
720 /* Like malloc but check for no memory and block interrupt input.. */
723 xmalloc (size_t size
)
729 MALLOC_UNBLOCK_INPUT
;
736 /* Like the above, but zeroes out the memory just allocated. */
739 xzalloc (size_t size
)
745 MALLOC_UNBLOCK_INPUT
;
749 memset (val
, 0, size
);
753 /* Like realloc but check for no memory and block interrupt input.. */
756 xrealloc (void *block
, size_t size
)
761 /* We must call malloc explicitly when BLOCK is 0, since some
762 reallocs don't do this. */
766 val
= realloc (block
, size
);
767 MALLOC_UNBLOCK_INPUT
;
775 /* Like free but block interrupt input. */
784 MALLOC_UNBLOCK_INPUT
;
785 /* We don't call refill_memory_reserve here
786 because that duplicates doing so in emacs_blocked_free
787 and the criterion should go there. */
791 /* Other parts of Emacs pass large int values to allocator functions
792 expecting ptrdiff_t. This is portable in practice, but check it to
794 verify (INT_MAX
<= PTRDIFF_MAX
);
797 /* Allocate an array of NITEMS items, each of size ITEM_SIZE.
798 Signal an error on memory exhaustion, and block interrupt input. */
801 xnmalloc (ptrdiff_t nitems
, ptrdiff_t item_size
)
803 eassert (0 <= nitems
&& 0 < item_size
);
804 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
805 memory_full (SIZE_MAX
);
806 return xmalloc (nitems
* item_size
);
810 /* Reallocate an array PA to make it of NITEMS items, each of size ITEM_SIZE.
811 Signal an error on memory exhaustion, and block interrupt input. */
814 xnrealloc (void *pa
, ptrdiff_t nitems
, ptrdiff_t item_size
)
816 eassert (0 <= nitems
&& 0 < item_size
);
817 if (min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
< nitems
)
818 memory_full (SIZE_MAX
);
819 return xrealloc (pa
, nitems
* item_size
);
823 /* Grow PA, which points to an array of *NITEMS items, and return the
824 location of the reallocated array, updating *NITEMS to reflect its
825 new size. The new array will contain at least NITEMS_INCR_MIN more
826 items, but will not contain more than NITEMS_MAX items total.
827 ITEM_SIZE is the size of each item, in bytes.
829 ITEM_SIZE and NITEMS_INCR_MIN must be positive. *NITEMS must be
830 nonnegative. If NITEMS_MAX is -1, it is treated as if it were
833 If PA is null, then allocate a new array instead of reallocating
834 the old one. Thus, to grow an array A without saving its old
835 contents, invoke xfree (A) immediately followed by xgrowalloc (0,
838 Block interrupt input as needed. If memory exhaustion occurs, set
839 *NITEMS to zero if PA is null, and signal an error (i.e., do not
843 xpalloc (void *pa
, ptrdiff_t *nitems
, ptrdiff_t nitems_incr_min
,
844 ptrdiff_t nitems_max
, ptrdiff_t item_size
)
846 /* The approximate size to use for initial small allocation
847 requests. This is the largest "small" request for the GNU C
849 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
851 /* If the array is tiny, grow it to about (but no greater than)
852 DEFAULT_MXFAST bytes. Otherwise, grow it by about 50%. */
853 ptrdiff_t n
= *nitems
;
854 ptrdiff_t tiny_max
= DEFAULT_MXFAST
/ item_size
- n
;
855 ptrdiff_t half_again
= n
>> 1;
856 ptrdiff_t incr_estimate
= max (tiny_max
, half_again
);
858 /* Adjust the increment according to three constraints: NITEMS_INCR_MIN,
859 NITEMS_MAX, and what the C language can represent safely. */
860 ptrdiff_t C_language_max
= min (PTRDIFF_MAX
, SIZE_MAX
) / item_size
;
861 ptrdiff_t n_max
= (0 <= nitems_max
&& nitems_max
< C_language_max
862 ? nitems_max
: C_language_max
);
863 ptrdiff_t nitems_incr_max
= n_max
- n
;
864 ptrdiff_t incr
= max (nitems_incr_min
, min (incr_estimate
, nitems_incr_max
));
866 eassert (0 < item_size
&& 0 < nitems_incr_min
&& 0 <= n
&& -1 <= nitems_max
);
869 if (nitems_incr_max
< incr
)
870 memory_full (SIZE_MAX
);
872 pa
= xrealloc (pa
, n
* item_size
);
878 /* Like strdup, but uses xmalloc. */
881 xstrdup (const char *s
)
883 size_t len
= strlen (s
) + 1;
884 char *p
= xmalloc (len
);
890 /* Unwind for SAFE_ALLOCA */
893 safe_alloca_unwind (Lisp_Object arg
)
895 register struct Lisp_Save_Value
*p
= XSAVE_VALUE (arg
);
904 /* Return a newly allocated memory block of SIZE bytes, remembering
905 to free it when unwinding. */
907 record_xmalloc (size_t size
)
909 void *p
= xmalloc (size
);
910 record_unwind_protect (safe_alloca_unwind
, make_save_value (p
, 0));
915 /* Like malloc but used for allocating Lisp data. NBYTES is the
916 number of bytes to allocate, TYPE describes the intended use of the
917 allocated memory block (for strings, for conses, ...). */
920 void *lisp_malloc_loser EXTERNALLY_VISIBLE
;
924 lisp_malloc (size_t nbytes
, enum mem_type type
)
930 #ifdef GC_MALLOC_CHECK
931 allocated_mem_type
= type
;
934 val
= malloc (nbytes
);
937 /* If the memory just allocated cannot be addressed thru a Lisp
938 object's pointer, and it needs to be,
939 that's equivalent to running out of memory. */
940 if (val
&& type
!= MEM_TYPE_NON_LISP
)
943 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
944 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
946 lisp_malloc_loser
= val
;
953 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
954 if (val
&& type
!= MEM_TYPE_NON_LISP
)
955 mem_insert (val
, (char *) val
+ nbytes
, type
);
958 MALLOC_UNBLOCK_INPUT
;
960 memory_full (nbytes
);
964 /* Free BLOCK. This must be called to free memory allocated with a
965 call to lisp_malloc. */
968 lisp_free (void *block
)
972 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
973 mem_delete (mem_find (block
));
975 MALLOC_UNBLOCK_INPUT
;
978 /***** Allocation of aligned blocks of memory to store Lisp data. *****/
980 /* The entry point is lisp_align_malloc which returns blocks of at most
981 BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
983 #if defined (HAVE_POSIX_MEMALIGN) && defined (SYSTEM_MALLOC)
984 #define USE_POSIX_MEMALIGN 1
987 /* BLOCK_ALIGN has to be a power of 2. */
988 #define BLOCK_ALIGN (1 << 10)
990 /* Padding to leave at the end of a malloc'd block. This is to give
991 malloc a chance to minimize the amount of memory wasted to alignment.
992 It should be tuned to the particular malloc library used.
993 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
994 posix_memalign on the other hand would ideally prefer a value of 4
995 because otherwise, there's 1020 bytes wasted between each ablocks.
996 In Emacs, testing shows that those 1020 can most of the time be
997 efficiently used by malloc to place other objects, so a value of 0 can
998 still preferable unless you have a lot of aligned blocks and virtually
1000 #define BLOCK_PADDING 0
1001 #define BLOCK_BYTES \
1002 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
1004 /* Internal data structures and constants. */
1006 #define ABLOCKS_SIZE 16
1008 /* An aligned block of memory. */
1013 char payload
[BLOCK_BYTES
];
1014 struct ablock
*next_free
;
1016 /* `abase' is the aligned base of the ablocks. */
1017 /* It is overloaded to hold the virtual `busy' field that counts
1018 the number of used ablock in the parent ablocks.
1019 The first ablock has the `busy' field, the others have the `abase'
1020 field. To tell the difference, we assume that pointers will have
1021 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
1022 is used to tell whether the real base of the parent ablocks is `abase'
1023 (if not, the word before the first ablock holds a pointer to the
1025 struct ablocks
*abase
;
1026 /* The padding of all but the last ablock is unused. The padding of
1027 the last ablock in an ablocks is not allocated. */
1029 char padding
[BLOCK_PADDING
];
1033 /* A bunch of consecutive aligned blocks. */
1036 struct ablock blocks
[ABLOCKS_SIZE
];
1039 /* Size of the block requested from malloc or posix_memalign. */
1040 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
1042 #define ABLOCK_ABASE(block) \
1043 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
1044 ? (struct ablocks *)(block) \
1047 /* Virtual `busy' field. */
1048 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
1050 /* Pointer to the (not necessarily aligned) malloc block. */
1051 #ifdef USE_POSIX_MEMALIGN
1052 #define ABLOCKS_BASE(abase) (abase)
1054 #define ABLOCKS_BASE(abase) \
1055 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void**)abase)[-1])
1058 /* The list of free ablock. */
1059 static struct ablock
*free_ablock
;
1061 /* Allocate an aligned block of nbytes.
1062 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
1063 smaller or equal to BLOCK_BYTES. */
1065 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
1068 struct ablocks
*abase
;
1070 eassert (nbytes
<= BLOCK_BYTES
);
1074 #ifdef GC_MALLOC_CHECK
1075 allocated_mem_type
= type
;
1081 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
1083 #ifdef DOUG_LEA_MALLOC
1084 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1085 because mapped region contents are not preserved in
1087 mallopt (M_MMAP_MAX
, 0);
1090 #ifdef USE_POSIX_MEMALIGN
1092 int err
= posix_memalign (&base
, BLOCK_ALIGN
, ABLOCKS_BYTES
);
1098 base
= malloc (ABLOCKS_BYTES
);
1099 abase
= ALIGN (base
, BLOCK_ALIGN
);
1104 MALLOC_UNBLOCK_INPUT
;
1105 memory_full (ABLOCKS_BYTES
);
1108 aligned
= (base
== abase
);
1110 ((void**)abase
)[-1] = base
;
1112 #ifdef DOUG_LEA_MALLOC
1113 /* Back to a reasonable maximum of mmap'ed areas. */
1114 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1118 /* If the memory just allocated cannot be addressed thru a Lisp
1119 object's pointer, and it needs to be, that's equivalent to
1120 running out of memory. */
1121 if (type
!= MEM_TYPE_NON_LISP
)
1124 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1125 XSETCONS (tem
, end
);
1126 if ((char *) XCONS (tem
) != end
)
1128 lisp_malloc_loser
= base
;
1130 MALLOC_UNBLOCK_INPUT
;
1131 memory_full (SIZE_MAX
);
1136 /* Initialize the blocks and put them on the free list.
1137 If `base' was not properly aligned, we can't use the last block. */
1138 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1140 abase
->blocks
[i
].abase
= abase
;
1141 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1142 free_ablock
= &abase
->blocks
[i
];
1144 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
1146 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
1147 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1148 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1149 eassert (ABLOCKS_BASE (abase
) == base
);
1150 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1153 abase
= ABLOCK_ABASE (free_ablock
);
1154 ABLOCKS_BUSY (abase
) =
1155 (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1157 free_ablock
= free_ablock
->x
.next_free
;
1159 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1160 if (type
!= MEM_TYPE_NON_LISP
)
1161 mem_insert (val
, (char *) val
+ nbytes
, type
);
1164 MALLOC_UNBLOCK_INPUT
;
1166 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1171 lisp_align_free (void *block
)
1173 struct ablock
*ablock
= block
;
1174 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1177 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1178 mem_delete (mem_find (block
));
1180 /* Put on free list. */
1181 ablock
->x
.next_free
= free_ablock
;
1182 free_ablock
= ablock
;
1183 /* Update busy count. */
1184 ABLOCKS_BUSY (abase
)
1185 = (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1187 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1188 { /* All the blocks are free. */
1189 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1190 struct ablock
**tem
= &free_ablock
;
1191 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1195 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1198 *tem
= (*tem
)->x
.next_free
;
1201 tem
= &(*tem
)->x
.next_free
;
1203 eassert ((aligned
& 1) == aligned
);
1204 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1205 #ifdef USE_POSIX_MEMALIGN
1206 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1208 free (ABLOCKS_BASE (abase
));
1210 MALLOC_UNBLOCK_INPUT
;
1214 #ifndef SYSTEM_MALLOC
1216 /* Arranging to disable input signals while we're in malloc.
1218 This only works with GNU malloc. To help out systems which can't
1219 use GNU malloc, all the calls to malloc, realloc, and free
1220 elsewhere in the code should be inside a BLOCK_INPUT/UNBLOCK_INPUT
1221 pair; unfortunately, we have no idea what C library functions
1222 might call malloc, so we can't really protect them unless you're
1223 using GNU malloc. Fortunately, most of the major operating systems
1224 can use GNU malloc. */
1227 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
1228 there's no need to block input around malloc. */
1230 #ifndef DOUG_LEA_MALLOC
1231 extern void * (*__malloc_hook
) (size_t, const void *);
1232 extern void * (*__realloc_hook
) (void *, size_t, const void *);
1233 extern void (*__free_hook
) (void *, const void *);
1234 /* Else declared in malloc.h, perhaps with an extra arg. */
1235 #endif /* DOUG_LEA_MALLOC */
1236 static void * (*old_malloc_hook
) (size_t, const void *);
1237 static void * (*old_realloc_hook
) (void *, size_t, const void*);
1238 static void (*old_free_hook
) (void*, const void*);
1240 #ifdef DOUG_LEA_MALLOC
1241 # define BYTES_USED (mallinfo ().uordblks)
1243 # define BYTES_USED _bytes_used
1246 #ifdef GC_MALLOC_CHECK
1247 static bool dont_register_blocks
;
1250 static size_t bytes_used_when_reconsidered
;
1252 /* Value of _bytes_used, when spare_memory was freed. */
1254 static size_t bytes_used_when_full
;
1256 /* This function is used as the hook for free to call. */
1259 emacs_blocked_free (void *ptr
, const void *ptr2
)
1263 #ifdef GC_MALLOC_CHECK
1269 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1272 "Freeing `%p' which wasn't allocated with malloc\n", ptr
);
1277 /* fprintf (stderr, "free %p...%p (%p)\n", m->start, m->end, ptr); */
1281 #endif /* GC_MALLOC_CHECK */
1283 __free_hook
= old_free_hook
;
1286 /* If we released our reserve (due to running out of memory),
1287 and we have a fair amount free once again,
1288 try to set aside another reserve in case we run out once more. */
1289 if (! NILP (Vmemory_full
)
1290 /* Verify there is enough space that even with the malloc
1291 hysteresis this call won't run out again.
1292 The code here is correct as long as SPARE_MEMORY
1293 is substantially larger than the block size malloc uses. */
1294 && (bytes_used_when_full
1295 > ((bytes_used_when_reconsidered
= BYTES_USED
)
1296 + max (malloc_hysteresis
, 4) * SPARE_MEMORY
)))
1297 refill_memory_reserve ();
1299 __free_hook
= emacs_blocked_free
;
1300 UNBLOCK_INPUT_ALLOC
;
1304 /* This function is the malloc hook that Emacs uses. */
1307 emacs_blocked_malloc (size_t size
, const void *ptr
)
1312 __malloc_hook
= old_malloc_hook
;
1313 #ifdef DOUG_LEA_MALLOC
1314 /* Segfaults on my system. --lorentey */
1315 /* mallopt (M_TOP_PAD, malloc_hysteresis * 4096); */
1317 __malloc_extra_blocks
= malloc_hysteresis
;
1320 value
= malloc (size
);
1322 #ifdef GC_MALLOC_CHECK
1324 struct mem_node
*m
= mem_find (value
);
1327 fprintf (stderr
, "Malloc returned %p which is already in use\n",
1329 fprintf (stderr
, "Region in use is %p...%p, %td bytes, type %d\n",
1330 m
->start
, m
->end
, (char *) m
->end
- (char *) m
->start
,
1335 if (!dont_register_blocks
)
1337 mem_insert (value
, (char *) value
+ max (1, size
), allocated_mem_type
);
1338 allocated_mem_type
= MEM_TYPE_NON_LISP
;
1341 #endif /* GC_MALLOC_CHECK */
1343 __malloc_hook
= emacs_blocked_malloc
;
1344 UNBLOCK_INPUT_ALLOC
;
1346 /* fprintf (stderr, "%p malloc\n", value); */
1351 /* This function is the realloc hook that Emacs uses. */
1354 emacs_blocked_realloc (void *ptr
, size_t size
, const void *ptr2
)
1359 __realloc_hook
= old_realloc_hook
;
1361 #ifdef GC_MALLOC_CHECK
1364 struct mem_node
*m
= mem_find (ptr
);
1365 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1368 "Realloc of %p which wasn't allocated with malloc\n",
1376 /* fprintf (stderr, "%p -> realloc\n", ptr); */
1378 /* Prevent malloc from registering blocks. */
1379 dont_register_blocks
= 1;
1380 #endif /* GC_MALLOC_CHECK */
1382 value
= realloc (ptr
, size
);
1384 #ifdef GC_MALLOC_CHECK
1385 dont_register_blocks
= 0;
1388 struct mem_node
*m
= mem_find (value
);
1391 fprintf (stderr
, "Realloc returns memory that is already in use\n");
1395 /* Can't handle zero size regions in the red-black tree. */
1396 mem_insert (value
, (char *) value
+ max (size
, 1), MEM_TYPE_NON_LISP
);
1399 /* fprintf (stderr, "%p <- realloc\n", value); */
1400 #endif /* GC_MALLOC_CHECK */
1402 __realloc_hook
= emacs_blocked_realloc
;
1403 UNBLOCK_INPUT_ALLOC
;
1410 /* Called from Fdump_emacs so that when the dumped Emacs starts, it has a
1411 normal malloc. Some thread implementations need this as they call
1412 malloc before main. The pthread_self call in BLOCK_INPUT_ALLOC then
1413 calls malloc because it is the first call, and we have an endless loop. */
1416 reset_malloc_hooks (void)
1418 __free_hook
= old_free_hook
;
1419 __malloc_hook
= old_malloc_hook
;
1420 __realloc_hook
= old_realloc_hook
;
1422 #endif /* HAVE_PTHREAD */
1425 /* Called from main to set up malloc to use our hooks. */
1428 uninterrupt_malloc (void)
1431 #ifdef DOUG_LEA_MALLOC
1432 pthread_mutexattr_t attr
;
1434 /* GLIBC has a faster way to do this, but let's keep it portable.
1435 This is according to the Single UNIX Specification. */
1436 pthread_mutexattr_init (&attr
);
1437 pthread_mutexattr_settype (&attr
, PTHREAD_MUTEX_RECURSIVE
);
1438 pthread_mutex_init (&alloc_mutex
, &attr
);
1439 #else /* !DOUG_LEA_MALLOC */
1440 /* Some systems such as Solaris 2.6 don't have a recursive mutex,
1441 and the bundled gmalloc.c doesn't require it. */
1442 pthread_mutex_init (&alloc_mutex
, NULL
);
1443 #endif /* !DOUG_LEA_MALLOC */
1444 #endif /* HAVE_PTHREAD */
1446 if (__free_hook
!= emacs_blocked_free
)
1447 old_free_hook
= __free_hook
;
1448 __free_hook
= emacs_blocked_free
;
1450 if (__malloc_hook
!= emacs_blocked_malloc
)
1451 old_malloc_hook
= __malloc_hook
;
1452 __malloc_hook
= emacs_blocked_malloc
;
1454 if (__realloc_hook
!= emacs_blocked_realloc
)
1455 old_realloc_hook
= __realloc_hook
;
1456 __realloc_hook
= emacs_blocked_realloc
;
1459 #endif /* not SYNC_INPUT */
1460 #endif /* not SYSTEM_MALLOC */
1464 /***********************************************************************
1466 ***********************************************************************/
1468 /* Number of intervals allocated in an interval_block structure.
1469 The 1020 is 1024 minus malloc overhead. */
1471 #define INTERVAL_BLOCK_SIZE \
1472 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1474 /* Intervals are allocated in chunks in form of an interval_block
1477 struct interval_block
1479 /* Place `intervals' first, to preserve alignment. */
1480 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1481 struct interval_block
*next
;
1484 /* Current interval block. Its `next' pointer points to older
1487 static struct interval_block
*interval_block
;
1489 /* Index in interval_block above of the next unused interval
1492 static int interval_block_index
= INTERVAL_BLOCK_SIZE
;
1494 /* Number of free and live intervals. */
1496 static EMACS_INT total_free_intervals
, total_intervals
;
1498 /* List of free intervals. */
1500 static INTERVAL interval_free_list
;
1502 /* Return a new interval. */
1505 make_interval (void)
1509 /* eassert (!handling_signal); */
1513 if (interval_free_list
)
1515 val
= interval_free_list
;
1516 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1520 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1522 struct interval_block
*newi
1523 = lisp_malloc (sizeof *newi
, MEM_TYPE_NON_LISP
);
1525 newi
->next
= interval_block
;
1526 interval_block
= newi
;
1527 interval_block_index
= 0;
1528 total_free_intervals
+= INTERVAL_BLOCK_SIZE
;
1530 val
= &interval_block
->intervals
[interval_block_index
++];
1533 MALLOC_UNBLOCK_INPUT
;
1535 consing_since_gc
+= sizeof (struct interval
);
1537 total_free_intervals
--;
1538 RESET_INTERVAL (val
);
1544 /* Mark Lisp objects in interval I. */
1547 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1549 /* Intervals should never be shared. So, if extra internal checking is
1550 enabled, GC aborts if it seems to have visited an interval twice. */
1551 eassert (!i
->gcmarkbit
);
1553 mark_object (i
->plist
);
1556 /* Mark the interval tree rooted in I. */
1558 #define MARK_INTERVAL_TREE(i) \
1560 if (i && !i->gcmarkbit) \
1561 traverse_intervals_noorder (i, mark_interval, Qnil); \
1564 /***********************************************************************
1566 ***********************************************************************/
1568 /* Lisp_Strings are allocated in string_block structures. When a new
1569 string_block is allocated, all the Lisp_Strings it contains are
1570 added to a free-list string_free_list. When a new Lisp_String is
1571 needed, it is taken from that list. During the sweep phase of GC,
1572 string_blocks that are entirely free are freed, except two which
1575 String data is allocated from sblock structures. Strings larger
1576 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1577 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1579 Sblocks consist internally of sdata structures, one for each
1580 Lisp_String. The sdata structure points to the Lisp_String it
1581 belongs to. The Lisp_String points back to the `u.data' member of
1582 its sdata structure.
1584 When a Lisp_String is freed during GC, it is put back on
1585 string_free_list, and its `data' member and its sdata's `string'
1586 pointer is set to null. The size of the string is recorded in the
1587 `u.nbytes' member of the sdata. So, sdata structures that are no
1588 longer used, can be easily recognized, and it's easy to compact the
1589 sblocks of small strings which we do in compact_small_strings. */
1591 /* Size in bytes of an sblock structure used for small strings. This
1592 is 8192 minus malloc overhead. */
1594 #define SBLOCK_SIZE 8188
1596 /* Strings larger than this are considered large strings. String data
1597 for large strings is allocated from individual sblocks. */
1599 #define LARGE_STRING_BYTES 1024
1601 /* Structure describing string memory sub-allocated from an sblock.
1602 This is where the contents of Lisp strings are stored. */
1606 /* Back-pointer to the string this sdata belongs to. If null, this
1607 structure is free, and the NBYTES member of the union below
1608 contains the string's byte size (the same value that STRING_BYTES
1609 would return if STRING were non-null). If non-null, STRING_BYTES
1610 (STRING) is the size of the data, and DATA contains the string's
1612 struct Lisp_String
*string
;
1614 #ifdef GC_CHECK_STRING_BYTES
1617 unsigned char data
[1];
1619 #define SDATA_NBYTES(S) (S)->nbytes
1620 #define SDATA_DATA(S) (S)->data
1621 #define SDATA_SELECTOR(member) member
1623 #else /* not GC_CHECK_STRING_BYTES */
1627 /* When STRING is non-null. */
1628 unsigned char data
[1];
1630 /* When STRING is null. */
1634 #define SDATA_NBYTES(S) (S)->u.nbytes
1635 #define SDATA_DATA(S) (S)->u.data
1636 #define SDATA_SELECTOR(member) u.member
1638 #endif /* not GC_CHECK_STRING_BYTES */
1640 #define SDATA_DATA_OFFSET offsetof (struct sdata, SDATA_SELECTOR (data))
1644 /* Structure describing a block of memory which is sub-allocated to
1645 obtain string data memory for strings. Blocks for small strings
1646 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1647 as large as needed. */
1652 struct sblock
*next
;
1654 /* Pointer to the next free sdata block. This points past the end
1655 of the sblock if there isn't any space left in this block. */
1656 struct sdata
*next_free
;
1658 /* Start of data. */
1659 struct sdata first_data
;
1662 /* Number of Lisp strings in a string_block structure. The 1020 is
1663 1024 minus malloc overhead. */
1665 #define STRING_BLOCK_SIZE \
1666 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1668 /* Structure describing a block from which Lisp_String structures
1673 /* Place `strings' first, to preserve alignment. */
1674 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1675 struct string_block
*next
;
1678 /* Head and tail of the list of sblock structures holding Lisp string
1679 data. We always allocate from current_sblock. The NEXT pointers
1680 in the sblock structures go from oldest_sblock to current_sblock. */
1682 static struct sblock
*oldest_sblock
, *current_sblock
;
1684 /* List of sblocks for large strings. */
1686 static struct sblock
*large_sblocks
;
1688 /* List of string_block structures. */
1690 static struct string_block
*string_blocks
;
1692 /* Free-list of Lisp_Strings. */
1694 static struct Lisp_String
*string_free_list
;
1696 /* Number of live and free Lisp_Strings. */
1698 static EMACS_INT total_strings
, total_free_strings
;
1700 /* Number of bytes used by live strings. */
1702 static EMACS_INT total_string_bytes
;
1704 /* Given a pointer to a Lisp_String S which is on the free-list
1705 string_free_list, return a pointer to its successor in the
1708 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1710 /* Return a pointer to the sdata structure belonging to Lisp string S.
1711 S must be live, i.e. S->data must not be null. S->data is actually
1712 a pointer to the `u.data' member of its sdata structure; the
1713 structure starts at a constant offset in front of that. */
1715 #define SDATA_OF_STRING(S) ((struct sdata *) ((S)->data - SDATA_DATA_OFFSET))
1718 #ifdef GC_CHECK_STRING_OVERRUN
1720 /* We check for overrun in string data blocks by appending a small
1721 "cookie" after each allocated string data block, and check for the
1722 presence of this cookie during GC. */
1724 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1725 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1726 { '\xde', '\xad', '\xbe', '\xef' };
1729 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1732 /* Value is the size of an sdata structure large enough to hold NBYTES
1733 bytes of string data. The value returned includes a terminating
1734 NUL byte, the size of the sdata structure, and padding. */
1736 #ifdef GC_CHECK_STRING_BYTES
1738 #define SDATA_SIZE(NBYTES) \
1739 ((SDATA_DATA_OFFSET \
1741 + sizeof (ptrdiff_t) - 1) \
1742 & ~(sizeof (ptrdiff_t) - 1))
1744 #else /* not GC_CHECK_STRING_BYTES */
1746 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1747 less than the size of that member. The 'max' is not needed when
1748 SDATA_DATA_OFFSET is a multiple of sizeof (ptrdiff_t), because then the
1749 alignment code reserves enough space. */
1751 #define SDATA_SIZE(NBYTES) \
1752 ((SDATA_DATA_OFFSET \
1753 + (SDATA_DATA_OFFSET % sizeof (ptrdiff_t) == 0 \
1755 : max (NBYTES, sizeof (ptrdiff_t) - 1)) \
1757 + sizeof (ptrdiff_t) - 1) \
1758 & ~(sizeof (ptrdiff_t) - 1))
1760 #endif /* not GC_CHECK_STRING_BYTES */
1762 /* Extra bytes to allocate for each string. */
1764 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1766 /* Exact bound on the number of bytes in a string, not counting the
1767 terminating null. A string cannot contain more bytes than
1768 STRING_BYTES_BOUND, nor can it be so long that the size_t
1769 arithmetic in allocate_string_data would overflow while it is
1770 calculating a value to be passed to malloc. */
1771 static ptrdiff_t const STRING_BYTES_MAX
=
1772 min (STRING_BYTES_BOUND
,
1773 ((SIZE_MAX
- XMALLOC_OVERRUN_CHECK_OVERHEAD
1775 - offsetof (struct sblock
, first_data
)
1776 - SDATA_DATA_OFFSET
)
1777 & ~(sizeof (EMACS_INT
) - 1)));
1779 /* Initialize string allocation. Called from init_alloc_once. */
1784 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1785 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1789 #ifdef GC_CHECK_STRING_BYTES
1791 static int check_string_bytes_count
;
1793 /* Like STRING_BYTES, but with debugging check. Can be
1794 called during GC, so pay attention to the mark bit. */
1797 string_bytes (struct Lisp_String
*s
)
1800 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1802 if (!PURE_POINTER_P (s
)
1804 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1809 /* Check validity of Lisp strings' string_bytes member in B. */
1812 check_sblock (struct sblock
*b
)
1814 struct sdata
*from
, *end
, *from_end
;
1818 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1820 /* Compute the next FROM here because copying below may
1821 overwrite data we need to compute it. */
1824 /* Check that the string size recorded in the string is the
1825 same as the one recorded in the sdata structure. */
1826 nbytes
= SDATA_SIZE (from
->string
? string_bytes (from
->string
)
1827 : SDATA_NBYTES (from
));
1828 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1833 /* Check validity of Lisp strings' string_bytes member. ALL_P
1834 means check all strings, otherwise check only most
1835 recently allocated strings. Used for hunting a bug. */
1838 check_string_bytes (bool all_p
)
1844 for (b
= large_sblocks
; b
; b
= b
->next
)
1846 struct Lisp_String
*s
= b
->first_data
.string
;
1851 for (b
= oldest_sblock
; b
; b
= b
->next
)
1854 else if (current_sblock
)
1855 check_sblock (current_sblock
);
1858 #else /* not GC_CHECK_STRING_BYTES */
1860 #define check_string_bytes(all) ((void) 0)
1862 #endif /* GC_CHECK_STRING_BYTES */
1864 #ifdef GC_CHECK_STRING_FREE_LIST
1866 /* Walk through the string free list looking for bogus next pointers.
1867 This may catch buffer overrun from a previous string. */
1870 check_string_free_list (void)
1872 struct Lisp_String
*s
;
1874 /* Pop a Lisp_String off the free-list. */
1875 s
= string_free_list
;
1878 if ((uintptr_t) s
< 1024)
1880 s
= NEXT_FREE_LISP_STRING (s
);
1884 #define check_string_free_list()
1887 /* Return a new Lisp_String. */
1889 static struct Lisp_String
*
1890 allocate_string (void)
1892 struct Lisp_String
*s
;
1894 /* eassert (!handling_signal); */
1898 /* If the free-list is empty, allocate a new string_block, and
1899 add all the Lisp_Strings in it to the free-list. */
1900 if (string_free_list
== NULL
)
1902 struct string_block
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1905 b
->next
= string_blocks
;
1908 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1911 /* Every string on a free list should have NULL data pointer. */
1913 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1914 string_free_list
= s
;
1917 total_free_strings
+= STRING_BLOCK_SIZE
;
1920 check_string_free_list ();
1922 /* Pop a Lisp_String off the free-list. */
1923 s
= string_free_list
;
1924 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1926 MALLOC_UNBLOCK_INPUT
;
1928 --total_free_strings
;
1931 consing_since_gc
+= sizeof *s
;
1933 #ifdef GC_CHECK_STRING_BYTES
1934 if (!noninteractive
)
1936 if (++check_string_bytes_count
== 200)
1938 check_string_bytes_count
= 0;
1939 check_string_bytes (1);
1942 check_string_bytes (0);
1944 #endif /* GC_CHECK_STRING_BYTES */
1950 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1951 plus a NUL byte at the end. Allocate an sdata structure for S, and
1952 set S->data to its `u.data' member. Store a NUL byte at the end of
1953 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1954 S->data if it was initially non-null. */
1957 allocate_string_data (struct Lisp_String
*s
,
1958 EMACS_INT nchars
, EMACS_INT nbytes
)
1960 struct sdata
*data
, *old_data
;
1962 ptrdiff_t needed
, old_nbytes
;
1964 if (STRING_BYTES_MAX
< nbytes
)
1967 /* Determine the number of bytes needed to store NBYTES bytes
1969 needed
= SDATA_SIZE (nbytes
);
1972 old_data
= SDATA_OF_STRING (s
);
1973 old_nbytes
= STRING_BYTES (s
);
1980 if (nbytes
> LARGE_STRING_BYTES
)
1982 size_t size
= offsetof (struct sblock
, first_data
) + needed
;
1984 #ifdef DOUG_LEA_MALLOC
1985 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1986 because mapped region contents are not preserved in
1989 In case you think of allowing it in a dumped Emacs at the
1990 cost of not being able to re-dump, there's another reason:
1991 mmap'ed data typically have an address towards the top of the
1992 address space, which won't fit into an EMACS_INT (at least on
1993 32-bit systems with the current tagging scheme). --fx */
1994 mallopt (M_MMAP_MAX
, 0);
1997 b
= lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
1999 #ifdef DOUG_LEA_MALLOC
2000 /* Back to a reasonable maximum of mmap'ed areas. */
2001 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2004 b
->next_free
= &b
->first_data
;
2005 b
->first_data
.string
= NULL
;
2006 b
->next
= large_sblocks
;
2009 else if (current_sblock
== NULL
2010 || (((char *) current_sblock
+ SBLOCK_SIZE
2011 - (char *) current_sblock
->next_free
)
2012 < (needed
+ GC_STRING_EXTRA
)))
2014 /* Not enough room in the current sblock. */
2015 b
= lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
2016 b
->next_free
= &b
->first_data
;
2017 b
->first_data
.string
= NULL
;
2021 current_sblock
->next
= b
;
2029 data
= b
->next_free
;
2030 b
->next_free
= (struct sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
2032 MALLOC_UNBLOCK_INPUT
;
2035 s
->data
= SDATA_DATA (data
);
2036 #ifdef GC_CHECK_STRING_BYTES
2037 SDATA_NBYTES (data
) = nbytes
;
2040 s
->size_byte
= nbytes
;
2041 s
->data
[nbytes
] = '\0';
2042 #ifdef GC_CHECK_STRING_OVERRUN
2043 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
2044 GC_STRING_OVERRUN_COOKIE_SIZE
);
2047 /* Note that Faset may call to this function when S has already data
2048 assigned. In this case, mark data as free by setting it's string
2049 back-pointer to null, and record the size of the data in it. */
2052 SDATA_NBYTES (old_data
) = old_nbytes
;
2053 old_data
->string
= NULL
;
2056 consing_since_gc
+= needed
;
2060 /* Sweep and compact strings. */
2063 sweep_strings (void)
2065 struct string_block
*b
, *next
;
2066 struct string_block
*live_blocks
= NULL
;
2068 string_free_list
= NULL
;
2069 total_strings
= total_free_strings
= 0;
2070 total_string_bytes
= 0;
2072 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
2073 for (b
= string_blocks
; b
; b
= next
)
2076 struct Lisp_String
*free_list_before
= string_free_list
;
2080 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
2082 struct Lisp_String
*s
= b
->strings
+ i
;
2086 /* String was not on free-list before. */
2087 if (STRING_MARKED_P (s
))
2089 /* String is live; unmark it and its intervals. */
2092 /* Do not use string_(set|get)_intervals here. */
2093 s
->intervals
= balance_intervals (s
->intervals
);
2096 total_string_bytes
+= STRING_BYTES (s
);
2100 /* String is dead. Put it on the free-list. */
2101 struct sdata
*data
= SDATA_OF_STRING (s
);
2103 /* Save the size of S in its sdata so that we know
2104 how large that is. Reset the sdata's string
2105 back-pointer so that we know it's free. */
2106 #ifdef GC_CHECK_STRING_BYTES
2107 if (string_bytes (s
) != SDATA_NBYTES (data
))
2110 data
->u
.nbytes
= STRING_BYTES (s
);
2112 data
->string
= NULL
;
2114 /* Reset the strings's `data' member so that we
2118 /* Put the string on the free-list. */
2119 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2120 string_free_list
= s
;
2126 /* S was on the free-list before. Put it there again. */
2127 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2128 string_free_list
= s
;
2133 /* Free blocks that contain free Lisp_Strings only, except
2134 the first two of them. */
2135 if (nfree
== STRING_BLOCK_SIZE
2136 && total_free_strings
> STRING_BLOCK_SIZE
)
2139 string_free_list
= free_list_before
;
2143 total_free_strings
+= nfree
;
2144 b
->next
= live_blocks
;
2149 check_string_free_list ();
2151 string_blocks
= live_blocks
;
2152 free_large_strings ();
2153 compact_small_strings ();
2155 check_string_free_list ();
2159 /* Free dead large strings. */
2162 free_large_strings (void)
2164 struct sblock
*b
, *next
;
2165 struct sblock
*live_blocks
= NULL
;
2167 for (b
= large_sblocks
; b
; b
= next
)
2171 if (b
->first_data
.string
== NULL
)
2175 b
->next
= live_blocks
;
2180 large_sblocks
= live_blocks
;
2184 /* Compact data of small strings. Free sblocks that don't contain
2185 data of live strings after compaction. */
2188 compact_small_strings (void)
2190 struct sblock
*b
, *tb
, *next
;
2191 struct sdata
*from
, *to
, *end
, *tb_end
;
2192 struct sdata
*to_end
, *from_end
;
2194 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2195 to, and TB_END is the end of TB. */
2197 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2198 to
= &tb
->first_data
;
2200 /* Step through the blocks from the oldest to the youngest. We
2201 expect that old blocks will stabilize over time, so that less
2202 copying will happen this way. */
2203 for (b
= oldest_sblock
; b
; b
= b
->next
)
2206 eassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2208 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
2210 /* Compute the next FROM here because copying below may
2211 overwrite data we need to compute it. */
2213 struct Lisp_String
*s
= from
->string
;
2215 #ifdef GC_CHECK_STRING_BYTES
2216 /* Check that the string size recorded in the string is the
2217 same as the one recorded in the sdata structure. */
2218 if (s
&& string_bytes (s
) != SDATA_NBYTES (from
))
2220 #endif /* GC_CHECK_STRING_BYTES */
2222 nbytes
= s
? STRING_BYTES (s
) : SDATA_NBYTES (from
);
2223 eassert (nbytes
<= LARGE_STRING_BYTES
);
2225 nbytes
= SDATA_SIZE (nbytes
);
2226 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2228 #ifdef GC_CHECK_STRING_OVERRUN
2229 if (memcmp (string_overrun_cookie
,
2230 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2231 GC_STRING_OVERRUN_COOKIE_SIZE
))
2235 /* Non-NULL S means it's alive. Copy its data. */
2238 /* If TB is full, proceed with the next sblock. */
2239 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2240 if (to_end
> tb_end
)
2244 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2245 to
= &tb
->first_data
;
2246 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2249 /* Copy, and update the string's `data' pointer. */
2252 eassert (tb
!= b
|| to
< from
);
2253 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2254 to
->string
->data
= SDATA_DATA (to
);
2257 /* Advance past the sdata we copied to. */
2263 /* The rest of the sblocks following TB don't contain live data, so
2264 we can free them. */
2265 for (b
= tb
->next
; b
; b
= next
)
2273 current_sblock
= tb
;
2277 string_overflow (void)
2279 error ("Maximum string size exceeded");
2282 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2283 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2284 LENGTH must be an integer.
2285 INIT must be an integer that represents a character. */)
2286 (Lisp_Object length
, Lisp_Object init
)
2288 register Lisp_Object val
;
2289 register unsigned char *p
, *end
;
2293 CHECK_NATNUM (length
);
2294 CHECK_CHARACTER (init
);
2296 c
= XFASTINT (init
);
2297 if (ASCII_CHAR_P (c
))
2299 nbytes
= XINT (length
);
2300 val
= make_uninit_string (nbytes
);
2302 end
= p
+ SCHARS (val
);
2308 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2309 int len
= CHAR_STRING (c
, str
);
2310 EMACS_INT string_len
= XINT (length
);
2312 if (string_len
> STRING_BYTES_MAX
/ len
)
2314 nbytes
= len
* string_len
;
2315 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2320 memcpy (p
, str
, len
);
2330 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2331 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2332 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2333 (Lisp_Object length
, Lisp_Object init
)
2335 register Lisp_Object val
;
2336 struct Lisp_Bool_Vector
*p
;
2337 ptrdiff_t length_in_chars
;
2338 EMACS_INT length_in_elts
;
2340 int extra_bool_elts
= ((bool_header_size
- header_size
+ word_size
- 1)
2343 CHECK_NATNUM (length
);
2345 bits_per_value
= sizeof (EMACS_INT
) * BOOL_VECTOR_BITS_PER_CHAR
;
2347 length_in_elts
= (XFASTINT (length
) + bits_per_value
- 1) / bits_per_value
;
2349 val
= Fmake_vector (make_number (length_in_elts
+ extra_bool_elts
), Qnil
);
2351 /* No Lisp_Object to trace in there. */
2352 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0);
2354 p
= XBOOL_VECTOR (val
);
2355 p
->size
= XFASTINT (length
);
2357 length_in_chars
= ((XFASTINT (length
) + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2358 / BOOL_VECTOR_BITS_PER_CHAR
);
2359 if (length_in_chars
)
2361 memset (p
->data
, ! NILP (init
) ? -1 : 0, length_in_chars
);
2363 /* Clear any extraneous bits in the last byte. */
2364 p
->data
[length_in_chars
- 1]
2365 &= (1 << ((XFASTINT (length
) - 1) % BOOL_VECTOR_BITS_PER_CHAR
+ 1)) - 1;
2372 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2373 of characters from the contents. This string may be unibyte or
2374 multibyte, depending on the contents. */
2377 make_string (const char *contents
, ptrdiff_t nbytes
)
2379 register Lisp_Object val
;
2380 ptrdiff_t nchars
, multibyte_nbytes
;
2382 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2383 &nchars
, &multibyte_nbytes
);
2384 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2385 /* CONTENTS contains no multibyte sequences or contains an invalid
2386 multibyte sequence. We must make unibyte string. */
2387 val
= make_unibyte_string (contents
, nbytes
);
2389 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2394 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2397 make_unibyte_string (const char *contents
, ptrdiff_t length
)
2399 register Lisp_Object val
;
2400 val
= make_uninit_string (length
);
2401 memcpy (SDATA (val
), contents
, length
);
2406 /* Make a multibyte string from NCHARS characters occupying NBYTES
2407 bytes at CONTENTS. */
2410 make_multibyte_string (const char *contents
,
2411 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2413 register Lisp_Object val
;
2414 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2415 memcpy (SDATA (val
), contents
, nbytes
);
2420 /* Make a string from NCHARS characters occupying NBYTES bytes at
2421 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2424 make_string_from_bytes (const char *contents
,
2425 ptrdiff_t nchars
, ptrdiff_t nbytes
)
2427 register Lisp_Object val
;
2428 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2429 memcpy (SDATA (val
), contents
, nbytes
);
2430 if (SBYTES (val
) == SCHARS (val
))
2431 STRING_SET_UNIBYTE (val
);
2436 /* Make a string from NCHARS characters occupying NBYTES bytes at
2437 CONTENTS. The argument MULTIBYTE controls whether to label the
2438 string as multibyte. If NCHARS is negative, it counts the number of
2439 characters by itself. */
2442 make_specified_string (const char *contents
,
2443 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
2450 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2455 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2456 memcpy (SDATA (val
), contents
, nbytes
);
2458 STRING_SET_UNIBYTE (val
);
2463 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2464 occupying LENGTH bytes. */
2467 make_uninit_string (EMACS_INT length
)
2472 return empty_unibyte_string
;
2473 val
= make_uninit_multibyte_string (length
, length
);
2474 STRING_SET_UNIBYTE (val
);
2479 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2480 which occupy NBYTES bytes. */
2483 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2486 struct Lisp_String
*s
;
2491 return empty_multibyte_string
;
2493 s
= allocate_string ();
2494 s
->intervals
= NULL
;
2495 allocate_string_data (s
, nchars
, nbytes
);
2496 XSETSTRING (string
, s
);
2497 string_chars_consed
+= nbytes
;
2501 /* Print arguments to BUF according to a FORMAT, then return
2502 a Lisp_String initialized with the data from BUF. */
2505 make_formatted_string (char *buf
, const char *format
, ...)
2510 va_start (ap
, format
);
2511 length
= vsprintf (buf
, format
, ap
);
2513 return make_string (buf
, length
);
2517 /***********************************************************************
2519 ***********************************************************************/
2521 /* We store float cells inside of float_blocks, allocating a new
2522 float_block with malloc whenever necessary. Float cells reclaimed
2523 by GC are put on a free list to be reallocated before allocating
2524 any new float cells from the latest float_block. */
2526 #define FLOAT_BLOCK_SIZE \
2527 (((BLOCK_BYTES - sizeof (struct float_block *) \
2528 /* The compiler might add padding at the end. */ \
2529 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2530 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2532 #define GETMARKBIT(block,n) \
2533 (((block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2534 >> ((n) % (sizeof (int) * CHAR_BIT))) \
2537 #define SETMARKBIT(block,n) \
2538 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2539 |= 1 << ((n) % (sizeof (int) * CHAR_BIT))
2541 #define UNSETMARKBIT(block,n) \
2542 (block)->gcmarkbits[(n) / (sizeof (int) * CHAR_BIT)] \
2543 &= ~(1 << ((n) % (sizeof (int) * CHAR_BIT)))
2545 #define FLOAT_BLOCK(fptr) \
2546 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2548 #define FLOAT_INDEX(fptr) \
2549 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2553 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2554 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2555 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2556 struct float_block
*next
;
2559 #define FLOAT_MARKED_P(fptr) \
2560 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2562 #define FLOAT_MARK(fptr) \
2563 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2565 #define FLOAT_UNMARK(fptr) \
2566 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2568 /* Current float_block. */
2570 static struct float_block
*float_block
;
2572 /* Index of first unused Lisp_Float in the current float_block. */
2574 static int float_block_index
= FLOAT_BLOCK_SIZE
;
2576 /* Free-list of Lisp_Floats. */
2578 static struct Lisp_Float
*float_free_list
;
2580 /* Return a new float object with value FLOAT_VALUE. */
2583 make_float (double float_value
)
2585 register Lisp_Object val
;
2587 /* eassert (!handling_signal); */
2591 if (float_free_list
)
2593 /* We use the data field for chaining the free list
2594 so that we won't use the same field that has the mark bit. */
2595 XSETFLOAT (val
, float_free_list
);
2596 float_free_list
= float_free_list
->u
.chain
;
2600 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2602 struct float_block
*new
2603 = lisp_align_malloc (sizeof *new, MEM_TYPE_FLOAT
);
2604 new->next
= float_block
;
2605 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2607 float_block_index
= 0;
2608 total_free_floats
+= FLOAT_BLOCK_SIZE
;
2610 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2611 float_block_index
++;
2614 MALLOC_UNBLOCK_INPUT
;
2616 XFLOAT_INIT (val
, float_value
);
2617 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2618 consing_since_gc
+= sizeof (struct Lisp_Float
);
2620 total_free_floats
--;
2626 /***********************************************************************
2628 ***********************************************************************/
2630 /* We store cons cells inside of cons_blocks, allocating a new
2631 cons_block with malloc whenever necessary. Cons cells reclaimed by
2632 GC are put on a free list to be reallocated before allocating
2633 any new cons cells from the latest cons_block. */
2635 #define CONS_BLOCK_SIZE \
2636 (((BLOCK_BYTES - sizeof (struct cons_block *) \
2637 /* The compiler might add padding at the end. */ \
2638 - (sizeof (struct Lisp_Cons) - sizeof (int))) * CHAR_BIT) \
2639 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2641 #define CONS_BLOCK(fptr) \
2642 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2644 #define CONS_INDEX(fptr) \
2645 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2649 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2650 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2651 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof (int) * CHAR_BIT
)];
2652 struct cons_block
*next
;
2655 #define CONS_MARKED_P(fptr) \
2656 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2658 #define CONS_MARK(fptr) \
2659 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2661 #define CONS_UNMARK(fptr) \
2662 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2664 /* Current cons_block. */
2666 static struct cons_block
*cons_block
;
2668 /* Index of first unused Lisp_Cons in the current block. */
2670 static int cons_block_index
= CONS_BLOCK_SIZE
;
2672 /* Free-list of Lisp_Cons structures. */
2674 static struct Lisp_Cons
*cons_free_list
;
2676 /* Explicitly free a cons cell by putting it on the free-list. */
2679 free_cons (struct Lisp_Cons
*ptr
)
2681 ptr
->u
.chain
= cons_free_list
;
2685 cons_free_list
= ptr
;
2686 consing_since_gc
-= sizeof *ptr
;
2687 total_free_conses
++;
2690 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2691 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2692 (Lisp_Object car
, Lisp_Object cdr
)
2694 register Lisp_Object val
;
2696 /* eassert (!handling_signal); */
2702 /* We use the cdr for chaining the free list
2703 so that we won't use the same field that has the mark bit. */
2704 XSETCONS (val
, cons_free_list
);
2705 cons_free_list
= cons_free_list
->u
.chain
;
2709 if (cons_block_index
== CONS_BLOCK_SIZE
)
2711 struct cons_block
*new
2712 = lisp_align_malloc (sizeof *new, MEM_TYPE_CONS
);
2713 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2714 new->next
= cons_block
;
2716 cons_block_index
= 0;
2717 total_free_conses
+= CONS_BLOCK_SIZE
;
2719 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2723 MALLOC_UNBLOCK_INPUT
;
2727 eassert (!CONS_MARKED_P (XCONS (val
)));
2728 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2729 total_free_conses
--;
2730 cons_cells_consed
++;
2734 #ifdef GC_CHECK_CONS_LIST
2735 /* Get an error now if there's any junk in the cons free list. */
2737 check_cons_list (void)
2739 struct Lisp_Cons
*tail
= cons_free_list
;
2742 tail
= tail
->u
.chain
;
2746 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2749 list1 (Lisp_Object arg1
)
2751 return Fcons (arg1
, Qnil
);
2755 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2757 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2762 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2764 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2769 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2771 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2776 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2778 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2779 Fcons (arg5
, Qnil
)))));
2782 /* Make a list of COUNT Lisp_Objects, where ARG is the
2783 first one. Allocate conses from pure space if TYPE
2784 is CONSTYPE_PURE, or allocate as usual if type is CONSTYPE_HEAP. */
2787 listn (enum constype type
, ptrdiff_t count
, Lisp_Object arg
, ...)
2791 Lisp_Object val
, *objp
;
2793 /* Change to SAFE_ALLOCA if you hit this eassert. */
2794 eassert (count
<= MAX_ALLOCA
/ word_size
);
2796 objp
= alloca (count
* word_size
);
2799 for (i
= 1; i
< count
; i
++)
2800 objp
[i
] = va_arg (ap
, Lisp_Object
);
2803 for (val
= Qnil
, i
= count
- 1; i
>= 0; i
--)
2805 if (type
== CONSTYPE_PURE
)
2806 val
= pure_cons (objp
[i
], val
);
2807 else if (type
== CONSTYPE_HEAP
)
2808 val
= Fcons (objp
[i
], val
);
2815 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2816 doc
: /* Return a newly created list with specified arguments as elements.
2817 Any number of arguments, even zero arguments, are allowed.
2818 usage: (list &rest OBJECTS) */)
2819 (ptrdiff_t nargs
, Lisp_Object
*args
)
2821 register Lisp_Object val
;
2827 val
= Fcons (args
[nargs
], val
);
2833 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2834 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2835 (register Lisp_Object length
, Lisp_Object init
)
2837 register Lisp_Object val
;
2838 register EMACS_INT size
;
2840 CHECK_NATNUM (length
);
2841 size
= XFASTINT (length
);
2846 val
= Fcons (init
, val
);
2851 val
= Fcons (init
, val
);
2856 val
= Fcons (init
, val
);
2861 val
= Fcons (init
, val
);
2866 val
= Fcons (init
, val
);
2881 /***********************************************************************
2883 ***********************************************************************/
2885 /* This value is balanced well enough to avoid too much internal overhead
2886 for the most common cases; it's not required to be a power of two, but
2887 it's expected to be a mult-of-ROUNDUP_SIZE (see below). */
2889 #define VECTOR_BLOCK_SIZE 4096
2891 /* Align allocation request sizes to be a multiple of ROUNDUP_SIZE. */
2894 roundup_size
= COMMON_MULTIPLE (word_size
, USE_LSB_TAG
? GCALIGNMENT
: 1)
2897 /* ROUNDUP_SIZE must be a power of 2. */
2898 verify ((roundup_size
& (roundup_size
- 1)) == 0);
2900 /* Verify assumptions described above. */
2901 verify ((VECTOR_BLOCK_SIZE
% roundup_size
) == 0);
2902 verify (VECTOR_BLOCK_SIZE
<= (1 << PSEUDOVECTOR_SIZE_BITS
));
2904 /* Round up X to nearest mult-of-ROUNDUP_SIZE. */
2906 #define vroundup(x) (((x) + (roundup_size - 1)) & ~(roundup_size - 1))
2908 /* Rounding helps to maintain alignment constraints if USE_LSB_TAG. */
2910 #define VECTOR_BLOCK_BYTES (VECTOR_BLOCK_SIZE - vroundup (sizeof (void *)))
2912 /* Size of the minimal vector allocated from block. */
2914 #define VBLOCK_BYTES_MIN vroundup (sizeof (struct Lisp_Vector))
2916 /* Size of the largest vector allocated from block. */
2918 #define VBLOCK_BYTES_MAX \
2919 vroundup ((VECTOR_BLOCK_BYTES / 2) - word_size)
2921 /* We maintain one free list for each possible block-allocated
2922 vector size, and this is the number of free lists we have. */
2924 #define VECTOR_MAX_FREE_LIST_INDEX \
2925 ((VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN) / roundup_size + 1)
2927 /* Common shortcut to advance vector pointer over a block data. */
2929 #define ADVANCE(v, nbytes) ((struct Lisp_Vector *) ((char *) (v) + (nbytes)))
2931 /* Common shortcut to calculate NBYTES-vector index in VECTOR_FREE_LISTS. */
2933 #define VINDEX(nbytes) (((nbytes) - VBLOCK_BYTES_MIN) / roundup_size)
2935 /* Common shortcut to setup vector on a free list. */
2937 #define SETUP_ON_FREE_LIST(v, nbytes, index) \
2939 XSETPVECTYPESIZE (v, PVEC_FREE, nbytes); \
2940 eassert ((nbytes) % roundup_size == 0); \
2941 (index) = VINDEX (nbytes); \
2942 eassert ((index) < VECTOR_MAX_FREE_LIST_INDEX); \
2943 (v)->header.next.vector = vector_free_lists[index]; \
2944 vector_free_lists[index] = (v); \
2945 total_free_vector_slots += (nbytes) / word_size; \
2950 char data
[VECTOR_BLOCK_BYTES
];
2951 struct vector_block
*next
;
2954 /* Chain of vector blocks. */
2956 static struct vector_block
*vector_blocks
;
2958 /* Vector free lists, where NTH item points to a chain of free
2959 vectors of the same NBYTES size, so NTH == VINDEX (NBYTES). */
2961 static struct Lisp_Vector
*vector_free_lists
[VECTOR_MAX_FREE_LIST_INDEX
];
2963 /* Singly-linked list of large vectors. */
2965 static struct Lisp_Vector
*large_vectors
;
2967 /* The only vector with 0 slots, allocated from pure space. */
2969 Lisp_Object zero_vector
;
2971 /* Number of live vectors. */
2973 static EMACS_INT total_vectors
;
2975 /* Total size of live and free vectors, in Lisp_Object units. */
2977 static EMACS_INT total_vector_slots
, total_free_vector_slots
;
2979 /* Get a new vector block. */
2981 static struct vector_block
*
2982 allocate_vector_block (void)
2984 struct vector_block
*block
= xmalloc (sizeof *block
);
2986 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
2987 mem_insert (block
->data
, block
->data
+ VECTOR_BLOCK_BYTES
,
2988 MEM_TYPE_VECTOR_BLOCK
);
2991 block
->next
= vector_blocks
;
2992 vector_blocks
= block
;
2996 /* Called once to initialize vector allocation. */
3001 zero_vector
= make_pure_vector (0);
3004 /* Allocate vector from a vector block. */
3006 static struct Lisp_Vector
*
3007 allocate_vector_from_block (size_t nbytes
)
3009 struct Lisp_Vector
*vector
, *rest
;
3010 struct vector_block
*block
;
3011 size_t index
, restbytes
;
3013 eassert (VBLOCK_BYTES_MIN
<= nbytes
&& nbytes
<= VBLOCK_BYTES_MAX
);
3014 eassert (nbytes
% roundup_size
== 0);
3016 /* First, try to allocate from a free list
3017 containing vectors of the requested size. */
3018 index
= VINDEX (nbytes
);
3019 if (vector_free_lists
[index
])
3021 vector
= vector_free_lists
[index
];
3022 vector_free_lists
[index
] = vector
->header
.next
.vector
;
3023 vector
->header
.next
.nbytes
= nbytes
;
3024 total_free_vector_slots
-= nbytes
/ word_size
;
3028 /* Next, check free lists containing larger vectors. Since
3029 we will split the result, we should have remaining space
3030 large enough to use for one-slot vector at least. */
3031 for (index
= VINDEX (nbytes
+ VBLOCK_BYTES_MIN
);
3032 index
< VECTOR_MAX_FREE_LIST_INDEX
; index
++)
3033 if (vector_free_lists
[index
])
3035 /* This vector is larger than requested. */
3036 vector
= vector_free_lists
[index
];
3037 vector_free_lists
[index
] = vector
->header
.next
.vector
;
3038 vector
->header
.next
.nbytes
= nbytes
;
3039 total_free_vector_slots
-= nbytes
/ word_size
;
3041 /* Excess bytes are used for the smaller vector,
3042 which should be set on an appropriate free list. */
3043 restbytes
= index
* roundup_size
+ VBLOCK_BYTES_MIN
- nbytes
;
3044 eassert (restbytes
% roundup_size
== 0);
3045 rest
= ADVANCE (vector
, nbytes
);
3046 SETUP_ON_FREE_LIST (rest
, restbytes
, index
);
3050 /* Finally, need a new vector block. */
3051 block
= allocate_vector_block ();
3053 /* New vector will be at the beginning of this block. */
3054 vector
= (struct Lisp_Vector
*) block
->data
;
3055 vector
->header
.next
.nbytes
= nbytes
;
3057 /* If the rest of space from this block is large enough
3058 for one-slot vector at least, set up it on a free list. */
3059 restbytes
= VECTOR_BLOCK_BYTES
- nbytes
;
3060 if (restbytes
>= VBLOCK_BYTES_MIN
)
3062 eassert (restbytes
% roundup_size
== 0);
3063 rest
= ADVANCE (vector
, nbytes
);
3064 SETUP_ON_FREE_LIST (rest
, restbytes
, index
);
3069 /* Nonzero if VECTOR pointer is valid pointer inside BLOCK. */
3071 #define VECTOR_IN_BLOCK(vector, block) \
3072 ((char *) (vector) <= (block)->data \
3073 + VECTOR_BLOCK_BYTES - VBLOCK_BYTES_MIN)
3075 /* Number of bytes used by vector-block-allocated object. This is the only
3076 place where we actually use the `nbytes' field of the vector-header.
3077 I.e. we could get rid of the `nbytes' field by computing it based on the
3080 #define PSEUDOVECTOR_NBYTES(vector) \
3081 (PSEUDOVECTOR_TYPEP (&vector->header, PVEC_FREE) \
3082 ? vector->header.size & PSEUDOVECTOR_SIZE_MASK \
3083 : vector->header.next.nbytes)
3085 /* Reclaim space used by unmarked vectors. */
3088 sweep_vectors (void)
3090 struct vector_block
*block
= vector_blocks
, **bprev
= &vector_blocks
;
3091 struct Lisp_Vector
*vector
, *next
, **vprev
= &large_vectors
;
3093 total_vectors
= total_vector_slots
= total_free_vector_slots
= 0;
3094 memset (vector_free_lists
, 0, sizeof (vector_free_lists
));
3096 /* Looking through vector blocks. */
3098 for (block
= vector_blocks
; block
; block
= *bprev
)
3100 bool free_this_block
= 0;
3102 for (vector
= (struct Lisp_Vector
*) block
->data
;
3103 VECTOR_IN_BLOCK (vector
, block
); vector
= next
)
3105 if (VECTOR_MARKED_P (vector
))
3107 VECTOR_UNMARK (vector
);
3109 total_vector_slots
+= vector
->header
.next
.nbytes
/ word_size
;
3110 next
= ADVANCE (vector
, vector
->header
.next
.nbytes
);
3114 ptrdiff_t nbytes
= PSEUDOVECTOR_NBYTES (vector
);
3115 ptrdiff_t total_bytes
= nbytes
;
3117 next
= ADVANCE (vector
, nbytes
);
3119 /* While NEXT is not marked, try to coalesce with VECTOR,
3120 thus making VECTOR of the largest possible size. */
3122 while (VECTOR_IN_BLOCK (next
, block
))
3124 if (VECTOR_MARKED_P (next
))
3126 nbytes
= PSEUDOVECTOR_NBYTES (next
);
3127 total_bytes
+= nbytes
;
3128 next
= ADVANCE (next
, nbytes
);
3131 eassert (total_bytes
% roundup_size
== 0);
3133 if (vector
== (struct Lisp_Vector
*) block
->data
3134 && !VECTOR_IN_BLOCK (next
, block
))
3135 /* This block should be freed because all of it's
3136 space was coalesced into the only free vector. */
3137 free_this_block
= 1;
3141 SETUP_ON_FREE_LIST (vector
, total_bytes
, tmp
);
3146 if (free_this_block
)
3148 *bprev
= block
->next
;
3149 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
3150 mem_delete (mem_find (block
->data
));
3155 bprev
= &block
->next
;
3158 /* Sweep large vectors. */
3160 for (vector
= large_vectors
; vector
; vector
= *vprev
)
3162 if (VECTOR_MARKED_P (vector
))
3164 VECTOR_UNMARK (vector
);
3166 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
3168 struct Lisp_Bool_Vector
*b
= (struct Lisp_Bool_Vector
*) vector
;
3170 /* All non-bool pseudovectors are small enough to be allocated
3171 from vector blocks. This code should be redesigned if some
3172 pseudovector type grows beyond VBLOCK_BYTES_MAX. */
3173 eassert (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_BOOL_VECTOR
));
3176 += (bool_header_size
3177 + ((b
->size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1)
3178 / BOOL_VECTOR_BITS_PER_CHAR
)) / word_size
;
3182 += header_size
/ word_size
+ vector
->header
.size
;
3183 vprev
= &vector
->header
.next
.vector
;
3187 *vprev
= vector
->header
.next
.vector
;
3193 /* Value is a pointer to a newly allocated Lisp_Vector structure
3194 with room for LEN Lisp_Objects. */
3196 static struct Lisp_Vector
*
3197 allocate_vectorlike (ptrdiff_t len
)
3199 struct Lisp_Vector
*p
;
3203 /* This gets triggered by code which I haven't bothered to fix. --Stef */
3204 /* eassert (!handling_signal); */
3207 p
= XVECTOR (zero_vector
);
3210 size_t nbytes
= header_size
+ len
* word_size
;
3212 #ifdef DOUG_LEA_MALLOC
3213 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
3214 because mapped region contents are not preserved in
3216 mallopt (M_MMAP_MAX
, 0);
3219 if (nbytes
<= VBLOCK_BYTES_MAX
)
3220 p
= allocate_vector_from_block (vroundup (nbytes
));
3223 p
= lisp_malloc (nbytes
, MEM_TYPE_VECTORLIKE
);
3224 p
->header
.next
.vector
= large_vectors
;
3228 #ifdef DOUG_LEA_MALLOC
3229 /* Back to a reasonable maximum of mmap'ed areas. */
3230 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
3233 consing_since_gc
+= nbytes
;
3234 vector_cells_consed
+= len
;
3237 MALLOC_UNBLOCK_INPUT
;
3243 /* Allocate a vector with LEN slots. */
3245 struct Lisp_Vector
*
3246 allocate_vector (EMACS_INT len
)
3248 struct Lisp_Vector
*v
;
3249 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
3251 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
3252 memory_full (SIZE_MAX
);
3253 v
= allocate_vectorlike (len
);
3254 v
->header
.size
= len
;
3259 /* Allocate other vector-like structures. */
3261 struct Lisp_Vector
*
3262 allocate_pseudovector (int memlen
, int lisplen
, int tag
)
3264 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
3267 /* Only the first lisplen slots will be traced normally by the GC. */
3268 for (i
= 0; i
< lisplen
; ++i
)
3269 v
->contents
[i
] = Qnil
;
3271 XSETPVECTYPESIZE (v
, tag
, lisplen
);
3276 allocate_buffer (void)
3278 struct buffer
*b
= lisp_malloc (sizeof *b
, MEM_TYPE_BUFFER
);
3280 XSETPVECTYPESIZE (b
, PVEC_BUFFER
, (offsetof (struct buffer
, own_text
)
3281 - header_size
) / word_size
);
3282 /* Put B on the chain of all buffers including killed ones. */
3283 b
->header
.next
.buffer
= all_buffers
;
3285 /* Note that the rest fields of B are not initialized. */
3289 struct Lisp_Hash_Table
*
3290 allocate_hash_table (void)
3292 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
3296 allocate_window (void)
3300 w
= ALLOCATE_PSEUDOVECTOR (struct window
, current_matrix
, PVEC_WINDOW
);
3301 /* Users assumes that non-Lisp data is zeroed. */
3302 memset (&w
->current_matrix
, 0,
3303 sizeof (*w
) - offsetof (struct window
, current_matrix
));
3308 allocate_terminal (void)
3312 t
= ALLOCATE_PSEUDOVECTOR (struct terminal
, next_terminal
, PVEC_TERMINAL
);
3313 /* Users assumes that non-Lisp data is zeroed. */
3314 memset (&t
->next_terminal
, 0,
3315 sizeof (*t
) - offsetof (struct terminal
, next_terminal
));
3320 allocate_frame (void)
3324 f
= ALLOCATE_PSEUDOVECTOR (struct frame
, face_cache
, PVEC_FRAME
);
3325 /* Users assumes that non-Lisp data is zeroed. */
3326 memset (&f
->face_cache
, 0,
3327 sizeof (*f
) - offsetof (struct frame
, face_cache
));
3331 struct Lisp_Process
*
3332 allocate_process (void)
3334 struct Lisp_Process
*p
;
3336 p
= ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
3337 /* Users assumes that non-Lisp data is zeroed. */
3339 sizeof (*p
) - offsetof (struct Lisp_Process
, pid
));
3343 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
3344 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
3345 See also the function `vector'. */)
3346 (register Lisp_Object length
, Lisp_Object init
)
3349 register ptrdiff_t sizei
;
3350 register ptrdiff_t i
;
3351 register struct Lisp_Vector
*p
;
3353 CHECK_NATNUM (length
);
3355 p
= allocate_vector (XFASTINT (length
));
3356 sizei
= XFASTINT (length
);
3357 for (i
= 0; i
< sizei
; i
++)
3358 p
->contents
[i
] = init
;
3360 XSETVECTOR (vector
, p
);
3365 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3366 doc
: /* Return a newly created vector with specified arguments as elements.
3367 Any number of arguments, even zero arguments, are allowed.
3368 usage: (vector &rest OBJECTS) */)
3369 (ptrdiff_t nargs
, Lisp_Object
*args
)
3371 register Lisp_Object len
, val
;
3373 register struct Lisp_Vector
*p
;
3375 XSETFASTINT (len
, nargs
);
3376 val
= Fmake_vector (len
, Qnil
);
3378 for (i
= 0; i
< nargs
; i
++)
3379 p
->contents
[i
] = args
[i
];
3384 make_byte_code (struct Lisp_Vector
*v
)
3386 if (v
->header
.size
> 1 && STRINGP (v
->contents
[1])
3387 && STRING_MULTIBYTE (v
->contents
[1]))
3388 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3389 earlier because they produced a raw 8-bit string for byte-code
3390 and now such a byte-code string is loaded as multibyte while
3391 raw 8-bit characters converted to multibyte form. Thus, now we
3392 must convert them back to the original unibyte form. */
3393 v
->contents
[1] = Fstring_as_unibyte (v
->contents
[1]);
3394 XSETPVECTYPE (v
, PVEC_COMPILED
);
3397 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3398 doc
: /* Create a byte-code object with specified arguments as elements.
3399 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
3400 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
3401 and (optional) INTERACTIVE-SPEC.
3402 The first four arguments are required; at most six have any
3404 The ARGLIST can be either like the one of `lambda', in which case the arguments
3405 will be dynamically bound before executing the byte code, or it can be an
3406 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
3407 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
3408 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
3409 argument to catch the left-over arguments. If such an integer is used, the
3410 arguments will not be dynamically bound but will be instead pushed on the
3411 stack before executing the byte-code.
3412 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3413 (ptrdiff_t nargs
, Lisp_Object
*args
)
3415 register Lisp_Object len
, val
;
3417 register struct Lisp_Vector
*p
;
3419 /* We used to purecopy everything here, if purify-flga was set. This worked
3420 OK for Emacs-23, but with Emacs-24's lexical binding code, it can be
3421 dangerous, since make-byte-code is used during execution to build
3422 closures, so any closure built during the preload phase would end up
3423 copied into pure space, including its free variables, which is sometimes
3424 just wasteful and other times plainly wrong (e.g. those free vars may want
3427 XSETFASTINT (len
, nargs
);
3428 val
= Fmake_vector (len
, Qnil
);
3431 for (i
= 0; i
< nargs
; i
++)
3432 p
->contents
[i
] = args
[i
];
3434 XSETCOMPILED (val
, p
);
3440 /***********************************************************************
3442 ***********************************************************************/
3444 /* Like struct Lisp_Symbol, but padded so that the size is a multiple
3445 of the required alignment if LSB tags are used. */
3447 union aligned_Lisp_Symbol
3449 struct Lisp_Symbol s
;
3451 unsigned char c
[(sizeof (struct Lisp_Symbol
) + GCALIGNMENT
- 1)
3456 /* Each symbol_block is just under 1020 bytes long, since malloc
3457 really allocates in units of powers of two and uses 4 bytes for its
3460 #define SYMBOL_BLOCK_SIZE \
3461 ((1020 - sizeof (struct symbol_block *)) / sizeof (union aligned_Lisp_Symbol))
3465 /* Place `symbols' first, to preserve alignment. */
3466 union aligned_Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3467 struct symbol_block
*next
;
3470 /* Current symbol block and index of first unused Lisp_Symbol
3473 static struct symbol_block
*symbol_block
;
3474 static int symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3476 /* List of free symbols. */
3478 static struct Lisp_Symbol
*symbol_free_list
;
3480 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3481 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3482 Its value and function definition are void, and its property list is nil. */)
3485 register Lisp_Object val
;
3486 register struct Lisp_Symbol
*p
;
3488 CHECK_STRING (name
);
3490 /* eassert (!handling_signal); */
3494 if (symbol_free_list
)
3496 XSETSYMBOL (val
, symbol_free_list
);
3497 symbol_free_list
= symbol_free_list
->next
;
3501 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3503 struct symbol_block
*new
3504 = lisp_malloc (sizeof *new, MEM_TYPE_SYMBOL
);
3505 new->next
= symbol_block
;
3507 symbol_block_index
= 0;
3508 total_free_symbols
+= SYMBOL_BLOCK_SIZE
;
3510 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
].s
);
3511 symbol_block_index
++;
3514 MALLOC_UNBLOCK_INPUT
;
3517 set_symbol_name (val
, name
);
3518 set_symbol_plist (val
, Qnil
);
3519 p
->redirect
= SYMBOL_PLAINVAL
;
3520 SET_SYMBOL_VAL (p
, Qunbound
);
3521 set_symbol_function (val
, Qunbound
);
3522 set_symbol_next (val
, NULL
);
3524 p
->interned
= SYMBOL_UNINTERNED
;
3526 p
->declared_special
= 0;
3527 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3529 total_free_symbols
--;
3535 /***********************************************************************
3536 Marker (Misc) Allocation
3537 ***********************************************************************/
3539 /* Like union Lisp_Misc, but padded so that its size is a multiple of
3540 the required alignment when LSB tags are used. */
3542 union aligned_Lisp_Misc
3546 unsigned char c
[(sizeof (union Lisp_Misc
) + GCALIGNMENT
- 1)
3551 /* Allocation of markers and other objects that share that structure.
3552 Works like allocation of conses. */
3554 #define MARKER_BLOCK_SIZE \
3555 ((1020 - sizeof (struct marker_block *)) / sizeof (union aligned_Lisp_Misc))
3559 /* Place `markers' first, to preserve alignment. */
3560 union aligned_Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3561 struct marker_block
*next
;
3564 static struct marker_block
*marker_block
;
3565 static int marker_block_index
= MARKER_BLOCK_SIZE
;
3567 static union Lisp_Misc
*marker_free_list
;
3569 /* Return a newly allocated Lisp_Misc object of specified TYPE. */
3572 allocate_misc (enum Lisp_Misc_Type type
)
3576 /* eassert (!handling_signal); */
3580 if (marker_free_list
)
3582 XSETMISC (val
, marker_free_list
);
3583 marker_free_list
= marker_free_list
->u_free
.chain
;
3587 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3589 struct marker_block
*new = lisp_malloc (sizeof *new, MEM_TYPE_MISC
);
3590 new->next
= marker_block
;
3592 marker_block_index
= 0;
3593 total_free_markers
+= MARKER_BLOCK_SIZE
;
3595 XSETMISC (val
, &marker_block
->markers
[marker_block_index
].m
);
3596 marker_block_index
++;
3599 MALLOC_UNBLOCK_INPUT
;
3601 --total_free_markers
;
3602 consing_since_gc
+= sizeof (union Lisp_Misc
);
3603 misc_objects_consed
++;
3604 XMISCTYPE (val
) = type
;
3605 XMISCANY (val
)->gcmarkbit
= 0;
3609 /* Free a Lisp_Misc object */
3612 free_misc (Lisp_Object misc
)
3614 XMISCTYPE (misc
) = Lisp_Misc_Free
;
3615 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3616 marker_free_list
= XMISC (misc
);
3617 consing_since_gc
-= sizeof (union Lisp_Misc
);
3618 total_free_markers
++;
3621 /* Return a Lisp_Misc_Save_Value object containing POINTER and
3622 INTEGER. This is used to package C values to call record_unwind_protect.
3623 The unwind function can get the C values back using XSAVE_VALUE. */
3626 make_save_value (void *pointer
, ptrdiff_t integer
)
3628 register Lisp_Object val
;
3629 register struct Lisp_Save_Value
*p
;
3631 val
= allocate_misc (Lisp_Misc_Save_Value
);
3632 p
= XSAVE_VALUE (val
);
3633 p
->pointer
= pointer
;
3634 p
->integer
= integer
;
3639 /* Return a Lisp_Misc_Overlay object with specified START, END and PLIST. */
3642 build_overlay (Lisp_Object start
, Lisp_Object end
, Lisp_Object plist
)
3644 register Lisp_Object overlay
;
3646 overlay
= allocate_misc (Lisp_Misc_Overlay
);
3647 OVERLAY_START (overlay
) = start
;
3648 OVERLAY_END (overlay
) = end
;
3649 set_overlay_plist (overlay
, plist
);
3650 XOVERLAY (overlay
)->next
= NULL
;
3654 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3655 doc
: /* Return a newly allocated marker which does not point at any place. */)
3658 register Lisp_Object val
;
3659 register struct Lisp_Marker
*p
;
3661 val
= allocate_misc (Lisp_Misc_Marker
);
3667 p
->insertion_type
= 0;
3671 /* Return a newly allocated marker which points into BUF
3672 at character position CHARPOS and byte position BYTEPOS. */
3675 build_marker (struct buffer
*buf
, ptrdiff_t charpos
, ptrdiff_t bytepos
)
3678 struct Lisp_Marker
*m
;
3680 /* No dead buffers here. */
3681 eassert (!NILP (BVAR (buf
, name
)));
3683 /* Every character is at least one byte. */
3684 eassert (charpos
<= bytepos
);
3686 obj
= allocate_misc (Lisp_Misc_Marker
);
3689 m
->charpos
= charpos
;
3690 m
->bytepos
= bytepos
;
3691 m
->insertion_type
= 0;
3692 m
->next
= BUF_MARKERS (buf
);
3693 BUF_MARKERS (buf
) = m
;
3697 /* Put MARKER back on the free list after using it temporarily. */
3700 free_marker (Lisp_Object marker
)
3702 unchain_marker (XMARKER (marker
));
3707 /* Return a newly created vector or string with specified arguments as
3708 elements. If all the arguments are characters that can fit
3709 in a string of events, make a string; otherwise, make a vector.
3711 Any number of arguments, even zero arguments, are allowed. */
3714 make_event_array (register int nargs
, Lisp_Object
*args
)
3718 for (i
= 0; i
< nargs
; i
++)
3719 /* The things that fit in a string
3720 are characters that are in 0...127,
3721 after discarding the meta bit and all the bits above it. */
3722 if (!INTEGERP (args
[i
])
3723 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3724 return Fvector (nargs
, args
);
3726 /* Since the loop exited, we know that all the things in it are
3727 characters, so we can make a string. */
3731 result
= Fmake_string (make_number (nargs
), make_number (0));
3732 for (i
= 0; i
< nargs
; i
++)
3734 SSET (result
, i
, XINT (args
[i
]));
3735 /* Move the meta bit to the right place for a string char. */
3736 if (XINT (args
[i
]) & CHAR_META
)
3737 SSET (result
, i
, SREF (result
, i
) | 0x80);
3746 /************************************************************************
3747 Memory Full Handling
3748 ************************************************************************/
3751 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3752 there may have been size_t overflow so that malloc was never
3753 called, or perhaps malloc was invoked successfully but the
3754 resulting pointer had problems fitting into a tagged EMACS_INT. In
3755 either case this counts as memory being full even though malloc did
3759 memory_full (size_t nbytes
)
3761 /* Do not go into hysterics merely because a large request failed. */
3762 bool enough_free_memory
= 0;
3763 if (SPARE_MEMORY
< nbytes
)
3768 p
= malloc (SPARE_MEMORY
);
3772 enough_free_memory
= 1;
3774 MALLOC_UNBLOCK_INPUT
;
3777 if (! enough_free_memory
)
3783 memory_full_cons_threshold
= sizeof (struct cons_block
);
3785 /* The first time we get here, free the spare memory. */
3786 for (i
= 0; i
< sizeof (spare_memory
) / sizeof (char *); i
++)
3787 if (spare_memory
[i
])
3790 free (spare_memory
[i
]);
3791 else if (i
>= 1 && i
<= 4)
3792 lisp_align_free (spare_memory
[i
]);
3794 lisp_free (spare_memory
[i
]);
3795 spare_memory
[i
] = 0;
3798 /* Record the space now used. When it decreases substantially,
3799 we can refill the memory reserve. */
3800 #if !defined SYSTEM_MALLOC && !defined SYNC_INPUT
3801 bytes_used_when_full
= BYTES_USED
;
3805 /* This used to call error, but if we've run out of memory, we could
3806 get infinite recursion trying to build the string. */
3807 xsignal (Qnil
, Vmemory_signal_data
);
3810 /* If we released our reserve (due to running out of memory),
3811 and we have a fair amount free once again,
3812 try to set aside another reserve in case we run out once more.
3814 This is called when a relocatable block is freed in ralloc.c,
3815 and also directly from this file, in case we're not using ralloc.c. */
3818 refill_memory_reserve (void)
3820 #ifndef SYSTEM_MALLOC
3821 if (spare_memory
[0] == 0)
3822 spare_memory
[0] = malloc (SPARE_MEMORY
);
3823 if (spare_memory
[1] == 0)
3824 spare_memory
[1] = lisp_align_malloc (sizeof (struct cons_block
),
3826 if (spare_memory
[2] == 0)
3827 spare_memory
[2] = lisp_align_malloc (sizeof (struct cons_block
),
3829 if (spare_memory
[3] == 0)
3830 spare_memory
[3] = lisp_align_malloc (sizeof (struct cons_block
),
3832 if (spare_memory
[4] == 0)
3833 spare_memory
[4] = lisp_align_malloc (sizeof (struct cons_block
),
3835 if (spare_memory
[5] == 0)
3836 spare_memory
[5] = lisp_malloc (sizeof (struct string_block
),
3838 if (spare_memory
[6] == 0)
3839 spare_memory
[6] = lisp_malloc (sizeof (struct string_block
),
3841 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3842 Vmemory_full
= Qnil
;
3846 /************************************************************************
3848 ************************************************************************/
3850 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3852 /* Conservative C stack marking requires a method to identify possibly
3853 live Lisp objects given a pointer value. We do this by keeping
3854 track of blocks of Lisp data that are allocated in a red-black tree
3855 (see also the comment of mem_node which is the type of nodes in
3856 that tree). Function lisp_malloc adds information for an allocated
3857 block to the red-black tree with calls to mem_insert, and function
3858 lisp_free removes it with mem_delete. Functions live_string_p etc
3859 call mem_find to lookup information about a given pointer in the
3860 tree, and use that to determine if the pointer points to a Lisp
3863 /* Initialize this part of alloc.c. */
3868 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3869 mem_z
.parent
= NULL
;
3870 mem_z
.color
= MEM_BLACK
;
3871 mem_z
.start
= mem_z
.end
= NULL
;
3876 /* Value is a pointer to the mem_node containing START. Value is
3877 MEM_NIL if there is no node in the tree containing START. */
3879 static inline struct mem_node
*
3880 mem_find (void *start
)
3884 if (start
< min_heap_address
|| start
> max_heap_address
)
3887 /* Make the search always successful to speed up the loop below. */
3888 mem_z
.start
= start
;
3889 mem_z
.end
= (char *) start
+ 1;
3892 while (start
< p
->start
|| start
>= p
->end
)
3893 p
= start
< p
->start
? p
->left
: p
->right
;
3898 /* Insert a new node into the tree for a block of memory with start
3899 address START, end address END, and type TYPE. Value is a
3900 pointer to the node that was inserted. */
3902 static struct mem_node
*
3903 mem_insert (void *start
, void *end
, enum mem_type type
)
3905 struct mem_node
*c
, *parent
, *x
;
3907 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3908 min_heap_address
= start
;
3909 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3910 max_heap_address
= end
;
3912 /* See where in the tree a node for START belongs. In this
3913 particular application, it shouldn't happen that a node is already
3914 present. For debugging purposes, let's check that. */
3918 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3920 while (c
!= MEM_NIL
)
3922 if (start
>= c
->start
&& start
< c
->end
)
3925 c
= start
< c
->start
? c
->left
: c
->right
;
3928 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3930 while (c
!= MEM_NIL
)
3933 c
= start
< c
->start
? c
->left
: c
->right
;
3936 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3938 /* Create a new node. */
3939 #ifdef GC_MALLOC_CHECK
3940 x
= _malloc_internal (sizeof *x
);
3944 x
= xmalloc (sizeof *x
);
3950 x
->left
= x
->right
= MEM_NIL
;
3953 /* Insert it as child of PARENT or install it as root. */
3956 if (start
< parent
->start
)
3964 /* Re-establish red-black tree properties. */
3965 mem_insert_fixup (x
);
3971 /* Re-establish the red-black properties of the tree, and thereby
3972 balance the tree, after node X has been inserted; X is always red. */
3975 mem_insert_fixup (struct mem_node
*x
)
3977 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3979 /* X is red and its parent is red. This is a violation of
3980 red-black tree property #3. */
3982 if (x
->parent
== x
->parent
->parent
->left
)
3984 /* We're on the left side of our grandparent, and Y is our
3986 struct mem_node
*y
= x
->parent
->parent
->right
;
3988 if (y
->color
== MEM_RED
)
3990 /* Uncle and parent are red but should be black because
3991 X is red. Change the colors accordingly and proceed
3992 with the grandparent. */
3993 x
->parent
->color
= MEM_BLACK
;
3994 y
->color
= MEM_BLACK
;
3995 x
->parent
->parent
->color
= MEM_RED
;
3996 x
= x
->parent
->parent
;
4000 /* Parent and uncle have different colors; parent is
4001 red, uncle is black. */
4002 if (x
== x
->parent
->right
)
4005 mem_rotate_left (x
);
4008 x
->parent
->color
= MEM_BLACK
;
4009 x
->parent
->parent
->color
= MEM_RED
;
4010 mem_rotate_right (x
->parent
->parent
);
4015 /* This is the symmetrical case of above. */
4016 struct mem_node
*y
= x
->parent
->parent
->left
;
4018 if (y
->color
== MEM_RED
)
4020 x
->parent
->color
= MEM_BLACK
;
4021 y
->color
= MEM_BLACK
;
4022 x
->parent
->parent
->color
= MEM_RED
;
4023 x
= x
->parent
->parent
;
4027 if (x
== x
->parent
->left
)
4030 mem_rotate_right (x
);
4033 x
->parent
->color
= MEM_BLACK
;
4034 x
->parent
->parent
->color
= MEM_RED
;
4035 mem_rotate_left (x
->parent
->parent
);
4040 /* The root may have been changed to red due to the algorithm. Set
4041 it to black so that property #5 is satisfied. */
4042 mem_root
->color
= MEM_BLACK
;
4053 mem_rotate_left (struct mem_node
*x
)
4057 /* Turn y's left sub-tree into x's right sub-tree. */
4060 if (y
->left
!= MEM_NIL
)
4061 y
->left
->parent
= x
;
4063 /* Y's parent was x's parent. */
4065 y
->parent
= x
->parent
;
4067 /* Get the parent to point to y instead of x. */
4070 if (x
== x
->parent
->left
)
4071 x
->parent
->left
= y
;
4073 x
->parent
->right
= y
;
4078 /* Put x on y's left. */
4092 mem_rotate_right (struct mem_node
*x
)
4094 struct mem_node
*y
= x
->left
;
4097 if (y
->right
!= MEM_NIL
)
4098 y
->right
->parent
= x
;
4101 y
->parent
= x
->parent
;
4104 if (x
== x
->parent
->right
)
4105 x
->parent
->right
= y
;
4107 x
->parent
->left
= y
;
4118 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
4121 mem_delete (struct mem_node
*z
)
4123 struct mem_node
*x
, *y
;
4125 if (!z
|| z
== MEM_NIL
)
4128 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
4133 while (y
->left
!= MEM_NIL
)
4137 if (y
->left
!= MEM_NIL
)
4142 x
->parent
= y
->parent
;
4145 if (y
== y
->parent
->left
)
4146 y
->parent
->left
= x
;
4148 y
->parent
->right
= x
;
4155 z
->start
= y
->start
;
4160 if (y
->color
== MEM_BLACK
)
4161 mem_delete_fixup (x
);
4163 #ifdef GC_MALLOC_CHECK
4171 /* Re-establish the red-black properties of the tree, after a
4175 mem_delete_fixup (struct mem_node
*x
)
4177 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
4179 if (x
== x
->parent
->left
)
4181 struct mem_node
*w
= x
->parent
->right
;
4183 if (w
->color
== MEM_RED
)
4185 w
->color
= MEM_BLACK
;
4186 x
->parent
->color
= MEM_RED
;
4187 mem_rotate_left (x
->parent
);
4188 w
= x
->parent
->right
;
4191 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
4198 if (w
->right
->color
== MEM_BLACK
)
4200 w
->left
->color
= MEM_BLACK
;
4202 mem_rotate_right (w
);
4203 w
= x
->parent
->right
;
4205 w
->color
= x
->parent
->color
;
4206 x
->parent
->color
= MEM_BLACK
;
4207 w
->right
->color
= MEM_BLACK
;
4208 mem_rotate_left (x
->parent
);
4214 struct mem_node
*w
= x
->parent
->left
;
4216 if (w
->color
== MEM_RED
)
4218 w
->color
= MEM_BLACK
;
4219 x
->parent
->color
= MEM_RED
;
4220 mem_rotate_right (x
->parent
);
4221 w
= x
->parent
->left
;
4224 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
4231 if (w
->left
->color
== MEM_BLACK
)
4233 w
->right
->color
= MEM_BLACK
;
4235 mem_rotate_left (w
);
4236 w
= x
->parent
->left
;
4239 w
->color
= x
->parent
->color
;
4240 x
->parent
->color
= MEM_BLACK
;
4241 w
->left
->color
= MEM_BLACK
;
4242 mem_rotate_right (x
->parent
);
4248 x
->color
= MEM_BLACK
;
4252 /* Value is non-zero if P is a pointer to a live Lisp string on
4253 the heap. M is a pointer to the mem_block for P. */
4256 live_string_p (struct mem_node
*m
, void *p
)
4258 if (m
->type
== MEM_TYPE_STRING
)
4260 struct string_block
*b
= (struct string_block
*) m
->start
;
4261 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
4263 /* P must point to the start of a Lisp_String structure, and it
4264 must not be on the free-list. */
4266 && offset
% sizeof b
->strings
[0] == 0
4267 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
4268 && ((struct Lisp_String
*) p
)->data
!= NULL
);
4275 /* Value is non-zero if P is a pointer to a live Lisp cons on
4276 the heap. M is a pointer to the mem_block for P. */
4279 live_cons_p (struct mem_node
*m
, void *p
)
4281 if (m
->type
== MEM_TYPE_CONS
)
4283 struct cons_block
*b
= (struct cons_block
*) m
->start
;
4284 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
4286 /* P must point to the start of a Lisp_Cons, not be
4287 one of the unused cells in the current cons block,
4288 and not be on the free-list. */
4290 && offset
% sizeof b
->conses
[0] == 0
4291 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
4293 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
4294 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
4301 /* Value is non-zero if P is a pointer to a live Lisp symbol on
4302 the heap. M is a pointer to the mem_block for P. */
4305 live_symbol_p (struct mem_node
*m
, void *p
)
4307 if (m
->type
== MEM_TYPE_SYMBOL
)
4309 struct symbol_block
*b
= (struct symbol_block
*) m
->start
;
4310 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
4312 /* P must point to the start of a Lisp_Symbol, not be
4313 one of the unused cells in the current symbol block,
4314 and not be on the free-list. */
4316 && offset
% sizeof b
->symbols
[0] == 0
4317 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
4318 && (b
!= symbol_block
4319 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
4320 && !EQ (((struct Lisp_Symbol
*)p
)->function
, Vdead
));
4327 /* Value is non-zero if P is a pointer to a live Lisp float on
4328 the heap. M is a pointer to the mem_block for P. */
4331 live_float_p (struct mem_node
*m
, void *p
)
4333 if (m
->type
== MEM_TYPE_FLOAT
)
4335 struct float_block
*b
= (struct float_block
*) m
->start
;
4336 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
4338 /* P must point to the start of a Lisp_Float and not be
4339 one of the unused cells in the current float block. */
4341 && offset
% sizeof b
->floats
[0] == 0
4342 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
4343 && (b
!= float_block
4344 || offset
/ sizeof b
->floats
[0] < float_block_index
));
4351 /* Value is non-zero if P is a pointer to a live Lisp Misc on
4352 the heap. M is a pointer to the mem_block for P. */
4355 live_misc_p (struct mem_node
*m
, void *p
)
4357 if (m
->type
== MEM_TYPE_MISC
)
4359 struct marker_block
*b
= (struct marker_block
*) m
->start
;
4360 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
4362 /* P must point to the start of a Lisp_Misc, not be
4363 one of the unused cells in the current misc block,
4364 and not be on the free-list. */
4366 && offset
% sizeof b
->markers
[0] == 0
4367 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
4368 && (b
!= marker_block
4369 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
4370 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
4377 /* Value is non-zero if P is a pointer to a live vector-like object.
4378 M is a pointer to the mem_block for P. */
4381 live_vector_p (struct mem_node
*m
, void *p
)
4383 if (m
->type
== MEM_TYPE_VECTOR_BLOCK
)
4385 /* This memory node corresponds to a vector block. */
4386 struct vector_block
*block
= (struct vector_block
*) m
->start
;
4387 struct Lisp_Vector
*vector
= (struct Lisp_Vector
*) block
->data
;
4389 /* P is in the block's allocation range. Scan the block
4390 up to P and see whether P points to the start of some
4391 vector which is not on a free list. FIXME: check whether
4392 some allocation patterns (probably a lot of short vectors)
4393 may cause a substantial overhead of this loop. */
4394 while (VECTOR_IN_BLOCK (vector
, block
)
4395 && vector
<= (struct Lisp_Vector
*) p
)
4397 if (PSEUDOVECTOR_TYPEP (&vector
->header
, PVEC_FREE
))
4398 vector
= ADVANCE (vector
, (vector
->header
.size
4399 & PSEUDOVECTOR_SIZE_MASK
));
4400 else if (vector
== p
)
4403 vector
= ADVANCE (vector
, vector
->header
.next
.nbytes
);
4406 else if (m
->type
== MEM_TYPE_VECTORLIKE
&& p
== m
->start
)
4407 /* This memory node corresponds to a large vector. */
4413 /* Value is non-zero if P is a pointer to a live buffer. M is a
4414 pointer to the mem_block for P. */
4417 live_buffer_p (struct mem_node
*m
, void *p
)
4419 /* P must point to the start of the block, and the buffer
4420 must not have been killed. */
4421 return (m
->type
== MEM_TYPE_BUFFER
4423 && !NILP (((struct buffer
*) p
)->INTERNAL_FIELD (name
)));
4426 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4430 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4432 /* Array of objects that are kept alive because the C stack contains
4433 a pattern that looks like a reference to them . */
4435 #define MAX_ZOMBIES 10
4436 static Lisp_Object zombies
[MAX_ZOMBIES
];
4438 /* Number of zombie objects. */
4440 static EMACS_INT nzombies
;
4442 /* Number of garbage collections. */
4444 static EMACS_INT ngcs
;
4446 /* Average percentage of zombies per collection. */
4448 static double avg_zombies
;
4450 /* Max. number of live and zombie objects. */
4452 static EMACS_INT max_live
, max_zombies
;
4454 /* Average number of live objects per GC. */
4456 static double avg_live
;
4458 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
4459 doc
: /* Show information about live and zombie objects. */)
4462 Lisp_Object args
[8], zombie_list
= Qnil
;
4464 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); i
++)
4465 zombie_list
= Fcons (zombies
[i
], zombie_list
);
4466 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4467 args
[1] = make_number (ngcs
);
4468 args
[2] = make_float (avg_live
);
4469 args
[3] = make_float (avg_zombies
);
4470 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
4471 args
[5] = make_number (max_live
);
4472 args
[6] = make_number (max_zombies
);
4473 args
[7] = zombie_list
;
4474 return Fmessage (8, args
);
4477 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4480 /* Mark OBJ if we can prove it's a Lisp_Object. */
4483 mark_maybe_object (Lisp_Object obj
)
4491 po
= (void *) XPNTR (obj
);
4498 switch (XTYPE (obj
))
4501 mark_p
= (live_string_p (m
, po
)
4502 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4506 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4510 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4514 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4517 case Lisp_Vectorlike
:
4518 /* Note: can't check BUFFERP before we know it's a
4519 buffer because checking that dereferences the pointer
4520 PO which might point anywhere. */
4521 if (live_vector_p (m
, po
))
4522 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4523 else if (live_buffer_p (m
, po
))
4524 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4528 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4537 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4538 if (nzombies
< MAX_ZOMBIES
)
4539 zombies
[nzombies
] = obj
;
4548 /* If P points to Lisp data, mark that as live if it isn't already
4552 mark_maybe_pointer (void *p
)
4556 /* Quickly rule out some values which can't point to Lisp data.
4557 USE_LSB_TAG needs Lisp data to be aligned on multiples of GCALIGNMENT.
4558 Otherwise, assume that Lisp data is aligned on even addresses. */
4559 if ((intptr_t) p
% (USE_LSB_TAG
? GCALIGNMENT
: 2))
4565 Lisp_Object obj
= Qnil
;
4569 case MEM_TYPE_NON_LISP
:
4570 case MEM_TYPE_SPARE
:
4571 /* Nothing to do; not a pointer to Lisp memory. */
4574 case MEM_TYPE_BUFFER
:
4575 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P ((struct buffer
*)p
))
4576 XSETVECTOR (obj
, p
);
4580 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4584 case MEM_TYPE_STRING
:
4585 if (live_string_p (m
, p
)
4586 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4587 XSETSTRING (obj
, p
);
4591 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4595 case MEM_TYPE_SYMBOL
:
4596 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4597 XSETSYMBOL (obj
, p
);
4600 case MEM_TYPE_FLOAT
:
4601 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4605 case MEM_TYPE_VECTORLIKE
:
4606 case MEM_TYPE_VECTOR_BLOCK
:
4607 if (live_vector_p (m
, p
))
4610 XSETVECTOR (tem
, p
);
4611 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4626 /* Alignment of pointer values. Use alignof, as it sometimes returns
4627 a smaller alignment than GCC's __alignof__ and mark_memory might
4628 miss objects if __alignof__ were used. */
4629 #define GC_POINTER_ALIGNMENT alignof (void *)
4631 /* Define POINTERS_MIGHT_HIDE_IN_OBJECTS to 1 if marking via C pointers does
4632 not suffice, which is the typical case. A host where a Lisp_Object is
4633 wider than a pointer might allocate a Lisp_Object in non-adjacent halves.
4634 If USE_LSB_TAG, the bottom half is not a valid pointer, but it should
4635 suffice to widen it to to a Lisp_Object and check it that way. */
4636 #if USE_LSB_TAG || VAL_MAX < UINTPTR_MAX
4637 # if !USE_LSB_TAG && VAL_MAX < UINTPTR_MAX >> GCTYPEBITS
4638 /* If tag bits straddle pointer-word boundaries, neither mark_maybe_pointer
4639 nor mark_maybe_object can follow the pointers. This should not occur on
4640 any practical porting target. */
4641 # error "MSB type bits straddle pointer-word boundaries"
4643 /* Marking via C pointers does not suffice, because Lisp_Objects contain
4644 pointer words that hold pointers ORed with type bits. */
4645 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 1
4647 /* Marking via C pointers suffices, because Lisp_Objects contain pointer
4648 words that hold unmodified pointers. */
4649 # define POINTERS_MIGHT_HIDE_IN_OBJECTS 0
4652 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4653 or END+OFFSET..START. */
4656 mark_memory (void *start
, void *end
)
4657 #if defined (__clang__) && defined (__has_feature)
4658 #if __has_feature(address_sanitizer)
4659 /* Do not allow -faddress-sanitizer to check this function, since it
4660 crosses the function stack boundary, and thus would yield many
4662 __attribute__((no_address_safety_analysis
))
4669 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4673 /* Make START the pointer to the start of the memory region,
4674 if it isn't already. */
4682 /* Mark Lisp data pointed to. This is necessary because, in some
4683 situations, the C compiler optimizes Lisp objects away, so that
4684 only a pointer to them remains. Example:
4686 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4689 Lisp_Object obj = build_string ("test");
4690 struct Lisp_String *s = XSTRING (obj);
4691 Fgarbage_collect ();
4692 fprintf (stderr, "test `%s'\n", s->data);
4696 Here, `obj' isn't really used, and the compiler optimizes it
4697 away. The only reference to the life string is through the
4700 for (pp
= start
; (void *) pp
< end
; pp
++)
4701 for (i
= 0; i
< sizeof *pp
; i
+= GC_POINTER_ALIGNMENT
)
4703 void *p
= *(void **) ((char *) pp
+ i
);
4704 mark_maybe_pointer (p
);
4705 if (POINTERS_MIGHT_HIDE_IN_OBJECTS
)
4706 mark_maybe_object (XIL ((intptr_t) p
));
4710 /* setjmp will work with GCC unless NON_SAVING_SETJMP is defined in
4711 the GCC system configuration. In gcc 3.2, the only systems for
4712 which this is so are i386-sco5 non-ELF, i386-sysv3 (maybe included
4713 by others?) and ns32k-pc532-min. */
4715 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4717 static bool setjmp_tested_p
;
4718 static int longjmps_done
;
4720 #define SETJMP_WILL_LIKELY_WORK "\
4722 Emacs garbage collector has been changed to use conservative stack\n\
4723 marking. Emacs has determined that the method it uses to do the\n\
4724 marking will likely work on your system, but this isn't sure.\n\
4726 If you are a system-programmer, or can get the help of a local wizard\n\
4727 who is, please take a look at the function mark_stack in alloc.c, and\n\
4728 verify that the methods used are appropriate for your system.\n\
4730 Please mail the result to <emacs-devel@gnu.org>.\n\
4733 #define SETJMP_WILL_NOT_WORK "\
4735 Emacs garbage collector has been changed to use conservative stack\n\
4736 marking. Emacs has determined that the default method it uses to do the\n\
4737 marking will not work on your system. We will need a system-dependent\n\
4738 solution for your system.\n\
4740 Please take a look at the function mark_stack in alloc.c, and\n\
4741 try to find a way to make it work on your system.\n\
4743 Note that you may get false negatives, depending on the compiler.\n\
4744 In particular, you need to use -O with GCC for this test.\n\
4746 Please mail the result to <emacs-devel@gnu.org>.\n\
4750 /* Perform a quick check if it looks like setjmp saves registers in a
4751 jmp_buf. Print a message to stderr saying so. When this test
4752 succeeds, this is _not_ a proof that setjmp is sufficient for
4753 conservative stack marking. Only the sources or a disassembly
4763 /* Arrange for X to be put in a register. */
4769 if (longjmps_done
== 1)
4771 /* Came here after the longjmp at the end of the function.
4773 If x == 1, the longjmp has restored the register to its
4774 value before the setjmp, and we can hope that setjmp
4775 saves all such registers in the jmp_buf, although that
4778 For other values of X, either something really strange is
4779 taking place, or the setjmp just didn't save the register. */
4782 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4785 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4792 if (longjmps_done
== 1)
4796 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4799 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4801 /* Abort if anything GCPRO'd doesn't survive the GC. */
4809 for (p
= gcprolist
; p
; p
= p
->next
)
4810 for (i
= 0; i
< p
->nvars
; ++i
)
4811 if (!survives_gc_p (p
->var
[i
]))
4812 /* FIXME: It's not necessarily a bug. It might just be that the
4813 GCPRO is unnecessary or should release the object sooner. */
4817 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4824 fprintf (stderr
, "\nZombies kept alive = %"pI
"d:\n", nzombies
);
4825 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4827 fprintf (stderr
, " %d = ", i
);
4828 debug_print (zombies
[i
]);
4832 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4835 /* Mark live Lisp objects on the C stack.
4837 There are several system-dependent problems to consider when
4838 porting this to new architectures:
4842 We have to mark Lisp objects in CPU registers that can hold local
4843 variables or are used to pass parameters.
4845 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4846 something that either saves relevant registers on the stack, or
4847 calls mark_maybe_object passing it each register's contents.
4849 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4850 implementation assumes that calling setjmp saves registers we need
4851 to see in a jmp_buf which itself lies on the stack. This doesn't
4852 have to be true! It must be verified for each system, possibly
4853 by taking a look at the source code of setjmp.
4855 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4856 can use it as a machine independent method to store all registers
4857 to the stack. In this case the macros described in the previous
4858 two paragraphs are not used.
4862 Architectures differ in the way their processor stack is organized.
4863 For example, the stack might look like this
4866 | Lisp_Object | size = 4
4868 | something else | size = 2
4870 | Lisp_Object | size = 4
4874 In such a case, not every Lisp_Object will be aligned equally. To
4875 find all Lisp_Object on the stack it won't be sufficient to walk
4876 the stack in steps of 4 bytes. Instead, two passes will be
4877 necessary, one starting at the start of the stack, and a second
4878 pass starting at the start of the stack + 2. Likewise, if the
4879 minimal alignment of Lisp_Objects on the stack is 1, four passes
4880 would be necessary, each one starting with one byte more offset
4881 from the stack start. */
4888 #ifdef HAVE___BUILTIN_UNWIND_INIT
4889 /* Force callee-saved registers and register windows onto the stack.
4890 This is the preferred method if available, obviating the need for
4891 machine dependent methods. */
4892 __builtin_unwind_init ();
4894 #else /* not HAVE___BUILTIN_UNWIND_INIT */
4895 #ifndef GC_SAVE_REGISTERS_ON_STACK
4896 /* jmp_buf may not be aligned enough on darwin-ppc64 */
4897 union aligned_jmpbuf
{
4901 volatile bool stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4903 /* This trick flushes the register windows so that all the state of
4904 the process is contained in the stack. */
4905 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4906 needed on ia64 too. See mach_dep.c, where it also says inline
4907 assembler doesn't work with relevant proprietary compilers. */
4909 #if defined (__sparc64__) && defined (__FreeBSD__)
4910 /* FreeBSD does not have a ta 3 handler. */
4917 /* Save registers that we need to see on the stack. We need to see
4918 registers used to hold register variables and registers used to
4920 #ifdef GC_SAVE_REGISTERS_ON_STACK
4921 GC_SAVE_REGISTERS_ON_STACK (end
);
4922 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4924 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4925 setjmp will definitely work, test it
4926 and print a message with the result
4928 if (!setjmp_tested_p
)
4930 setjmp_tested_p
= 1;
4933 #endif /* GC_SETJMP_WORKS */
4936 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4937 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4938 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
4940 /* This assumes that the stack is a contiguous region in memory. If
4941 that's not the case, something has to be done here to iterate
4942 over the stack segments. */
4943 mark_memory (stack_base
, end
);
4945 /* Allow for marking a secondary stack, like the register stack on the
4947 #ifdef GC_MARK_SECONDARY_STACK
4948 GC_MARK_SECONDARY_STACK ();
4951 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4956 #endif /* GC_MARK_STACK != 0 */
4959 /* Determine whether it is safe to access memory at address P. */
4961 valid_pointer_p (void *p
)
4964 return w32_valid_pointer_p (p
, 16);
4968 /* Obviously, we cannot just access it (we would SEGV trying), so we
4969 trick the o/s to tell us whether p is a valid pointer.
4970 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4971 not validate p in that case. */
4975 bool valid
= emacs_write (fd
[1], (char *) p
, 16) == 16;
4976 emacs_close (fd
[1]);
4977 emacs_close (fd
[0]);
4985 /* Return 2 if OBJ is a killed or special buffer object.
4986 Return 1 if OBJ is a valid lisp object.
4987 Return 0 if OBJ is NOT a valid lisp object.
4988 Return -1 if we cannot validate OBJ.
4989 This function can be quite slow,
4990 so it should only be used in code for manual debugging. */
4993 valid_lisp_object_p (Lisp_Object obj
)
5003 p
= (void *) XPNTR (obj
);
5004 if (PURE_POINTER_P (p
))
5007 if (p
== &buffer_defaults
|| p
== &buffer_local_symbols
)
5011 return valid_pointer_p (p
);
5018 int valid
= valid_pointer_p (p
);
5030 case MEM_TYPE_NON_LISP
:
5031 case MEM_TYPE_SPARE
:
5034 case MEM_TYPE_BUFFER
:
5035 return live_buffer_p (m
, p
) ? 1 : 2;
5038 return live_cons_p (m
, p
);
5040 case MEM_TYPE_STRING
:
5041 return live_string_p (m
, p
);
5044 return live_misc_p (m
, p
);
5046 case MEM_TYPE_SYMBOL
:
5047 return live_symbol_p (m
, p
);
5049 case MEM_TYPE_FLOAT
:
5050 return live_float_p (m
, p
);
5052 case MEM_TYPE_VECTORLIKE
:
5053 case MEM_TYPE_VECTOR_BLOCK
:
5054 return live_vector_p (m
, p
);
5067 /***********************************************************************
5068 Pure Storage Management
5069 ***********************************************************************/
5071 /* Allocate room for SIZE bytes from pure Lisp storage and return a
5072 pointer to it. TYPE is the Lisp type for which the memory is
5073 allocated. TYPE < 0 means it's not used for a Lisp object. */
5076 pure_alloc (size_t size
, int type
)
5080 size_t alignment
= GCALIGNMENT
;
5082 size_t alignment
= alignof (EMACS_INT
);
5084 /* Give Lisp_Floats an extra alignment. */
5085 if (type
== Lisp_Float
)
5086 alignment
= alignof (struct Lisp_Float
);
5092 /* Allocate space for a Lisp object from the beginning of the free
5093 space with taking account of alignment. */
5094 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
5095 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
5099 /* Allocate space for a non-Lisp object from the end of the free
5101 pure_bytes_used_non_lisp
+= size
;
5102 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5104 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
5106 if (pure_bytes_used
<= pure_size
)
5109 /* Don't allocate a large amount here,
5110 because it might get mmap'd and then its address
5111 might not be usable. */
5112 purebeg
= xmalloc (10000);
5114 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
5115 pure_bytes_used
= 0;
5116 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
5121 /* Print a warning if PURESIZE is too small. */
5124 check_pure_size (void)
5126 if (pure_bytes_used_before_overflow
)
5127 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
5129 pure_bytes_used
+ pure_bytes_used_before_overflow
);
5133 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
5134 the non-Lisp data pool of the pure storage, and return its start
5135 address. Return NULL if not found. */
5138 find_string_data_in_pure (const char *data
, ptrdiff_t nbytes
)
5141 ptrdiff_t skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
5142 const unsigned char *p
;
5145 if (pure_bytes_used_non_lisp
<= nbytes
)
5148 /* Set up the Boyer-Moore table. */
5150 for (i
= 0; i
< 256; i
++)
5153 p
= (const unsigned char *) data
;
5155 bm_skip
[*p
++] = skip
;
5157 last_char_skip
= bm_skip
['\0'];
5159 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
5160 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
5162 /* See the comments in the function `boyer_moore' (search.c) for the
5163 use of `infinity'. */
5164 infinity
= pure_bytes_used_non_lisp
+ 1;
5165 bm_skip
['\0'] = infinity
;
5167 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
5171 /* Check the last character (== '\0'). */
5174 start
+= bm_skip
[*(p
+ start
)];
5176 while (start
<= start_max
);
5178 if (start
< infinity
)
5179 /* Couldn't find the last character. */
5182 /* No less than `infinity' means we could find the last
5183 character at `p[start - infinity]'. */
5186 /* Check the remaining characters. */
5187 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
5189 return non_lisp_beg
+ start
;
5191 start
+= last_char_skip
;
5193 while (start
<= start_max
);
5199 /* Return a string allocated in pure space. DATA is a buffer holding
5200 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
5201 means make the result string multibyte.
5203 Must get an error if pure storage is full, since if it cannot hold
5204 a large string it may be able to hold conses that point to that
5205 string; then the string is not protected from gc. */
5208 make_pure_string (const char *data
,
5209 ptrdiff_t nchars
, ptrdiff_t nbytes
, bool multibyte
)
5212 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5213 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
5214 if (s
->data
== NULL
)
5216 s
->data
= pure_alloc (nbytes
+ 1, -1);
5217 memcpy (s
->data
, data
, nbytes
);
5218 s
->data
[nbytes
] = '\0';
5221 s
->size_byte
= multibyte
? nbytes
: -1;
5222 s
->intervals
= NULL
;
5223 XSETSTRING (string
, s
);
5227 /* Return a string allocated in pure space. Do not
5228 allocate the string data, just point to DATA. */
5231 make_pure_c_string (const char *data
, ptrdiff_t nchars
)
5234 struct Lisp_String
*s
= pure_alloc (sizeof *s
, Lisp_String
);
5237 s
->data
= (unsigned char *) data
;
5238 s
->intervals
= NULL
;
5239 XSETSTRING (string
, s
);
5243 /* Return a cons allocated from pure space. Give it pure copies
5244 of CAR as car and CDR as cdr. */
5247 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
5250 struct Lisp_Cons
*p
= pure_alloc (sizeof *p
, Lisp_Cons
);
5252 XSETCAR (new, Fpurecopy (car
));
5253 XSETCDR (new, Fpurecopy (cdr
));
5258 /* Value is a float object with value NUM allocated from pure space. */
5261 make_pure_float (double num
)
5264 struct Lisp_Float
*p
= pure_alloc (sizeof *p
, Lisp_Float
);
5266 XFLOAT_INIT (new, num
);
5271 /* Return a vector with room for LEN Lisp_Objects allocated from
5275 make_pure_vector (ptrdiff_t len
)
5278 size_t size
= header_size
+ len
* word_size
;
5279 struct Lisp_Vector
*p
= pure_alloc (size
, Lisp_Vectorlike
);
5280 XSETVECTOR (new, p
);
5281 XVECTOR (new)->header
.size
= len
;
5286 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
5287 doc
: /* Make a copy of object OBJ in pure storage.
5288 Recursively copies contents of vectors and cons cells.
5289 Does not copy symbols. Copies strings without text properties. */)
5290 (register Lisp_Object obj
)
5292 if (NILP (Vpurify_flag
))
5295 if (PURE_POINTER_P (XPNTR (obj
)))
5298 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5300 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
5306 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
5307 else if (FLOATP (obj
))
5308 obj
= make_pure_float (XFLOAT_DATA (obj
));
5309 else if (STRINGP (obj
))
5310 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
5312 STRING_MULTIBYTE (obj
));
5313 else if (COMPILEDP (obj
) || VECTORP (obj
))
5315 register struct Lisp_Vector
*vec
;
5316 register ptrdiff_t i
;
5320 if (size
& PSEUDOVECTOR_FLAG
)
5321 size
&= PSEUDOVECTOR_SIZE_MASK
;
5322 vec
= XVECTOR (make_pure_vector (size
));
5323 for (i
= 0; i
< size
; i
++)
5324 vec
->contents
[i
] = Fpurecopy (AREF (obj
, i
));
5325 if (COMPILEDP (obj
))
5327 XSETPVECTYPE (vec
, PVEC_COMPILED
);
5328 XSETCOMPILED (obj
, vec
);
5331 XSETVECTOR (obj
, vec
);
5333 else if (MARKERP (obj
))
5334 error ("Attempt to copy a marker to pure storage");
5336 /* Not purified, don't hash-cons. */
5339 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
5340 Fputhash (obj
, obj
, Vpurify_flag
);
5347 /***********************************************************************
5349 ***********************************************************************/
5351 /* Put an entry in staticvec, pointing at the variable with address
5355 staticpro (Lisp_Object
*varaddress
)
5357 staticvec
[staticidx
++] = varaddress
;
5358 if (staticidx
>= NSTATICS
)
5363 /***********************************************************************
5365 ***********************************************************************/
5367 /* Temporarily prevent garbage collection. */
5370 inhibit_garbage_collection (void)
5372 ptrdiff_t count
= SPECPDL_INDEX ();
5374 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
5378 /* Used to avoid possible overflows when
5379 converting from C to Lisp integers. */
5381 static inline Lisp_Object
5382 bounded_number (EMACS_INT number
)
5384 return make_number (min (MOST_POSITIVE_FIXNUM
, number
));
5387 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
5388 doc
: /* Reclaim storage for Lisp objects no longer needed.
5389 Garbage collection happens automatically if you cons more than
5390 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5391 `garbage-collect' normally returns a list with info on amount of space in use,
5392 where each entry has the form (NAME SIZE USED FREE), where:
5393 - NAME is a symbol describing the kind of objects this entry represents,
5394 - SIZE is the number of bytes used by each one,
5395 - USED is the number of those objects that were found live in the heap,
5396 - FREE is the number of those objects that are not live but that Emacs
5397 keeps around for future allocations (maybe because it does not know how
5398 to return them to the OS).
5399 However, if there was overflow in pure space, `garbage-collect'
5400 returns nil, because real GC can't be done.
5401 See Info node `(elisp)Garbage Collection'. */)
5404 struct specbinding
*bind
;
5405 struct buffer
*nextb
;
5406 char stack_top_variable
;
5409 ptrdiff_t count
= SPECPDL_INDEX ();
5411 Lisp_Object retval
= Qnil
;
5416 /* Can't GC if pure storage overflowed because we can't determine
5417 if something is a pure object or not. */
5418 if (pure_bytes_used_before_overflow
)
5423 /* Don't keep undo information around forever.
5424 Do this early on, so it is no problem if the user quits. */
5425 FOR_EACH_BUFFER (nextb
)
5426 compact_buffer (nextb
);
5428 start
= current_emacs_time ();
5430 /* In case user calls debug_print during GC,
5431 don't let that cause a recursive GC. */
5432 consing_since_gc
= 0;
5434 /* Save what's currently displayed in the echo area. */
5435 message_p
= push_message ();
5436 record_unwind_protect (pop_message_unwind
, Qnil
);
5438 /* Save a copy of the contents of the stack, for debugging. */
5439 #if MAX_SAVE_STACK > 0
5440 if (NILP (Vpurify_flag
))
5443 ptrdiff_t stack_size
;
5444 if (&stack_top_variable
< stack_bottom
)
5446 stack
= &stack_top_variable
;
5447 stack_size
= stack_bottom
- &stack_top_variable
;
5451 stack
= stack_bottom
;
5452 stack_size
= &stack_top_variable
- stack_bottom
;
5454 if (stack_size
<= MAX_SAVE_STACK
)
5456 if (stack_copy_size
< stack_size
)
5458 stack_copy
= xrealloc (stack_copy
, stack_size
);
5459 stack_copy_size
= stack_size
;
5461 memcpy (stack_copy
, stack
, stack_size
);
5464 #endif /* MAX_SAVE_STACK > 0 */
5466 if (garbage_collection_messages
)
5467 message1_nolog ("Garbage collecting...");
5471 shrink_regexp_cache ();
5475 /* Mark all the special slots that serve as the roots of accessibility. */
5477 mark_buffer (&buffer_defaults
);
5478 mark_buffer (&buffer_local_symbols
);
5480 for (i
= 0; i
< staticidx
; i
++)
5481 mark_object (*staticvec
[i
]);
5483 for (bind
= specpdl
; bind
!= specpdl_ptr
; bind
++)
5485 mark_object (bind
->symbol
);
5486 mark_object (bind
->old_value
);
5495 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5496 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5500 register struct gcpro
*tail
;
5501 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5502 for (i
= 0; i
< tail
->nvars
; i
++)
5503 mark_object (tail
->var
[i
]);
5507 struct catchtag
*catch;
5508 struct handler
*handler
;
5510 for (catch = catchlist
; catch; catch = catch->next
)
5512 mark_object (catch->tag
);
5513 mark_object (catch->val
);
5515 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5517 mark_object (handler
->handler
);
5518 mark_object (handler
->var
);
5524 #ifdef HAVE_WINDOW_SYSTEM
5525 mark_fringe_data ();
5528 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5532 /* Everything is now marked, except for the things that require special
5533 finalization, i.e. the undo_list.
5534 Look thru every buffer's undo list
5535 for elements that update markers that were not marked,
5537 FOR_EACH_BUFFER (nextb
)
5539 /* If a buffer's undo list is Qt, that means that undo is
5540 turned off in that buffer. Calling truncate_undo_list on
5541 Qt tends to return NULL, which effectively turns undo back on.
5542 So don't call truncate_undo_list if undo_list is Qt. */
5543 if (! EQ (nextb
->INTERNAL_FIELD (undo_list
), Qt
))
5545 Lisp_Object tail
, prev
;
5546 tail
= nextb
->INTERNAL_FIELD (undo_list
);
5548 while (CONSP (tail
))
5550 if (CONSP (XCAR (tail
))
5551 && MARKERP (XCAR (XCAR (tail
)))
5552 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5555 nextb
->INTERNAL_FIELD (undo_list
) = tail
= XCDR (tail
);
5559 XSETCDR (prev
, tail
);
5569 /* Now that we have stripped the elements that need not be in the
5570 undo_list any more, we can finally mark the list. */
5571 mark_object (nextb
->INTERNAL_FIELD (undo_list
));
5576 /* Clear the mark bits that we set in certain root slots. */
5578 unmark_byte_stack ();
5579 VECTOR_UNMARK (&buffer_defaults
);
5580 VECTOR_UNMARK (&buffer_local_symbols
);
5582 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5592 consing_since_gc
= 0;
5593 if (gc_cons_threshold
< GC_DEFAULT_THRESHOLD
/ 10)
5594 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
/ 10;
5596 gc_relative_threshold
= 0;
5597 if (FLOATP (Vgc_cons_percentage
))
5598 { /* Set gc_cons_combined_threshold. */
5601 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5602 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5603 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5604 tot
+= total_string_bytes
;
5605 tot
+= total_vector_slots
* word_size
;
5606 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5607 tot
+= total_intervals
* sizeof (struct interval
);
5608 tot
+= total_strings
* sizeof (struct Lisp_String
);
5610 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5613 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5614 gc_relative_threshold
= tot
;
5616 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5620 if (garbage_collection_messages
)
5622 if (message_p
|| minibuf_level
> 0)
5625 message1_nolog ("Garbage collecting...done");
5628 unbind_to (count
, Qnil
);
5630 Lisp_Object total
[11];
5631 int total_size
= 10;
5633 total
[0] = list4 (Qconses
, make_number (sizeof (struct Lisp_Cons
)),
5634 bounded_number (total_conses
),
5635 bounded_number (total_free_conses
));
5637 total
[1] = list4 (Qsymbols
, make_number (sizeof (struct Lisp_Symbol
)),
5638 bounded_number (total_symbols
),
5639 bounded_number (total_free_symbols
));
5641 total
[2] = list4 (Qmiscs
, make_number (sizeof (union Lisp_Misc
)),
5642 bounded_number (total_markers
),
5643 bounded_number (total_free_markers
));
5645 total
[3] = list4 (Qstrings
, make_number (sizeof (struct Lisp_String
)),
5646 bounded_number (total_strings
),
5647 bounded_number (total_free_strings
));
5649 total
[4] = list3 (Qstring_bytes
, make_number (1),
5650 bounded_number (total_string_bytes
));
5652 total
[5] = list3 (Qvectors
, make_number (sizeof (struct Lisp_Vector
)),
5653 bounded_number (total_vectors
));
5655 total
[6] = list4 (Qvector_slots
, make_number (word_size
),
5656 bounded_number (total_vector_slots
),
5657 bounded_number (total_free_vector_slots
));
5659 total
[7] = list4 (Qfloats
, make_number (sizeof (struct Lisp_Float
)),
5660 bounded_number (total_floats
),
5661 bounded_number (total_free_floats
));
5663 total
[8] = list4 (Qintervals
, make_number (sizeof (struct interval
)),
5664 bounded_number (total_intervals
),
5665 bounded_number (total_free_intervals
));
5667 total
[9] = list3 (Qbuffers
, make_number (sizeof (struct buffer
)),
5668 bounded_number (total_buffers
));
5670 #ifdef DOUG_LEA_MALLOC
5672 total
[10] = list4 (Qheap
, make_number (1024),
5673 bounded_number ((mallinfo ().uordblks
+ 1023) >> 10),
5674 bounded_number ((mallinfo ().fordblks
+ 1023) >> 10));
5676 retval
= Flist (total_size
, total
);
5679 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5681 /* Compute average percentage of zombies. */
5683 = (total_conses
+ total_symbols
+ total_markers
+ total_strings
5684 + total_vectors
+ total_floats
+ total_intervals
+ total_buffers
);
5686 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5687 max_live
= max (nlive
, max_live
);
5688 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5689 max_zombies
= max (nzombies
, max_zombies
);
5694 if (!NILP (Vpost_gc_hook
))
5696 ptrdiff_t gc_count
= inhibit_garbage_collection ();
5697 safe_run_hooks (Qpost_gc_hook
);
5698 unbind_to (gc_count
, Qnil
);
5701 /* Accumulate statistics. */
5702 if (FLOATP (Vgc_elapsed
))
5704 EMACS_TIME since_start
= sub_emacs_time (current_emacs_time (), start
);
5705 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
)
5706 + EMACS_TIME_TO_DOUBLE (since_start
));
5715 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5716 only interesting objects referenced from glyphs are strings. */
5719 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5721 struct glyph_row
*row
= matrix
->rows
;
5722 struct glyph_row
*end
= row
+ matrix
->nrows
;
5724 for (; row
< end
; ++row
)
5728 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5730 struct glyph
*glyph
= row
->glyphs
[area
];
5731 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5733 for (; glyph
< end_glyph
; ++glyph
)
5734 if (STRINGP (glyph
->object
)
5735 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5736 mark_object (glyph
->object
);
5742 /* Mark Lisp faces in the face cache C. */
5745 mark_face_cache (struct face_cache
*c
)
5750 for (i
= 0; i
< c
->used
; ++i
)
5752 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5756 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5757 mark_object (face
->lface
[j
]);
5765 /* Mark reference to a Lisp_Object.
5766 If the object referred to has not been seen yet, recursively mark
5767 all the references contained in it. */
5769 #define LAST_MARKED_SIZE 500
5770 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5771 static int last_marked_index
;
5773 /* For debugging--call abort when we cdr down this many
5774 links of a list, in mark_object. In debugging,
5775 the call to abort will hit a breakpoint.
5776 Normally this is zero and the check never goes off. */
5777 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5780 mark_vectorlike (struct Lisp_Vector
*ptr
)
5782 ptrdiff_t size
= ptr
->header
.size
;
5785 eassert (!VECTOR_MARKED_P (ptr
));
5786 VECTOR_MARK (ptr
); /* Else mark it. */
5787 if (size
& PSEUDOVECTOR_FLAG
)
5788 size
&= PSEUDOVECTOR_SIZE_MASK
;
5790 /* Note that this size is not the memory-footprint size, but only
5791 the number of Lisp_Object fields that we should trace.
5792 The distinction is used e.g. by Lisp_Process which places extra
5793 non-Lisp_Object fields at the end of the structure... */
5794 for (i
= 0; i
< size
; i
++) /* ...and then mark its elements. */
5795 mark_object (ptr
->contents
[i
]);
5798 /* Like mark_vectorlike but optimized for char-tables (and
5799 sub-char-tables) assuming that the contents are mostly integers or
5803 mark_char_table (struct Lisp_Vector
*ptr
)
5805 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5808 eassert (!VECTOR_MARKED_P (ptr
));
5810 for (i
= 0; i
< size
; i
++)
5812 Lisp_Object val
= ptr
->contents
[i
];
5814 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5816 if (SUB_CHAR_TABLE_P (val
))
5818 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5819 mark_char_table (XVECTOR (val
));
5826 /* Mark the chain of overlays starting at PTR. */
5829 mark_overlay (struct Lisp_Overlay
*ptr
)
5831 for (; ptr
&& !ptr
->gcmarkbit
; ptr
= ptr
->next
)
5834 mark_object (ptr
->start
);
5835 mark_object (ptr
->end
);
5836 mark_object (ptr
->plist
);
5840 /* Mark Lisp_Objects and special pointers in BUFFER. */
5843 mark_buffer (struct buffer
*buffer
)
5845 if (NILP (BVAR (buffer
, name
)))
5846 /* If the buffer is killed, mark just the buffer itself. */
5847 VECTOR_MARK (buffer
);
5850 /* This is handled much like other pseudovectors... */
5851 mark_vectorlike ((struct Lisp_Vector
*) buffer
);
5853 /* ...but there are some buffer-specific things. */
5855 MARK_INTERVAL_TREE (buffer_intervals (buffer
));
5857 /* For now, we just don't mark the undo_list. It's done later in
5858 a special way just before the sweep phase, and after stripping
5859 some of its elements that are not needed any more. */
5861 mark_overlay (buffer
->overlays_before
);
5862 mark_overlay (buffer
->overlays_after
);
5864 /* If this is an indirect buffer, mark its base buffer. */
5865 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5866 mark_buffer (buffer
->base_buffer
);
5870 /* Determine type of generic Lisp_Object and mark it accordingly. */
5873 mark_object (Lisp_Object arg
)
5875 register Lisp_Object obj
= arg
;
5876 #ifdef GC_CHECK_MARKED_OBJECTS
5880 ptrdiff_t cdr_count
= 0;
5884 if (PURE_POINTER_P (XPNTR (obj
)))
5887 last_marked
[last_marked_index
++] = obj
;
5888 if (last_marked_index
== LAST_MARKED_SIZE
)
5889 last_marked_index
= 0;
5891 /* Perform some sanity checks on the objects marked here. Abort if
5892 we encounter an object we know is bogus. This increases GC time
5893 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5894 #ifdef GC_CHECK_MARKED_OBJECTS
5896 po
= (void *) XPNTR (obj
);
5898 /* Check that the object pointed to by PO is known to be a Lisp
5899 structure allocated from the heap. */
5900 #define CHECK_ALLOCATED() \
5902 m = mem_find (po); \
5907 /* Check that the object pointed to by PO is live, using predicate
5909 #define CHECK_LIVE(LIVEP) \
5911 if (!LIVEP (m, po)) \
5915 /* Check both of the above conditions. */
5916 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5918 CHECK_ALLOCATED (); \
5919 CHECK_LIVE (LIVEP); \
5922 #else /* not GC_CHECK_MARKED_OBJECTS */
5924 #define CHECK_LIVE(LIVEP) (void) 0
5925 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5927 #endif /* not GC_CHECK_MARKED_OBJECTS */
5929 switch (XTYPE (obj
))
5933 register struct Lisp_String
*ptr
= XSTRING (obj
);
5934 if (STRING_MARKED_P (ptr
))
5936 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
5938 MARK_INTERVAL_TREE (ptr
->intervals
);
5939 #ifdef GC_CHECK_STRING_BYTES
5940 /* Check that the string size recorded in the string is the
5941 same as the one recorded in the sdata structure. */
5943 #endif /* GC_CHECK_STRING_BYTES */
5947 case Lisp_Vectorlike
:
5949 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5950 register ptrdiff_t pvectype
;
5952 if (VECTOR_MARKED_P (ptr
))
5955 #ifdef GC_CHECK_MARKED_OBJECTS
5957 if (m
== MEM_NIL
&& !SUBRP (obj
))
5959 #endif /* GC_CHECK_MARKED_OBJECTS */
5961 if (ptr
->header
.size
& PSEUDOVECTOR_FLAG
)
5962 pvectype
= ((ptr
->header
.size
& PVEC_TYPE_MASK
)
5963 >> PSEUDOVECTOR_SIZE_BITS
);
5967 if (pvectype
!= PVEC_SUBR
&& pvectype
!= PVEC_BUFFER
)
5968 CHECK_LIVE (live_vector_p
);
5973 #ifdef GC_CHECK_MARKED_OBJECTS
5982 #endif /* GC_CHECK_MARKED_OBJECTS */
5983 mark_buffer ((struct buffer
*) ptr
);
5987 { /* We could treat this just like a vector, but it is better
5988 to save the COMPILED_CONSTANTS element for last and avoid
5990 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5994 for (i
= 0; i
< size
; i
++)
5995 if (i
!= COMPILED_CONSTANTS
)
5996 mark_object (ptr
->contents
[i
]);
5997 if (size
> COMPILED_CONSTANTS
)
5999 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
6007 struct frame
*f
= (struct frame
*) ptr
;
6009 if (FRAME_LIVE_P (f
))
6011 mark_vectorlike (ptr
);
6012 mark_face_cache (f
->face_cache
);
6015 /* If the frame is deleted, mark just the frame itself. */
6022 struct window
*w
= (struct window
*) ptr
;
6024 /* Even if the window is deleted, we can't mark just the window
6025 itself because set-window-configuration can resurrect it. */
6026 mark_vectorlike (ptr
);
6027 /* Mark glyphs for leaf windows. Marking window
6028 matrices is sufficient because frame matrices
6029 use the same glyph memory. */
6030 if (NILP (w
->hchild
) && NILP (w
->vchild
)
6031 && w
->current_matrix
)
6033 mark_glyph_matrix (w
->current_matrix
);
6034 mark_glyph_matrix (w
->desired_matrix
);
6039 case PVEC_HASH_TABLE
:
6041 struct Lisp_Hash_Table
*h
= (struct Lisp_Hash_Table
*) ptr
;
6043 mark_vectorlike (ptr
);
6044 /* If hash table is not weak, mark all keys and values.
6045 For weak tables, mark only the vector. */
6047 mark_object (h
->key_and_value
);
6049 VECTOR_MARK (XVECTOR (h
->key_and_value
));
6053 case PVEC_CHAR_TABLE
:
6054 mark_char_table (ptr
);
6057 case PVEC_BOOL_VECTOR
:
6058 /* No Lisp_Objects to mark in a bool vector. */
6069 mark_vectorlike (ptr
);
6076 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
6077 struct Lisp_Symbol
*ptrx
;
6081 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
6083 mark_object (ptr
->function
);
6084 mark_object (ptr
->plist
);
6085 switch (ptr
->redirect
)
6087 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
6088 case SYMBOL_VARALIAS
:
6091 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
6095 case SYMBOL_LOCALIZED
:
6097 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
6098 /* If the value is forwarded to a buffer or keyboard field,
6099 these are marked when we see the corresponding object.
6100 And if it's forwarded to a C variable, either it's not
6101 a Lisp_Object var, or it's staticpro'd already. */
6102 mark_object (blv
->where
);
6103 mark_object (blv
->valcell
);
6104 mark_object (blv
->defcell
);
6107 case SYMBOL_FORWARDED
:
6108 /* If the value is forwarded to a buffer or keyboard field,
6109 these are marked when we see the corresponding object.
6110 And if it's forwarded to a C variable, either it's not
6111 a Lisp_Object var, or it's staticpro'd already. */
6113 default: emacs_abort ();
6115 if (!PURE_POINTER_P (XSTRING (ptr
->name
)))
6116 MARK_STRING (XSTRING (ptr
->name
));
6117 MARK_INTERVAL_TREE (string_intervals (ptr
->name
));
6122 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun. */
6123 XSETSYMBOL (obj
, ptrx
);
6130 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
6132 if (XMISCANY (obj
)->gcmarkbit
)
6135 switch (XMISCTYPE (obj
))
6137 case Lisp_Misc_Marker
:
6138 /* DO NOT mark thru the marker's chain.
6139 The buffer's markers chain does not preserve markers from gc;
6140 instead, markers are removed from the chain when freed by gc. */
6141 XMISCANY (obj
)->gcmarkbit
= 1;
6144 case Lisp_Misc_Save_Value
:
6145 XMISCANY (obj
)->gcmarkbit
= 1;
6148 register struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
6149 /* If DOGC is set, POINTER is the address of a memory
6150 area containing INTEGER potential Lisp_Objects. */
6153 Lisp_Object
*p
= (Lisp_Object
*) ptr
->pointer
;
6155 for (nelt
= ptr
->integer
; nelt
> 0; nelt
--, p
++)
6156 mark_maybe_object (*p
);
6162 case Lisp_Misc_Overlay
:
6163 mark_overlay (XOVERLAY (obj
));
6173 register struct Lisp_Cons
*ptr
= XCONS (obj
);
6174 if (CONS_MARKED_P (ptr
))
6176 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
6178 /* If the cdr is nil, avoid recursion for the car. */
6179 if (EQ (ptr
->u
.cdr
, Qnil
))
6185 mark_object (ptr
->car
);
6188 if (cdr_count
== mark_object_loop_halt
)
6194 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
6195 FLOAT_MARK (XFLOAT (obj
));
6206 #undef CHECK_ALLOCATED
6207 #undef CHECK_ALLOCATED_AND_LIVE
6209 /* Mark the Lisp pointers in the terminal objects.
6210 Called by Fgarbage_collect. */
6213 mark_terminals (void)
6216 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
6218 eassert (t
->name
!= NULL
);
6219 #ifdef HAVE_WINDOW_SYSTEM
6220 /* If a terminal object is reachable from a stacpro'ed object,
6221 it might have been marked already. Make sure the image cache
6223 mark_image_cache (t
->image_cache
);
6224 #endif /* HAVE_WINDOW_SYSTEM */
6225 if (!VECTOR_MARKED_P (t
))
6226 mark_vectorlike ((struct Lisp_Vector
*)t
);
6232 /* Value is non-zero if OBJ will survive the current GC because it's
6233 either marked or does not need to be marked to survive. */
6236 survives_gc_p (Lisp_Object obj
)
6240 switch (XTYPE (obj
))
6247 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
6251 survives_p
= XMISCANY (obj
)->gcmarkbit
;
6255 survives_p
= STRING_MARKED_P (XSTRING (obj
));
6258 case Lisp_Vectorlike
:
6259 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
6263 survives_p
= CONS_MARKED_P (XCONS (obj
));
6267 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
6274 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
6279 /* Sweep: find all structures not marked, and free them. */
6284 /* Remove or mark entries in weak hash tables.
6285 This must be done before any object is unmarked. */
6286 sweep_weak_hash_tables ();
6289 check_string_bytes (!noninteractive
);
6291 /* Put all unmarked conses on free list */
6293 register struct cons_block
*cblk
;
6294 struct cons_block
**cprev
= &cons_block
;
6295 register int lim
= cons_block_index
;
6296 EMACS_INT num_free
= 0, num_used
= 0;
6300 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
6304 int ilim
= (lim
+ BITS_PER_INT
- 1) / BITS_PER_INT
;
6306 /* Scan the mark bits an int at a time. */
6307 for (i
= 0; i
< ilim
; i
++)
6309 if (cblk
->gcmarkbits
[i
] == -1)
6311 /* Fast path - all cons cells for this int are marked. */
6312 cblk
->gcmarkbits
[i
] = 0;
6313 num_used
+= BITS_PER_INT
;
6317 /* Some cons cells for this int are not marked.
6318 Find which ones, and free them. */
6319 int start
, pos
, stop
;
6321 start
= i
* BITS_PER_INT
;
6323 if (stop
> BITS_PER_INT
)
6324 stop
= BITS_PER_INT
;
6327 for (pos
= start
; pos
< stop
; pos
++)
6329 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
6332 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
6333 cons_free_list
= &cblk
->conses
[pos
];
6335 cons_free_list
->car
= Vdead
;
6341 CONS_UNMARK (&cblk
->conses
[pos
]);
6347 lim
= CONS_BLOCK_SIZE
;
6348 /* If this block contains only free conses and we have already
6349 seen more than two blocks worth of free conses then deallocate
6351 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
6353 *cprev
= cblk
->next
;
6354 /* Unhook from the free list. */
6355 cons_free_list
= cblk
->conses
[0].u
.chain
;
6356 lisp_align_free (cblk
);
6360 num_free
+= this_free
;
6361 cprev
= &cblk
->next
;
6364 total_conses
= num_used
;
6365 total_free_conses
= num_free
;
6368 /* Put all unmarked floats on free list */
6370 register struct float_block
*fblk
;
6371 struct float_block
**fprev
= &float_block
;
6372 register int lim
= float_block_index
;
6373 EMACS_INT num_free
= 0, num_used
= 0;
6375 float_free_list
= 0;
6377 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
6381 for (i
= 0; i
< lim
; i
++)
6382 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
6385 fblk
->floats
[i
].u
.chain
= float_free_list
;
6386 float_free_list
= &fblk
->floats
[i
];
6391 FLOAT_UNMARK (&fblk
->floats
[i
]);
6393 lim
= FLOAT_BLOCK_SIZE
;
6394 /* If this block contains only free floats and we have already
6395 seen more than two blocks worth of free floats then deallocate
6397 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
6399 *fprev
= fblk
->next
;
6400 /* Unhook from the free list. */
6401 float_free_list
= fblk
->floats
[0].u
.chain
;
6402 lisp_align_free (fblk
);
6406 num_free
+= this_free
;
6407 fprev
= &fblk
->next
;
6410 total_floats
= num_used
;
6411 total_free_floats
= num_free
;
6414 /* Put all unmarked intervals on free list */
6416 register struct interval_block
*iblk
;
6417 struct interval_block
**iprev
= &interval_block
;
6418 register int lim
= interval_block_index
;
6419 EMACS_INT num_free
= 0, num_used
= 0;
6421 interval_free_list
= 0;
6423 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
6428 for (i
= 0; i
< lim
; i
++)
6430 if (!iblk
->intervals
[i
].gcmarkbit
)
6432 set_interval_parent (&iblk
->intervals
[i
], interval_free_list
);
6433 interval_free_list
= &iblk
->intervals
[i
];
6439 iblk
->intervals
[i
].gcmarkbit
= 0;
6442 lim
= INTERVAL_BLOCK_SIZE
;
6443 /* If this block contains only free intervals and we have already
6444 seen more than two blocks worth of free intervals then
6445 deallocate this block. */
6446 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
6448 *iprev
= iblk
->next
;
6449 /* Unhook from the free list. */
6450 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
6455 num_free
+= this_free
;
6456 iprev
= &iblk
->next
;
6459 total_intervals
= num_used
;
6460 total_free_intervals
= num_free
;
6463 /* Put all unmarked symbols on free list */
6465 register struct symbol_block
*sblk
;
6466 struct symbol_block
**sprev
= &symbol_block
;
6467 register int lim
= symbol_block_index
;
6468 EMACS_INT num_free
= 0, num_used
= 0;
6470 symbol_free_list
= NULL
;
6472 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
6475 union aligned_Lisp_Symbol
*sym
= sblk
->symbols
;
6476 union aligned_Lisp_Symbol
*end
= sym
+ lim
;
6478 for (; sym
< end
; ++sym
)
6480 /* Check if the symbol was created during loadup. In such a case
6481 it might be pointed to by pure bytecode which we don't trace,
6482 so we conservatively assume that it is live. */
6483 bool pure_p
= PURE_POINTER_P (XSTRING (sym
->s
.name
));
6485 if (!sym
->s
.gcmarkbit
&& !pure_p
)
6487 if (sym
->s
.redirect
== SYMBOL_LOCALIZED
)
6488 xfree (SYMBOL_BLV (&sym
->s
));
6489 sym
->s
.next
= symbol_free_list
;
6490 symbol_free_list
= &sym
->s
;
6492 symbol_free_list
->function
= Vdead
;
6500 UNMARK_STRING (XSTRING (sym
->s
.name
));
6501 sym
->s
.gcmarkbit
= 0;
6505 lim
= SYMBOL_BLOCK_SIZE
;
6506 /* If this block contains only free symbols and we have already
6507 seen more than two blocks worth of free symbols then deallocate
6509 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
6511 *sprev
= sblk
->next
;
6512 /* Unhook from the free list. */
6513 symbol_free_list
= sblk
->symbols
[0].s
.next
;
6518 num_free
+= this_free
;
6519 sprev
= &sblk
->next
;
6522 total_symbols
= num_used
;
6523 total_free_symbols
= num_free
;
6526 /* Put all unmarked misc's on free list.
6527 For a marker, first unchain it from the buffer it points into. */
6529 register struct marker_block
*mblk
;
6530 struct marker_block
**mprev
= &marker_block
;
6531 register int lim
= marker_block_index
;
6532 EMACS_INT num_free
= 0, num_used
= 0;
6534 marker_free_list
= 0;
6536 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6541 for (i
= 0; i
< lim
; i
++)
6543 if (!mblk
->markers
[i
].m
.u_any
.gcmarkbit
)
6545 if (mblk
->markers
[i
].m
.u_any
.type
== Lisp_Misc_Marker
)
6546 unchain_marker (&mblk
->markers
[i
].m
.u_marker
);
6547 /* Set the type of the freed object to Lisp_Misc_Free.
6548 We could leave the type alone, since nobody checks it,
6549 but this might catch bugs faster. */
6550 mblk
->markers
[i
].m
.u_marker
.type
= Lisp_Misc_Free
;
6551 mblk
->markers
[i
].m
.u_free
.chain
= marker_free_list
;
6552 marker_free_list
= &mblk
->markers
[i
].m
;
6558 mblk
->markers
[i
].m
.u_any
.gcmarkbit
= 0;
6561 lim
= MARKER_BLOCK_SIZE
;
6562 /* If this block contains only free markers and we have already
6563 seen more than two blocks worth of free markers then deallocate
6565 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6567 *mprev
= mblk
->next
;
6568 /* Unhook from the free list. */
6569 marker_free_list
= mblk
->markers
[0].m
.u_free
.chain
;
6574 num_free
+= this_free
;
6575 mprev
= &mblk
->next
;
6579 total_markers
= num_used
;
6580 total_free_markers
= num_free
;
6583 /* Free all unmarked buffers */
6585 register struct buffer
*buffer
= all_buffers
, *prev
= 0, *next
;
6589 if (!VECTOR_MARKED_P (buffer
))
6592 prev
->header
.next
= buffer
->header
.next
;
6594 all_buffers
= buffer
->header
.next
.buffer
;
6595 next
= buffer
->header
.next
.buffer
;
6601 VECTOR_UNMARK (buffer
);
6602 /* Do not use buffer_(set|get)_intervals here. */
6603 buffer
->text
->intervals
= balance_intervals (buffer
->text
->intervals
);
6605 prev
= buffer
, buffer
= buffer
->header
.next
.buffer
;
6610 check_string_bytes (!noninteractive
);
6616 /* Debugging aids. */
6618 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6619 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6620 This may be helpful in debugging Emacs's memory usage.
6621 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6626 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6631 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6632 doc
: /* Return a list of counters that measure how much consing there has been.
6633 Each of these counters increments for a certain kind of object.
6634 The counters wrap around from the largest positive integer to zero.
6635 Garbage collection does not decrease them.
6636 The elements of the value are as follows:
6637 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6638 All are in units of 1 = one object consed
6639 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6641 MISCS include overlays, markers, and some internal types.
6642 Frames, windows, buffers, and subprocesses count as vectors
6643 (but the contents of a buffer's text do not count here). */)
6646 return listn (CONSTYPE_HEAP
, 8,
6647 bounded_number (cons_cells_consed
),
6648 bounded_number (floats_consed
),
6649 bounded_number (vector_cells_consed
),
6650 bounded_number (symbols_consed
),
6651 bounded_number (string_chars_consed
),
6652 bounded_number (misc_objects_consed
),
6653 bounded_number (intervals_consed
),
6654 bounded_number (strings_consed
));
6657 /* Find at most FIND_MAX symbols which have OBJ as their value or
6658 function. This is used in gdbinit's `xwhichsymbols' command. */
6661 which_symbols (Lisp_Object obj
, EMACS_INT find_max
)
6663 struct symbol_block
*sblk
;
6664 ptrdiff_t gc_count
= inhibit_garbage_collection ();
6665 Lisp_Object found
= Qnil
;
6669 for (sblk
= symbol_block
; sblk
; sblk
= sblk
->next
)
6671 union aligned_Lisp_Symbol
*aligned_sym
= sblk
->symbols
;
6674 for (bn
= 0; bn
< SYMBOL_BLOCK_SIZE
; bn
++, aligned_sym
++)
6676 struct Lisp_Symbol
*sym
= &aligned_sym
->s
;
6680 if (sblk
== symbol_block
&& bn
>= symbol_block_index
)
6683 XSETSYMBOL (tem
, sym
);
6684 val
= find_symbol_value (tem
);
6686 || EQ (sym
->function
, obj
)
6687 || (!NILP (sym
->function
)
6688 && COMPILEDP (sym
->function
)
6689 && EQ (AREF (sym
->function
, COMPILED_BYTECODE
), obj
))
6692 && EQ (AREF (val
, COMPILED_BYTECODE
), obj
)))
6694 found
= Fcons (tem
, found
);
6695 if (--find_max
== 0)
6703 unbind_to (gc_count
, Qnil
);
6707 #ifdef ENABLE_CHECKING
6709 bool suppress_checking
;
6712 die (const char *msg
, const char *file
, int line
)
6714 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: %s\r\n",
6716 fatal_error_backtrace (SIGABRT
, INT_MAX
);
6720 /* Initialization */
6723 init_alloc_once (void)
6725 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6727 pure_size
= PURESIZE
;
6729 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6731 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6734 #ifdef DOUG_LEA_MALLOC
6735 mallopt (M_TRIM_THRESHOLD
, 128*1024); /* trim threshold */
6736 mallopt (M_MMAP_THRESHOLD
, 64*1024); /* mmap threshold */
6737 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* max. number of mmap'ed areas */
6743 malloc_hysteresis
= 32;
6745 malloc_hysteresis
= 0;
6748 refill_memory_reserve ();
6749 gc_cons_threshold
= GC_DEFAULT_THRESHOLD
;
6756 byte_stack_list
= 0;
6758 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6759 setjmp_tested_p
= longjmps_done
= 0;
6762 Vgc_elapsed
= make_float (0.0);
6767 syms_of_alloc (void)
6769 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6770 doc
: /* Number of bytes of consing between garbage collections.
6771 Garbage collection can happen automatically once this many bytes have been
6772 allocated since the last garbage collection. All data types count.
6774 Garbage collection happens automatically only when `eval' is called.
6776 By binding this temporarily to a large number, you can effectively
6777 prevent garbage collection during a part of the program.
6778 See also `gc-cons-percentage'. */);
6780 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6781 doc
: /* Portion of the heap used for allocation.
6782 Garbage collection can happen automatically once this portion of the heap
6783 has been allocated since the last garbage collection.
6784 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6785 Vgc_cons_percentage
= make_float (0.1);
6787 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6788 doc
: /* Number of bytes of shareable Lisp data allocated so far. */);
6790 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6791 doc
: /* Number of cons cells that have been consed so far. */);
6793 DEFVAR_INT ("floats-consed", floats_consed
,
6794 doc
: /* Number of floats that have been consed so far. */);
6796 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
6797 doc
: /* Number of vector cells that have been consed so far. */);
6799 DEFVAR_INT ("symbols-consed", symbols_consed
,
6800 doc
: /* Number of symbols that have been consed so far. */);
6802 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
6803 doc
: /* Number of string characters that have been consed so far. */);
6805 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
6806 doc
: /* Number of miscellaneous objects that have been consed so far.
6807 These include markers and overlays, plus certain objects not visible
6810 DEFVAR_INT ("intervals-consed", intervals_consed
,
6811 doc
: /* Number of intervals that have been consed so far. */);
6813 DEFVAR_INT ("strings-consed", strings_consed
,
6814 doc
: /* Number of strings that have been consed so far. */);
6816 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
6817 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
6818 This means that certain objects should be allocated in shared (pure) space.
6819 It can also be set to a hash-table, in which case this table is used to
6820 do hash-consing of the objects allocated to pure space. */);
6822 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
6823 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
6824 garbage_collection_messages
= 0;
6826 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
6827 doc
: /* Hook run after garbage collection has finished. */);
6828 Vpost_gc_hook
= Qnil
;
6829 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
6831 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
6832 doc
: /* Precomputed `signal' argument for memory-full error. */);
6833 /* We build this in advance because if we wait until we need it, we might
6834 not be able to allocate the memory to hold it. */
6836 = listn (CONSTYPE_PURE
, 2, Qerror
,
6837 build_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
6839 DEFVAR_LISP ("memory-full", Vmemory_full
,
6840 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
6841 Vmemory_full
= Qnil
;
6843 DEFSYM (Qconses
, "conses");
6844 DEFSYM (Qsymbols
, "symbols");
6845 DEFSYM (Qmiscs
, "miscs");
6846 DEFSYM (Qstrings
, "strings");
6847 DEFSYM (Qvectors
, "vectors");
6848 DEFSYM (Qfloats
, "floats");
6849 DEFSYM (Qintervals
, "intervals");
6850 DEFSYM (Qbuffers
, "buffers");
6851 DEFSYM (Qstring_bytes
, "string-bytes");
6852 DEFSYM (Qvector_slots
, "vector-slots");
6853 DEFSYM (Qheap
, "heap");
6855 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
6856 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
6858 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
6859 doc
: /* Accumulated time elapsed in garbage collections.
6860 The time is in seconds as a floating point value. */);
6861 DEFVAR_INT ("gcs-done", gcs_done
,
6862 doc
: /* Accumulated number of garbage collections done. */);
6867 defsubr (&Smake_byte_code
);
6868 defsubr (&Smake_list
);
6869 defsubr (&Smake_vector
);
6870 defsubr (&Smake_string
);
6871 defsubr (&Smake_bool_vector
);
6872 defsubr (&Smake_symbol
);
6873 defsubr (&Smake_marker
);
6874 defsubr (&Spurecopy
);
6875 defsubr (&Sgarbage_collect
);
6876 defsubr (&Smemory_limit
);
6877 defsubr (&Smemory_use_counts
);
6879 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
6880 defsubr (&Sgc_status
);
6884 /* When compiled with GCC, GDB might say "No enum type named
6885 pvec_type" if we don't have at least one symbol with that type, and
6886 then xbacktrace could fail. Similarly for the other enums and
6890 enum CHARTAB_SIZE_BITS CHARTAB_SIZE_BITS
;
6891 enum CHAR_TABLE_STANDARD_SLOTS CHAR_TABLE_STANDARD_SLOTS
;
6892 enum char_bits char_bits
;
6893 enum CHECK_LISP_OBJECT_TYPE CHECK_LISP_OBJECT_TYPE
;
6894 enum DEFAULT_HASH_SIZE DEFAULT_HASH_SIZE
;
6895 enum enum_USE_LSB_TAG enum_USE_LSB_TAG
;
6896 enum FLOAT_TO_STRING_BUFSIZE FLOAT_TO_STRING_BUFSIZE
;
6897 enum Lisp_Bits Lisp_Bits
;
6898 enum Lisp_Compiled Lisp_Compiled
;
6899 enum maxargs maxargs
;
6900 enum MAX_ALLOCA MAX_ALLOCA
;
6901 enum More_Lisp_Bits More_Lisp_Bits
;
6902 enum pvec_type pvec_type
;
6904 enum lsb_bits lsb_bits
;
6906 } const EXTERNALLY_VISIBLE gdb_make_enums_visible
= {0};