1 /* Storage allocation and gc for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985, 1986, 1988, 1993, 1994, 1995, 1997, 1998, 1999,
3 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
24 #include <limits.h> /* For CHAR_BIT. */
30 /* Note that this declares bzero on OSF/1. How dumb. */
34 #ifdef HAVE_GTK_AND_PTHREAD
38 /* This file is part of the core Lisp implementation, and thus must
39 deal with the real data structures. If the Lisp implementation is
40 replaced, this file likely will not be used. */
42 #undef HIDE_LISP_IMPLEMENTATION
45 #include "intervals.h"
51 #include "blockinput.h"
52 #include "character.h"
53 #include "syssignal.h"
56 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
57 memory. Can do this only if using gmalloc.c. */
59 #if defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC
60 #undef GC_MALLOC_CHECK
66 extern POINTER_TYPE
*sbrk ();
69 #ifdef DOUG_LEA_MALLOC
72 /* malloc.h #defines this as size_t, at least in glibc2. */
73 #ifndef __malloc_size_t
74 #define __malloc_size_t int
77 /* Specify maximum number of areas to mmap. It would be nice to use a
78 value that explicitly means "no limit". */
80 #define MMAP_MAX_AREAS 100000000
82 #else /* not DOUG_LEA_MALLOC */
84 /* The following come from gmalloc.c. */
86 #define __malloc_size_t size_t
87 extern __malloc_size_t _bytes_used
;
88 extern __malloc_size_t __malloc_extra_blocks
;
90 #endif /* not DOUG_LEA_MALLOC */
92 #if ! defined (SYSTEM_MALLOC) && defined (HAVE_GTK_AND_PTHREAD)
94 /* When GTK uses the file chooser dialog, different backends can be loaded
95 dynamically. One such a backend is the Gnome VFS backend that gets loaded
96 if you run Gnome. That backend creates several threads and also allocates
99 If Emacs sets malloc hooks (! SYSTEM_MALLOC) and the emacs_blocked_*
100 functions below are called from malloc, there is a chance that one
101 of these threads preempts the Emacs main thread and the hook variables
102 end up in an inconsistent state. So we have a mutex to prevent that (note
103 that the backend handles concurrent access to malloc within its own threads
104 but Emacs code running in the main thread is not included in that control).
106 When UNBLOCK_INPUT is called, reinvoke_input_signal may be called. If this
107 happens in one of the backend threads we will have two threads that tries
108 to run Emacs code at once, and the code is not prepared for that.
109 To prevent that, we only call BLOCK/UNBLOCK from the main thread. */
111 static pthread_mutex_t alloc_mutex
;
113 #define BLOCK_INPUT_ALLOC \
116 pthread_mutex_lock (&alloc_mutex); \
117 if (pthread_self () == main_thread) \
121 #define UNBLOCK_INPUT_ALLOC \
124 if (pthread_self () == main_thread) \
126 pthread_mutex_unlock (&alloc_mutex); \
130 #else /* SYSTEM_MALLOC || not HAVE_GTK_AND_PTHREAD */
132 #define BLOCK_INPUT_ALLOC BLOCK_INPUT
133 #define UNBLOCK_INPUT_ALLOC UNBLOCK_INPUT
135 #endif /* SYSTEM_MALLOC || not HAVE_GTK_AND_PTHREAD */
137 /* Value of _bytes_used, when spare_memory was freed. */
139 static __malloc_size_t bytes_used_when_full
;
141 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
142 to a struct Lisp_String. */
144 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
145 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
146 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
148 #define VECTOR_MARK(V) ((V)->size |= ARRAY_MARK_FLAG)
149 #define VECTOR_UNMARK(V) ((V)->size &= ~ARRAY_MARK_FLAG)
150 #define VECTOR_MARKED_P(V) (((V)->size & ARRAY_MARK_FLAG) != 0)
152 /* Value is the number of bytes/chars of S, a pointer to a struct
153 Lisp_String. This must be used instead of STRING_BYTES (S) or
154 S->size during GC, because S->size contains the mark bit for
157 #define GC_STRING_BYTES(S) (STRING_BYTES (S))
158 #define GC_STRING_CHARS(S) ((S)->size & ~ARRAY_MARK_FLAG)
160 /* Number of bytes of consing done since the last gc. */
162 int consing_since_gc
;
164 /* Count the amount of consing of various sorts of space. */
166 EMACS_INT cons_cells_consed
;
167 EMACS_INT floats_consed
;
168 EMACS_INT vector_cells_consed
;
169 EMACS_INT symbols_consed
;
170 EMACS_INT string_chars_consed
;
171 EMACS_INT misc_objects_consed
;
172 EMACS_INT intervals_consed
;
173 EMACS_INT strings_consed
;
175 /* Minimum number of bytes of consing since GC before next GC. */
177 EMACS_INT gc_cons_threshold
;
179 /* Similar minimum, computed from Vgc_cons_percentage. */
181 EMACS_INT gc_relative_threshold
;
183 static Lisp_Object Vgc_cons_percentage
;
185 /* Nonzero during GC. */
189 /* Nonzero means abort if try to GC.
190 This is for code which is written on the assumption that
191 no GC will happen, so as to verify that assumption. */
195 /* Nonzero means display messages at beginning and end of GC. */
197 int garbage_collection_messages
;
199 #ifndef VIRT_ADDR_VARIES
201 #endif /* VIRT_ADDR_VARIES */
202 int malloc_sbrk_used
;
204 #ifndef VIRT_ADDR_VARIES
206 #endif /* VIRT_ADDR_VARIES */
207 int malloc_sbrk_unused
;
209 /* Number of live and free conses etc. */
211 static int total_conses
, total_markers
, total_symbols
, total_vector_size
;
212 static int total_free_conses
, total_free_markers
, total_free_symbols
;
213 static int total_free_floats
, total_floats
;
215 /* Points to memory space allocated as "spare", to be freed if we run
218 static char *spare_memory
;
220 /* Amount of spare memory to keep in reserve. */
222 #define SPARE_MEMORY (1 << 14)
224 /* Number of extra blocks malloc should get when it needs more core. */
226 static int malloc_hysteresis
;
228 /* Non-nil means defun should do purecopy on the function definition. */
230 Lisp_Object Vpurify_flag
;
232 /* Non-nil means we are handling a memory-full error. */
234 Lisp_Object Vmemory_full
;
238 /* Initialize it to a nonzero value to force it into data space
239 (rather than bss space). That way unexec will remap it into text
240 space (pure), on some systems. We have not implemented the
241 remapping on more recent systems because this is less important
242 nowadays than in the days of small memories and timesharing. */
244 EMACS_INT pure
[PURESIZE
/ sizeof (EMACS_INT
)] = {1,};
245 #define PUREBEG (char *) pure
249 #define pure PURE_SEG_BITS /* Use shared memory segment */
250 #define PUREBEG (char *)PURE_SEG_BITS
252 #endif /* HAVE_SHM */
254 /* Pointer to the pure area, and its size. */
256 static char *purebeg
;
257 static size_t pure_size
;
259 /* Number of bytes of pure storage used before pure storage overflowed.
260 If this is non-zero, this implies that an overflow occurred. */
262 static size_t pure_bytes_used_before_overflow
;
264 /* Value is non-zero if P points into pure space. */
266 #define PURE_POINTER_P(P) \
267 (((PNTR_COMPARISON_TYPE) (P) \
268 < (PNTR_COMPARISON_TYPE) ((char *) purebeg + pure_size)) \
269 && ((PNTR_COMPARISON_TYPE) (P) \
270 >= (PNTR_COMPARISON_TYPE) purebeg))
272 /* Index in pure at which next pure object will be allocated.. */
274 EMACS_INT pure_bytes_used
;
276 /* If nonzero, this is a warning delivered by malloc and not yet
279 char *pending_malloc_warning
;
281 /* Pre-computed signal argument for use when memory is exhausted. */
283 Lisp_Object Vmemory_signal_data
;
285 /* Maximum amount of C stack to save when a GC happens. */
287 #ifndef MAX_SAVE_STACK
288 #define MAX_SAVE_STACK 16000
291 /* Buffer in which we save a copy of the C stack at each GC. */
296 /* Non-zero means ignore malloc warnings. Set during initialization.
297 Currently not used. */
301 Lisp_Object Qgc_cons_threshold
, Qchar_table_extra_slots
;
303 /* Hook run after GC has finished. */
305 Lisp_Object Vpost_gc_hook
, Qpost_gc_hook
;
307 Lisp_Object Vgc_elapsed
; /* accumulated elapsed time in GC */
308 EMACS_INT gcs_done
; /* accumulated GCs */
310 static void mark_buffer
P_ ((Lisp_Object
));
311 extern void mark_kboards
P_ ((void));
312 extern void mark_backtrace
P_ ((void));
313 static void gc_sweep
P_ ((void));
314 static void mark_glyph_matrix
P_ ((struct glyph_matrix
*));
315 static void mark_face_cache
P_ ((struct face_cache
*));
317 #ifdef HAVE_WINDOW_SYSTEM
318 extern void mark_fringe_data
P_ ((void));
319 static void mark_image
P_ ((struct image
*));
320 static void mark_image_cache
P_ ((struct frame
*));
321 #endif /* HAVE_WINDOW_SYSTEM */
323 static struct Lisp_String
*allocate_string
P_ ((void));
324 static void compact_small_strings
P_ ((void));
325 static void free_large_strings
P_ ((void));
326 static void sweep_strings
P_ ((void));
328 extern int message_enable_multibyte
;
330 /* When scanning the C stack for live Lisp objects, Emacs keeps track
331 of what memory allocated via lisp_malloc is intended for what
332 purpose. This enumeration specifies the type of memory. */
343 /* Keep the following vector-like types together, with
344 MEM_TYPE_WINDOW being the last, and MEM_TYPE_VECTOR the
345 first. Or change the code of live_vector_p, for instance. */
353 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
355 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
356 #include <stdio.h> /* For fprintf. */
359 /* A unique object in pure space used to make some Lisp objects
360 on free lists recognizable in O(1). */
364 #ifdef GC_MALLOC_CHECK
366 enum mem_type allocated_mem_type
;
367 int dont_register_blocks
;
369 #endif /* GC_MALLOC_CHECK */
371 /* A node in the red-black tree describing allocated memory containing
372 Lisp data. Each such block is recorded with its start and end
373 address when it is allocated, and removed from the tree when it
376 A red-black tree is a balanced binary tree with the following
379 1. Every node is either red or black.
380 2. Every leaf is black.
381 3. If a node is red, then both of its children are black.
382 4. Every simple path from a node to a descendant leaf contains
383 the same number of black nodes.
384 5. The root is always black.
386 When nodes are inserted into the tree, or deleted from the tree,
387 the tree is "fixed" so that these properties are always true.
389 A red-black tree with N internal nodes has height at most 2
390 log(N+1). Searches, insertions and deletions are done in O(log N).
391 Please see a text book about data structures for a detailed
392 description of red-black trees. Any book worth its salt should
397 /* Children of this node. These pointers are never NULL. When there
398 is no child, the value is MEM_NIL, which points to a dummy node. */
399 struct mem_node
*left
, *right
;
401 /* The parent of this node. In the root node, this is NULL. */
402 struct mem_node
*parent
;
404 /* Start and end of allocated region. */
408 enum {MEM_BLACK
, MEM_RED
} color
;
414 /* Base address of stack. Set in main. */
416 Lisp_Object
*stack_base
;
418 /* Root of the tree describing allocated Lisp memory. */
420 static struct mem_node
*mem_root
;
422 /* Lowest and highest known address in the heap. */
424 static void *min_heap_address
, *max_heap_address
;
426 /* Sentinel node of the tree. */
428 static struct mem_node mem_z
;
429 #define MEM_NIL &mem_z
431 static POINTER_TYPE
*lisp_malloc
P_ ((size_t, enum mem_type
));
432 static struct Lisp_Vector
*allocate_vectorlike
P_ ((EMACS_INT
, enum mem_type
));
433 static void lisp_free
P_ ((POINTER_TYPE
*));
434 static void mark_stack
P_ ((void));
435 static int live_vector_p
P_ ((struct mem_node
*, void *));
436 static int live_buffer_p
P_ ((struct mem_node
*, void *));
437 static int live_string_p
P_ ((struct mem_node
*, void *));
438 static int live_cons_p
P_ ((struct mem_node
*, void *));
439 static int live_symbol_p
P_ ((struct mem_node
*, void *));
440 static int live_float_p
P_ ((struct mem_node
*, void *));
441 static int live_misc_p
P_ ((struct mem_node
*, void *));
442 static void mark_maybe_object
P_ ((Lisp_Object
));
443 static void mark_memory
P_ ((void *, void *));
444 static void mem_init
P_ ((void));
445 static struct mem_node
*mem_insert
P_ ((void *, void *, enum mem_type
));
446 static void mem_insert_fixup
P_ ((struct mem_node
*));
447 static void mem_rotate_left
P_ ((struct mem_node
*));
448 static void mem_rotate_right
P_ ((struct mem_node
*));
449 static void mem_delete
P_ ((struct mem_node
*));
450 static void mem_delete_fixup
P_ ((struct mem_node
*));
451 static INLINE
struct mem_node
*mem_find
P_ ((void *));
453 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
454 static void check_gcpros
P_ ((void));
457 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
459 /* Recording what needs to be marked for gc. */
461 struct gcpro
*gcprolist
;
463 /* Addresses of staticpro'd variables. Initialize it to a nonzero
464 value; otherwise some compilers put it into BSS. */
466 #define NSTATICS 1280
467 Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
469 /* Index of next unused slot in staticvec. */
473 static POINTER_TYPE
*pure_alloc
P_ ((size_t, int));
476 /* Value is SZ rounded up to the next multiple of ALIGNMENT.
477 ALIGNMENT must be a power of 2. */
479 #define ALIGN(ptr, ALIGNMENT) \
480 ((POINTER_TYPE *) ((((EMACS_UINT)(ptr)) + (ALIGNMENT) - 1) \
481 & ~((ALIGNMENT) - 1)))
485 /************************************************************************
487 ************************************************************************/
489 /* Function malloc calls this if it finds we are near exhausting storage. */
495 pending_malloc_warning
= str
;
499 /* Display an already-pending malloc warning. */
502 display_malloc_warning ()
504 call3 (intern ("display-warning"),
506 build_string (pending_malloc_warning
),
507 intern ("emergency"));
508 pending_malloc_warning
= 0;
512 #ifdef DOUG_LEA_MALLOC
513 # define BYTES_USED (mallinfo ().arena)
515 # define BYTES_USED _bytes_used
519 /* Called if malloc returns zero. */
526 #ifndef SYSTEM_MALLOC
527 bytes_used_when_full
= BYTES_USED
;
530 /* The first time we get here, free the spare memory. */
537 /* This used to call error, but if we've run out of memory, we could
538 get infinite recursion trying to build the string. */
540 Fsignal (Qnil
, Vmemory_signal_data
);
543 DEFUN ("memory-full-p", Fmemory_full_p
, Smemory_full_p
, 0, 0, 0,
544 doc
: /* t if memory is nearly full, nil otherwise. */)
547 return (spare_memory
? Qnil
: Qt
);
550 /* Called if we can't allocate relocatable space for a buffer. */
553 buffer_memory_full ()
555 /* If buffers use the relocating allocator, no need to free
556 spare_memory, because we may have plenty of malloc space left
557 that we could get, and if we don't, the malloc that fails will
558 itself cause spare_memory to be freed. If buffers don't use the
559 relocating allocator, treat this like any other failing
568 /* This used to call error, but if we've run out of memory, we could
569 get infinite recursion trying to build the string. */
571 Fsignal (Qnil
, Vmemory_signal_data
);
575 #ifdef XMALLOC_OVERRUN_CHECK
577 /* Check for overrun in malloc'ed buffers by wrapping a 16 byte header
578 and a 16 byte trailer around each block.
580 The header consists of 12 fixed bytes + a 4 byte integer contaning the
581 original block size, while the trailer consists of 16 fixed bytes.
583 The header is used to detect whether this block has been allocated
584 through these functions -- as it seems that some low-level libc
585 functions may bypass the malloc hooks.
589 #define XMALLOC_OVERRUN_CHECK_SIZE 16
591 static char xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
-4] =
592 { 0x9a, 0x9b, 0xae, 0xaf,
593 0xbf, 0xbe, 0xce, 0xcf,
594 0xea, 0xeb, 0xec, 0xed };
596 static char xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
597 { 0xaa, 0xab, 0xac, 0xad,
598 0xba, 0xbb, 0xbc, 0xbd,
599 0xca, 0xcb, 0xcc, 0xcd,
600 0xda, 0xdb, 0xdc, 0xdd };
602 /* Macros to insert and extract the block size in the header. */
604 #define XMALLOC_PUT_SIZE(ptr, size) \
605 (ptr[-1] = (size & 0xff), \
606 ptr[-2] = ((size >> 8) & 0xff), \
607 ptr[-3] = ((size >> 16) & 0xff), \
608 ptr[-4] = ((size >> 24) & 0xff))
610 #define XMALLOC_GET_SIZE(ptr) \
611 (size_t)((unsigned)(ptr[-1]) | \
612 ((unsigned)(ptr[-2]) << 8) | \
613 ((unsigned)(ptr[-3]) << 16) | \
614 ((unsigned)(ptr[-4]) << 24))
617 /* The call depth in overrun_check functions. For example, this might happen:
619 overrun_check_malloc()
620 -> malloc -> (via hook)_-> emacs_blocked_malloc
621 -> overrun_check_malloc
622 call malloc (hooks are NULL, so real malloc is called).
623 malloc returns 10000.
624 add overhead, return 10016.
625 <- (back in overrun_check_malloc)
626 add overhead again, return 10032
627 xmalloc returns 10032.
632 overrun_check_free(10032)
634 free(10016) <- crash, because 10000 is the original pointer. */
636 static int check_depth
;
638 /* Like malloc, but wraps allocated block with header and trailer. */
641 overrun_check_malloc (size
)
644 register unsigned char *val
;
645 size_t overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_SIZE
*2 : 0;
647 val
= (unsigned char *) malloc (size
+ overhead
);
648 if (val
&& check_depth
== 1)
650 bcopy (xmalloc_overrun_check_header
, val
, XMALLOC_OVERRUN_CHECK_SIZE
- 4);
651 val
+= XMALLOC_OVERRUN_CHECK_SIZE
;
652 XMALLOC_PUT_SIZE(val
, size
);
653 bcopy (xmalloc_overrun_check_trailer
, val
+ size
, XMALLOC_OVERRUN_CHECK_SIZE
);
656 return (POINTER_TYPE
*)val
;
660 /* Like realloc, but checks old block for overrun, and wraps new block
661 with header and trailer. */
664 overrun_check_realloc (block
, size
)
668 register unsigned char *val
= (unsigned char *)block
;
669 size_t overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_SIZE
*2 : 0;
673 && bcmp (xmalloc_overrun_check_header
,
674 val
- XMALLOC_OVERRUN_CHECK_SIZE
,
675 XMALLOC_OVERRUN_CHECK_SIZE
- 4) == 0)
677 size_t osize
= XMALLOC_GET_SIZE (val
);
678 if (bcmp (xmalloc_overrun_check_trailer
,
680 XMALLOC_OVERRUN_CHECK_SIZE
))
682 bzero (val
+ osize
, XMALLOC_OVERRUN_CHECK_SIZE
);
683 val
-= XMALLOC_OVERRUN_CHECK_SIZE
;
684 bzero (val
, XMALLOC_OVERRUN_CHECK_SIZE
);
687 val
= (unsigned char *) realloc ((POINTER_TYPE
*)val
, size
+ overhead
);
689 if (val
&& check_depth
== 1)
691 bcopy (xmalloc_overrun_check_header
, val
, XMALLOC_OVERRUN_CHECK_SIZE
- 4);
692 val
+= XMALLOC_OVERRUN_CHECK_SIZE
;
693 XMALLOC_PUT_SIZE(val
, size
);
694 bcopy (xmalloc_overrun_check_trailer
, val
+ size
, XMALLOC_OVERRUN_CHECK_SIZE
);
697 return (POINTER_TYPE
*)val
;
700 /* Like free, but checks block for overrun. */
703 overrun_check_free (block
)
706 unsigned char *val
= (unsigned char *)block
;
711 && bcmp (xmalloc_overrun_check_header
,
712 val
- XMALLOC_OVERRUN_CHECK_SIZE
,
713 XMALLOC_OVERRUN_CHECK_SIZE
- 4) == 0)
715 size_t osize
= XMALLOC_GET_SIZE (val
);
716 if (bcmp (xmalloc_overrun_check_trailer
,
718 XMALLOC_OVERRUN_CHECK_SIZE
))
720 #ifdef XMALLOC_CLEAR_FREE_MEMORY
721 val
-= XMALLOC_OVERRUN_CHECK_SIZE
;
722 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_SIZE
*2);
724 bzero (val
+ osize
, XMALLOC_OVERRUN_CHECK_SIZE
);
725 val
-= XMALLOC_OVERRUN_CHECK_SIZE
;
726 bzero (val
, XMALLOC_OVERRUN_CHECK_SIZE
);
737 #define malloc overrun_check_malloc
738 #define realloc overrun_check_realloc
739 #define free overrun_check_free
743 /* Like malloc but check for no memory and block interrupt input.. */
749 register POINTER_TYPE
*val
;
752 val
= (POINTER_TYPE
*) malloc (size
);
761 /* Like realloc but check for no memory and block interrupt input.. */
764 xrealloc (block
, size
)
768 register POINTER_TYPE
*val
;
771 /* We must call malloc explicitly when BLOCK is 0, since some
772 reallocs don't do this. */
774 val
= (POINTER_TYPE
*) malloc (size
);
776 val
= (POINTER_TYPE
*) realloc (block
, size
);
779 if (!val
&& size
) memory_full ();
784 /* Like free but block interrupt input. */
796 /* Like strdup, but uses xmalloc. */
802 size_t len
= strlen (s
) + 1;
803 char *p
= (char *) xmalloc (len
);
809 /* Unwind for SAFE_ALLOCA */
812 safe_alloca_unwind (arg
)
815 register struct Lisp_Save_Value
*p
= XSAVE_VALUE (arg
);
825 /* Like malloc but used for allocating Lisp data. NBYTES is the
826 number of bytes to allocate, TYPE describes the intended use of the
827 allcated memory block (for strings, for conses, ...). */
830 static void *lisp_malloc_loser
;
833 static POINTER_TYPE
*
834 lisp_malloc (nbytes
, type
)
842 #ifdef GC_MALLOC_CHECK
843 allocated_mem_type
= type
;
846 val
= (void *) malloc (nbytes
);
849 /* If the memory just allocated cannot be addressed thru a Lisp
850 object's pointer, and it needs to be,
851 that's equivalent to running out of memory. */
852 if (val
&& type
!= MEM_TYPE_NON_LISP
)
855 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
856 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
858 lisp_malloc_loser
= val
;
865 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
866 if (val
&& type
!= MEM_TYPE_NON_LISP
)
867 mem_insert (val
, (char *) val
+ nbytes
, type
);
876 /* Free BLOCK. This must be called to free memory allocated with a
877 call to lisp_malloc. */
885 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
886 mem_delete (mem_find (block
));
891 /* Allocation of aligned blocks of memory to store Lisp data. */
892 /* The entry point is lisp_align_malloc which returns blocks of at most */
893 /* BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
896 /* BLOCK_ALIGN has to be a power of 2. */
897 #define BLOCK_ALIGN (1 << 10)
899 /* Padding to leave at the end of a malloc'd block. This is to give
900 malloc a chance to minimize the amount of memory wasted to alignment.
901 It should be tuned to the particular malloc library used.
902 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
903 posix_memalign on the other hand would ideally prefer a value of 4
904 because otherwise, there's 1020 bytes wasted between each ablocks.
905 In Emacs, testing shows that those 1020 can most of the time be
906 efficiently used by malloc to place other objects, so a value of 0 can
907 still preferable unless you have a lot of aligned blocks and virtually
909 #define BLOCK_PADDING 0
910 #define BLOCK_BYTES \
911 (BLOCK_ALIGN - sizeof (struct ablock *) - BLOCK_PADDING)
913 /* Internal data structures and constants. */
915 #define ABLOCKS_SIZE 16
917 /* An aligned block of memory. */
922 char payload
[BLOCK_BYTES
];
923 struct ablock
*next_free
;
925 /* `abase' is the aligned base of the ablocks. */
926 /* It is overloaded to hold the virtual `busy' field that counts
927 the number of used ablock in the parent ablocks.
928 The first ablock has the `busy' field, the others have the `abase'
929 field. To tell the difference, we assume that pointers will have
930 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
931 is used to tell whether the real base of the parent ablocks is `abase'
932 (if not, the word before the first ablock holds a pointer to the
934 struct ablocks
*abase
;
935 /* The padding of all but the last ablock is unused. The padding of
936 the last ablock in an ablocks is not allocated. */
938 char padding
[BLOCK_PADDING
];
942 /* A bunch of consecutive aligned blocks. */
945 struct ablock blocks
[ABLOCKS_SIZE
];
948 /* Size of the block requested from malloc or memalign. */
949 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
951 #define ABLOCK_ABASE(block) \
952 (((unsigned long) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
953 ? (struct ablocks *)(block) \
956 /* Virtual `busy' field. */
957 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
959 /* Pointer to the (not necessarily aligned) malloc block. */
960 #ifdef HAVE_POSIX_MEMALIGN
961 #define ABLOCKS_BASE(abase) (abase)
963 #define ABLOCKS_BASE(abase) \
964 (1 & (long) ABLOCKS_BUSY (abase) ? abase : ((void**)abase)[-1])
967 /* The list of free ablock. */
968 static struct ablock
*free_ablock
;
970 /* Allocate an aligned block of nbytes.
971 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
972 smaller or equal to BLOCK_BYTES. */
973 static POINTER_TYPE
*
974 lisp_align_malloc (nbytes
, type
)
979 struct ablocks
*abase
;
981 eassert (nbytes
<= BLOCK_BYTES
);
985 #ifdef GC_MALLOC_CHECK
986 allocated_mem_type
= type
;
992 EMACS_INT aligned
; /* int gets warning casting to 64-bit pointer. */
994 #ifdef DOUG_LEA_MALLOC
995 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
996 because mapped region contents are not preserved in
998 mallopt (M_MMAP_MAX
, 0);
1001 #ifdef HAVE_POSIX_MEMALIGN
1003 int err
= posix_memalign (&base
, BLOCK_ALIGN
, ABLOCKS_BYTES
);
1009 base
= malloc (ABLOCKS_BYTES
);
1010 abase
= ALIGN (base
, BLOCK_ALIGN
);
1019 aligned
= (base
== abase
);
1021 ((void**)abase
)[-1] = base
;
1023 #ifdef DOUG_LEA_MALLOC
1024 /* Back to a reasonable maximum of mmap'ed areas. */
1025 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1029 /* If the memory just allocated cannot be addressed thru a Lisp
1030 object's pointer, and it needs to be, that's equivalent to
1031 running out of memory. */
1032 if (type
!= MEM_TYPE_NON_LISP
)
1035 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
1036 XSETCONS (tem
, end
);
1037 if ((char *) XCONS (tem
) != end
)
1039 lisp_malloc_loser
= base
;
1047 /* Initialize the blocks and put them on the free list.
1048 Is `base' was not properly aligned, we can't use the last block. */
1049 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
1051 abase
->blocks
[i
].abase
= abase
;
1052 abase
->blocks
[i
].x
.next_free
= free_ablock
;
1053 free_ablock
= &abase
->blocks
[i
];
1055 ABLOCKS_BUSY (abase
) = (struct ablocks
*) (long) aligned
;
1057 eassert (0 == ((EMACS_UINT
)abase
) % BLOCK_ALIGN
);
1058 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
1059 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
1060 eassert (ABLOCKS_BASE (abase
) == base
);
1061 eassert (aligned
== (long) ABLOCKS_BUSY (abase
));
1064 abase
= ABLOCK_ABASE (free_ablock
);
1065 ABLOCKS_BUSY (abase
) = (struct ablocks
*) (2 + (long) ABLOCKS_BUSY (abase
));
1067 free_ablock
= free_ablock
->x
.next_free
;
1069 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1070 if (val
&& type
!= MEM_TYPE_NON_LISP
)
1071 mem_insert (val
, (char *) val
+ nbytes
, type
);
1078 eassert (0 == ((EMACS_UINT
)val
) % BLOCK_ALIGN
);
1083 lisp_align_free (block
)
1084 POINTER_TYPE
*block
;
1086 struct ablock
*ablock
= block
;
1087 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1090 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1091 mem_delete (mem_find (block
));
1093 /* Put on free list. */
1094 ablock
->x
.next_free
= free_ablock
;
1095 free_ablock
= ablock
;
1096 /* Update busy count. */
1097 ABLOCKS_BUSY (abase
) = (struct ablocks
*) (-2 + (long) ABLOCKS_BUSY (abase
));
1099 if (2 > (long) ABLOCKS_BUSY (abase
))
1100 { /* All the blocks are free. */
1101 int i
= 0, aligned
= (long) ABLOCKS_BUSY (abase
);
1102 struct ablock
**tem
= &free_ablock
;
1103 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1107 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1110 *tem
= (*tem
)->x
.next_free
;
1113 tem
= &(*tem
)->x
.next_free
;
1115 eassert ((aligned
& 1) == aligned
);
1116 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1117 free (ABLOCKS_BASE (abase
));
1122 /* Return a new buffer structure allocated from the heap with
1123 a call to lisp_malloc. */
1129 = (struct buffer
*) lisp_malloc (sizeof (struct buffer
),
1135 #ifndef SYSTEM_MALLOC
1137 /* If we released our reserve (due to running out of memory),
1138 and we have a fair amount free once again,
1139 try to set aside another reserve in case we run out once more.
1141 This is called when a relocatable block is freed in ralloc.c. */
1144 refill_memory_reserve ()
1146 if (spare_memory
== 0)
1147 spare_memory
= (char *) malloc ((size_t) SPARE_MEMORY
);
1151 /* Arranging to disable input signals while we're in malloc.
1153 This only works with GNU malloc. To help out systems which can't
1154 use GNU malloc, all the calls to malloc, realloc, and free
1155 elsewhere in the code should be inside a BLOCK_INPUT/UNBLOCK_INPUT
1156 pair; unfortunately, we have no idea what C library functions
1157 might call malloc, so we can't really protect them unless you're
1158 using GNU malloc. Fortunately, most of the major operating systems
1159 can use GNU malloc. */
1163 #ifndef DOUG_LEA_MALLOC
1164 extern void * (*__malloc_hook
) P_ ((size_t));
1165 extern void * (*__realloc_hook
) P_ ((void *, size_t));
1166 extern void (*__free_hook
) P_ ((void *));
1167 /* Else declared in malloc.h, perhaps with an extra arg. */
1168 #endif /* DOUG_LEA_MALLOC */
1169 static void * (*old_malloc_hook
) ();
1170 static void * (*old_realloc_hook
) ();
1171 static void (*old_free_hook
) ();
1173 /* This function is used as the hook for free to call. */
1176 emacs_blocked_free (ptr
)
1181 #ifdef GC_MALLOC_CHECK
1187 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1190 "Freeing `%p' which wasn't allocated with malloc\n", ptr
);
1195 /* fprintf (stderr, "free %p...%p (%p)\n", m->start, m->end, ptr); */
1199 #endif /* GC_MALLOC_CHECK */
1201 __free_hook
= old_free_hook
;
1204 /* If we released our reserve (due to running out of memory),
1205 and we have a fair amount free once again,
1206 try to set aside another reserve in case we run out once more. */
1207 if (spare_memory
== 0
1208 /* Verify there is enough space that even with the malloc
1209 hysteresis this call won't run out again.
1210 The code here is correct as long as SPARE_MEMORY
1211 is substantially larger than the block size malloc uses. */
1212 && (bytes_used_when_full
1213 > BYTES_USED
+ max (malloc_hysteresis
, 4) * SPARE_MEMORY
))
1214 spare_memory
= (char *) malloc ((size_t) SPARE_MEMORY
);
1216 __free_hook
= emacs_blocked_free
;
1217 UNBLOCK_INPUT_ALLOC
;
1221 /* This function is the malloc hook that Emacs uses. */
1224 emacs_blocked_malloc (size
)
1230 __malloc_hook
= old_malloc_hook
;
1231 #ifdef DOUG_LEA_MALLOC
1232 mallopt (M_TOP_PAD
, malloc_hysteresis
* 4096);
1234 __malloc_extra_blocks
= malloc_hysteresis
;
1237 value
= (void *) malloc (size
);
1239 #ifdef GC_MALLOC_CHECK
1241 struct mem_node
*m
= mem_find (value
);
1244 fprintf (stderr
, "Malloc returned %p which is already in use\n",
1246 fprintf (stderr
, "Region in use is %p...%p, %u bytes, type %d\n",
1247 m
->start
, m
->end
, (char *) m
->end
- (char *) m
->start
,
1252 if (!dont_register_blocks
)
1254 mem_insert (value
, (char *) value
+ max (1, size
), allocated_mem_type
);
1255 allocated_mem_type
= MEM_TYPE_NON_LISP
;
1258 #endif /* GC_MALLOC_CHECK */
1260 __malloc_hook
= emacs_blocked_malloc
;
1261 UNBLOCK_INPUT_ALLOC
;
1263 /* fprintf (stderr, "%p malloc\n", value); */
1268 /* This function is the realloc hook that Emacs uses. */
1271 emacs_blocked_realloc (ptr
, size
)
1278 __realloc_hook
= old_realloc_hook
;
1280 #ifdef GC_MALLOC_CHECK
1283 struct mem_node
*m
= mem_find (ptr
);
1284 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1287 "Realloc of %p which wasn't allocated with malloc\n",
1295 /* fprintf (stderr, "%p -> realloc\n", ptr); */
1297 /* Prevent malloc from registering blocks. */
1298 dont_register_blocks
= 1;
1299 #endif /* GC_MALLOC_CHECK */
1301 value
= (void *) realloc (ptr
, size
);
1303 #ifdef GC_MALLOC_CHECK
1304 dont_register_blocks
= 0;
1307 struct mem_node
*m
= mem_find (value
);
1310 fprintf (stderr
, "Realloc returns memory that is already in use\n");
1314 /* Can't handle zero size regions in the red-black tree. */
1315 mem_insert (value
, (char *) value
+ max (size
, 1), MEM_TYPE_NON_LISP
);
1318 /* fprintf (stderr, "%p <- realloc\n", value); */
1319 #endif /* GC_MALLOC_CHECK */
1321 __realloc_hook
= emacs_blocked_realloc
;
1322 UNBLOCK_INPUT_ALLOC
;
1328 #ifdef HAVE_GTK_AND_PTHREAD
1329 /* Called from Fdump_emacs so that when the dumped Emacs starts, it has a
1330 normal malloc. Some thread implementations need this as they call
1331 malloc before main. The pthread_self call in BLOCK_INPUT_ALLOC then
1332 calls malloc because it is the first call, and we have an endless loop. */
1335 reset_malloc_hooks ()
1341 #endif /* HAVE_GTK_AND_PTHREAD */
1344 /* Called from main to set up malloc to use our hooks. */
1347 uninterrupt_malloc ()
1349 #ifdef HAVE_GTK_AND_PTHREAD
1350 pthread_mutexattr_t attr
;
1352 /* GLIBC has a faster way to do this, but lets keep it portable.
1353 This is according to the Single UNIX Specification. */
1354 pthread_mutexattr_init (&attr
);
1355 pthread_mutexattr_settype (&attr
, PTHREAD_MUTEX_RECURSIVE
);
1356 pthread_mutex_init (&alloc_mutex
, &attr
);
1357 #endif /* HAVE_GTK_AND_PTHREAD */
1359 if (__free_hook
!= emacs_blocked_free
)
1360 old_free_hook
= __free_hook
;
1361 __free_hook
= emacs_blocked_free
;
1363 if (__malloc_hook
!= emacs_blocked_malloc
)
1364 old_malloc_hook
= __malloc_hook
;
1365 __malloc_hook
= emacs_blocked_malloc
;
1367 if (__realloc_hook
!= emacs_blocked_realloc
)
1368 old_realloc_hook
= __realloc_hook
;
1369 __realloc_hook
= emacs_blocked_realloc
;
1372 #endif /* not SYNC_INPUT */
1373 #endif /* not SYSTEM_MALLOC */
1377 /***********************************************************************
1379 ***********************************************************************/
1381 /* Number of intervals allocated in an interval_block structure.
1382 The 1020 is 1024 minus malloc overhead. */
1384 #define INTERVAL_BLOCK_SIZE \
1385 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1387 /* Intervals are allocated in chunks in form of an interval_block
1390 struct interval_block
1392 /* Place `intervals' first, to preserve alignment. */
1393 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1394 struct interval_block
*next
;
1397 /* Current interval block. Its `next' pointer points to older
1400 struct interval_block
*interval_block
;
1402 /* Index in interval_block above of the next unused interval
1405 static int interval_block_index
;
1407 /* Number of free and live intervals. */
1409 static int total_free_intervals
, total_intervals
;
1411 /* List of free intervals. */
1413 INTERVAL interval_free_list
;
1415 /* Total number of interval blocks now in use. */
1417 int n_interval_blocks
;
1420 /* Initialize interval allocation. */
1425 interval_block
= NULL
;
1426 interval_block_index
= INTERVAL_BLOCK_SIZE
;
1427 interval_free_list
= 0;
1428 n_interval_blocks
= 0;
1432 /* Return a new interval. */
1439 if (interval_free_list
)
1441 val
= interval_free_list
;
1442 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1446 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1448 register struct interval_block
*newi
;
1450 newi
= (struct interval_block
*) lisp_malloc (sizeof *newi
,
1453 newi
->next
= interval_block
;
1454 interval_block
= newi
;
1455 interval_block_index
= 0;
1456 n_interval_blocks
++;
1458 val
= &interval_block
->intervals
[interval_block_index
++];
1460 consing_since_gc
+= sizeof (struct interval
);
1462 RESET_INTERVAL (val
);
1468 /* Mark Lisp objects in interval I. */
1471 mark_interval (i
, dummy
)
1472 register INTERVAL i
;
1475 eassert (!i
->gcmarkbit
); /* Intervals are never shared. */
1477 mark_object (i
->plist
);
1481 /* Mark the interval tree rooted in TREE. Don't call this directly;
1482 use the macro MARK_INTERVAL_TREE instead. */
1485 mark_interval_tree (tree
)
1486 register INTERVAL tree
;
1488 /* No need to test if this tree has been marked already; this
1489 function is always called through the MARK_INTERVAL_TREE macro,
1490 which takes care of that. */
1492 traverse_intervals_noorder (tree
, mark_interval
, Qnil
);
1496 /* Mark the interval tree rooted in I. */
1498 #define MARK_INTERVAL_TREE(i) \
1500 if (!NULL_INTERVAL_P (i) && !i->gcmarkbit) \
1501 mark_interval_tree (i); \
1505 #define UNMARK_BALANCE_INTERVALS(i) \
1507 if (! NULL_INTERVAL_P (i)) \
1508 (i) = balance_intervals (i); \
1512 /* Number support. If NO_UNION_TYPE isn't in effect, we
1513 can't create number objects in macros. */
1521 obj
.s
.type
= Lisp_Int
;
1526 /***********************************************************************
1528 ***********************************************************************/
1530 /* Lisp_Strings are allocated in string_block structures. When a new
1531 string_block is allocated, all the Lisp_Strings it contains are
1532 added to a free-list string_free_list. When a new Lisp_String is
1533 needed, it is taken from that list. During the sweep phase of GC,
1534 string_blocks that are entirely free are freed, except two which
1537 String data is allocated from sblock structures. Strings larger
1538 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1539 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1541 Sblocks consist internally of sdata structures, one for each
1542 Lisp_String. The sdata structure points to the Lisp_String it
1543 belongs to. The Lisp_String points back to the `u.data' member of
1544 its sdata structure.
1546 When a Lisp_String is freed during GC, it is put back on
1547 string_free_list, and its `data' member and its sdata's `string'
1548 pointer is set to null. The size of the string is recorded in the
1549 `u.nbytes' member of the sdata. So, sdata structures that are no
1550 longer used, can be easily recognized, and it's easy to compact the
1551 sblocks of small strings which we do in compact_small_strings. */
1553 /* Size in bytes of an sblock structure used for small strings. This
1554 is 8192 minus malloc overhead. */
1556 #define SBLOCK_SIZE 8188
1558 /* Strings larger than this are considered large strings. String data
1559 for large strings is allocated from individual sblocks. */
1561 #define LARGE_STRING_BYTES 1024
1563 /* Structure describing string memory sub-allocated from an sblock.
1564 This is where the contents of Lisp strings are stored. */
1568 /* Back-pointer to the string this sdata belongs to. If null, this
1569 structure is free, and the NBYTES member of the union below
1570 contains the string's byte size (the same value that STRING_BYTES
1571 would return if STRING were non-null). If non-null, STRING_BYTES
1572 (STRING) is the size of the data, and DATA contains the string's
1574 struct Lisp_String
*string
;
1576 #ifdef GC_CHECK_STRING_BYTES
1579 unsigned char data
[1];
1581 #define SDATA_NBYTES(S) (S)->nbytes
1582 #define SDATA_DATA(S) (S)->data
1584 #else /* not GC_CHECK_STRING_BYTES */
1588 /* When STRING in non-null. */
1589 unsigned char data
[1];
1591 /* When STRING is null. */
1596 #define SDATA_NBYTES(S) (S)->u.nbytes
1597 #define SDATA_DATA(S) (S)->u.data
1599 #endif /* not GC_CHECK_STRING_BYTES */
1603 /* Structure describing a block of memory which is sub-allocated to
1604 obtain string data memory for strings. Blocks for small strings
1605 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1606 as large as needed. */
1611 struct sblock
*next
;
1613 /* Pointer to the next free sdata block. This points past the end
1614 of the sblock if there isn't any space left in this block. */
1615 struct sdata
*next_free
;
1617 /* Start of data. */
1618 struct sdata first_data
;
1621 /* Number of Lisp strings in a string_block structure. The 1020 is
1622 1024 minus malloc overhead. */
1624 #define STRING_BLOCK_SIZE \
1625 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1627 /* Structure describing a block from which Lisp_String structures
1632 /* Place `strings' first, to preserve alignment. */
1633 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1634 struct string_block
*next
;
1637 /* Head and tail of the list of sblock structures holding Lisp string
1638 data. We always allocate from current_sblock. The NEXT pointers
1639 in the sblock structures go from oldest_sblock to current_sblock. */
1641 static struct sblock
*oldest_sblock
, *current_sblock
;
1643 /* List of sblocks for large strings. */
1645 static struct sblock
*large_sblocks
;
1647 /* List of string_block structures, and how many there are. */
1649 static struct string_block
*string_blocks
;
1650 static int n_string_blocks
;
1652 /* Free-list of Lisp_Strings. */
1654 static struct Lisp_String
*string_free_list
;
1656 /* Number of live and free Lisp_Strings. */
1658 static int total_strings
, total_free_strings
;
1660 /* Number of bytes used by live strings. */
1662 static int total_string_size
;
1664 /* Given a pointer to a Lisp_String S which is on the free-list
1665 string_free_list, return a pointer to its successor in the
1668 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1670 /* Return a pointer to the sdata structure belonging to Lisp string S.
1671 S must be live, i.e. S->data must not be null. S->data is actually
1672 a pointer to the `u.data' member of its sdata structure; the
1673 structure starts at a constant offset in front of that. */
1675 #ifdef GC_CHECK_STRING_BYTES
1677 #define SDATA_OF_STRING(S) \
1678 ((struct sdata *) ((S)->data - sizeof (struct Lisp_String *) \
1679 - sizeof (EMACS_INT)))
1681 #else /* not GC_CHECK_STRING_BYTES */
1683 #define SDATA_OF_STRING(S) \
1684 ((struct sdata *) ((S)->data - sizeof (struct Lisp_String *)))
1686 #endif /* not GC_CHECK_STRING_BYTES */
1689 #ifdef GC_CHECK_STRING_OVERRUN
1691 /* We check for overrun in string data blocks by appending a small
1692 "cookie" after each allocated string data block, and check for the
1693 presence of this cookie during GC. */
1695 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1696 static char string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1697 { 0xde, 0xad, 0xbe, 0xef };
1700 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1703 /* Value is the size of an sdata structure large enough to hold NBYTES
1704 bytes of string data. The value returned includes a terminating
1705 NUL byte, the size of the sdata structure, and padding. */
1707 #ifdef GC_CHECK_STRING_BYTES
1709 #define SDATA_SIZE(NBYTES) \
1710 ((sizeof (struct Lisp_String *) \
1712 + sizeof (EMACS_INT) \
1713 + sizeof (EMACS_INT) - 1) \
1714 & ~(sizeof (EMACS_INT) - 1))
1716 #else /* not GC_CHECK_STRING_BYTES */
1718 #define SDATA_SIZE(NBYTES) \
1719 ((sizeof (struct Lisp_String *) \
1721 + sizeof (EMACS_INT) - 1) \
1722 & ~(sizeof (EMACS_INT) - 1))
1724 #endif /* not GC_CHECK_STRING_BYTES */
1726 /* Extra bytes to allocate for each string. */
1728 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1730 /* Initialize string allocation. Called from init_alloc_once. */
1735 total_strings
= total_free_strings
= total_string_size
= 0;
1736 oldest_sblock
= current_sblock
= large_sblocks
= NULL
;
1737 string_blocks
= NULL
;
1738 n_string_blocks
= 0;
1739 string_free_list
= NULL
;
1743 #ifdef GC_CHECK_STRING_BYTES
1745 static int check_string_bytes_count
;
1747 void check_string_bytes
P_ ((int));
1748 void check_sblock
P_ ((struct sblock
*));
1750 #define CHECK_STRING_BYTES(S) STRING_BYTES (S)
1753 /* Like GC_STRING_BYTES, but with debugging check. */
1757 struct Lisp_String
*s
;
1759 int nbytes
= (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1760 if (!PURE_POINTER_P (s
)
1762 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1767 /* Check validity of Lisp strings' string_bytes member in B. */
1773 struct sdata
*from
, *end
, *from_end
;
1777 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1779 /* Compute the next FROM here because copying below may
1780 overwrite data we need to compute it. */
1783 /* Check that the string size recorded in the string is the
1784 same as the one recorded in the sdata structure. */
1786 CHECK_STRING_BYTES (from
->string
);
1789 nbytes
= GC_STRING_BYTES (from
->string
);
1791 nbytes
= SDATA_NBYTES (from
);
1793 nbytes
= SDATA_SIZE (nbytes
);
1794 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1799 /* Check validity of Lisp strings' string_bytes member. ALL_P
1800 non-zero means check all strings, otherwise check only most
1801 recently allocated strings. Used for hunting a bug. */
1804 check_string_bytes (all_p
)
1811 for (b
= large_sblocks
; b
; b
= b
->next
)
1813 struct Lisp_String
*s
= b
->first_data
.string
;
1815 CHECK_STRING_BYTES (s
);
1818 for (b
= oldest_sblock
; b
; b
= b
->next
)
1822 check_sblock (current_sblock
);
1825 #endif /* GC_CHECK_STRING_BYTES */
1827 #ifdef GC_CHECK_STRING_FREE_LIST
1829 /* Walk through the string free list looking for bogus next pointers.
1830 This may catch buffer overrun from a previous string. */
1833 check_string_free_list ()
1835 struct Lisp_String
*s
;
1837 /* Pop a Lisp_String off the free-list. */
1838 s
= string_free_list
;
1841 if ((unsigned)s
< 1024)
1843 s
= NEXT_FREE_LISP_STRING (s
);
1847 #define check_string_free_list()
1850 /* Return a new Lisp_String. */
1852 static struct Lisp_String
*
1855 struct Lisp_String
*s
;
1857 /* If the free-list is empty, allocate a new string_block, and
1858 add all the Lisp_Strings in it to the free-list. */
1859 if (string_free_list
== NULL
)
1861 struct string_block
*b
;
1864 b
= (struct string_block
*) lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1865 bzero (b
, sizeof *b
);
1866 b
->next
= string_blocks
;
1870 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1873 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1874 string_free_list
= s
;
1877 total_free_strings
+= STRING_BLOCK_SIZE
;
1880 check_string_free_list ();
1882 /* Pop a Lisp_String off the free-list. */
1883 s
= string_free_list
;
1884 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1886 /* Probably not strictly necessary, but play it safe. */
1887 bzero (s
, sizeof *s
);
1889 --total_free_strings
;
1892 consing_since_gc
+= sizeof *s
;
1894 #ifdef GC_CHECK_STRING_BYTES
1901 if (++check_string_bytes_count
== 200)
1903 check_string_bytes_count
= 0;
1904 check_string_bytes (1);
1907 check_string_bytes (0);
1909 #endif /* GC_CHECK_STRING_BYTES */
1915 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1916 plus a NUL byte at the end. Allocate an sdata structure for S, and
1917 set S->data to its `u.data' member. Store a NUL byte at the end of
1918 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1919 S->data if it was initially non-null. */
1922 allocate_string_data (s
, nchars
, nbytes
)
1923 struct Lisp_String
*s
;
1926 struct sdata
*data
, *old_data
;
1928 int needed
, old_nbytes
;
1930 /* Determine the number of bytes needed to store NBYTES bytes
1932 needed
= SDATA_SIZE (nbytes
);
1934 if (nbytes
> LARGE_STRING_BYTES
)
1936 size_t size
= sizeof *b
- sizeof (struct sdata
) + needed
;
1938 #ifdef DOUG_LEA_MALLOC
1939 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1940 because mapped region contents are not preserved in
1943 In case you think of allowing it in a dumped Emacs at the
1944 cost of not being able to re-dump, there's another reason:
1945 mmap'ed data typically have an address towards the top of the
1946 address space, which won't fit into an EMACS_INT (at least on
1947 32-bit systems with the current tagging scheme). --fx */
1949 mallopt (M_MMAP_MAX
, 0);
1953 b
= (struct sblock
*) lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
1955 #ifdef DOUG_LEA_MALLOC
1956 /* Back to a reasonable maximum of mmap'ed areas. */
1958 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1962 b
->next_free
= &b
->first_data
;
1963 b
->first_data
.string
= NULL
;
1964 b
->next
= large_sblocks
;
1967 else if (current_sblock
== NULL
1968 || (((char *) current_sblock
+ SBLOCK_SIZE
1969 - (char *) current_sblock
->next_free
)
1970 < (needed
+ GC_STRING_EXTRA
)))
1972 /* Not enough room in the current sblock. */
1973 b
= (struct sblock
*) lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
1974 b
->next_free
= &b
->first_data
;
1975 b
->first_data
.string
= NULL
;
1979 current_sblock
->next
= b
;
1987 old_data
= s
->data
? SDATA_OF_STRING (s
) : NULL
;
1988 old_nbytes
= GC_STRING_BYTES (s
);
1990 data
= b
->next_free
;
1992 s
->data
= SDATA_DATA (data
);
1993 #ifdef GC_CHECK_STRING_BYTES
1994 SDATA_NBYTES (data
) = nbytes
;
1997 s
->size_byte
= nbytes
;
1998 s
->data
[nbytes
] = '\0';
1999 #ifdef GC_CHECK_STRING_OVERRUN
2000 bcopy (string_overrun_cookie
, (char *) data
+ needed
,
2001 GC_STRING_OVERRUN_COOKIE_SIZE
);
2003 b
->next_free
= (struct sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
2005 /* If S had already data assigned, mark that as free by setting its
2006 string back-pointer to null, and recording the size of the data
2010 SDATA_NBYTES (old_data
) = old_nbytes
;
2011 old_data
->string
= NULL
;
2014 consing_since_gc
+= needed
;
2018 /* Sweep and compact strings. */
2023 struct string_block
*b
, *next
;
2024 struct string_block
*live_blocks
= NULL
;
2026 string_free_list
= NULL
;
2027 total_strings
= total_free_strings
= 0;
2028 total_string_size
= 0;
2030 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
2031 for (b
= string_blocks
; b
; b
= next
)
2034 struct Lisp_String
*free_list_before
= string_free_list
;
2038 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
2040 struct Lisp_String
*s
= b
->strings
+ i
;
2044 /* String was not on free-list before. */
2045 if (STRING_MARKED_P (s
))
2047 /* String is live; unmark it and its intervals. */
2050 if (!NULL_INTERVAL_P (s
->intervals
))
2051 UNMARK_BALANCE_INTERVALS (s
->intervals
);
2054 total_string_size
+= STRING_BYTES (s
);
2058 /* String is dead. Put it on the free-list. */
2059 struct sdata
*data
= SDATA_OF_STRING (s
);
2061 /* Save the size of S in its sdata so that we know
2062 how large that is. Reset the sdata's string
2063 back-pointer so that we know it's free. */
2064 #ifdef GC_CHECK_STRING_BYTES
2065 if (GC_STRING_BYTES (s
) != SDATA_NBYTES (data
))
2068 data
->u
.nbytes
= GC_STRING_BYTES (s
);
2070 data
->string
= NULL
;
2072 /* Reset the strings's `data' member so that we
2076 /* Put the string on the free-list. */
2077 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2078 string_free_list
= s
;
2084 /* S was on the free-list before. Put it there again. */
2085 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2086 string_free_list
= s
;
2091 /* Free blocks that contain free Lisp_Strings only, except
2092 the first two of them. */
2093 if (nfree
== STRING_BLOCK_SIZE
2094 && total_free_strings
> STRING_BLOCK_SIZE
)
2098 string_free_list
= free_list_before
;
2102 total_free_strings
+= nfree
;
2103 b
->next
= live_blocks
;
2108 check_string_free_list ();
2110 string_blocks
= live_blocks
;
2111 free_large_strings ();
2112 compact_small_strings ();
2114 check_string_free_list ();
2118 /* Free dead large strings. */
2121 free_large_strings ()
2123 struct sblock
*b
, *next
;
2124 struct sblock
*live_blocks
= NULL
;
2126 for (b
= large_sblocks
; b
; b
= next
)
2130 if (b
->first_data
.string
== NULL
)
2134 b
->next
= live_blocks
;
2139 large_sblocks
= live_blocks
;
2143 /* Compact data of small strings. Free sblocks that don't contain
2144 data of live strings after compaction. */
2147 compact_small_strings ()
2149 struct sblock
*b
, *tb
, *next
;
2150 struct sdata
*from
, *to
, *end
, *tb_end
;
2151 struct sdata
*to_end
, *from_end
;
2153 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2154 to, and TB_END is the end of TB. */
2156 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2157 to
= &tb
->first_data
;
2159 /* Step through the blocks from the oldest to the youngest. We
2160 expect that old blocks will stabilize over time, so that less
2161 copying will happen this way. */
2162 for (b
= oldest_sblock
; b
; b
= b
->next
)
2165 xassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2167 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
2169 /* Compute the next FROM here because copying below may
2170 overwrite data we need to compute it. */
2173 #ifdef GC_CHECK_STRING_BYTES
2174 /* Check that the string size recorded in the string is the
2175 same as the one recorded in the sdata structure. */
2177 && GC_STRING_BYTES (from
->string
) != SDATA_NBYTES (from
))
2179 #endif /* GC_CHECK_STRING_BYTES */
2182 nbytes
= GC_STRING_BYTES (from
->string
);
2184 nbytes
= SDATA_NBYTES (from
);
2186 if (nbytes
> LARGE_STRING_BYTES
)
2189 nbytes
= SDATA_SIZE (nbytes
);
2190 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2192 #ifdef GC_CHECK_STRING_OVERRUN
2193 if (bcmp (string_overrun_cookie
,
2194 ((char *) from_end
) - GC_STRING_OVERRUN_COOKIE_SIZE
,
2195 GC_STRING_OVERRUN_COOKIE_SIZE
))
2199 /* FROM->string non-null means it's alive. Copy its data. */
2202 /* If TB is full, proceed with the next sblock. */
2203 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2204 if (to_end
> tb_end
)
2208 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2209 to
= &tb
->first_data
;
2210 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2213 /* Copy, and update the string's `data' pointer. */
2216 xassert (tb
!= b
|| to
<= from
);
2217 safe_bcopy ((char *) from
, (char *) to
, nbytes
+ GC_STRING_EXTRA
);
2218 to
->string
->data
= SDATA_DATA (to
);
2221 /* Advance past the sdata we copied to. */
2227 /* The rest of the sblocks following TB don't contain live data, so
2228 we can free them. */
2229 for (b
= tb
->next
; b
; b
= next
)
2237 current_sblock
= tb
;
2241 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2242 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2243 LENGTH must be an integer.
2244 INIT must be an integer that represents a character. */)
2246 Lisp_Object length
, init
;
2248 register Lisp_Object val
;
2249 register unsigned char *p
, *end
;
2252 CHECK_NATNUM (length
);
2253 CHECK_NUMBER (init
);
2256 if (ASCII_CHAR_P (c
))
2258 nbytes
= XINT (length
);
2259 val
= make_uninit_string (nbytes
);
2261 end
= p
+ SCHARS (val
);
2267 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2268 int len
= CHAR_STRING (c
, str
);
2270 nbytes
= len
* XINT (length
);
2271 val
= make_uninit_multibyte_string (XINT (length
), nbytes
);
2276 bcopy (str
, p
, len
);
2286 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2287 doc
: /* Return a new bool-vector of length LENGTH, using INIT for as each element.
2288 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2290 Lisp_Object length
, init
;
2292 register Lisp_Object val
;
2293 struct Lisp_Bool_Vector
*p
;
2295 int length_in_chars
, length_in_elts
, bits_per_value
;
2297 CHECK_NATNUM (length
);
2299 bits_per_value
= sizeof (EMACS_INT
) * BOOL_VECTOR_BITS_PER_CHAR
;
2301 length_in_elts
= (XFASTINT (length
) + bits_per_value
- 1) / bits_per_value
;
2302 length_in_chars
= ((XFASTINT (length
) + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2303 / BOOL_VECTOR_BITS_PER_CHAR
);
2305 /* We must allocate one more elements than LENGTH_IN_ELTS for the
2306 slot `size' of the struct Lisp_Bool_Vector. */
2307 val
= Fmake_vector (make_number (length_in_elts
+ 1), Qnil
);
2308 p
= XBOOL_VECTOR (val
);
2310 /* Get rid of any bits that would cause confusion. */
2312 XSETBOOL_VECTOR (val
, p
);
2313 p
->size
= XFASTINT (length
);
2315 real_init
= (NILP (init
) ? 0 : -1);
2316 for (i
= 0; i
< length_in_chars
; i
++)
2317 p
->data
[i
] = real_init
;
2319 /* Clear the extraneous bits in the last byte. */
2320 if (XINT (length
) != length_in_chars
* BOOL_VECTOR_BITS_PER_CHAR
)
2321 XBOOL_VECTOR (val
)->data
[length_in_chars
- 1]
2322 &= (1 << (XINT (length
) % BOOL_VECTOR_BITS_PER_CHAR
)) - 1;
2328 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2329 of characters from the contents. This string may be unibyte or
2330 multibyte, depending on the contents. */
2333 make_string (contents
, nbytes
)
2334 const char *contents
;
2337 register Lisp_Object val
;
2338 int nchars
, multibyte_nbytes
;
2340 parse_str_as_multibyte (contents
, nbytes
, &nchars
, &multibyte_nbytes
);
2341 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2342 /* CONTENTS contains no multibyte sequences or contains an invalid
2343 multibyte sequence. We must make unibyte string. */
2344 val
= make_unibyte_string (contents
, nbytes
);
2346 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2351 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2354 make_unibyte_string (contents
, length
)
2355 const char *contents
;
2358 register Lisp_Object val
;
2359 val
= make_uninit_string (length
);
2360 bcopy (contents
, SDATA (val
), length
);
2361 STRING_SET_UNIBYTE (val
);
2366 /* Make a multibyte string from NCHARS characters occupying NBYTES
2367 bytes at CONTENTS. */
2370 make_multibyte_string (contents
, nchars
, nbytes
)
2371 const char *contents
;
2374 register Lisp_Object val
;
2375 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2376 bcopy (contents
, SDATA (val
), nbytes
);
2381 /* Make a string from NCHARS characters occupying NBYTES bytes at
2382 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2385 make_string_from_bytes (contents
, nchars
, nbytes
)
2386 const char *contents
;
2389 register Lisp_Object val
;
2390 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2391 bcopy (contents
, SDATA (val
), nbytes
);
2392 if (SBYTES (val
) == SCHARS (val
))
2393 STRING_SET_UNIBYTE (val
);
2398 /* Make a string from NCHARS characters occupying NBYTES bytes at
2399 CONTENTS. The argument MULTIBYTE controls whether to label the
2400 string as multibyte. If NCHARS is negative, it counts the number of
2401 characters by itself. */
2404 make_specified_string (contents
, nchars
, nbytes
, multibyte
)
2405 const char *contents
;
2409 register Lisp_Object val
;
2414 nchars
= multibyte_chars_in_text (contents
, nbytes
);
2418 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2419 bcopy (contents
, SDATA (val
), nbytes
);
2421 STRING_SET_UNIBYTE (val
);
2426 /* Make a string from the data at STR, treating it as multibyte if the
2433 return make_string (str
, strlen (str
));
2437 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2438 occupying LENGTH bytes. */
2441 make_uninit_string (length
)
2445 val
= make_uninit_multibyte_string (length
, length
);
2446 STRING_SET_UNIBYTE (val
);
2451 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2452 which occupy NBYTES bytes. */
2455 make_uninit_multibyte_string (nchars
, nbytes
)
2459 struct Lisp_String
*s
;
2464 s
= allocate_string ();
2465 allocate_string_data (s
, nchars
, nbytes
);
2466 XSETSTRING (string
, s
);
2467 string_chars_consed
+= nbytes
;
2473 /***********************************************************************
2475 ***********************************************************************/
2477 /* We store float cells inside of float_blocks, allocating a new
2478 float_block with malloc whenever necessary. Float cells reclaimed
2479 by GC are put on a free list to be reallocated before allocating
2480 any new float cells from the latest float_block. */
2482 #define FLOAT_BLOCK_SIZE \
2483 (((BLOCK_BYTES - sizeof (struct float_block *) \
2484 /* The compiler might add padding at the end. */ \
2485 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2486 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2488 #define GETMARKBIT(block,n) \
2489 (((block)->gcmarkbits[(n) / (sizeof(int) * CHAR_BIT)] \
2490 >> ((n) % (sizeof(int) * CHAR_BIT))) \
2493 #define SETMARKBIT(block,n) \
2494 (block)->gcmarkbits[(n) / (sizeof(int) * CHAR_BIT)] \
2495 |= 1 << ((n) % (sizeof(int) * CHAR_BIT))
2497 #define UNSETMARKBIT(block,n) \
2498 (block)->gcmarkbits[(n) / (sizeof(int) * CHAR_BIT)] \
2499 &= ~(1 << ((n) % (sizeof(int) * CHAR_BIT)))
2501 #define FLOAT_BLOCK(fptr) \
2502 ((struct float_block *)(((EMACS_UINT)(fptr)) & ~(BLOCK_ALIGN - 1)))
2504 #define FLOAT_INDEX(fptr) \
2505 ((((EMACS_UINT)(fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2509 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2510 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2511 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof(int) * CHAR_BIT
)];
2512 struct float_block
*next
;
2515 #define FLOAT_MARKED_P(fptr) \
2516 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2518 #define FLOAT_MARK(fptr) \
2519 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2521 #define FLOAT_UNMARK(fptr) \
2522 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2524 /* Current float_block. */
2526 struct float_block
*float_block
;
2528 /* Index of first unused Lisp_Float in the current float_block. */
2530 int float_block_index
;
2532 /* Total number of float blocks now in use. */
2536 /* Free-list of Lisp_Floats. */
2538 struct Lisp_Float
*float_free_list
;
2541 /* Initialize float allocation. */
2547 float_block_index
= FLOAT_BLOCK_SIZE
; /* Force alloc of new float_block. */
2548 float_free_list
= 0;
2553 /* Explicitly free a float cell by putting it on the free-list. */
2557 struct Lisp_Float
*ptr
;
2559 *(struct Lisp_Float
**)&ptr
->data
= float_free_list
;
2560 float_free_list
= ptr
;
2564 /* Return a new float object with value FLOAT_VALUE. */
2567 make_float (float_value
)
2570 register Lisp_Object val
;
2572 if (float_free_list
)
2574 /* We use the data field for chaining the free list
2575 so that we won't use the same field that has the mark bit. */
2576 XSETFLOAT (val
, float_free_list
);
2577 float_free_list
= *(struct Lisp_Float
**)&float_free_list
->data
;
2581 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2583 register struct float_block
*new;
2585 new = (struct float_block
*) lisp_align_malloc (sizeof *new,
2587 new->next
= float_block
;
2588 bzero ((char *) new->gcmarkbits
, sizeof new->gcmarkbits
);
2590 float_block_index
= 0;
2593 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2594 float_block_index
++;
2597 XFLOAT_DATA (val
) = float_value
;
2598 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2599 consing_since_gc
+= sizeof (struct Lisp_Float
);
2606 /***********************************************************************
2608 ***********************************************************************/
2610 /* We store cons cells inside of cons_blocks, allocating a new
2611 cons_block with malloc whenever necessary. Cons cells reclaimed by
2612 GC are put on a free list to be reallocated before allocating
2613 any new cons cells from the latest cons_block. */
2615 #define CONS_BLOCK_SIZE \
2616 (((BLOCK_BYTES - sizeof (struct cons_block *)) * CHAR_BIT) \
2617 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2619 #define CONS_BLOCK(fptr) \
2620 ((struct cons_block *)(((EMACS_UINT)(fptr)) & ~(BLOCK_ALIGN - 1)))
2622 #define CONS_INDEX(fptr) \
2623 ((((EMACS_UINT)(fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2627 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2628 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2629 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof(int) * CHAR_BIT
)];
2630 struct cons_block
*next
;
2633 #define CONS_MARKED_P(fptr) \
2634 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2636 #define CONS_MARK(fptr) \
2637 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2639 #define CONS_UNMARK(fptr) \
2640 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2642 /* Current cons_block. */
2644 struct cons_block
*cons_block
;
2646 /* Index of first unused Lisp_Cons in the current block. */
2648 int cons_block_index
;
2650 /* Free-list of Lisp_Cons structures. */
2652 struct Lisp_Cons
*cons_free_list
;
2654 /* Total number of cons blocks now in use. */
2659 /* Initialize cons allocation. */
2665 cons_block_index
= CONS_BLOCK_SIZE
; /* Force alloc of new cons_block. */
2671 /* Explicitly free a cons cell by putting it on the free-list. */
2675 struct Lisp_Cons
*ptr
;
2677 *(struct Lisp_Cons
**)&ptr
->cdr
= cons_free_list
;
2681 cons_free_list
= ptr
;
2684 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2685 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2687 Lisp_Object car
, cdr
;
2689 register Lisp_Object val
;
2693 /* We use the cdr for chaining the free list
2694 so that we won't use the same field that has the mark bit. */
2695 XSETCONS (val
, cons_free_list
);
2696 cons_free_list
= *(struct Lisp_Cons
**)&cons_free_list
->cdr
;
2700 if (cons_block_index
== CONS_BLOCK_SIZE
)
2702 register struct cons_block
*new;
2703 new = (struct cons_block
*) lisp_align_malloc (sizeof *new,
2705 bzero ((char *) new->gcmarkbits
, sizeof new->gcmarkbits
);
2706 new->next
= cons_block
;
2708 cons_block_index
= 0;
2711 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2717 eassert (!CONS_MARKED_P (XCONS (val
)));
2718 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2719 cons_cells_consed
++;
2723 /* Get an error now if there's any junk in the cons free list. */
2727 #ifdef GC_CHECK_CONS_LIST
2728 struct Lisp_Cons
*tail
= cons_free_list
;
2731 tail
= *(struct Lisp_Cons
**)&tail
->cdr
;
2735 /* Make a list of 2, 3, 4 or 5 specified objects. */
2739 Lisp_Object arg1
, arg2
;
2741 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2746 list3 (arg1
, arg2
, arg3
)
2747 Lisp_Object arg1
, arg2
, arg3
;
2749 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2754 list4 (arg1
, arg2
, arg3
, arg4
)
2755 Lisp_Object arg1
, arg2
, arg3
, arg4
;
2757 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2762 list5 (arg1
, arg2
, arg3
, arg4
, arg5
)
2763 Lisp_Object arg1
, arg2
, arg3
, arg4
, arg5
;
2765 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2766 Fcons (arg5
, Qnil
)))));
2770 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2771 doc
: /* Return a newly created list with specified arguments as elements.
2772 Any number of arguments, even zero arguments, are allowed.
2773 usage: (list &rest OBJECTS) */)
2776 register Lisp_Object
*args
;
2778 register Lisp_Object val
;
2784 val
= Fcons (args
[nargs
], val
);
2790 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2791 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2793 register Lisp_Object length
, init
;
2795 register Lisp_Object val
;
2798 CHECK_NATNUM (length
);
2799 size
= XFASTINT (length
);
2804 val
= Fcons (init
, val
);
2809 val
= Fcons (init
, val
);
2814 val
= Fcons (init
, val
);
2819 val
= Fcons (init
, val
);
2824 val
= Fcons (init
, val
);
2839 /***********************************************************************
2841 ***********************************************************************/
2843 /* Singly-linked list of all vectors. */
2845 struct Lisp_Vector
*all_vectors
;
2847 /* Total number of vector-like objects now in use. */
2852 /* Value is a pointer to a newly allocated Lisp_Vector structure
2853 with room for LEN Lisp_Objects. */
2855 static struct Lisp_Vector
*
2856 allocate_vectorlike (len
, type
)
2860 struct Lisp_Vector
*p
;
2863 #ifdef DOUG_LEA_MALLOC
2864 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
2865 because mapped region contents are not preserved in
2868 mallopt (M_MMAP_MAX
, 0);
2872 nbytes
= sizeof *p
+ (len
- 1) * sizeof p
->contents
[0];
2873 p
= (struct Lisp_Vector
*) lisp_malloc (nbytes
, type
);
2875 #ifdef DOUG_LEA_MALLOC
2876 /* Back to a reasonable maximum of mmap'ed areas. */
2878 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2882 consing_since_gc
+= nbytes
;
2883 vector_cells_consed
+= len
;
2885 p
->next
= all_vectors
;
2892 /* Allocate a vector with NSLOTS slots. */
2894 struct Lisp_Vector
*
2895 allocate_vector (nslots
)
2898 struct Lisp_Vector
*v
= allocate_vectorlike (nslots
, MEM_TYPE_VECTOR
);
2904 /* Allocate other vector-like structures. */
2906 struct Lisp_Hash_Table
*
2907 allocate_hash_table ()
2909 EMACS_INT len
= VECSIZE (struct Lisp_Hash_Table
);
2910 struct Lisp_Vector
*v
= allocate_vectorlike (len
, MEM_TYPE_HASH_TABLE
);
2914 for (i
= 0; i
< len
; ++i
)
2915 v
->contents
[i
] = Qnil
;
2917 return (struct Lisp_Hash_Table
*) v
;
2924 EMACS_INT len
= VECSIZE (struct window
);
2925 struct Lisp_Vector
*v
= allocate_vectorlike (len
, MEM_TYPE_WINDOW
);
2928 for (i
= 0; i
< len
; ++i
)
2929 v
->contents
[i
] = Qnil
;
2932 return (struct window
*) v
;
2939 EMACS_INT len
= VECSIZE (struct frame
);
2940 struct Lisp_Vector
*v
= allocate_vectorlike (len
, MEM_TYPE_FRAME
);
2943 for (i
= 0; i
< len
; ++i
)
2944 v
->contents
[i
] = make_number (0);
2946 return (struct frame
*) v
;
2950 struct Lisp_Process
*
2953 EMACS_INT len
= VECSIZE (struct Lisp_Process
);
2954 struct Lisp_Vector
*v
= allocate_vectorlike (len
, MEM_TYPE_PROCESS
);
2957 for (i
= 0; i
< len
; ++i
)
2958 v
->contents
[i
] = Qnil
;
2961 return (struct Lisp_Process
*) v
;
2965 struct Lisp_Vector
*
2966 allocate_other_vector (len
)
2969 struct Lisp_Vector
*v
= allocate_vectorlike (len
, MEM_TYPE_VECTOR
);
2972 for (i
= 0; i
< len
; ++i
)
2973 v
->contents
[i
] = Qnil
;
2980 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
2981 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
2982 See also the function `vector'. */)
2984 register Lisp_Object length
, init
;
2987 register EMACS_INT sizei
;
2989 register struct Lisp_Vector
*p
;
2991 CHECK_NATNUM (length
);
2992 sizei
= XFASTINT (length
);
2994 p
= allocate_vector (sizei
);
2995 for (index
= 0; index
< sizei
; index
++)
2996 p
->contents
[index
] = init
;
2998 XSETVECTOR (vector
, p
);
3003 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
3004 doc
: /* Return a newly created vector with specified arguments as elements.
3005 Any number of arguments, even zero arguments, are allowed.
3006 usage: (vector &rest OBJECTS) */)
3011 register Lisp_Object len
, val
;
3013 register struct Lisp_Vector
*p
;
3015 XSETFASTINT (len
, nargs
);
3016 val
= Fmake_vector (len
, Qnil
);
3018 for (index
= 0; index
< nargs
; index
++)
3019 p
->contents
[index
] = args
[index
];
3024 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
3025 doc
: /* Create a byte-code object with specified arguments as elements.
3026 The arguments should be the arglist, bytecode-string, constant vector,
3027 stack size, (optional) doc string, and (optional) interactive spec.
3028 The first four arguments are required; at most six have any
3030 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3035 register Lisp_Object len
, val
;
3037 register struct Lisp_Vector
*p
;
3039 XSETFASTINT (len
, nargs
);
3040 if (!NILP (Vpurify_flag
))
3041 val
= make_pure_vector ((EMACS_INT
) nargs
);
3043 val
= Fmake_vector (len
, Qnil
);
3045 if (STRINGP (args
[1]) && STRING_MULTIBYTE (args
[1]))
3046 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3047 earlier because they produced a raw 8-bit string for byte-code
3048 and now such a byte-code string is loaded as multibyte while
3049 raw 8-bit characters converted to multibyte form. Thus, now we
3050 must convert them back to the original unibyte form. */
3051 args
[1] = Fstring_as_unibyte (args
[1]);
3054 for (index
= 0; index
< nargs
; index
++)
3056 if (!NILP (Vpurify_flag
))
3057 args
[index
] = Fpurecopy (args
[index
]);
3058 p
->contents
[index
] = args
[index
];
3060 XSETCOMPILED (val
, p
);
3066 /***********************************************************************
3068 ***********************************************************************/
3070 /* Each symbol_block is just under 1020 bytes long, since malloc
3071 really allocates in units of powers of two and uses 4 bytes for its
3074 #define SYMBOL_BLOCK_SIZE \
3075 ((1020 - sizeof (struct symbol_block *)) / sizeof (struct Lisp_Symbol))
3079 /* Place `symbols' first, to preserve alignment. */
3080 struct Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3081 struct symbol_block
*next
;
3084 /* Current symbol block and index of first unused Lisp_Symbol
3087 struct symbol_block
*symbol_block
;
3088 int symbol_block_index
;
3090 /* List of free symbols. */
3092 struct Lisp_Symbol
*symbol_free_list
;
3094 /* Total number of symbol blocks now in use. */
3096 int n_symbol_blocks
;
3099 /* Initialize symbol allocation. */
3104 symbol_block
= NULL
;
3105 symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3106 symbol_free_list
= 0;
3107 n_symbol_blocks
= 0;
3111 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3112 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3113 Its value and function definition are void, and its property list is nil. */)
3117 register Lisp_Object val
;
3118 register struct Lisp_Symbol
*p
;
3120 CHECK_STRING (name
);
3122 if (symbol_free_list
)
3124 XSETSYMBOL (val
, symbol_free_list
);
3125 symbol_free_list
= *(struct Lisp_Symbol
**)&symbol_free_list
->value
;
3129 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3131 struct symbol_block
*new;
3132 new = (struct symbol_block
*) lisp_malloc (sizeof *new,
3134 new->next
= symbol_block
;
3136 symbol_block_index
= 0;
3139 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
]);
3140 symbol_block_index
++;
3146 p
->value
= Qunbound
;
3147 p
->function
= Qunbound
;
3150 p
->interned
= SYMBOL_UNINTERNED
;
3152 p
->indirect_variable
= 0;
3153 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3160 /***********************************************************************
3161 Marker (Misc) Allocation
3162 ***********************************************************************/
3164 /* Allocation of markers and other objects that share that structure.
3165 Works like allocation of conses. */
3167 #define MARKER_BLOCK_SIZE \
3168 ((1020 - sizeof (struct marker_block *)) / sizeof (union Lisp_Misc))
3172 /* Place `markers' first, to preserve alignment. */
3173 union Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3174 struct marker_block
*next
;
3177 struct marker_block
*marker_block
;
3178 int marker_block_index
;
3180 union Lisp_Misc
*marker_free_list
;
3182 /* Total number of marker blocks now in use. */
3184 int n_marker_blocks
;
3189 marker_block
= NULL
;
3190 marker_block_index
= MARKER_BLOCK_SIZE
;
3191 marker_free_list
= 0;
3192 n_marker_blocks
= 0;
3195 /* Return a newly allocated Lisp_Misc object, with no substructure. */
3202 if (marker_free_list
)
3204 XSETMISC (val
, marker_free_list
);
3205 marker_free_list
= marker_free_list
->u_free
.chain
;
3209 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3211 struct marker_block
*new;
3212 new = (struct marker_block
*) lisp_malloc (sizeof *new,
3214 new->next
= marker_block
;
3216 marker_block_index
= 0;
3218 total_free_markers
+= MARKER_BLOCK_SIZE
;
3220 XSETMISC (val
, &marker_block
->markers
[marker_block_index
]);
3221 marker_block_index
++;
3224 --total_free_markers
;
3225 consing_since_gc
+= sizeof (union Lisp_Misc
);
3226 misc_objects_consed
++;
3227 XMARKER (val
)->gcmarkbit
= 0;
3231 /* Free a Lisp_Misc object */
3237 XMISC (misc
)->u_marker
.type
= Lisp_Misc_Free
;
3238 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3239 marker_free_list
= XMISC (misc
);
3241 total_free_markers
++;
3244 /* Return a Lisp_Misc_Save_Value object containing POINTER and
3245 INTEGER. This is used to package C values to call record_unwind_protect.
3246 The unwind function can get the C values back using XSAVE_VALUE. */
3249 make_save_value (pointer
, integer
)
3253 register Lisp_Object val
;
3254 register struct Lisp_Save_Value
*p
;
3256 val
= allocate_misc ();
3257 XMISCTYPE (val
) = Lisp_Misc_Save_Value
;
3258 p
= XSAVE_VALUE (val
);
3259 p
->pointer
= pointer
;
3260 p
->integer
= integer
;
3265 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3266 doc
: /* Return a newly allocated marker which does not point at any place. */)
3269 register Lisp_Object val
;
3270 register struct Lisp_Marker
*p
;
3272 val
= allocate_misc ();
3273 XMISCTYPE (val
) = Lisp_Misc_Marker
;
3279 p
->insertion_type
= 0;
3283 /* Put MARKER back on the free list after using it temporarily. */
3286 free_marker (marker
)
3289 unchain_marker (XMARKER (marker
));
3294 /* Return a newly created vector or string with specified arguments as
3295 elements. If all the arguments are characters that can fit
3296 in a string of events, make a string; otherwise, make a vector.
3298 Any number of arguments, even zero arguments, are allowed. */
3301 make_event_array (nargs
, args
)
3307 for (i
= 0; i
< nargs
; i
++)
3308 /* The things that fit in a string
3309 are characters that are in 0...127,
3310 after discarding the meta bit and all the bits above it. */
3311 if (!INTEGERP (args
[i
])
3312 || (XUINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3313 return Fvector (nargs
, args
);
3315 /* Since the loop exited, we know that all the things in it are
3316 characters, so we can make a string. */
3320 result
= Fmake_string (make_number (nargs
), make_number (0));
3321 for (i
= 0; i
< nargs
; i
++)
3323 SSET (result
, i
, XINT (args
[i
]));
3324 /* Move the meta bit to the right place for a string char. */
3325 if (XINT (args
[i
]) & CHAR_META
)
3326 SSET (result
, i
, SREF (result
, i
) | 0x80);
3335 /************************************************************************
3337 ************************************************************************/
3339 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3341 /* Conservative C stack marking requires a method to identify possibly
3342 live Lisp objects given a pointer value. We do this by keeping
3343 track of blocks of Lisp data that are allocated in a red-black tree
3344 (see also the comment of mem_node which is the type of nodes in
3345 that tree). Function lisp_malloc adds information for an allocated
3346 block to the red-black tree with calls to mem_insert, and function
3347 lisp_free removes it with mem_delete. Functions live_string_p etc
3348 call mem_find to lookup information about a given pointer in the
3349 tree, and use that to determine if the pointer points to a Lisp
3352 /* Initialize this part of alloc.c. */
3357 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3358 mem_z
.parent
= NULL
;
3359 mem_z
.color
= MEM_BLACK
;
3360 mem_z
.start
= mem_z
.end
= NULL
;
3365 /* Value is a pointer to the mem_node containing START. Value is
3366 MEM_NIL if there is no node in the tree containing START. */
3368 static INLINE
struct mem_node
*
3374 if (start
< min_heap_address
|| start
> max_heap_address
)
3377 /* Make the search always successful to speed up the loop below. */
3378 mem_z
.start
= start
;
3379 mem_z
.end
= (char *) start
+ 1;
3382 while (start
< p
->start
|| start
>= p
->end
)
3383 p
= start
< p
->start
? p
->left
: p
->right
;
3388 /* Insert a new node into the tree for a block of memory with start
3389 address START, end address END, and type TYPE. Value is a
3390 pointer to the node that was inserted. */
3392 static struct mem_node
*
3393 mem_insert (start
, end
, type
)
3397 struct mem_node
*c
, *parent
, *x
;
3399 if (start
< min_heap_address
)
3400 min_heap_address
= start
;
3401 if (end
> max_heap_address
)
3402 max_heap_address
= end
;
3404 /* See where in the tree a node for START belongs. In this
3405 particular application, it shouldn't happen that a node is already
3406 present. For debugging purposes, let's check that. */
3410 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3412 while (c
!= MEM_NIL
)
3414 if (start
>= c
->start
&& start
< c
->end
)
3417 c
= start
< c
->start
? c
->left
: c
->right
;
3420 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3422 while (c
!= MEM_NIL
)
3425 c
= start
< c
->start
? c
->left
: c
->right
;
3428 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3430 /* Create a new node. */
3431 #ifdef GC_MALLOC_CHECK
3432 x
= (struct mem_node
*) _malloc_internal (sizeof *x
);
3436 x
= (struct mem_node
*) xmalloc (sizeof *x
);
3442 x
->left
= x
->right
= MEM_NIL
;
3445 /* Insert it as child of PARENT or install it as root. */
3448 if (start
< parent
->start
)
3456 /* Re-establish red-black tree properties. */
3457 mem_insert_fixup (x
);
3463 /* Re-establish the red-black properties of the tree, and thereby
3464 balance the tree, after node X has been inserted; X is always red. */
3467 mem_insert_fixup (x
)
3470 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3472 /* X is red and its parent is red. This is a violation of
3473 red-black tree property #3. */
3475 if (x
->parent
== x
->parent
->parent
->left
)
3477 /* We're on the left side of our grandparent, and Y is our
3479 struct mem_node
*y
= x
->parent
->parent
->right
;
3481 if (y
->color
== MEM_RED
)
3483 /* Uncle and parent are red but should be black because
3484 X is red. Change the colors accordingly and proceed
3485 with the grandparent. */
3486 x
->parent
->color
= MEM_BLACK
;
3487 y
->color
= MEM_BLACK
;
3488 x
->parent
->parent
->color
= MEM_RED
;
3489 x
= x
->parent
->parent
;
3493 /* Parent and uncle have different colors; parent is
3494 red, uncle is black. */
3495 if (x
== x
->parent
->right
)
3498 mem_rotate_left (x
);
3501 x
->parent
->color
= MEM_BLACK
;
3502 x
->parent
->parent
->color
= MEM_RED
;
3503 mem_rotate_right (x
->parent
->parent
);
3508 /* This is the symmetrical case of above. */
3509 struct mem_node
*y
= x
->parent
->parent
->left
;
3511 if (y
->color
== MEM_RED
)
3513 x
->parent
->color
= MEM_BLACK
;
3514 y
->color
= MEM_BLACK
;
3515 x
->parent
->parent
->color
= MEM_RED
;
3516 x
= x
->parent
->parent
;
3520 if (x
== x
->parent
->left
)
3523 mem_rotate_right (x
);
3526 x
->parent
->color
= MEM_BLACK
;
3527 x
->parent
->parent
->color
= MEM_RED
;
3528 mem_rotate_left (x
->parent
->parent
);
3533 /* The root may have been changed to red due to the algorithm. Set
3534 it to black so that property #5 is satisfied. */
3535 mem_root
->color
= MEM_BLACK
;
3551 /* Turn y's left sub-tree into x's right sub-tree. */
3554 if (y
->left
!= MEM_NIL
)
3555 y
->left
->parent
= x
;
3557 /* Y's parent was x's parent. */
3559 y
->parent
= x
->parent
;
3561 /* Get the parent to point to y instead of x. */
3564 if (x
== x
->parent
->left
)
3565 x
->parent
->left
= y
;
3567 x
->parent
->right
= y
;
3572 /* Put x on y's left. */
3586 mem_rotate_right (x
)
3589 struct mem_node
*y
= x
->left
;
3592 if (y
->right
!= MEM_NIL
)
3593 y
->right
->parent
= x
;
3596 y
->parent
= x
->parent
;
3599 if (x
== x
->parent
->right
)
3600 x
->parent
->right
= y
;
3602 x
->parent
->left
= y
;
3613 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
3619 struct mem_node
*x
, *y
;
3621 if (!z
|| z
== MEM_NIL
)
3624 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
3629 while (y
->left
!= MEM_NIL
)
3633 if (y
->left
!= MEM_NIL
)
3638 x
->parent
= y
->parent
;
3641 if (y
== y
->parent
->left
)
3642 y
->parent
->left
= x
;
3644 y
->parent
->right
= x
;
3651 z
->start
= y
->start
;
3656 if (y
->color
== MEM_BLACK
)
3657 mem_delete_fixup (x
);
3659 #ifdef GC_MALLOC_CHECK
3667 /* Re-establish the red-black properties of the tree, after a
3671 mem_delete_fixup (x
)
3674 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
3676 if (x
== x
->parent
->left
)
3678 struct mem_node
*w
= x
->parent
->right
;
3680 if (w
->color
== MEM_RED
)
3682 w
->color
= MEM_BLACK
;
3683 x
->parent
->color
= MEM_RED
;
3684 mem_rotate_left (x
->parent
);
3685 w
= x
->parent
->right
;
3688 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
3695 if (w
->right
->color
== MEM_BLACK
)
3697 w
->left
->color
= MEM_BLACK
;
3699 mem_rotate_right (w
);
3700 w
= x
->parent
->right
;
3702 w
->color
= x
->parent
->color
;
3703 x
->parent
->color
= MEM_BLACK
;
3704 w
->right
->color
= MEM_BLACK
;
3705 mem_rotate_left (x
->parent
);
3711 struct mem_node
*w
= x
->parent
->left
;
3713 if (w
->color
== MEM_RED
)
3715 w
->color
= MEM_BLACK
;
3716 x
->parent
->color
= MEM_RED
;
3717 mem_rotate_right (x
->parent
);
3718 w
= x
->parent
->left
;
3721 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
3728 if (w
->left
->color
== MEM_BLACK
)
3730 w
->right
->color
= MEM_BLACK
;
3732 mem_rotate_left (w
);
3733 w
= x
->parent
->left
;
3736 w
->color
= x
->parent
->color
;
3737 x
->parent
->color
= MEM_BLACK
;
3738 w
->left
->color
= MEM_BLACK
;
3739 mem_rotate_right (x
->parent
);
3745 x
->color
= MEM_BLACK
;
3749 /* Value is non-zero if P is a pointer to a live Lisp string on
3750 the heap. M is a pointer to the mem_block for P. */
3753 live_string_p (m
, p
)
3757 if (m
->type
== MEM_TYPE_STRING
)
3759 struct string_block
*b
= (struct string_block
*) m
->start
;
3760 int offset
= (char *) p
- (char *) &b
->strings
[0];
3762 /* P must point to the start of a Lisp_String structure, and it
3763 must not be on the free-list. */
3765 && offset
% sizeof b
->strings
[0] == 0
3766 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
3767 && ((struct Lisp_String
*) p
)->data
!= NULL
);
3774 /* Value is non-zero if P is a pointer to a live Lisp cons on
3775 the heap. M is a pointer to the mem_block for P. */
3782 if (m
->type
== MEM_TYPE_CONS
)
3784 struct cons_block
*b
= (struct cons_block
*) m
->start
;
3785 int offset
= (char *) p
- (char *) &b
->conses
[0];
3787 /* P must point to the start of a Lisp_Cons, not be
3788 one of the unused cells in the current cons block,
3789 and not be on the free-list. */
3791 && offset
% sizeof b
->conses
[0] == 0
3792 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
3794 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
3795 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
3802 /* Value is non-zero if P is a pointer to a live Lisp symbol on
3803 the heap. M is a pointer to the mem_block for P. */
3806 live_symbol_p (m
, p
)
3810 if (m
->type
== MEM_TYPE_SYMBOL
)
3812 struct symbol_block
*b
= (struct symbol_block
*) m
->start
;
3813 int offset
= (char *) p
- (char *) &b
->symbols
[0];
3815 /* P must point to the start of a Lisp_Symbol, not be
3816 one of the unused cells in the current symbol block,
3817 and not be on the free-list. */
3819 && offset
% sizeof b
->symbols
[0] == 0
3820 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
3821 && (b
!= symbol_block
3822 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
3823 && !EQ (((struct Lisp_Symbol
*) p
)->function
, Vdead
));
3830 /* Value is non-zero if P is a pointer to a live Lisp float on
3831 the heap. M is a pointer to the mem_block for P. */
3838 if (m
->type
== MEM_TYPE_FLOAT
)
3840 struct float_block
*b
= (struct float_block
*) m
->start
;
3841 int offset
= (char *) p
- (char *) &b
->floats
[0];
3843 /* P must point to the start of a Lisp_Float and not be
3844 one of the unused cells in the current float block. */
3846 && offset
% sizeof b
->floats
[0] == 0
3847 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
3848 && (b
!= float_block
3849 || offset
/ sizeof b
->floats
[0] < float_block_index
));
3856 /* Value is non-zero if P is a pointer to a live Lisp Misc on
3857 the heap. M is a pointer to the mem_block for P. */
3864 if (m
->type
== MEM_TYPE_MISC
)
3866 struct marker_block
*b
= (struct marker_block
*) m
->start
;
3867 int offset
= (char *) p
- (char *) &b
->markers
[0];
3869 /* P must point to the start of a Lisp_Misc, not be
3870 one of the unused cells in the current misc block,
3871 and not be on the free-list. */
3873 && offset
% sizeof b
->markers
[0] == 0
3874 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
3875 && (b
!= marker_block
3876 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
3877 && ((union Lisp_Misc
*) p
)->u_marker
.type
!= Lisp_Misc_Free
);
3884 /* Value is non-zero if P is a pointer to a live vector-like object.
3885 M is a pointer to the mem_block for P. */
3888 live_vector_p (m
, p
)
3892 return (p
== m
->start
3893 && m
->type
>= MEM_TYPE_VECTOR
3894 && m
->type
<= MEM_TYPE_WINDOW
);
3898 /* Value is non-zero if P is a pointer to a live buffer. M is a
3899 pointer to the mem_block for P. */
3902 live_buffer_p (m
, p
)
3906 /* P must point to the start of the block, and the buffer
3907 must not have been killed. */
3908 return (m
->type
== MEM_TYPE_BUFFER
3910 && !NILP (((struct buffer
*) p
)->name
));
3913 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
3917 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
3919 /* Array of objects that are kept alive because the C stack contains
3920 a pattern that looks like a reference to them . */
3922 #define MAX_ZOMBIES 10
3923 static Lisp_Object zombies
[MAX_ZOMBIES
];
3925 /* Number of zombie objects. */
3927 static int nzombies
;
3929 /* Number of garbage collections. */
3933 /* Average percentage of zombies per collection. */
3935 static double avg_zombies
;
3937 /* Max. number of live and zombie objects. */
3939 static int max_live
, max_zombies
;
3941 /* Average number of live objects per GC. */
3943 static double avg_live
;
3945 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
3946 doc
: /* Show information about live and zombie objects. */)
3949 Lisp_Object args
[8], zombie_list
= Qnil
;
3951 for (i
= 0; i
< nzombies
; i
++)
3952 zombie_list
= Fcons (zombies
[i
], zombie_list
);
3953 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
3954 args
[1] = make_number (ngcs
);
3955 args
[2] = make_float (avg_live
);
3956 args
[3] = make_float (avg_zombies
);
3957 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
3958 args
[5] = make_number (max_live
);
3959 args
[6] = make_number (max_zombies
);
3960 args
[7] = zombie_list
;
3961 return Fmessage (8, args
);
3964 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
3967 /* Mark OBJ if we can prove it's a Lisp_Object. */
3970 mark_maybe_object (obj
)
3973 void *po
= (void *) XPNTR (obj
);
3974 struct mem_node
*m
= mem_find (po
);
3980 switch (XGCTYPE (obj
))
3983 mark_p
= (live_string_p (m
, po
)
3984 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
3988 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
3992 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
3996 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
3999 case Lisp_Vectorlike
:
4000 /* Note: can't check GC_BUFFERP before we know it's a
4001 buffer because checking that dereferences the pointer
4002 PO which might point anywhere. */
4003 if (live_vector_p (m
, po
))
4004 mark_p
= !GC_SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4005 else if (live_buffer_p (m
, po
))
4006 mark_p
= GC_BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4010 mark_p
= (live_misc_p (m
, po
) && !XMARKER (obj
)->gcmarkbit
);
4014 case Lisp_Type_Limit
:
4020 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4021 if (nzombies
< MAX_ZOMBIES
)
4022 zombies
[nzombies
] = obj
;
4031 /* If P points to Lisp data, mark that as live if it isn't already
4035 mark_maybe_pointer (p
)
4040 /* Quickly rule out some values which can't point to Lisp data. We
4041 assume that Lisp data is aligned on even addresses. */
4042 if ((EMACS_INT
) p
& 1)
4048 Lisp_Object obj
= Qnil
;
4052 case MEM_TYPE_NON_LISP
:
4053 /* Nothing to do; not a pointer to Lisp memory. */
4056 case MEM_TYPE_BUFFER
:
4057 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P((struct buffer
*)p
))
4058 XSETVECTOR (obj
, p
);
4062 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4066 case MEM_TYPE_STRING
:
4067 if (live_string_p (m
, p
)
4068 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4069 XSETSTRING (obj
, p
);
4073 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4077 case MEM_TYPE_SYMBOL
:
4078 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4079 XSETSYMBOL (obj
, p
);
4082 case MEM_TYPE_FLOAT
:
4083 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4087 case MEM_TYPE_VECTOR
:
4088 case MEM_TYPE_PROCESS
:
4089 case MEM_TYPE_HASH_TABLE
:
4090 case MEM_TYPE_FRAME
:
4091 case MEM_TYPE_WINDOW
:
4092 if (live_vector_p (m
, p
))
4095 XSETVECTOR (tem
, p
);
4096 if (!GC_SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4111 /* Mark Lisp objects referenced from the address range START..END. */
4114 mark_memory (start
, end
)
4120 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4124 /* Make START the pointer to the start of the memory region,
4125 if it isn't already. */
4133 /* Mark Lisp_Objects. */
4134 for (p
= (Lisp_Object
*) start
; (void *) p
< end
; ++p
)
4135 mark_maybe_object (*p
);
4137 /* Mark Lisp data pointed to. This is necessary because, in some
4138 situations, the C compiler optimizes Lisp objects away, so that
4139 only a pointer to them remains. Example:
4141 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4144 Lisp_Object obj = build_string ("test");
4145 struct Lisp_String *s = XSTRING (obj);
4146 Fgarbage_collect ();
4147 fprintf (stderr, "test `%s'\n", s->data);
4151 Here, `obj' isn't really used, and the compiler optimizes it
4152 away. The only reference to the life string is through the
4155 for (pp
= (void **) start
; (void *) pp
< end
; ++pp
)
4156 mark_maybe_pointer (*pp
);
4159 /* setjmp will work with GCC unless NON_SAVING_SETJMP is defined in
4160 the GCC system configuration. In gcc 3.2, the only systems for
4161 which this is so are i386-sco5 non-ELF, i386-sysv3 (maybe included
4162 by others?) and ns32k-pc532-min. */
4164 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4166 static int setjmp_tested_p
, longjmps_done
;
4168 #define SETJMP_WILL_LIKELY_WORK "\
4170 Emacs garbage collector has been changed to use conservative stack\n\
4171 marking. Emacs has determined that the method it uses to do the\n\
4172 marking will likely work on your system, but this isn't sure.\n\
4174 If you are a system-programmer, or can get the help of a local wizard\n\
4175 who is, please take a look at the function mark_stack in alloc.c, and\n\
4176 verify that the methods used are appropriate for your system.\n\
4178 Please mail the result to <emacs-devel@gnu.org>.\n\
4181 #define SETJMP_WILL_NOT_WORK "\
4183 Emacs garbage collector has been changed to use conservative stack\n\
4184 marking. Emacs has determined that the default method it uses to do the\n\
4185 marking will not work on your system. We will need a system-dependent\n\
4186 solution for your system.\n\
4188 Please take a look at the function mark_stack in alloc.c, and\n\
4189 try to find a way to make it work on your system.\n\
4191 Note that you may get false negatives, depending on the compiler.\n\
4192 In particular, you need to use -O with GCC for this test.\n\
4194 Please mail the result to <emacs-devel@gnu.org>.\n\
4198 /* Perform a quick check if it looks like setjmp saves registers in a
4199 jmp_buf. Print a message to stderr saying so. When this test
4200 succeeds, this is _not_ a proof that setjmp is sufficient for
4201 conservative stack marking. Only the sources or a disassembly
4212 /* Arrange for X to be put in a register. */
4218 if (longjmps_done
== 1)
4220 /* Came here after the longjmp at the end of the function.
4222 If x == 1, the longjmp has restored the register to its
4223 value before the setjmp, and we can hope that setjmp
4224 saves all such registers in the jmp_buf, although that
4227 For other values of X, either something really strange is
4228 taking place, or the setjmp just didn't save the register. */
4231 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4234 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4241 if (longjmps_done
== 1)
4245 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4248 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4250 /* Abort if anything GCPRO'd doesn't survive the GC. */
4258 for (p
= gcprolist
; p
; p
= p
->next
)
4259 for (i
= 0; i
< p
->nvars
; ++i
)
4260 if (!survives_gc_p (p
->var
[i
]))
4261 /* FIXME: It's not necessarily a bug. It might just be that the
4262 GCPRO is unnecessary or should release the object sooner. */
4266 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4273 fprintf (stderr
, "\nZombies kept alive = %d:\n", nzombies
);
4274 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4276 fprintf (stderr
, " %d = ", i
);
4277 debug_print (zombies
[i
]);
4281 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4284 /* Mark live Lisp objects on the C stack.
4286 There are several system-dependent problems to consider when
4287 porting this to new architectures:
4291 We have to mark Lisp objects in CPU registers that can hold local
4292 variables or are used to pass parameters.
4294 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4295 something that either saves relevant registers on the stack, or
4296 calls mark_maybe_object passing it each register's contents.
4298 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4299 implementation assumes that calling setjmp saves registers we need
4300 to see in a jmp_buf which itself lies on the stack. This doesn't
4301 have to be true! It must be verified for each system, possibly
4302 by taking a look at the source code of setjmp.
4306 Architectures differ in the way their processor stack is organized.
4307 For example, the stack might look like this
4310 | Lisp_Object | size = 4
4312 | something else | size = 2
4314 | Lisp_Object | size = 4
4318 In such a case, not every Lisp_Object will be aligned equally. To
4319 find all Lisp_Object on the stack it won't be sufficient to walk
4320 the stack in steps of 4 bytes. Instead, two passes will be
4321 necessary, one starting at the start of the stack, and a second
4322 pass starting at the start of the stack + 2. Likewise, if the
4323 minimal alignment of Lisp_Objects on the stack is 1, four passes
4324 would be necessary, each one starting with one byte more offset
4325 from the stack start.
4327 The current code assumes by default that Lisp_Objects are aligned
4328 equally on the stack. */
4335 volatile int stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4338 /* This trick flushes the register windows so that all the state of
4339 the process is contained in the stack. */
4340 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4341 needed on ia64 too. See mach_dep.c, where it also says inline
4342 assembler doesn't work with relevant proprietary compilers. */
4347 /* Save registers that we need to see on the stack. We need to see
4348 registers used to hold register variables and registers used to
4350 #ifdef GC_SAVE_REGISTERS_ON_STACK
4351 GC_SAVE_REGISTERS_ON_STACK (end
);
4352 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4354 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4355 setjmp will definitely work, test it
4356 and print a message with the result
4358 if (!setjmp_tested_p
)
4360 setjmp_tested_p
= 1;
4363 #endif /* GC_SETJMP_WORKS */
4366 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4367 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4369 /* This assumes that the stack is a contiguous region in memory. If
4370 that's not the case, something has to be done here to iterate
4371 over the stack segments. */
4372 #ifndef GC_LISP_OBJECT_ALIGNMENT
4374 #define GC_LISP_OBJECT_ALIGNMENT __alignof__ (Lisp_Object)
4376 #define GC_LISP_OBJECT_ALIGNMENT sizeof (Lisp_Object)
4379 for (i
= 0; i
< sizeof (Lisp_Object
); i
+= GC_LISP_OBJECT_ALIGNMENT
)
4380 mark_memory ((char *) stack_base
+ i
, end
);
4381 /* Allow for marking a secondary stack, like the register stack on the
4383 #ifdef GC_MARK_SECONDARY_STACK
4384 GC_MARK_SECONDARY_STACK ();
4387 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4393 #endif /* GC_MARK_STACK != 0 */
4397 /***********************************************************************
4398 Pure Storage Management
4399 ***********************************************************************/
4401 /* Allocate room for SIZE bytes from pure Lisp storage and return a
4402 pointer to it. TYPE is the Lisp type for which the memory is
4403 allocated. TYPE < 0 means it's not used for a Lisp object.
4405 If store_pure_type_info is set and TYPE is >= 0, the type of
4406 the allocated object is recorded in pure_types. */
4408 static POINTER_TYPE
*
4409 pure_alloc (size
, type
)
4413 POINTER_TYPE
*result
;
4415 size_t alignment
= (1 << GCTYPEBITS
);
4417 size_t alignment
= sizeof (EMACS_INT
);
4419 /* Give Lisp_Floats an extra alignment. */
4420 if (type
== Lisp_Float
)
4422 #if defined __GNUC__ && __GNUC__ >= 2
4423 alignment
= __alignof (struct Lisp_Float
);
4425 alignment
= sizeof (struct Lisp_Float
);
4431 result
= ALIGN (purebeg
+ pure_bytes_used
, alignment
);
4432 pure_bytes_used
= ((char *)result
- (char *)purebeg
) + size
;
4434 if (pure_bytes_used
<= pure_size
)
4437 /* Don't allocate a large amount here,
4438 because it might get mmap'd and then its address
4439 might not be usable. */
4440 purebeg
= (char *) xmalloc (10000);
4442 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
4443 pure_bytes_used
= 0;
4448 /* Print a warning if PURESIZE is too small. */
4453 if (pure_bytes_used_before_overflow
)
4454 message ("Pure Lisp storage overflow (approx. %d bytes needed)",
4455 (int) (pure_bytes_used
+ pure_bytes_used_before_overflow
));
4459 /* Return a string allocated in pure space. DATA is a buffer holding
4460 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
4461 non-zero means make the result string multibyte.
4463 Must get an error if pure storage is full, since if it cannot hold
4464 a large string it may be able to hold conses that point to that
4465 string; then the string is not protected from gc. */
4468 make_pure_string (data
, nchars
, nbytes
, multibyte
)
4474 struct Lisp_String
*s
;
4476 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
4477 s
->data
= (unsigned char *) pure_alloc (nbytes
+ 1, -1);
4479 s
->size_byte
= multibyte
? nbytes
: -1;
4480 bcopy (data
, s
->data
, nbytes
);
4481 s
->data
[nbytes
] = '\0';
4482 s
->intervals
= NULL_INTERVAL
;
4483 XSETSTRING (string
, s
);
4488 /* Return a cons allocated from pure space. Give it pure copies
4489 of CAR as car and CDR as cdr. */
4492 pure_cons (car
, cdr
)
4493 Lisp_Object car
, cdr
;
4495 register Lisp_Object
new;
4496 struct Lisp_Cons
*p
;
4498 p
= (struct Lisp_Cons
*) pure_alloc (sizeof *p
, Lisp_Cons
);
4500 XSETCAR (new, Fpurecopy (car
));
4501 XSETCDR (new, Fpurecopy (cdr
));
4506 /* Value is a float object with value NUM allocated from pure space. */
4509 make_pure_float (num
)
4512 register Lisp_Object
new;
4513 struct Lisp_Float
*p
;
4515 p
= (struct Lisp_Float
*) pure_alloc (sizeof *p
, Lisp_Float
);
4517 XFLOAT_DATA (new) = num
;
4522 /* Return a vector with room for LEN Lisp_Objects allocated from
4526 make_pure_vector (len
)
4530 struct Lisp_Vector
*p
;
4531 size_t size
= sizeof *p
+ (len
- 1) * sizeof (Lisp_Object
);
4533 p
= (struct Lisp_Vector
*) pure_alloc (size
, Lisp_Vectorlike
);
4534 XSETVECTOR (new, p
);
4535 XVECTOR (new)->size
= len
;
4540 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
4541 doc
: /* Make a copy of OBJECT in pure storage.
4542 Recursively copies contents of vectors and cons cells.
4543 Does not copy symbols. Copies strings without text properties. */)
4545 register Lisp_Object obj
;
4547 if (NILP (Vpurify_flag
))
4550 if (PURE_POINTER_P (XPNTR (obj
)))
4554 return pure_cons (XCAR (obj
), XCDR (obj
));
4555 else if (FLOATP (obj
))
4556 return make_pure_float (XFLOAT_DATA (obj
));
4557 else if (STRINGP (obj
))
4558 return make_pure_string (SDATA (obj
), SCHARS (obj
),
4560 STRING_MULTIBYTE (obj
));
4561 else if (COMPILEDP (obj
) || VECTORP (obj
))
4563 register struct Lisp_Vector
*vec
;
4567 size
= XVECTOR (obj
)->size
;
4568 if (size
& PSEUDOVECTOR_FLAG
)
4569 size
&= PSEUDOVECTOR_SIZE_MASK
;
4570 vec
= XVECTOR (make_pure_vector (size
));
4571 for (i
= 0; i
< size
; i
++)
4572 vec
->contents
[i
] = Fpurecopy (XVECTOR (obj
)->contents
[i
]);
4573 if (COMPILEDP (obj
))
4574 XSETCOMPILED (obj
, vec
);
4576 XSETVECTOR (obj
, vec
);
4579 else if (MARKERP (obj
))
4580 error ("Attempt to copy a marker to pure storage");
4587 /***********************************************************************
4589 ***********************************************************************/
4591 /* Put an entry in staticvec, pointing at the variable with address
4595 staticpro (varaddress
)
4596 Lisp_Object
*varaddress
;
4598 staticvec
[staticidx
++] = varaddress
;
4599 if (staticidx
>= NSTATICS
)
4607 struct catchtag
*next
;
4611 /***********************************************************************
4613 ***********************************************************************/
4615 /* Temporarily prevent garbage collection. */
4618 inhibit_garbage_collection ()
4620 int count
= SPECPDL_INDEX ();
4621 int nbits
= min (VALBITS
, BITS_PER_INT
);
4623 specbind (Qgc_cons_threshold
, make_number (((EMACS_INT
) 1 << (nbits
- 1)) - 1));
4628 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
4629 doc
: /* Reclaim storage for Lisp objects no longer needed.
4630 Garbage collection happens automatically if you cons more than
4631 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
4632 `garbage-collect' normally returns a list with info on amount of space in use:
4633 ((USED-CONSES . FREE-CONSES) (USED-SYMS . FREE-SYMS)
4634 (USED-MARKERS . FREE-MARKERS) USED-STRING-CHARS USED-VECTOR-SLOTS
4635 (USED-FLOATS . FREE-FLOATS) (USED-INTERVALS . FREE-INTERVALS)
4636 (USED-STRINGS . FREE-STRINGS))
4637 However, if there was overflow in pure space, `garbage-collect'
4638 returns nil, because real GC can't be done. */)
4641 register struct specbinding
*bind
;
4642 struct catchtag
*catch;
4643 struct handler
*handler
;
4644 char stack_top_variable
;
4647 Lisp_Object total
[8];
4648 int count
= SPECPDL_INDEX ();
4649 EMACS_TIME t1
, t2
, t3
;
4654 /* Can't GC if pure storage overflowed because we can't determine
4655 if something is a pure object or not. */
4656 if (pure_bytes_used_before_overflow
)
4661 /* Don't keep undo information around forever.
4662 Do this early on, so it is no problem if the user quits. */
4664 register struct buffer
*nextb
= all_buffers
;
4668 /* If a buffer's undo list is Qt, that means that undo is
4669 turned off in that buffer. Calling truncate_undo_list on
4670 Qt tends to return NULL, which effectively turns undo back on.
4671 So don't call truncate_undo_list if undo_list is Qt. */
4672 if (! NILP (nextb
->name
) && ! EQ (nextb
->undo_list
, Qt
))
4673 truncate_undo_list (nextb
);
4675 /* Shrink buffer gaps, but skip indirect and dead buffers. */
4676 if (nextb
->base_buffer
== 0 && !NILP (nextb
->name
))
4678 /* If a buffer's gap size is more than 10% of the buffer
4679 size, or larger than 2000 bytes, then shrink it
4680 accordingly. Keep a minimum size of 20 bytes. */
4681 int size
= min (2000, max (20, (nextb
->text
->z_byte
/ 10)));
4683 if (nextb
->text
->gap_size
> size
)
4685 struct buffer
*save_current
= current_buffer
;
4686 current_buffer
= nextb
;
4687 make_gap (-(nextb
->text
->gap_size
- size
));
4688 current_buffer
= save_current
;
4692 nextb
= nextb
->next
;
4696 EMACS_GET_TIME (t1
);
4698 /* In case user calls debug_print during GC,
4699 don't let that cause a recursive GC. */
4700 consing_since_gc
= 0;
4702 /* Save what's currently displayed in the echo area. */
4703 message_p
= push_message ();
4704 record_unwind_protect (pop_message_unwind
, Qnil
);
4706 /* Save a copy of the contents of the stack, for debugging. */
4707 #if MAX_SAVE_STACK > 0
4708 if (NILP (Vpurify_flag
))
4710 i
= &stack_top_variable
- stack_bottom
;
4712 if (i
< MAX_SAVE_STACK
)
4714 if (stack_copy
== 0)
4715 stack_copy
= (char *) xmalloc (stack_copy_size
= i
);
4716 else if (stack_copy_size
< i
)
4717 stack_copy
= (char *) xrealloc (stack_copy
, (stack_copy_size
= i
));
4720 if ((EMACS_INT
) (&stack_top_variable
- stack_bottom
) > 0)
4721 bcopy (stack_bottom
, stack_copy
, i
);
4723 bcopy (&stack_top_variable
, stack_copy
, i
);
4727 #endif /* MAX_SAVE_STACK > 0 */
4729 if (garbage_collection_messages
)
4730 message1_nolog ("Garbage collecting...");
4734 shrink_regexp_cache ();
4738 /* clear_marks (); */
4740 /* Mark all the special slots that serve as the roots of accessibility. */
4742 for (i
= 0; i
< staticidx
; i
++)
4743 mark_object (*staticvec
[i
]);
4745 for (bind
= specpdl
; bind
!= specpdl_ptr
; bind
++)
4747 mark_object (bind
->symbol
);
4748 mark_object (bind
->old_value
);
4754 extern void xg_mark_data ();
4759 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
4760 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
4764 register struct gcpro
*tail
;
4765 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
4766 for (i
= 0; i
< tail
->nvars
; i
++)
4767 mark_object (tail
->var
[i
]);
4772 for (catch = catchlist
; catch; catch = catch->next
)
4774 mark_object (catch->tag
);
4775 mark_object (catch->val
);
4777 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
4779 mark_object (handler
->handler
);
4780 mark_object (handler
->var
);
4784 #ifdef HAVE_WINDOW_SYSTEM
4785 mark_fringe_data ();
4788 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4792 /* Everything is now marked, except for the things that require special
4793 finalization, i.e. the undo_list.
4794 Look thru every buffer's undo list
4795 for elements that update markers that were not marked,
4798 register struct buffer
*nextb
= all_buffers
;
4802 /* If a buffer's undo list is Qt, that means that undo is
4803 turned off in that buffer. Calling truncate_undo_list on
4804 Qt tends to return NULL, which effectively turns undo back on.
4805 So don't call truncate_undo_list if undo_list is Qt. */
4806 if (! EQ (nextb
->undo_list
, Qt
))
4808 Lisp_Object tail
, prev
;
4809 tail
= nextb
->undo_list
;
4811 while (CONSP (tail
))
4813 if (GC_CONSP (XCAR (tail
))
4814 && GC_MARKERP (XCAR (XCAR (tail
)))
4815 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
4818 nextb
->undo_list
= tail
= XCDR (tail
);
4822 XSETCDR (prev
, tail
);
4832 /* Now that we have stripped the elements that need not be in the
4833 undo_list any more, we can finally mark the list. */
4834 mark_object (nextb
->undo_list
);
4836 nextb
= nextb
->next
;
4842 /* Clear the mark bits that we set in certain root slots. */
4844 unmark_byte_stack ();
4845 VECTOR_UNMARK (&buffer_defaults
);
4846 VECTOR_UNMARK (&buffer_local_symbols
);
4848 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
4856 /* clear_marks (); */
4859 consing_since_gc
= 0;
4860 if (gc_cons_threshold
< 10000)
4861 gc_cons_threshold
= 10000;
4863 if (FLOATP (Vgc_cons_percentage
))
4864 { /* Set gc_cons_combined_threshold. */
4865 EMACS_INT total
= 0;
4867 total
+= total_conses
* sizeof (struct Lisp_Cons
);
4868 total
+= total_symbols
* sizeof (struct Lisp_Symbol
);
4869 total
+= total_markers
* sizeof (union Lisp_Misc
);
4870 total
+= total_string_size
;
4871 total
+= total_vector_size
* sizeof (Lisp_Object
);
4872 total
+= total_floats
* sizeof (struct Lisp_Float
);
4873 total
+= total_intervals
* sizeof (struct interval
);
4874 total
+= total_strings
* sizeof (struct Lisp_String
);
4876 gc_relative_threshold
= total
* XFLOAT_DATA (Vgc_cons_percentage
);
4879 gc_relative_threshold
= 0;
4881 if (garbage_collection_messages
)
4883 if (message_p
|| minibuf_level
> 0)
4886 message1_nolog ("Garbage collecting...done");
4889 unbind_to (count
, Qnil
);
4891 total
[0] = Fcons (make_number (total_conses
),
4892 make_number (total_free_conses
));
4893 total
[1] = Fcons (make_number (total_symbols
),
4894 make_number (total_free_symbols
));
4895 total
[2] = Fcons (make_number (total_markers
),
4896 make_number (total_free_markers
));
4897 total
[3] = make_number (total_string_size
);
4898 total
[4] = make_number (total_vector_size
);
4899 total
[5] = Fcons (make_number (total_floats
),
4900 make_number (total_free_floats
));
4901 total
[6] = Fcons (make_number (total_intervals
),
4902 make_number (total_free_intervals
));
4903 total
[7] = Fcons (make_number (total_strings
),
4904 make_number (total_free_strings
));
4906 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4908 /* Compute average percentage of zombies. */
4911 for (i
= 0; i
< 7; ++i
)
4912 if (CONSP (total
[i
]))
4913 nlive
+= XFASTINT (XCAR (total
[i
]));
4915 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
4916 max_live
= max (nlive
, max_live
);
4917 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
4918 max_zombies
= max (nzombies
, max_zombies
);
4923 if (!NILP (Vpost_gc_hook
))
4925 int count
= inhibit_garbage_collection ();
4926 safe_run_hooks (Qpost_gc_hook
);
4927 unbind_to (count
, Qnil
);
4930 /* Accumulate statistics. */
4931 EMACS_GET_TIME (t2
);
4932 EMACS_SUB_TIME (t3
, t2
, t1
);
4933 if (FLOATP (Vgc_elapsed
))
4934 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
) +
4936 EMACS_USECS (t3
) * 1.0e-6);
4939 return Flist (sizeof total
/ sizeof *total
, total
);
4943 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
4944 only interesting objects referenced from glyphs are strings. */
4947 mark_glyph_matrix (matrix
)
4948 struct glyph_matrix
*matrix
;
4950 struct glyph_row
*row
= matrix
->rows
;
4951 struct glyph_row
*end
= row
+ matrix
->nrows
;
4953 for (; row
< end
; ++row
)
4957 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
4959 struct glyph
*glyph
= row
->glyphs
[area
];
4960 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
4962 for (; glyph
< end_glyph
; ++glyph
)
4963 if (GC_STRINGP (glyph
->object
)
4964 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
4965 mark_object (glyph
->object
);
4971 /* Mark Lisp faces in the face cache C. */
4975 struct face_cache
*c
;
4980 for (i
= 0; i
< c
->used
; ++i
)
4982 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
4986 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
4987 mark_object (face
->lface
[j
]);
4994 #ifdef HAVE_WINDOW_SYSTEM
4996 /* Mark Lisp objects in image IMG. */
5002 mark_object (img
->spec
);
5004 if (!NILP (img
->data
.lisp_val
))
5005 mark_object (img
->data
.lisp_val
);
5009 /* Mark Lisp objects in image cache of frame F. It's done this way so
5010 that we don't have to include xterm.h here. */
5013 mark_image_cache (f
)
5016 forall_images_in_image_cache (f
, mark_image
);
5019 #endif /* HAVE_X_WINDOWS */
5023 /* Mark reference to a Lisp_Object.
5024 If the object referred to has not been seen yet, recursively mark
5025 all the references contained in it. */
5027 #define LAST_MARKED_SIZE 500
5028 Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5029 int last_marked_index
;
5031 /* For debugging--call abort when we cdr down this many
5032 links of a list, in mark_object. In debugging,
5033 the call to abort will hit a breakpoint.
5034 Normally this is zero and the check never goes off. */
5035 int mark_object_loop_halt
;
5041 register Lisp_Object obj
= arg
;
5042 #ifdef GC_CHECK_MARKED_OBJECTS
5050 if (PURE_POINTER_P (XPNTR (obj
)))
5053 last_marked
[last_marked_index
++] = obj
;
5054 if (last_marked_index
== LAST_MARKED_SIZE
)
5055 last_marked_index
= 0;
5057 /* Perform some sanity checks on the objects marked here. Abort if
5058 we encounter an object we know is bogus. This increases GC time
5059 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5060 #ifdef GC_CHECK_MARKED_OBJECTS
5062 po
= (void *) XPNTR (obj
);
5064 /* Check that the object pointed to by PO is known to be a Lisp
5065 structure allocated from the heap. */
5066 #define CHECK_ALLOCATED() \
5068 m = mem_find (po); \
5073 /* Check that the object pointed to by PO is live, using predicate
5075 #define CHECK_LIVE(LIVEP) \
5077 if (!LIVEP (m, po)) \
5081 /* Check both of the above conditions. */
5082 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5084 CHECK_ALLOCATED (); \
5085 CHECK_LIVE (LIVEP); \
5088 #else /* not GC_CHECK_MARKED_OBJECTS */
5090 #define CHECK_ALLOCATED() (void) 0
5091 #define CHECK_LIVE(LIVEP) (void) 0
5092 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5094 #endif /* not GC_CHECK_MARKED_OBJECTS */
5096 switch (SWITCH_ENUM_CAST (XGCTYPE (obj
)))
5100 register struct Lisp_String
*ptr
= XSTRING (obj
);
5101 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
5102 MARK_INTERVAL_TREE (ptr
->intervals
);
5104 #ifdef GC_CHECK_STRING_BYTES
5105 /* Check that the string size recorded in the string is the
5106 same as the one recorded in the sdata structure. */
5107 CHECK_STRING_BYTES (ptr
);
5108 #endif /* GC_CHECK_STRING_BYTES */
5112 case Lisp_Vectorlike
:
5113 #ifdef GC_CHECK_MARKED_OBJECTS
5115 if (m
== MEM_NIL
&& !GC_SUBRP (obj
)
5116 && po
!= &buffer_defaults
5117 && po
!= &buffer_local_symbols
)
5119 #endif /* GC_CHECK_MARKED_OBJECTS */
5121 if (GC_BUFFERP (obj
))
5123 if (!VECTOR_MARKED_P (XBUFFER (obj
)))
5125 #ifdef GC_CHECK_MARKED_OBJECTS
5126 if (po
!= &buffer_defaults
&& po
!= &buffer_local_symbols
)
5129 for (b
= all_buffers
; b
&& b
!= po
; b
= b
->next
)
5134 #endif /* GC_CHECK_MARKED_OBJECTS */
5138 else if (GC_SUBRP (obj
))
5140 else if (GC_COMPILEDP (obj
))
5141 /* We could treat this just like a vector, but it is better to
5142 save the COMPILED_CONSTANTS element for last and avoid
5145 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5146 register EMACS_INT size
= ptr
->size
;
5149 if (VECTOR_MARKED_P (ptr
))
5150 break; /* Already marked */
5152 CHECK_LIVE (live_vector_p
);
5153 VECTOR_MARK (ptr
); /* Else mark it */
5154 size
&= PSEUDOVECTOR_SIZE_MASK
;
5155 for (i
= 0; i
< size
; i
++) /* and then mark its elements */
5157 if (i
!= COMPILED_CONSTANTS
)
5158 mark_object (ptr
->contents
[i
]);
5160 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
5163 else if (GC_FRAMEP (obj
))
5165 register struct frame
*ptr
= XFRAME (obj
);
5167 if (VECTOR_MARKED_P (ptr
)) break; /* Already marked */
5168 VECTOR_MARK (ptr
); /* Else mark it */
5170 CHECK_LIVE (live_vector_p
);
5171 mark_object (ptr
->name
);
5172 mark_object (ptr
->icon_name
);
5173 mark_object (ptr
->title
);
5174 mark_object (ptr
->focus_frame
);
5175 mark_object (ptr
->selected_window
);
5176 mark_object (ptr
->minibuffer_window
);
5177 mark_object (ptr
->param_alist
);
5178 mark_object (ptr
->scroll_bars
);
5179 mark_object (ptr
->condemned_scroll_bars
);
5180 mark_object (ptr
->menu_bar_items
);
5181 mark_object (ptr
->face_alist
);
5182 mark_object (ptr
->menu_bar_vector
);
5183 mark_object (ptr
->buffer_predicate
);
5184 mark_object (ptr
->buffer_list
);
5185 mark_object (ptr
->menu_bar_window
);
5186 mark_object (ptr
->tool_bar_window
);
5187 mark_face_cache (ptr
->face_cache
);
5188 #ifdef HAVE_WINDOW_SYSTEM
5189 mark_image_cache (ptr
);
5190 mark_object (ptr
->tool_bar_items
);
5191 mark_object (ptr
->desired_tool_bar_string
);
5192 mark_object (ptr
->current_tool_bar_string
);
5193 #endif /* HAVE_WINDOW_SYSTEM */
5195 else if (GC_BOOL_VECTOR_P (obj
))
5197 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5199 if (VECTOR_MARKED_P (ptr
))
5200 break; /* Already marked */
5201 CHECK_LIVE (live_vector_p
);
5202 VECTOR_MARK (ptr
); /* Else mark it */
5204 else if (GC_WINDOWP (obj
))
5206 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5207 struct window
*w
= XWINDOW (obj
);
5210 /* Stop if already marked. */
5211 if (VECTOR_MARKED_P (ptr
))
5215 CHECK_LIVE (live_vector_p
);
5218 /* There is no Lisp data above The member CURRENT_MATRIX in
5219 struct WINDOW. Stop marking when that slot is reached. */
5221 (char *) &ptr
->contents
[i
] < (char *) &w
->current_matrix
;
5223 mark_object (ptr
->contents
[i
]);
5225 /* Mark glyphs for leaf windows. Marking window matrices is
5226 sufficient because frame matrices use the same glyph
5228 if (NILP (w
->hchild
)
5230 && w
->current_matrix
)
5232 mark_glyph_matrix (w
->current_matrix
);
5233 mark_glyph_matrix (w
->desired_matrix
);
5236 else if (GC_HASH_TABLE_P (obj
))
5238 struct Lisp_Hash_Table
*h
= XHASH_TABLE (obj
);
5240 /* Stop if already marked. */
5241 if (VECTOR_MARKED_P (h
))
5245 CHECK_LIVE (live_vector_p
);
5248 /* Mark contents. */
5249 /* Do not mark next_free or next_weak.
5250 Being in the next_weak chain
5251 should not keep the hash table alive.
5252 No need to mark `count' since it is an integer. */
5253 mark_object (h
->test
);
5254 mark_object (h
->weak
);
5255 mark_object (h
->rehash_size
);
5256 mark_object (h
->rehash_threshold
);
5257 mark_object (h
->hash
);
5258 mark_object (h
->next
);
5259 mark_object (h
->index
);
5260 mark_object (h
->user_hash_function
);
5261 mark_object (h
->user_cmp_function
);
5263 /* If hash table is not weak, mark all keys and values.
5264 For weak tables, mark only the vector. */
5265 if (GC_NILP (h
->weak
))
5266 mark_object (h
->key_and_value
);
5268 VECTOR_MARK (XVECTOR (h
->key_and_value
));
5272 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5273 register EMACS_INT size
= ptr
->size
;
5276 if (VECTOR_MARKED_P (ptr
)) break; /* Already marked */
5277 CHECK_LIVE (live_vector_p
);
5278 VECTOR_MARK (ptr
); /* Else mark it */
5279 if (size
& PSEUDOVECTOR_FLAG
)
5280 size
&= PSEUDOVECTOR_SIZE_MASK
;
5282 for (i
= 0; i
< size
; i
++) /* and then mark its elements */
5283 mark_object (ptr
->contents
[i
]);
5289 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
5290 struct Lisp_Symbol
*ptrx
;
5292 if (ptr
->gcmarkbit
) break;
5293 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
5295 mark_object (ptr
->value
);
5296 mark_object (ptr
->function
);
5297 mark_object (ptr
->plist
);
5299 if (!PURE_POINTER_P (XSTRING (ptr
->xname
)))
5300 MARK_STRING (XSTRING (ptr
->xname
));
5301 MARK_INTERVAL_TREE (STRING_INTERVALS (ptr
->xname
));
5303 /* Note that we do not mark the obarray of the symbol.
5304 It is safe not to do so because nothing accesses that
5305 slot except to check whether it is nil. */
5309 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun */
5310 XSETSYMBOL (obj
, ptrx
);
5317 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
5318 if (XMARKER (obj
)->gcmarkbit
)
5320 XMARKER (obj
)->gcmarkbit
= 1;
5322 switch (XMISCTYPE (obj
))
5324 case Lisp_Misc_Buffer_Local_Value
:
5325 case Lisp_Misc_Some_Buffer_Local_Value
:
5327 register struct Lisp_Buffer_Local_Value
*ptr
5328 = XBUFFER_LOCAL_VALUE (obj
);
5329 /* If the cdr is nil, avoid recursion for the car. */
5330 if (EQ (ptr
->cdr
, Qnil
))
5332 obj
= ptr
->realvalue
;
5335 mark_object (ptr
->realvalue
);
5336 mark_object (ptr
->buffer
);
5337 mark_object (ptr
->frame
);
5342 case Lisp_Misc_Marker
:
5343 /* DO NOT mark thru the marker's chain.
5344 The buffer's markers chain does not preserve markers from gc;
5345 instead, markers are removed from the chain when freed by gc. */
5348 case Lisp_Misc_Intfwd
:
5349 case Lisp_Misc_Boolfwd
:
5350 case Lisp_Misc_Objfwd
:
5351 case Lisp_Misc_Buffer_Objfwd
:
5352 case Lisp_Misc_Kboard_Objfwd
:
5353 /* Don't bother with Lisp_Buffer_Objfwd,
5354 since all markable slots in current buffer marked anyway. */
5355 /* Don't need to do Lisp_Objfwd, since the places they point
5356 are protected with staticpro. */
5359 case Lisp_Misc_Save_Value
:
5362 register struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
5363 /* If DOGC is set, POINTER is the address of a memory
5364 area containing INTEGER potential Lisp_Objects. */
5367 Lisp_Object
*p
= (Lisp_Object
*) ptr
->pointer
;
5369 for (nelt
= ptr
->integer
; nelt
> 0; nelt
--, p
++)
5370 mark_maybe_object (*p
);
5376 case Lisp_Misc_Overlay
:
5378 struct Lisp_Overlay
*ptr
= XOVERLAY (obj
);
5379 mark_object (ptr
->start
);
5380 mark_object (ptr
->end
);
5381 mark_object (ptr
->plist
);
5384 XSETMISC (obj
, ptr
->next
);
5397 register struct Lisp_Cons
*ptr
= XCONS (obj
);
5398 if (CONS_MARKED_P (ptr
)) break;
5399 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
5401 /* If the cdr is nil, avoid recursion for the car. */
5402 if (EQ (ptr
->cdr
, Qnil
))
5408 mark_object (ptr
->car
);
5411 if (cdr_count
== mark_object_loop_halt
)
5417 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
5418 FLOAT_MARK (XFLOAT (obj
));
5429 #undef CHECK_ALLOCATED
5430 #undef CHECK_ALLOCATED_AND_LIVE
5433 /* Mark the pointers in a buffer structure. */
5439 register struct buffer
*buffer
= XBUFFER (buf
);
5440 register Lisp_Object
*ptr
, tmp
;
5441 Lisp_Object base_buffer
;
5443 VECTOR_MARK (buffer
);
5445 MARK_INTERVAL_TREE (BUF_INTERVALS (buffer
));
5447 /* For now, we just don't mark the undo_list. It's done later in
5448 a special way just before the sweep phase, and after stripping
5449 some of its elements that are not needed any more. */
5451 if (buffer
->overlays_before
)
5453 XSETMISC (tmp
, buffer
->overlays_before
);
5456 if (buffer
->overlays_after
)
5458 XSETMISC (tmp
, buffer
->overlays_after
);
5462 for (ptr
= &buffer
->name
;
5463 (char *)ptr
< (char *)buffer
+ sizeof (struct buffer
);
5467 /* If this is an indirect buffer, mark its base buffer. */
5468 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5470 XSETBUFFER (base_buffer
, buffer
->base_buffer
);
5471 mark_buffer (base_buffer
);
5476 /* Value is non-zero if OBJ will survive the current GC because it's
5477 either marked or does not need to be marked to survive. */
5485 switch (XGCTYPE (obj
))
5492 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
5496 survives_p
= XMARKER (obj
)->gcmarkbit
;
5500 survives_p
= STRING_MARKED_P (XSTRING (obj
));
5503 case Lisp_Vectorlike
:
5504 survives_p
= GC_SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
5508 survives_p
= CONS_MARKED_P (XCONS (obj
));
5512 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
5519 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
5524 /* Sweep: find all structures not marked, and free them. */
5529 /* Remove or mark entries in weak hash tables.
5530 This must be done before any object is unmarked. */
5531 sweep_weak_hash_tables ();
5534 #ifdef GC_CHECK_STRING_BYTES
5535 if (!noninteractive
)
5536 check_string_bytes (1);
5539 /* Put all unmarked conses on free list */
5541 register struct cons_block
*cblk
;
5542 struct cons_block
**cprev
= &cons_block
;
5543 register int lim
= cons_block_index
;
5544 register int num_free
= 0, num_used
= 0;
5548 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
5552 for (i
= 0; i
< lim
; i
++)
5553 if (!CONS_MARKED_P (&cblk
->conses
[i
]))
5556 *(struct Lisp_Cons
**)&cblk
->conses
[i
].cdr
= cons_free_list
;
5557 cons_free_list
= &cblk
->conses
[i
];
5559 cons_free_list
->car
= Vdead
;
5565 CONS_UNMARK (&cblk
->conses
[i
]);
5567 lim
= CONS_BLOCK_SIZE
;
5568 /* If this block contains only free conses and we have already
5569 seen more than two blocks worth of free conses then deallocate
5571 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
5573 *cprev
= cblk
->next
;
5574 /* Unhook from the free list. */
5575 cons_free_list
= *(struct Lisp_Cons
**) &cblk
->conses
[0].cdr
;
5576 lisp_align_free (cblk
);
5581 num_free
+= this_free
;
5582 cprev
= &cblk
->next
;
5585 total_conses
= num_used
;
5586 total_free_conses
= num_free
;
5589 /* Put all unmarked floats on free list */
5591 register struct float_block
*fblk
;
5592 struct float_block
**fprev
= &float_block
;
5593 register int lim
= float_block_index
;
5594 register int num_free
= 0, num_used
= 0;
5596 float_free_list
= 0;
5598 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
5602 for (i
= 0; i
< lim
; i
++)
5603 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
5606 *(struct Lisp_Float
**)&fblk
->floats
[i
].data
= float_free_list
;
5607 float_free_list
= &fblk
->floats
[i
];
5612 FLOAT_UNMARK (&fblk
->floats
[i
]);
5614 lim
= FLOAT_BLOCK_SIZE
;
5615 /* If this block contains only free floats and we have already
5616 seen more than two blocks worth of free floats then deallocate
5618 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
5620 *fprev
= fblk
->next
;
5621 /* Unhook from the free list. */
5622 float_free_list
= *(struct Lisp_Float
**) &fblk
->floats
[0].data
;
5623 lisp_align_free (fblk
);
5628 num_free
+= this_free
;
5629 fprev
= &fblk
->next
;
5632 total_floats
= num_used
;
5633 total_free_floats
= num_free
;
5636 /* Put all unmarked intervals on free list */
5638 register struct interval_block
*iblk
;
5639 struct interval_block
**iprev
= &interval_block
;
5640 register int lim
= interval_block_index
;
5641 register int num_free
= 0, num_used
= 0;
5643 interval_free_list
= 0;
5645 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
5650 for (i
= 0; i
< lim
; i
++)
5652 if (!iblk
->intervals
[i
].gcmarkbit
)
5654 SET_INTERVAL_PARENT (&iblk
->intervals
[i
], interval_free_list
);
5655 interval_free_list
= &iblk
->intervals
[i
];
5661 iblk
->intervals
[i
].gcmarkbit
= 0;
5664 lim
= INTERVAL_BLOCK_SIZE
;
5665 /* If this block contains only free intervals and we have already
5666 seen more than two blocks worth of free intervals then
5667 deallocate this block. */
5668 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
5670 *iprev
= iblk
->next
;
5671 /* Unhook from the free list. */
5672 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
5674 n_interval_blocks
--;
5678 num_free
+= this_free
;
5679 iprev
= &iblk
->next
;
5682 total_intervals
= num_used
;
5683 total_free_intervals
= num_free
;
5686 /* Put all unmarked symbols on free list */
5688 register struct symbol_block
*sblk
;
5689 struct symbol_block
**sprev
= &symbol_block
;
5690 register int lim
= symbol_block_index
;
5691 register int num_free
= 0, num_used
= 0;
5693 symbol_free_list
= NULL
;
5695 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
5698 struct Lisp_Symbol
*sym
= sblk
->symbols
;
5699 struct Lisp_Symbol
*end
= sym
+ lim
;
5701 for (; sym
< end
; ++sym
)
5703 /* Check if the symbol was created during loadup. In such a case
5704 it might be pointed to by pure bytecode which we don't trace,
5705 so we conservatively assume that it is live. */
5706 int pure_p
= PURE_POINTER_P (XSTRING (sym
->xname
));
5708 if (!sym
->gcmarkbit
&& !pure_p
)
5710 *(struct Lisp_Symbol
**) &sym
->value
= symbol_free_list
;
5711 symbol_free_list
= sym
;
5713 symbol_free_list
->function
= Vdead
;
5721 UNMARK_STRING (XSTRING (sym
->xname
));
5726 lim
= SYMBOL_BLOCK_SIZE
;
5727 /* If this block contains only free symbols and we have already
5728 seen more than two blocks worth of free symbols then deallocate
5730 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
5732 *sprev
= sblk
->next
;
5733 /* Unhook from the free list. */
5734 symbol_free_list
= *(struct Lisp_Symbol
**)&sblk
->symbols
[0].value
;
5740 num_free
+= this_free
;
5741 sprev
= &sblk
->next
;
5744 total_symbols
= num_used
;
5745 total_free_symbols
= num_free
;
5748 /* Put all unmarked misc's on free list.
5749 For a marker, first unchain it from the buffer it points into. */
5751 register struct marker_block
*mblk
;
5752 struct marker_block
**mprev
= &marker_block
;
5753 register int lim
= marker_block_index
;
5754 register int num_free
= 0, num_used
= 0;
5756 marker_free_list
= 0;
5758 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
5763 for (i
= 0; i
< lim
; i
++)
5765 if (!mblk
->markers
[i
].u_marker
.gcmarkbit
)
5767 if (mblk
->markers
[i
].u_marker
.type
== Lisp_Misc_Marker
)
5768 unchain_marker (&mblk
->markers
[i
].u_marker
);
5769 /* Set the type of the freed object to Lisp_Misc_Free.
5770 We could leave the type alone, since nobody checks it,
5771 but this might catch bugs faster. */
5772 mblk
->markers
[i
].u_marker
.type
= Lisp_Misc_Free
;
5773 mblk
->markers
[i
].u_free
.chain
= marker_free_list
;
5774 marker_free_list
= &mblk
->markers
[i
];
5780 mblk
->markers
[i
].u_marker
.gcmarkbit
= 0;
5783 lim
= MARKER_BLOCK_SIZE
;
5784 /* If this block contains only free markers and we have already
5785 seen more than two blocks worth of free markers then deallocate
5787 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
5789 *mprev
= mblk
->next
;
5790 /* Unhook from the free list. */
5791 marker_free_list
= mblk
->markers
[0].u_free
.chain
;
5797 num_free
+= this_free
;
5798 mprev
= &mblk
->next
;
5802 total_markers
= num_used
;
5803 total_free_markers
= num_free
;
5806 /* Free all unmarked buffers */
5808 register struct buffer
*buffer
= all_buffers
, *prev
= 0, *next
;
5811 if (!VECTOR_MARKED_P (buffer
))
5814 prev
->next
= buffer
->next
;
5816 all_buffers
= buffer
->next
;
5817 next
= buffer
->next
;
5823 VECTOR_UNMARK (buffer
);
5824 UNMARK_BALANCE_INTERVALS (BUF_INTERVALS (buffer
));
5825 prev
= buffer
, buffer
= buffer
->next
;
5829 /* Free all unmarked vectors */
5831 register struct Lisp_Vector
*vector
= all_vectors
, *prev
= 0, *next
;
5832 total_vector_size
= 0;
5835 if (!VECTOR_MARKED_P (vector
))
5838 prev
->next
= vector
->next
;
5840 all_vectors
= vector
->next
;
5841 next
= vector
->next
;
5849 VECTOR_UNMARK (vector
);
5850 if (vector
->size
& PSEUDOVECTOR_FLAG
)
5851 total_vector_size
+= (PSEUDOVECTOR_SIZE_MASK
& vector
->size
);
5853 total_vector_size
+= vector
->size
;
5854 prev
= vector
, vector
= vector
->next
;
5858 #ifdef GC_CHECK_STRING_BYTES
5859 if (!noninteractive
)
5860 check_string_bytes (1);
5867 /* Debugging aids. */
5869 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
5870 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
5871 This may be helpful in debugging Emacs's memory usage.
5872 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
5877 XSETINT (end
, (EMACS_INT
) sbrk (0) / 1024);
5882 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
5883 doc
: /* Return a list of counters that measure how much consing there has been.
5884 Each of these counters increments for a certain kind of object.
5885 The counters wrap around from the largest positive integer to zero.
5886 Garbage collection does not decrease them.
5887 The elements of the value are as follows:
5888 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
5889 All are in units of 1 = one object consed
5890 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
5892 MISCS include overlays, markers, and some internal types.
5893 Frames, windows, buffers, and subprocesses count as vectors
5894 (but the contents of a buffer's text do not count here). */)
5897 Lisp_Object consed
[8];
5899 consed
[0] = make_number (min (MOST_POSITIVE_FIXNUM
, cons_cells_consed
));
5900 consed
[1] = make_number (min (MOST_POSITIVE_FIXNUM
, floats_consed
));
5901 consed
[2] = make_number (min (MOST_POSITIVE_FIXNUM
, vector_cells_consed
));
5902 consed
[3] = make_number (min (MOST_POSITIVE_FIXNUM
, symbols_consed
));
5903 consed
[4] = make_number (min (MOST_POSITIVE_FIXNUM
, string_chars_consed
));
5904 consed
[5] = make_number (min (MOST_POSITIVE_FIXNUM
, misc_objects_consed
));
5905 consed
[6] = make_number (min (MOST_POSITIVE_FIXNUM
, intervals_consed
));
5906 consed
[7] = make_number (min (MOST_POSITIVE_FIXNUM
, strings_consed
));
5908 return Flist (8, consed
);
5911 int suppress_checking
;
5913 die (msg
, file
, line
)
5918 fprintf (stderr
, "\r\nEmacs fatal error: %s:%d: %s\r\n",
5923 /* Initialization */
5928 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
5930 pure_size
= PURESIZE
;
5931 pure_bytes_used
= 0;
5932 pure_bytes_used_before_overflow
= 0;
5934 /* Initialize the list of free aligned blocks. */
5937 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
5939 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
5943 ignore_warnings
= 1;
5944 #ifdef DOUG_LEA_MALLOC
5945 mallopt (M_TRIM_THRESHOLD
, 128*1024); /* trim threshold */
5946 mallopt (M_MMAP_THRESHOLD
, 64*1024); /* mmap threshold */
5947 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* max. number of mmap'ed areas */
5957 malloc_hysteresis
= 32;
5959 malloc_hysteresis
= 0;
5962 spare_memory
= (char *) malloc (SPARE_MEMORY
);
5964 ignore_warnings
= 0;
5966 byte_stack_list
= 0;
5968 consing_since_gc
= 0;
5969 gc_cons_threshold
= 100000 * sizeof (Lisp_Object
);
5970 gc_relative_threshold
= 0;
5972 #ifdef VIRT_ADDR_VARIES
5973 malloc_sbrk_unused
= 1<<22; /* A large number */
5974 malloc_sbrk_used
= 100000; /* as reasonable as any number */
5975 #endif /* VIRT_ADDR_VARIES */
5982 byte_stack_list
= 0;
5984 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
5985 setjmp_tested_p
= longjmps_done
= 0;
5988 Vgc_elapsed
= make_float (0.0);
5995 DEFVAR_INT ("gc-cons-threshold", &gc_cons_threshold
,
5996 doc
: /* *Number of bytes of consing between garbage collections.
5997 Garbage collection can happen automatically once this many bytes have been
5998 allocated since the last garbage collection. All data types count.
6000 Garbage collection happens automatically only when `eval' is called.
6002 By binding this temporarily to a large number, you can effectively
6003 prevent garbage collection during a part of the program.
6004 See also `gc-cons-percentage'. */);
6006 DEFVAR_LISP ("gc-cons-percentage", &Vgc_cons_percentage
,
6007 doc
: /* *Portion of the heap used for allocation.
6008 Garbage collection can happen automatically once this portion of the heap
6009 has been allocated since the last garbage collection.
6010 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6011 Vgc_cons_percentage
= make_float (0.1);
6013 DEFVAR_INT ("pure-bytes-used", &pure_bytes_used
,
6014 doc
: /* Number of bytes of sharable Lisp data allocated so far. */);
6016 DEFVAR_INT ("cons-cells-consed", &cons_cells_consed
,
6017 doc
: /* Number of cons cells that have been consed so far. */);
6019 DEFVAR_INT ("floats-consed", &floats_consed
,
6020 doc
: /* Number of floats that have been consed so far. */);
6022 DEFVAR_INT ("vector-cells-consed", &vector_cells_consed
,
6023 doc
: /* Number of vector cells that have been consed so far. */);
6025 DEFVAR_INT ("symbols-consed", &symbols_consed
,
6026 doc
: /* Number of symbols that have been consed so far. */);
6028 DEFVAR_INT ("string-chars-consed", &string_chars_consed
,
6029 doc
: /* Number of string characters that have been consed so far. */);
6031 DEFVAR_INT ("misc-objects-consed", &misc_objects_consed
,
6032 doc
: /* Number of miscellaneous objects that have been consed so far. */);
6034 DEFVAR_INT ("intervals-consed", &intervals_consed
,
6035 doc
: /* Number of intervals that have been consed so far. */);
6037 DEFVAR_INT ("strings-consed", &strings_consed
,
6038 doc
: /* Number of strings that have been consed so far. */);
6040 DEFVAR_LISP ("purify-flag", &Vpurify_flag
,
6041 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
6042 This means that certain objects should be allocated in shared (pure) space. */);
6044 DEFVAR_BOOL ("garbage-collection-messages", &garbage_collection_messages
,
6045 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
6046 garbage_collection_messages
= 0;
6048 DEFVAR_LISP ("post-gc-hook", &Vpost_gc_hook
,
6049 doc
: /* Hook run after garbage collection has finished. */);
6050 Vpost_gc_hook
= Qnil
;
6051 Qpost_gc_hook
= intern ("post-gc-hook");
6052 staticpro (&Qpost_gc_hook
);
6054 DEFVAR_LISP ("memory-signal-data", &Vmemory_signal_data
,
6055 doc
: /* Precomputed `signal' argument for memory-full error. */);
6056 /* We build this in advance because if we wait until we need it, we might
6057 not be able to allocate the memory to hold it. */
6060 build_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
6062 DEFVAR_LISP ("memory-full", &Vmemory_full
,
6063 doc
: /* Non-nil means we are handling a memory-full error. */);
6064 Vmemory_full
= Qnil
;
6066 staticpro (&Qgc_cons_threshold
);
6067 Qgc_cons_threshold
= intern ("gc-cons-threshold");
6069 staticpro (&Qchar_table_extra_slots
);
6070 Qchar_table_extra_slots
= intern ("char-table-extra-slots");
6072 DEFVAR_LISP ("gc-elapsed", &Vgc_elapsed
,
6073 doc
: /* Accumulated time elapsed in garbage collections.
6074 The time is in seconds as a floating point value. */);
6075 DEFVAR_INT ("gcs-done", &gcs_done
,
6076 doc
: /* Accumulated number of garbage collections done. */);
6078 defsubr (&Smemory_full_p
);
6082 defsubr (&Smake_byte_code
);
6083 defsubr (&Smake_list
);
6084 defsubr (&Smake_vector
);
6085 defsubr (&Smake_string
);
6086 defsubr (&Smake_bool_vector
);
6087 defsubr (&Smake_symbol
);
6088 defsubr (&Smake_marker
);
6089 defsubr (&Spurecopy
);
6090 defsubr (&Sgarbage_collect
);
6091 defsubr (&Smemory_limit
);
6092 defsubr (&Smemory_use_counts
);
6094 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
6095 defsubr (&Sgc_status
);
6099 /* arch-tag: 6695ca10-e3c5-4c2c-8bc3-ed26a7dda857
6100 (do not change this comment) */