1 /* Storage allocation and gc for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2011
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <limits.h> /* For CHAR_BIT. */
31 #ifdef HAVE_GTK_AND_PTHREAD
35 /* This file is part of the core Lisp implementation, and thus must
36 deal with the real data structures. If the Lisp implementation is
37 replaced, this file likely will not be used. */
39 #undef HIDE_LISP_IMPLEMENTATION
42 #include "intervals.h"
48 #include "blockinput.h"
49 #include "character.h"
50 #include "syssignal.h"
51 #include "termhooks.h" /* For struct terminal. */
54 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
55 memory. Can do this only if using gmalloc.c. */
57 #if defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC
58 #undef GC_MALLOC_CHECK
63 extern POINTER_TYPE
*sbrk ();
72 #ifdef DOUG_LEA_MALLOC
75 /* malloc.h #defines this as size_t, at least in glibc2. */
76 #ifndef __malloc_size_t
77 #define __malloc_size_t int
80 /* Specify maximum number of areas to mmap. It would be nice to use a
81 value that explicitly means "no limit". */
83 #define MMAP_MAX_AREAS 100000000
85 #else /* not DOUG_LEA_MALLOC */
87 /* The following come from gmalloc.c. */
89 #define __malloc_size_t size_t
90 extern __malloc_size_t _bytes_used
;
91 extern __malloc_size_t __malloc_extra_blocks
;
93 #endif /* not DOUG_LEA_MALLOC */
95 #if ! defined (SYSTEM_MALLOC) && defined (HAVE_GTK_AND_PTHREAD)
97 /* When GTK uses the file chooser dialog, different backends can be loaded
98 dynamically. One such a backend is the Gnome VFS backend that gets loaded
99 if you run Gnome. That backend creates several threads and also allocates
102 If Emacs sets malloc hooks (! SYSTEM_MALLOC) and the emacs_blocked_*
103 functions below are called from malloc, there is a chance that one
104 of these threads preempts the Emacs main thread and the hook variables
105 end up in an inconsistent state. So we have a mutex to prevent that (note
106 that the backend handles concurrent access to malloc within its own threads
107 but Emacs code running in the main thread is not included in that control).
109 When UNBLOCK_INPUT is called, reinvoke_input_signal may be called. If this
110 happens in one of the backend threads we will have two threads that tries
111 to run Emacs code at once, and the code is not prepared for that.
112 To prevent that, we only call BLOCK/UNBLOCK from the main thread. */
114 static pthread_mutex_t alloc_mutex
;
116 #define BLOCK_INPUT_ALLOC \
119 if (pthread_equal (pthread_self (), main_thread)) \
121 pthread_mutex_lock (&alloc_mutex); \
124 #define UNBLOCK_INPUT_ALLOC \
127 pthread_mutex_unlock (&alloc_mutex); \
128 if (pthread_equal (pthread_self (), main_thread)) \
133 #else /* SYSTEM_MALLOC || not HAVE_GTK_AND_PTHREAD */
135 #define BLOCK_INPUT_ALLOC BLOCK_INPUT
136 #define UNBLOCK_INPUT_ALLOC UNBLOCK_INPUT
138 #endif /* SYSTEM_MALLOC || not HAVE_GTK_AND_PTHREAD */
140 /* Value of _bytes_used, when spare_memory was freed. */
142 static __malloc_size_t bytes_used_when_full
;
144 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
145 to a struct Lisp_String. */
147 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
148 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
149 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
151 #define VECTOR_MARK(V) ((V)->size |= ARRAY_MARK_FLAG)
152 #define VECTOR_UNMARK(V) ((V)->size &= ~ARRAY_MARK_FLAG)
153 #define VECTOR_MARKED_P(V) (((V)->size & ARRAY_MARK_FLAG) != 0)
155 /* Value is the number of bytes/chars of S, a pointer to a struct
156 Lisp_String. This must be used instead of STRING_BYTES (S) or
157 S->size during GC, because S->size contains the mark bit for
160 #define GC_STRING_BYTES(S) (STRING_BYTES (S))
161 #define GC_STRING_CHARS(S) ((S)->size & ~ARRAY_MARK_FLAG)
163 /* Global variables. */
164 struct emacs_globals globals
;
166 /* Number of bytes of consing done since the last gc. */
168 int consing_since_gc
;
170 /* Similar minimum, computed from Vgc_cons_percentage. */
172 EMACS_INT gc_relative_threshold
;
174 /* Minimum number of bytes of consing since GC before next GC,
175 when memory is full. */
177 EMACS_INT memory_full_cons_threshold
;
179 /* Nonzero during GC. */
183 /* Nonzero means abort if try to GC.
184 This is for code which is written on the assumption that
185 no GC will happen, so as to verify that assumption. */
189 /* Number of live and free conses etc. */
191 static int total_conses
, total_markers
, total_symbols
, total_vector_size
;
192 static int total_free_conses
, total_free_markers
, total_free_symbols
;
193 static int total_free_floats
, total_floats
;
195 /* Points to memory space allocated as "spare", to be freed if we run
196 out of memory. We keep one large block, four cons-blocks, and
197 two string blocks. */
199 static char *spare_memory
[7];
201 /* Amount of spare memory to keep in large reserve block. */
203 #define SPARE_MEMORY (1 << 14)
205 /* Number of extra blocks malloc should get when it needs more core. */
207 static int malloc_hysteresis
;
209 /* Initialize it to a nonzero value to force it into data space
210 (rather than bss space). That way unexec will remap it into text
211 space (pure), on some systems. We have not implemented the
212 remapping on more recent systems because this is less important
213 nowadays than in the days of small memories and timesharing. */
215 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
216 #define PUREBEG (char *) pure
218 /* Pointer to the pure area, and its size. */
220 static char *purebeg
;
221 static size_t pure_size
;
223 /* Number of bytes of pure storage used before pure storage overflowed.
224 If this is non-zero, this implies that an overflow occurred. */
226 static size_t pure_bytes_used_before_overflow
;
228 /* Value is non-zero if P points into pure space. */
230 #define PURE_POINTER_P(P) \
231 (((PNTR_COMPARISON_TYPE) (P) \
232 < (PNTR_COMPARISON_TYPE) ((char *) purebeg + pure_size)) \
233 && ((PNTR_COMPARISON_TYPE) (P) \
234 >= (PNTR_COMPARISON_TYPE) purebeg))
236 /* Index in pure at which next pure Lisp object will be allocated.. */
238 static EMACS_INT pure_bytes_used_lisp
;
240 /* Number of bytes allocated for non-Lisp objects in pure storage. */
242 static EMACS_INT pure_bytes_used_non_lisp
;
244 /* If nonzero, this is a warning delivered by malloc and not yet
247 const char *pending_malloc_warning
;
249 /* Maximum amount of C stack to save when a GC happens. */
251 #ifndef MAX_SAVE_STACK
252 #define MAX_SAVE_STACK 16000
255 /* Buffer in which we save a copy of the C stack at each GC. */
257 static char *stack_copy
;
258 static int stack_copy_size
;
260 /* Non-zero means ignore malloc warnings. Set during initialization.
261 Currently not used. */
263 static int ignore_warnings
;
265 Lisp_Object Qgc_cons_threshold
, Qchar_table_extra_slots
;
267 /* Hook run after GC has finished. */
269 Lisp_Object Qpost_gc_hook
;
271 static void mark_buffer (Lisp_Object
);
272 static void mark_terminals (void);
273 extern void mark_kboards (void);
274 extern void mark_backtrace (void);
275 static void gc_sweep (void);
276 static void mark_glyph_matrix (struct glyph_matrix
*);
277 static void mark_face_cache (struct face_cache
*);
279 static struct Lisp_String
*allocate_string (void);
280 static void compact_small_strings (void);
281 static void free_large_strings (void);
282 static void sweep_strings (void);
284 extern int message_enable_multibyte
;
286 /* When scanning the C stack for live Lisp objects, Emacs keeps track
287 of what memory allocated via lisp_malloc is intended for what
288 purpose. This enumeration specifies the type of memory. */
299 /* We used to keep separate mem_types for subtypes of vectors such as
300 process, hash_table, frame, terminal, and window, but we never made
301 use of the distinction, so it only caused source-code complexity
302 and runtime slowdown. Minor but pointless. */
306 static POINTER_TYPE
*lisp_align_malloc (size_t, enum mem_type
);
307 static POINTER_TYPE
*lisp_malloc (size_t, enum mem_type
);
310 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
312 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
313 #include <stdio.h> /* For fprintf. */
316 /* A unique object in pure space used to make some Lisp objects
317 on free lists recognizable in O(1). */
319 static Lisp_Object Vdead
;
321 #ifdef GC_MALLOC_CHECK
323 enum mem_type allocated_mem_type
;
324 static int dont_register_blocks
;
326 #endif /* GC_MALLOC_CHECK */
328 /* A node in the red-black tree describing allocated memory containing
329 Lisp data. Each such block is recorded with its start and end
330 address when it is allocated, and removed from the tree when it
333 A red-black tree is a balanced binary tree with the following
336 1. Every node is either red or black.
337 2. Every leaf is black.
338 3. If a node is red, then both of its children are black.
339 4. Every simple path from a node to a descendant leaf contains
340 the same number of black nodes.
341 5. The root is always black.
343 When nodes are inserted into the tree, or deleted from the tree,
344 the tree is "fixed" so that these properties are always true.
346 A red-black tree with N internal nodes has height at most 2
347 log(N+1). Searches, insertions and deletions are done in O(log N).
348 Please see a text book about data structures for a detailed
349 description of red-black trees. Any book worth its salt should
354 /* Children of this node. These pointers are never NULL. When there
355 is no child, the value is MEM_NIL, which points to a dummy node. */
356 struct mem_node
*left
, *right
;
358 /* The parent of this node. In the root node, this is NULL. */
359 struct mem_node
*parent
;
361 /* Start and end of allocated region. */
365 enum {MEM_BLACK
, MEM_RED
} color
;
371 /* Base address of stack. Set in main. */
373 Lisp_Object
*stack_base
;
375 /* Root of the tree describing allocated Lisp memory. */
377 static struct mem_node
*mem_root
;
379 /* Lowest and highest known address in the heap. */
381 static void *min_heap_address
, *max_heap_address
;
383 /* Sentinel node of the tree. */
385 static struct mem_node mem_z
;
386 #define MEM_NIL &mem_z
388 static struct Lisp_Vector
*allocate_vectorlike (EMACS_INT
);
389 static void lisp_free (POINTER_TYPE
*);
390 static void mark_stack (void);
391 static int live_vector_p (struct mem_node
*, void *);
392 static int live_buffer_p (struct mem_node
*, void *);
393 static int live_string_p (struct mem_node
*, void *);
394 static int live_cons_p (struct mem_node
*, void *);
395 static int live_symbol_p (struct mem_node
*, void *);
396 static int live_float_p (struct mem_node
*, void *);
397 static int live_misc_p (struct mem_node
*, void *);
398 static void mark_maybe_object (Lisp_Object
);
399 static void mark_memory (void *, void *, int);
400 static void mem_init (void);
401 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
402 static void mem_insert_fixup (struct mem_node
*);
403 static void mem_rotate_left (struct mem_node
*);
404 static void mem_rotate_right (struct mem_node
*);
405 static void mem_delete (struct mem_node
*);
406 static void mem_delete_fixup (struct mem_node
*);
407 static INLINE
struct mem_node
*mem_find (void *);
410 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
411 static void check_gcpros (void);
414 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
416 /* Recording what needs to be marked for gc. */
418 struct gcpro
*gcprolist
;
420 /* Addresses of staticpro'd variables. Initialize it to a nonzero
421 value; otherwise some compilers put it into BSS. */
423 #define NSTATICS 0x640
424 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
426 /* Index of next unused slot in staticvec. */
428 static int staticidx
= 0;
430 static POINTER_TYPE
*pure_alloc (size_t, int);
433 /* Value is SZ rounded up to the next multiple of ALIGNMENT.
434 ALIGNMENT must be a power of 2. */
436 #define ALIGN(ptr, ALIGNMENT) \
437 ((POINTER_TYPE *) ((((EMACS_UINT)(ptr)) + (ALIGNMENT) - 1) \
438 & ~((ALIGNMENT) - 1)))
442 /************************************************************************
444 ************************************************************************/
446 /* Function malloc calls this if it finds we are near exhausting storage. */
449 malloc_warning (const char *str
)
451 pending_malloc_warning
= str
;
455 /* Display an already-pending malloc warning. */
458 display_malloc_warning (void)
460 call3 (intern ("display-warning"),
462 build_string (pending_malloc_warning
),
463 intern ("emergency"));
464 pending_malloc_warning
= 0;
468 #ifdef DOUG_LEA_MALLOC
469 # define BYTES_USED (mallinfo ().uordblks)
471 # define BYTES_USED _bytes_used
474 /* Called if we can't allocate relocatable space for a buffer. */
477 buffer_memory_full (void)
479 /* If buffers use the relocating allocator, no need to free
480 spare_memory, because we may have plenty of malloc space left
481 that we could get, and if we don't, the malloc that fails will
482 itself cause spare_memory to be freed. If buffers don't use the
483 relocating allocator, treat this like any other failing
490 /* This used to call error, but if we've run out of memory, we could
491 get infinite recursion trying to build the string. */
492 xsignal (Qnil
, Vmemory_signal_data
);
496 #ifdef XMALLOC_OVERRUN_CHECK
498 /* Check for overrun in malloc'ed buffers by wrapping a 16 byte header
499 and a 16 byte trailer around each block.
501 The header consists of 12 fixed bytes + a 4 byte integer contaning the
502 original block size, while the trailer consists of 16 fixed bytes.
504 The header is used to detect whether this block has been allocated
505 through these functions -- as it seems that some low-level libc
506 functions may bypass the malloc hooks.
510 #define XMALLOC_OVERRUN_CHECK_SIZE 16
512 static char xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
-4] =
513 { 0x9a, 0x9b, 0xae, 0xaf,
514 0xbf, 0xbe, 0xce, 0xcf,
515 0xea, 0xeb, 0xec, 0xed };
517 static char xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
518 { 0xaa, 0xab, 0xac, 0xad,
519 0xba, 0xbb, 0xbc, 0xbd,
520 0xca, 0xcb, 0xcc, 0xcd,
521 0xda, 0xdb, 0xdc, 0xdd };
523 /* Macros to insert and extract the block size in the header. */
525 #define XMALLOC_PUT_SIZE(ptr, size) \
526 (ptr[-1] = (size & 0xff), \
527 ptr[-2] = ((size >> 8) & 0xff), \
528 ptr[-3] = ((size >> 16) & 0xff), \
529 ptr[-4] = ((size >> 24) & 0xff))
531 #define XMALLOC_GET_SIZE(ptr) \
532 (size_t)((unsigned)(ptr[-1]) | \
533 ((unsigned)(ptr[-2]) << 8) | \
534 ((unsigned)(ptr[-3]) << 16) | \
535 ((unsigned)(ptr[-4]) << 24))
538 /* The call depth in overrun_check functions. For example, this might happen:
540 overrun_check_malloc()
541 -> malloc -> (via hook)_-> emacs_blocked_malloc
542 -> overrun_check_malloc
543 call malloc (hooks are NULL, so real malloc is called).
544 malloc returns 10000.
545 add overhead, return 10016.
546 <- (back in overrun_check_malloc)
547 add overhead again, return 10032
548 xmalloc returns 10032.
553 overrun_check_free(10032)
555 free(10016) <- crash, because 10000 is the original pointer. */
557 static int check_depth
;
559 /* Like malloc, but wraps allocated block with header and trailer. */
562 overrun_check_malloc (size
)
565 register unsigned char *val
;
566 size_t overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_SIZE
*2 : 0;
568 val
= (unsigned char *) malloc (size
+ overhead
);
569 if (val
&& check_depth
== 1)
571 memcpy (val
, xmalloc_overrun_check_header
,
572 XMALLOC_OVERRUN_CHECK_SIZE
- 4);
573 val
+= XMALLOC_OVERRUN_CHECK_SIZE
;
574 XMALLOC_PUT_SIZE(val
, size
);
575 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
576 XMALLOC_OVERRUN_CHECK_SIZE
);
579 return (POINTER_TYPE
*)val
;
583 /* Like realloc, but checks old block for overrun, and wraps new block
584 with header and trailer. */
587 overrun_check_realloc (block
, size
)
591 register unsigned char *val
= (unsigned char *)block
;
592 size_t overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_SIZE
*2 : 0;
596 && memcmp (xmalloc_overrun_check_header
,
597 val
- XMALLOC_OVERRUN_CHECK_SIZE
,
598 XMALLOC_OVERRUN_CHECK_SIZE
- 4) == 0)
600 size_t osize
= XMALLOC_GET_SIZE (val
);
601 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
602 XMALLOC_OVERRUN_CHECK_SIZE
))
604 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
605 val
-= XMALLOC_OVERRUN_CHECK_SIZE
;
606 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
609 val
= (unsigned char *) realloc ((POINTER_TYPE
*)val
, size
+ overhead
);
611 if (val
&& check_depth
== 1)
613 memcpy (val
, xmalloc_overrun_check_header
,
614 XMALLOC_OVERRUN_CHECK_SIZE
- 4);
615 val
+= XMALLOC_OVERRUN_CHECK_SIZE
;
616 XMALLOC_PUT_SIZE(val
, size
);
617 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
618 XMALLOC_OVERRUN_CHECK_SIZE
);
621 return (POINTER_TYPE
*)val
;
624 /* Like free, but checks block for overrun. */
627 overrun_check_free (block
)
630 unsigned char *val
= (unsigned char *)block
;
635 && memcmp (xmalloc_overrun_check_header
,
636 val
- XMALLOC_OVERRUN_CHECK_SIZE
,
637 XMALLOC_OVERRUN_CHECK_SIZE
- 4) == 0)
639 size_t osize
= XMALLOC_GET_SIZE (val
);
640 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
641 XMALLOC_OVERRUN_CHECK_SIZE
))
643 #ifdef XMALLOC_CLEAR_FREE_MEMORY
644 val
-= XMALLOC_OVERRUN_CHECK_SIZE
;
645 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_SIZE
*2);
647 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
648 val
-= XMALLOC_OVERRUN_CHECK_SIZE
;
649 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
660 #define malloc overrun_check_malloc
661 #define realloc overrun_check_realloc
662 #define free overrun_check_free
666 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
667 there's no need to block input around malloc. */
668 #define MALLOC_BLOCK_INPUT ((void)0)
669 #define MALLOC_UNBLOCK_INPUT ((void)0)
671 #define MALLOC_BLOCK_INPUT BLOCK_INPUT
672 #define MALLOC_UNBLOCK_INPUT UNBLOCK_INPUT
675 /* Like malloc but check for no memory and block interrupt input.. */
678 xmalloc (size_t size
)
680 register POINTER_TYPE
*val
;
683 val
= (POINTER_TYPE
*) malloc (size
);
684 MALLOC_UNBLOCK_INPUT
;
692 /* Like realloc but check for no memory and block interrupt input.. */
695 xrealloc (POINTER_TYPE
*block
, size_t size
)
697 register POINTER_TYPE
*val
;
700 /* We must call malloc explicitly when BLOCK is 0, since some
701 reallocs don't do this. */
703 val
= (POINTER_TYPE
*) malloc (size
);
705 val
= (POINTER_TYPE
*) realloc (block
, size
);
706 MALLOC_UNBLOCK_INPUT
;
708 if (!val
&& size
) memory_full ();
713 /* Like free but block interrupt input. */
716 xfree (POINTER_TYPE
*block
)
722 MALLOC_UNBLOCK_INPUT
;
723 /* We don't call refill_memory_reserve here
724 because that duplicates doing so in emacs_blocked_free
725 and the criterion should go there. */
729 /* Like strdup, but uses xmalloc. */
732 xstrdup (const char *s
)
734 size_t len
= strlen (s
) + 1;
735 char *p
= (char *) xmalloc (len
);
741 /* Unwind for SAFE_ALLOCA */
744 safe_alloca_unwind (Lisp_Object arg
)
746 register struct Lisp_Save_Value
*p
= XSAVE_VALUE (arg
);
756 /* Like malloc but used for allocating Lisp data. NBYTES is the
757 number of bytes to allocate, TYPE describes the intended use of the
758 allcated memory block (for strings, for conses, ...). */
761 static void *lisp_malloc_loser
;
764 static POINTER_TYPE
*
765 lisp_malloc (size_t nbytes
, enum mem_type type
)
771 #ifdef GC_MALLOC_CHECK
772 allocated_mem_type
= type
;
775 val
= (void *) malloc (nbytes
);
778 /* If the memory just allocated cannot be addressed thru a Lisp
779 object's pointer, and it needs to be,
780 that's equivalent to running out of memory. */
781 if (val
&& type
!= MEM_TYPE_NON_LISP
)
784 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
785 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
787 lisp_malloc_loser
= val
;
794 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
795 if (val
&& type
!= MEM_TYPE_NON_LISP
)
796 mem_insert (val
, (char *) val
+ nbytes
, type
);
799 MALLOC_UNBLOCK_INPUT
;
805 /* Free BLOCK. This must be called to free memory allocated with a
806 call to lisp_malloc. */
809 lisp_free (POINTER_TYPE
*block
)
813 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
814 mem_delete (mem_find (block
));
816 MALLOC_UNBLOCK_INPUT
;
819 /* Allocation of aligned blocks of memory to store Lisp data. */
820 /* The entry point is lisp_align_malloc which returns blocks of at most */
821 /* BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
823 /* Use posix_memalloc if the system has it and we're using the system's
824 malloc (because our gmalloc.c routines don't have posix_memalign although
825 its memalloc could be used). */
826 #if defined (HAVE_POSIX_MEMALIGN) && defined (SYSTEM_MALLOC)
827 #define USE_POSIX_MEMALIGN 1
830 /* BLOCK_ALIGN has to be a power of 2. */
831 #define BLOCK_ALIGN (1 << 10)
833 /* Padding to leave at the end of a malloc'd block. This is to give
834 malloc a chance to minimize the amount of memory wasted to alignment.
835 It should be tuned to the particular malloc library used.
836 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
837 posix_memalign on the other hand would ideally prefer a value of 4
838 because otherwise, there's 1020 bytes wasted between each ablocks.
839 In Emacs, testing shows that those 1020 can most of the time be
840 efficiently used by malloc to place other objects, so a value of 0 can
841 still preferable unless you have a lot of aligned blocks and virtually
843 #define BLOCK_PADDING 0
844 #define BLOCK_BYTES \
845 (BLOCK_ALIGN - sizeof (struct ablock *) - BLOCK_PADDING)
847 /* Internal data structures and constants. */
849 #define ABLOCKS_SIZE 16
851 /* An aligned block of memory. */
856 char payload
[BLOCK_BYTES
];
857 struct ablock
*next_free
;
859 /* `abase' is the aligned base of the ablocks. */
860 /* It is overloaded to hold the virtual `busy' field that counts
861 the number of used ablock in the parent ablocks.
862 The first ablock has the `busy' field, the others have the `abase'
863 field. To tell the difference, we assume that pointers will have
864 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
865 is used to tell whether the real base of the parent ablocks is `abase'
866 (if not, the word before the first ablock holds a pointer to the
868 struct ablocks
*abase
;
869 /* The padding of all but the last ablock is unused. The padding of
870 the last ablock in an ablocks is not allocated. */
872 char padding
[BLOCK_PADDING
];
876 /* A bunch of consecutive aligned blocks. */
879 struct ablock blocks
[ABLOCKS_SIZE
];
882 /* Size of the block requested from malloc or memalign. */
883 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
885 #define ABLOCK_ABASE(block) \
886 (((unsigned long) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
887 ? (struct ablocks *)(block) \
890 /* Virtual `busy' field. */
891 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
893 /* Pointer to the (not necessarily aligned) malloc block. */
894 #ifdef USE_POSIX_MEMALIGN
895 #define ABLOCKS_BASE(abase) (abase)
897 #define ABLOCKS_BASE(abase) \
898 (1 & (long) ABLOCKS_BUSY (abase) ? abase : ((void**)abase)[-1])
901 /* The list of free ablock. */
902 static struct ablock
*free_ablock
;
904 /* Allocate an aligned block of nbytes.
905 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
906 smaller or equal to BLOCK_BYTES. */
907 static POINTER_TYPE
*
908 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
911 struct ablocks
*abase
;
913 eassert (nbytes
<= BLOCK_BYTES
);
917 #ifdef GC_MALLOC_CHECK
918 allocated_mem_type
= type
;
924 EMACS_INT aligned
; /* int gets warning casting to 64-bit pointer. */
926 #ifdef DOUG_LEA_MALLOC
927 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
928 because mapped region contents are not preserved in
930 mallopt (M_MMAP_MAX
, 0);
933 #ifdef USE_POSIX_MEMALIGN
935 int err
= posix_memalign (&base
, BLOCK_ALIGN
, ABLOCKS_BYTES
);
941 base
= malloc (ABLOCKS_BYTES
);
942 abase
= ALIGN (base
, BLOCK_ALIGN
);
947 MALLOC_UNBLOCK_INPUT
;
951 aligned
= (base
== abase
);
953 ((void**)abase
)[-1] = base
;
955 #ifdef DOUG_LEA_MALLOC
956 /* Back to a reasonable maximum of mmap'ed areas. */
957 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
961 /* If the memory just allocated cannot be addressed thru a Lisp
962 object's pointer, and it needs to be, that's equivalent to
963 running out of memory. */
964 if (type
!= MEM_TYPE_NON_LISP
)
967 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
969 if ((char *) XCONS (tem
) != end
)
971 lisp_malloc_loser
= base
;
973 MALLOC_UNBLOCK_INPUT
;
979 /* Initialize the blocks and put them on the free list.
980 Is `base' was not properly aligned, we can't use the last block. */
981 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
983 abase
->blocks
[i
].abase
= abase
;
984 abase
->blocks
[i
].x
.next_free
= free_ablock
;
985 free_ablock
= &abase
->blocks
[i
];
987 ABLOCKS_BUSY (abase
) = (struct ablocks
*) (long) aligned
;
989 eassert (0 == ((EMACS_UINT
)abase
) % BLOCK_ALIGN
);
990 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
991 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
992 eassert (ABLOCKS_BASE (abase
) == base
);
993 eassert (aligned
== (long) ABLOCKS_BUSY (abase
));
996 abase
= ABLOCK_ABASE (free_ablock
);
997 ABLOCKS_BUSY (abase
) = (struct ablocks
*) (2 + (long) ABLOCKS_BUSY (abase
));
999 free_ablock
= free_ablock
->x
.next_free
;
1001 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1002 if (val
&& type
!= MEM_TYPE_NON_LISP
)
1003 mem_insert (val
, (char *) val
+ nbytes
, type
);
1006 MALLOC_UNBLOCK_INPUT
;
1010 eassert (0 == ((EMACS_UINT
)val
) % BLOCK_ALIGN
);
1015 lisp_align_free (POINTER_TYPE
*block
)
1017 struct ablock
*ablock
= block
;
1018 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1021 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1022 mem_delete (mem_find (block
));
1024 /* Put on free list. */
1025 ablock
->x
.next_free
= free_ablock
;
1026 free_ablock
= ablock
;
1027 /* Update busy count. */
1028 ABLOCKS_BUSY (abase
) = (struct ablocks
*) (-2 + (long) ABLOCKS_BUSY (abase
));
1030 if (2 > (long) ABLOCKS_BUSY (abase
))
1031 { /* All the blocks are free. */
1032 int i
= 0, aligned
= (long) ABLOCKS_BUSY (abase
);
1033 struct ablock
**tem
= &free_ablock
;
1034 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1038 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1041 *tem
= (*tem
)->x
.next_free
;
1044 tem
= &(*tem
)->x
.next_free
;
1046 eassert ((aligned
& 1) == aligned
);
1047 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1048 #ifdef USE_POSIX_MEMALIGN
1049 eassert ((unsigned long)ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1051 free (ABLOCKS_BASE (abase
));
1053 MALLOC_UNBLOCK_INPUT
;
1056 /* Return a new buffer structure allocated from the heap with
1057 a call to lisp_malloc. */
1060 allocate_buffer (void)
1063 = (struct buffer
*) lisp_malloc (sizeof (struct buffer
),
1065 b
->size
= sizeof (struct buffer
) / sizeof (EMACS_INT
);
1066 XSETPVECTYPE (b
, PVEC_BUFFER
);
1071 #ifndef SYSTEM_MALLOC
1073 /* Arranging to disable input signals while we're in malloc.
1075 This only works with GNU malloc. To help out systems which can't
1076 use GNU malloc, all the calls to malloc, realloc, and free
1077 elsewhere in the code should be inside a BLOCK_INPUT/UNBLOCK_INPUT
1078 pair; unfortunately, we have no idea what C library functions
1079 might call malloc, so we can't really protect them unless you're
1080 using GNU malloc. Fortunately, most of the major operating systems
1081 can use GNU malloc. */
1084 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
1085 there's no need to block input around malloc. */
1087 #ifndef DOUG_LEA_MALLOC
1088 extern void * (*__malloc_hook
) (size_t, const void *);
1089 extern void * (*__realloc_hook
) (void *, size_t, const void *);
1090 extern void (*__free_hook
) (void *, const void *);
1091 /* Else declared in malloc.h, perhaps with an extra arg. */
1092 #endif /* DOUG_LEA_MALLOC */
1093 static void * (*old_malloc_hook
) (size_t, const void *);
1094 static void * (*old_realloc_hook
) (void *, size_t, const void*);
1095 static void (*old_free_hook
) (void*, const void*);
1097 static __malloc_size_t bytes_used_when_reconsidered
;
1099 /* This function is used as the hook for free to call. */
1102 emacs_blocked_free (void *ptr
, const void *ptr2
)
1106 #ifdef GC_MALLOC_CHECK
1112 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1115 "Freeing `%p' which wasn't allocated with malloc\n", ptr
);
1120 /* fprintf (stderr, "free %p...%p (%p)\n", m->start, m->end, ptr); */
1124 #endif /* GC_MALLOC_CHECK */
1126 __free_hook
= old_free_hook
;
1129 /* If we released our reserve (due to running out of memory),
1130 and we have a fair amount free once again,
1131 try to set aside another reserve in case we run out once more. */
1132 if (! NILP (Vmemory_full
)
1133 /* Verify there is enough space that even with the malloc
1134 hysteresis this call won't run out again.
1135 The code here is correct as long as SPARE_MEMORY
1136 is substantially larger than the block size malloc uses. */
1137 && (bytes_used_when_full
1138 > ((bytes_used_when_reconsidered
= BYTES_USED
)
1139 + max (malloc_hysteresis
, 4) * SPARE_MEMORY
)))
1140 refill_memory_reserve ();
1142 __free_hook
= emacs_blocked_free
;
1143 UNBLOCK_INPUT_ALLOC
;
1147 /* This function is the malloc hook that Emacs uses. */
1150 emacs_blocked_malloc (size_t size
, const void *ptr
)
1155 __malloc_hook
= old_malloc_hook
;
1156 #ifdef DOUG_LEA_MALLOC
1157 /* Segfaults on my system. --lorentey */
1158 /* mallopt (M_TOP_PAD, malloc_hysteresis * 4096); */
1160 __malloc_extra_blocks
= malloc_hysteresis
;
1163 value
= (void *) malloc (size
);
1165 #ifdef GC_MALLOC_CHECK
1167 struct mem_node
*m
= mem_find (value
);
1170 fprintf (stderr
, "Malloc returned %p which is already in use\n",
1172 fprintf (stderr
, "Region in use is %p...%p, %u bytes, type %d\n",
1173 m
->start
, m
->end
, (char *) m
->end
- (char *) m
->start
,
1178 if (!dont_register_blocks
)
1180 mem_insert (value
, (char *) value
+ max (1, size
), allocated_mem_type
);
1181 allocated_mem_type
= MEM_TYPE_NON_LISP
;
1184 #endif /* GC_MALLOC_CHECK */
1186 __malloc_hook
= emacs_blocked_malloc
;
1187 UNBLOCK_INPUT_ALLOC
;
1189 /* fprintf (stderr, "%p malloc\n", value); */
1194 /* This function is the realloc hook that Emacs uses. */
1197 emacs_blocked_realloc (void *ptr
, size_t size
, const void *ptr2
)
1202 __realloc_hook
= old_realloc_hook
;
1204 #ifdef GC_MALLOC_CHECK
1207 struct mem_node
*m
= mem_find (ptr
);
1208 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1211 "Realloc of %p which wasn't allocated with malloc\n",
1219 /* fprintf (stderr, "%p -> realloc\n", ptr); */
1221 /* Prevent malloc from registering blocks. */
1222 dont_register_blocks
= 1;
1223 #endif /* GC_MALLOC_CHECK */
1225 value
= (void *) realloc (ptr
, size
);
1227 #ifdef GC_MALLOC_CHECK
1228 dont_register_blocks
= 0;
1231 struct mem_node
*m
= mem_find (value
);
1234 fprintf (stderr
, "Realloc returns memory that is already in use\n");
1238 /* Can't handle zero size regions in the red-black tree. */
1239 mem_insert (value
, (char *) value
+ max (size
, 1), MEM_TYPE_NON_LISP
);
1242 /* fprintf (stderr, "%p <- realloc\n", value); */
1243 #endif /* GC_MALLOC_CHECK */
1245 __realloc_hook
= emacs_blocked_realloc
;
1246 UNBLOCK_INPUT_ALLOC
;
1252 #ifdef HAVE_GTK_AND_PTHREAD
1253 /* Called from Fdump_emacs so that when the dumped Emacs starts, it has a
1254 normal malloc. Some thread implementations need this as they call
1255 malloc before main. The pthread_self call in BLOCK_INPUT_ALLOC then
1256 calls malloc because it is the first call, and we have an endless loop. */
1259 reset_malloc_hooks ()
1261 __free_hook
= old_free_hook
;
1262 __malloc_hook
= old_malloc_hook
;
1263 __realloc_hook
= old_realloc_hook
;
1265 #endif /* HAVE_GTK_AND_PTHREAD */
1268 /* Called from main to set up malloc to use our hooks. */
1271 uninterrupt_malloc (void)
1273 #ifdef HAVE_GTK_AND_PTHREAD
1274 #ifdef DOUG_LEA_MALLOC
1275 pthread_mutexattr_t attr
;
1277 /* GLIBC has a faster way to do this, but lets keep it portable.
1278 This is according to the Single UNIX Specification. */
1279 pthread_mutexattr_init (&attr
);
1280 pthread_mutexattr_settype (&attr
, PTHREAD_MUTEX_RECURSIVE
);
1281 pthread_mutex_init (&alloc_mutex
, &attr
);
1282 #else /* !DOUG_LEA_MALLOC */
1283 /* Some systems such as Solaris 2.6 don't have a recursive mutex,
1284 and the bundled gmalloc.c doesn't require it. */
1285 pthread_mutex_init (&alloc_mutex
, NULL
);
1286 #endif /* !DOUG_LEA_MALLOC */
1287 #endif /* HAVE_GTK_AND_PTHREAD */
1289 if (__free_hook
!= emacs_blocked_free
)
1290 old_free_hook
= __free_hook
;
1291 __free_hook
= emacs_blocked_free
;
1293 if (__malloc_hook
!= emacs_blocked_malloc
)
1294 old_malloc_hook
= __malloc_hook
;
1295 __malloc_hook
= emacs_blocked_malloc
;
1297 if (__realloc_hook
!= emacs_blocked_realloc
)
1298 old_realloc_hook
= __realloc_hook
;
1299 __realloc_hook
= emacs_blocked_realloc
;
1302 #endif /* not SYNC_INPUT */
1303 #endif /* not SYSTEM_MALLOC */
1307 /***********************************************************************
1309 ***********************************************************************/
1311 /* Number of intervals allocated in an interval_block structure.
1312 The 1020 is 1024 minus malloc overhead. */
1314 #define INTERVAL_BLOCK_SIZE \
1315 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1317 /* Intervals are allocated in chunks in form of an interval_block
1320 struct interval_block
1322 /* Place `intervals' first, to preserve alignment. */
1323 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1324 struct interval_block
*next
;
1327 /* Current interval block. Its `next' pointer points to older
1330 static struct interval_block
*interval_block
;
1332 /* Index in interval_block above of the next unused interval
1335 static int interval_block_index
;
1337 /* Number of free and live intervals. */
1339 static int total_free_intervals
, total_intervals
;
1341 /* List of free intervals. */
1343 INTERVAL interval_free_list
;
1345 /* Total number of interval blocks now in use. */
1347 static int n_interval_blocks
;
1350 /* Initialize interval allocation. */
1353 init_intervals (void)
1355 interval_block
= NULL
;
1356 interval_block_index
= INTERVAL_BLOCK_SIZE
;
1357 interval_free_list
= 0;
1358 n_interval_blocks
= 0;
1362 /* Return a new interval. */
1365 make_interval (void)
1369 /* eassert (!handling_signal); */
1373 if (interval_free_list
)
1375 val
= interval_free_list
;
1376 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1380 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1382 register struct interval_block
*newi
;
1384 newi
= (struct interval_block
*) lisp_malloc (sizeof *newi
,
1387 newi
->next
= interval_block
;
1388 interval_block
= newi
;
1389 interval_block_index
= 0;
1390 n_interval_blocks
++;
1392 val
= &interval_block
->intervals
[interval_block_index
++];
1395 MALLOC_UNBLOCK_INPUT
;
1397 consing_since_gc
+= sizeof (struct interval
);
1399 RESET_INTERVAL (val
);
1405 /* Mark Lisp objects in interval I. */
1408 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1410 eassert (!i
->gcmarkbit
); /* Intervals are never shared. */
1412 mark_object (i
->plist
);
1416 /* Mark the interval tree rooted in TREE. Don't call this directly;
1417 use the macro MARK_INTERVAL_TREE instead. */
1420 mark_interval_tree (register INTERVAL tree
)
1422 /* No need to test if this tree has been marked already; this
1423 function is always called through the MARK_INTERVAL_TREE macro,
1424 which takes care of that. */
1426 traverse_intervals_noorder (tree
, mark_interval
, Qnil
);
1430 /* Mark the interval tree rooted in I. */
1432 #define MARK_INTERVAL_TREE(i) \
1434 if (!NULL_INTERVAL_P (i) && !i->gcmarkbit) \
1435 mark_interval_tree (i); \
1439 #define UNMARK_BALANCE_INTERVALS(i) \
1441 if (! NULL_INTERVAL_P (i)) \
1442 (i) = balance_intervals (i); \
1446 /* Number support. If USE_LISP_UNION_TYPE is in effect, we
1447 can't create number objects in macros. */
1450 make_number (EMACS_INT n
)
1454 obj
.s
.type
= Lisp_Int
;
1459 /***********************************************************************
1461 ***********************************************************************/
1463 /* Lisp_Strings are allocated in string_block structures. When a new
1464 string_block is allocated, all the Lisp_Strings it contains are
1465 added to a free-list string_free_list. When a new Lisp_String is
1466 needed, it is taken from that list. During the sweep phase of GC,
1467 string_blocks that are entirely free are freed, except two which
1470 String data is allocated from sblock structures. Strings larger
1471 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1472 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1474 Sblocks consist internally of sdata structures, one for each
1475 Lisp_String. The sdata structure points to the Lisp_String it
1476 belongs to. The Lisp_String points back to the `u.data' member of
1477 its sdata structure.
1479 When a Lisp_String is freed during GC, it is put back on
1480 string_free_list, and its `data' member and its sdata's `string'
1481 pointer is set to null. The size of the string is recorded in the
1482 `u.nbytes' member of the sdata. So, sdata structures that are no
1483 longer used, can be easily recognized, and it's easy to compact the
1484 sblocks of small strings which we do in compact_small_strings. */
1486 /* Size in bytes of an sblock structure used for small strings. This
1487 is 8192 minus malloc overhead. */
1489 #define SBLOCK_SIZE 8188
1491 /* Strings larger than this are considered large strings. String data
1492 for large strings is allocated from individual sblocks. */
1494 #define LARGE_STRING_BYTES 1024
1496 /* Structure describing string memory sub-allocated from an sblock.
1497 This is where the contents of Lisp strings are stored. */
1501 /* Back-pointer to the string this sdata belongs to. If null, this
1502 structure is free, and the NBYTES member of the union below
1503 contains the string's byte size (the same value that STRING_BYTES
1504 would return if STRING were non-null). If non-null, STRING_BYTES
1505 (STRING) is the size of the data, and DATA contains the string's
1507 struct Lisp_String
*string
;
1509 #ifdef GC_CHECK_STRING_BYTES
1512 unsigned char data
[1];
1514 #define SDATA_NBYTES(S) (S)->nbytes
1515 #define SDATA_DATA(S) (S)->data
1517 #else /* not GC_CHECK_STRING_BYTES */
1521 /* When STRING in non-null. */
1522 unsigned char data
[1];
1524 /* When STRING is null. */
1529 #define SDATA_NBYTES(S) (S)->u.nbytes
1530 #define SDATA_DATA(S) (S)->u.data
1532 #endif /* not GC_CHECK_STRING_BYTES */
1536 /* Structure describing a block of memory which is sub-allocated to
1537 obtain string data memory for strings. Blocks for small strings
1538 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1539 as large as needed. */
1544 struct sblock
*next
;
1546 /* Pointer to the next free sdata block. This points past the end
1547 of the sblock if there isn't any space left in this block. */
1548 struct sdata
*next_free
;
1550 /* Start of data. */
1551 struct sdata first_data
;
1554 /* Number of Lisp strings in a string_block structure. The 1020 is
1555 1024 minus malloc overhead. */
1557 #define STRING_BLOCK_SIZE \
1558 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1560 /* Structure describing a block from which Lisp_String structures
1565 /* Place `strings' first, to preserve alignment. */
1566 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1567 struct string_block
*next
;
1570 /* Head and tail of the list of sblock structures holding Lisp string
1571 data. We always allocate from current_sblock. The NEXT pointers
1572 in the sblock structures go from oldest_sblock to current_sblock. */
1574 static struct sblock
*oldest_sblock
, *current_sblock
;
1576 /* List of sblocks for large strings. */
1578 static struct sblock
*large_sblocks
;
1580 /* List of string_block structures, and how many there are. */
1582 static struct string_block
*string_blocks
;
1583 static int n_string_blocks
;
1585 /* Free-list of Lisp_Strings. */
1587 static struct Lisp_String
*string_free_list
;
1589 /* Number of live and free Lisp_Strings. */
1591 static int total_strings
, total_free_strings
;
1593 /* Number of bytes used by live strings. */
1595 static EMACS_INT total_string_size
;
1597 /* Given a pointer to a Lisp_String S which is on the free-list
1598 string_free_list, return a pointer to its successor in the
1601 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1603 /* Return a pointer to the sdata structure belonging to Lisp string S.
1604 S must be live, i.e. S->data must not be null. S->data is actually
1605 a pointer to the `u.data' member of its sdata structure; the
1606 structure starts at a constant offset in front of that. */
1608 #ifdef GC_CHECK_STRING_BYTES
1610 #define SDATA_OF_STRING(S) \
1611 ((struct sdata *) ((S)->data - sizeof (struct Lisp_String *) \
1612 - sizeof (EMACS_INT)))
1614 #else /* not GC_CHECK_STRING_BYTES */
1616 #define SDATA_OF_STRING(S) \
1617 ((struct sdata *) ((S)->data - sizeof (struct Lisp_String *)))
1619 #endif /* not GC_CHECK_STRING_BYTES */
1622 #ifdef GC_CHECK_STRING_OVERRUN
1624 /* We check for overrun in string data blocks by appending a small
1625 "cookie" after each allocated string data block, and check for the
1626 presence of this cookie during GC. */
1628 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1629 static char string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1630 { 0xde, 0xad, 0xbe, 0xef };
1633 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1636 /* Value is the size of an sdata structure large enough to hold NBYTES
1637 bytes of string data. The value returned includes a terminating
1638 NUL byte, the size of the sdata structure, and padding. */
1640 #ifdef GC_CHECK_STRING_BYTES
1642 #define SDATA_SIZE(NBYTES) \
1643 ((sizeof (struct Lisp_String *) \
1645 + sizeof (EMACS_INT) \
1646 + sizeof (EMACS_INT) - 1) \
1647 & ~(sizeof (EMACS_INT) - 1))
1649 #else /* not GC_CHECK_STRING_BYTES */
1651 #define SDATA_SIZE(NBYTES) \
1652 ((sizeof (struct Lisp_String *) \
1654 + sizeof (EMACS_INT) - 1) \
1655 & ~(sizeof (EMACS_INT) - 1))
1657 #endif /* not GC_CHECK_STRING_BYTES */
1659 /* Extra bytes to allocate for each string. */
1661 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1663 /* Initialize string allocation. Called from init_alloc_once. */
1668 total_strings
= total_free_strings
= total_string_size
= 0;
1669 oldest_sblock
= current_sblock
= large_sblocks
= NULL
;
1670 string_blocks
= NULL
;
1671 n_string_blocks
= 0;
1672 string_free_list
= NULL
;
1673 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1674 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1678 #ifdef GC_CHECK_STRING_BYTES
1680 static int check_string_bytes_count
;
1682 static void check_string_bytes (int);
1683 static void check_sblock (struct sblock
*);
1685 #define CHECK_STRING_BYTES(S) STRING_BYTES (S)
1688 /* Like GC_STRING_BYTES, but with debugging check. */
1691 string_bytes (struct Lisp_String
*s
)
1694 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1696 if (!PURE_POINTER_P (s
)
1698 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1703 /* Check validity of Lisp strings' string_bytes member in B. */
1709 struct sdata
*from
, *end
, *from_end
;
1713 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1715 /* Compute the next FROM here because copying below may
1716 overwrite data we need to compute it. */
1719 /* Check that the string size recorded in the string is the
1720 same as the one recorded in the sdata structure. */
1722 CHECK_STRING_BYTES (from
->string
);
1725 nbytes
= GC_STRING_BYTES (from
->string
);
1727 nbytes
= SDATA_NBYTES (from
);
1729 nbytes
= SDATA_SIZE (nbytes
);
1730 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1735 /* Check validity of Lisp strings' string_bytes member. ALL_P
1736 non-zero means check all strings, otherwise check only most
1737 recently allocated strings. Used for hunting a bug. */
1740 check_string_bytes (all_p
)
1747 for (b
= large_sblocks
; b
; b
= b
->next
)
1749 struct Lisp_String
*s
= b
->first_data
.string
;
1751 CHECK_STRING_BYTES (s
);
1754 for (b
= oldest_sblock
; b
; b
= b
->next
)
1758 check_sblock (current_sblock
);
1761 #endif /* GC_CHECK_STRING_BYTES */
1763 #ifdef GC_CHECK_STRING_FREE_LIST
1765 /* Walk through the string free list looking for bogus next pointers.
1766 This may catch buffer overrun from a previous string. */
1769 check_string_free_list ()
1771 struct Lisp_String
*s
;
1773 /* Pop a Lisp_String off the free-list. */
1774 s
= string_free_list
;
1777 if ((unsigned long)s
< 1024)
1779 s
= NEXT_FREE_LISP_STRING (s
);
1783 #define check_string_free_list()
1786 /* Return a new Lisp_String. */
1788 static struct Lisp_String
*
1789 allocate_string (void)
1791 struct Lisp_String
*s
;
1793 /* eassert (!handling_signal); */
1797 /* If the free-list is empty, allocate a new string_block, and
1798 add all the Lisp_Strings in it to the free-list. */
1799 if (string_free_list
== NULL
)
1801 struct string_block
*b
;
1804 b
= (struct string_block
*) lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1805 memset (b
, 0, sizeof *b
);
1806 b
->next
= string_blocks
;
1810 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1813 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1814 string_free_list
= s
;
1817 total_free_strings
+= STRING_BLOCK_SIZE
;
1820 check_string_free_list ();
1822 /* Pop a Lisp_String off the free-list. */
1823 s
= string_free_list
;
1824 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1826 MALLOC_UNBLOCK_INPUT
;
1828 /* Probably not strictly necessary, but play it safe. */
1829 memset (s
, 0, sizeof *s
);
1831 --total_free_strings
;
1834 consing_since_gc
+= sizeof *s
;
1836 #ifdef GC_CHECK_STRING_BYTES
1837 if (!noninteractive
)
1839 if (++check_string_bytes_count
== 200)
1841 check_string_bytes_count
= 0;
1842 check_string_bytes (1);
1845 check_string_bytes (0);
1847 #endif /* GC_CHECK_STRING_BYTES */
1853 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1854 plus a NUL byte at the end. Allocate an sdata structure for S, and
1855 set S->data to its `u.data' member. Store a NUL byte at the end of
1856 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1857 S->data if it was initially non-null. */
1860 allocate_string_data (struct Lisp_String
*s
,
1861 EMACS_INT nchars
, EMACS_INT nbytes
)
1863 struct sdata
*data
, *old_data
;
1865 EMACS_INT needed
, old_nbytes
;
1867 /* Determine the number of bytes needed to store NBYTES bytes
1869 needed
= SDATA_SIZE (nbytes
);
1870 old_data
= s
->data
? SDATA_OF_STRING (s
) : NULL
;
1871 old_nbytes
= GC_STRING_BYTES (s
);
1875 if (nbytes
> LARGE_STRING_BYTES
)
1877 size_t size
= sizeof *b
- sizeof (struct sdata
) + needed
;
1879 #ifdef DOUG_LEA_MALLOC
1880 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1881 because mapped region contents are not preserved in
1884 In case you think of allowing it in a dumped Emacs at the
1885 cost of not being able to re-dump, there's another reason:
1886 mmap'ed data typically have an address towards the top of the
1887 address space, which won't fit into an EMACS_INT (at least on
1888 32-bit systems with the current tagging scheme). --fx */
1889 mallopt (M_MMAP_MAX
, 0);
1892 b
= (struct sblock
*) lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
1894 #ifdef DOUG_LEA_MALLOC
1895 /* Back to a reasonable maximum of mmap'ed areas. */
1896 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1899 b
->next_free
= &b
->first_data
;
1900 b
->first_data
.string
= NULL
;
1901 b
->next
= large_sblocks
;
1904 else if (current_sblock
== NULL
1905 || (((char *) current_sblock
+ SBLOCK_SIZE
1906 - (char *) current_sblock
->next_free
)
1907 < (needed
+ GC_STRING_EXTRA
)))
1909 /* Not enough room in the current sblock. */
1910 b
= (struct sblock
*) lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
1911 b
->next_free
= &b
->first_data
;
1912 b
->first_data
.string
= NULL
;
1916 current_sblock
->next
= b
;
1924 data
= b
->next_free
;
1925 b
->next_free
= (struct sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
1927 MALLOC_UNBLOCK_INPUT
;
1930 s
->data
= SDATA_DATA (data
);
1931 #ifdef GC_CHECK_STRING_BYTES
1932 SDATA_NBYTES (data
) = nbytes
;
1935 s
->size_byte
= nbytes
;
1936 s
->data
[nbytes
] = '\0';
1937 #ifdef GC_CHECK_STRING_OVERRUN
1938 memcpy (data
+ needed
, string_overrun_cookie
, GC_STRING_OVERRUN_COOKIE_SIZE
);
1941 /* If S had already data assigned, mark that as free by setting its
1942 string back-pointer to null, and recording the size of the data
1946 SDATA_NBYTES (old_data
) = old_nbytes
;
1947 old_data
->string
= NULL
;
1950 consing_since_gc
+= needed
;
1954 /* Sweep and compact strings. */
1957 sweep_strings (void)
1959 struct string_block
*b
, *next
;
1960 struct string_block
*live_blocks
= NULL
;
1962 string_free_list
= NULL
;
1963 total_strings
= total_free_strings
= 0;
1964 total_string_size
= 0;
1966 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
1967 for (b
= string_blocks
; b
; b
= next
)
1970 struct Lisp_String
*free_list_before
= string_free_list
;
1974 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
1976 struct Lisp_String
*s
= b
->strings
+ i
;
1980 /* String was not on free-list before. */
1981 if (STRING_MARKED_P (s
))
1983 /* String is live; unmark it and its intervals. */
1986 if (!NULL_INTERVAL_P (s
->intervals
))
1987 UNMARK_BALANCE_INTERVALS (s
->intervals
);
1990 total_string_size
+= STRING_BYTES (s
);
1994 /* String is dead. Put it on the free-list. */
1995 struct sdata
*data
= SDATA_OF_STRING (s
);
1997 /* Save the size of S in its sdata so that we know
1998 how large that is. Reset the sdata's string
1999 back-pointer so that we know it's free. */
2000 #ifdef GC_CHECK_STRING_BYTES
2001 if (GC_STRING_BYTES (s
) != SDATA_NBYTES (data
))
2004 data
->u
.nbytes
= GC_STRING_BYTES (s
);
2006 data
->string
= NULL
;
2008 /* Reset the strings's `data' member so that we
2012 /* Put the string on the free-list. */
2013 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2014 string_free_list
= s
;
2020 /* S was on the free-list before. Put it there again. */
2021 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2022 string_free_list
= s
;
2027 /* Free blocks that contain free Lisp_Strings only, except
2028 the first two of them. */
2029 if (nfree
== STRING_BLOCK_SIZE
2030 && total_free_strings
> STRING_BLOCK_SIZE
)
2034 string_free_list
= free_list_before
;
2038 total_free_strings
+= nfree
;
2039 b
->next
= live_blocks
;
2044 check_string_free_list ();
2046 string_blocks
= live_blocks
;
2047 free_large_strings ();
2048 compact_small_strings ();
2050 check_string_free_list ();
2054 /* Free dead large strings. */
2057 free_large_strings (void)
2059 struct sblock
*b
, *next
;
2060 struct sblock
*live_blocks
= NULL
;
2062 for (b
= large_sblocks
; b
; b
= next
)
2066 if (b
->first_data
.string
== NULL
)
2070 b
->next
= live_blocks
;
2075 large_sblocks
= live_blocks
;
2079 /* Compact data of small strings. Free sblocks that don't contain
2080 data of live strings after compaction. */
2083 compact_small_strings (void)
2085 struct sblock
*b
, *tb
, *next
;
2086 struct sdata
*from
, *to
, *end
, *tb_end
;
2087 struct sdata
*to_end
, *from_end
;
2089 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2090 to, and TB_END is the end of TB. */
2092 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2093 to
= &tb
->first_data
;
2095 /* Step through the blocks from the oldest to the youngest. We
2096 expect that old blocks will stabilize over time, so that less
2097 copying will happen this way. */
2098 for (b
= oldest_sblock
; b
; b
= b
->next
)
2101 xassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2103 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
2105 /* Compute the next FROM here because copying below may
2106 overwrite data we need to compute it. */
2109 #ifdef GC_CHECK_STRING_BYTES
2110 /* Check that the string size recorded in the string is the
2111 same as the one recorded in the sdata structure. */
2113 && GC_STRING_BYTES (from
->string
) != SDATA_NBYTES (from
))
2115 #endif /* GC_CHECK_STRING_BYTES */
2118 nbytes
= GC_STRING_BYTES (from
->string
);
2120 nbytes
= SDATA_NBYTES (from
);
2122 if (nbytes
> LARGE_STRING_BYTES
)
2125 nbytes
= SDATA_SIZE (nbytes
);
2126 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2128 #ifdef GC_CHECK_STRING_OVERRUN
2129 if (memcmp (string_overrun_cookie
,
2130 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2131 GC_STRING_OVERRUN_COOKIE_SIZE
))
2135 /* FROM->string non-null means it's alive. Copy its data. */
2138 /* If TB is full, proceed with the next sblock. */
2139 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2140 if (to_end
> tb_end
)
2144 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2145 to
= &tb
->first_data
;
2146 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2149 /* Copy, and update the string's `data' pointer. */
2152 xassert (tb
!= b
|| to
<= from
);
2153 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2154 to
->string
->data
= SDATA_DATA (to
);
2157 /* Advance past the sdata we copied to. */
2163 /* The rest of the sblocks following TB don't contain live data, so
2164 we can free them. */
2165 for (b
= tb
->next
; b
; b
= next
)
2173 current_sblock
= tb
;
2177 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2178 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2179 LENGTH must be an integer.
2180 INIT must be an integer that represents a character. */)
2181 (Lisp_Object length
, Lisp_Object init
)
2183 register Lisp_Object val
;
2184 register unsigned char *p
, *end
;
2188 CHECK_NATNUM (length
);
2189 CHECK_NUMBER (init
);
2192 if (ASCII_CHAR_P (c
))
2194 nbytes
= XINT (length
);
2195 val
= make_uninit_string (nbytes
);
2197 end
= p
+ SCHARS (val
);
2203 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2204 int len
= CHAR_STRING (c
, str
);
2205 EMACS_INT string_len
= XINT (length
);
2207 if (string_len
> MOST_POSITIVE_FIXNUM
/ len
)
2208 error ("Maximum string size exceeded");
2209 nbytes
= len
* string_len
;
2210 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2215 memcpy (p
, str
, len
);
2225 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2226 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2227 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2228 (Lisp_Object length
, Lisp_Object init
)
2230 register Lisp_Object val
;
2231 struct Lisp_Bool_Vector
*p
;
2233 EMACS_INT length_in_chars
, length_in_elts
;
2236 CHECK_NATNUM (length
);
2238 bits_per_value
= sizeof (EMACS_INT
) * BOOL_VECTOR_BITS_PER_CHAR
;
2240 length_in_elts
= (XFASTINT (length
) + bits_per_value
- 1) / bits_per_value
;
2241 length_in_chars
= ((XFASTINT (length
) + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2242 / BOOL_VECTOR_BITS_PER_CHAR
);
2244 /* We must allocate one more elements than LENGTH_IN_ELTS for the
2245 slot `size' of the struct Lisp_Bool_Vector. */
2246 val
= Fmake_vector (make_number (length_in_elts
+ 1), Qnil
);
2248 /* Get rid of any bits that would cause confusion. */
2249 XVECTOR (val
)->size
= 0; /* No Lisp_Object to trace in there. */
2250 /* Use XVECTOR (val) rather than `p' because p->size is not TRT. */
2251 XSETPVECTYPE (XVECTOR (val
), PVEC_BOOL_VECTOR
);
2253 p
= XBOOL_VECTOR (val
);
2254 p
->size
= XFASTINT (length
);
2256 real_init
= (NILP (init
) ? 0 : -1);
2257 for (i
= 0; i
< length_in_chars
; i
++)
2258 p
->data
[i
] = real_init
;
2260 /* Clear the extraneous bits in the last byte. */
2261 if (XINT (length
) != length_in_chars
* BOOL_VECTOR_BITS_PER_CHAR
)
2262 p
->data
[length_in_chars
- 1]
2263 &= (1 << (XINT (length
) % BOOL_VECTOR_BITS_PER_CHAR
)) - 1;
2269 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2270 of characters from the contents. This string may be unibyte or
2271 multibyte, depending on the contents. */
2274 make_string (const char *contents
, EMACS_INT nbytes
)
2276 register Lisp_Object val
;
2277 EMACS_INT nchars
, multibyte_nbytes
;
2279 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2280 &nchars
, &multibyte_nbytes
);
2281 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2282 /* CONTENTS contains no multibyte sequences or contains an invalid
2283 multibyte sequence. We must make unibyte string. */
2284 val
= make_unibyte_string (contents
, nbytes
);
2286 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2291 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2294 make_unibyte_string (const char *contents
, EMACS_INT length
)
2296 register Lisp_Object val
;
2297 val
= make_uninit_string (length
);
2298 memcpy (SDATA (val
), contents
, length
);
2303 /* Make a multibyte string from NCHARS characters occupying NBYTES
2304 bytes at CONTENTS. */
2307 make_multibyte_string (const char *contents
,
2308 EMACS_INT nchars
, EMACS_INT nbytes
)
2310 register Lisp_Object val
;
2311 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2312 memcpy (SDATA (val
), contents
, nbytes
);
2317 /* Make a string from NCHARS characters occupying NBYTES bytes at
2318 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2321 make_string_from_bytes (const char *contents
,
2322 EMACS_INT nchars
, EMACS_INT nbytes
)
2324 register Lisp_Object val
;
2325 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2326 memcpy (SDATA (val
), contents
, nbytes
);
2327 if (SBYTES (val
) == SCHARS (val
))
2328 STRING_SET_UNIBYTE (val
);
2333 /* Make a string from NCHARS characters occupying NBYTES bytes at
2334 CONTENTS. The argument MULTIBYTE controls whether to label the
2335 string as multibyte. If NCHARS is negative, it counts the number of
2336 characters by itself. */
2339 make_specified_string (const char *contents
,
2340 EMACS_INT nchars
, EMACS_INT nbytes
, int multibyte
)
2342 register Lisp_Object val
;
2347 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2352 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2353 memcpy (SDATA (val
), contents
, nbytes
);
2355 STRING_SET_UNIBYTE (val
);
2360 /* Make a string from the data at STR, treating it as multibyte if the
2364 build_string (const char *str
)
2366 return make_string (str
, strlen (str
));
2370 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2371 occupying LENGTH bytes. */
2374 make_uninit_string (EMACS_INT length
)
2379 return empty_unibyte_string
;
2380 val
= make_uninit_multibyte_string (length
, length
);
2381 STRING_SET_UNIBYTE (val
);
2386 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2387 which occupy NBYTES bytes. */
2390 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2393 struct Lisp_String
*s
;
2398 return empty_multibyte_string
;
2400 s
= allocate_string ();
2401 allocate_string_data (s
, nchars
, nbytes
);
2402 XSETSTRING (string
, s
);
2403 string_chars_consed
+= nbytes
;
2409 /***********************************************************************
2411 ***********************************************************************/
2413 /* We store float cells inside of float_blocks, allocating a new
2414 float_block with malloc whenever necessary. Float cells reclaimed
2415 by GC are put on a free list to be reallocated before allocating
2416 any new float cells from the latest float_block. */
2418 #define FLOAT_BLOCK_SIZE \
2419 (((BLOCK_BYTES - sizeof (struct float_block *) \
2420 /* The compiler might add padding at the end. */ \
2421 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2422 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2424 #define GETMARKBIT(block,n) \
2425 (((block)->gcmarkbits[(n) / (sizeof(int) * CHAR_BIT)] \
2426 >> ((n) % (sizeof(int) * CHAR_BIT))) \
2429 #define SETMARKBIT(block,n) \
2430 (block)->gcmarkbits[(n) / (sizeof(int) * CHAR_BIT)] \
2431 |= 1 << ((n) % (sizeof(int) * CHAR_BIT))
2433 #define UNSETMARKBIT(block,n) \
2434 (block)->gcmarkbits[(n) / (sizeof(int) * CHAR_BIT)] \
2435 &= ~(1 << ((n) % (sizeof(int) * CHAR_BIT)))
2437 #define FLOAT_BLOCK(fptr) \
2438 ((struct float_block *)(((EMACS_UINT)(fptr)) & ~(BLOCK_ALIGN - 1)))
2440 #define FLOAT_INDEX(fptr) \
2441 ((((EMACS_UINT)(fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2445 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2446 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2447 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof(int) * CHAR_BIT
)];
2448 struct float_block
*next
;
2451 #define FLOAT_MARKED_P(fptr) \
2452 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2454 #define FLOAT_MARK(fptr) \
2455 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2457 #define FLOAT_UNMARK(fptr) \
2458 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2460 /* Current float_block. */
2462 struct float_block
*float_block
;
2464 /* Index of first unused Lisp_Float in the current float_block. */
2466 int float_block_index
;
2468 /* Total number of float blocks now in use. */
2472 /* Free-list of Lisp_Floats. */
2474 struct Lisp_Float
*float_free_list
;
2477 /* Initialize float allocation. */
2483 float_block_index
= FLOAT_BLOCK_SIZE
; /* Force alloc of new float_block. */
2484 float_free_list
= 0;
2489 /* Return a new float object with value FLOAT_VALUE. */
2492 make_float (double float_value
)
2494 register Lisp_Object val
;
2496 /* eassert (!handling_signal); */
2500 if (float_free_list
)
2502 /* We use the data field for chaining the free list
2503 so that we won't use the same field that has the mark bit. */
2504 XSETFLOAT (val
, float_free_list
);
2505 float_free_list
= float_free_list
->u
.chain
;
2509 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2511 register struct float_block
*new;
2513 new = (struct float_block
*) lisp_align_malloc (sizeof *new,
2515 new->next
= float_block
;
2516 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2518 float_block_index
= 0;
2521 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2522 float_block_index
++;
2525 MALLOC_UNBLOCK_INPUT
;
2527 XFLOAT_INIT (val
, float_value
);
2528 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2529 consing_since_gc
+= sizeof (struct Lisp_Float
);
2536 /***********************************************************************
2538 ***********************************************************************/
2540 /* We store cons cells inside of cons_blocks, allocating a new
2541 cons_block with malloc whenever necessary. Cons cells reclaimed by
2542 GC are put on a free list to be reallocated before allocating
2543 any new cons cells from the latest cons_block. */
2545 #define CONS_BLOCK_SIZE \
2546 (((BLOCK_BYTES - sizeof (struct cons_block *)) * CHAR_BIT) \
2547 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2549 #define CONS_BLOCK(fptr) \
2550 ((struct cons_block *)(((EMACS_UINT)(fptr)) & ~(BLOCK_ALIGN - 1)))
2552 #define CONS_INDEX(fptr) \
2553 ((((EMACS_UINT)(fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2557 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2558 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2559 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof(int) * CHAR_BIT
)];
2560 struct cons_block
*next
;
2563 #define CONS_MARKED_P(fptr) \
2564 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2566 #define CONS_MARK(fptr) \
2567 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2569 #define CONS_UNMARK(fptr) \
2570 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2572 /* Current cons_block. */
2574 struct cons_block
*cons_block
;
2576 /* Index of first unused Lisp_Cons in the current block. */
2578 int cons_block_index
;
2580 /* Free-list of Lisp_Cons structures. */
2582 struct Lisp_Cons
*cons_free_list
;
2584 /* Total number of cons blocks now in use. */
2586 static int n_cons_blocks
;
2589 /* Initialize cons allocation. */
2595 cons_block_index
= CONS_BLOCK_SIZE
; /* Force alloc of new cons_block. */
2601 /* Explicitly free a cons cell by putting it on the free-list. */
2604 free_cons (struct Lisp_Cons
*ptr
)
2606 ptr
->u
.chain
= cons_free_list
;
2610 cons_free_list
= ptr
;
2613 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2614 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2615 (Lisp_Object car
, Lisp_Object cdr
)
2617 register Lisp_Object val
;
2619 /* eassert (!handling_signal); */
2625 /* We use the cdr for chaining the free list
2626 so that we won't use the same field that has the mark bit. */
2627 XSETCONS (val
, cons_free_list
);
2628 cons_free_list
= cons_free_list
->u
.chain
;
2632 if (cons_block_index
== CONS_BLOCK_SIZE
)
2634 register struct cons_block
*new;
2635 new = (struct cons_block
*) lisp_align_malloc (sizeof *new,
2637 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2638 new->next
= cons_block
;
2640 cons_block_index
= 0;
2643 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2647 MALLOC_UNBLOCK_INPUT
;
2651 eassert (!CONS_MARKED_P (XCONS (val
)));
2652 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2653 cons_cells_consed
++;
2657 /* Get an error now if there's any junk in the cons free list. */
2659 check_cons_list (void)
2661 #ifdef GC_CHECK_CONS_LIST
2662 struct Lisp_Cons
*tail
= cons_free_list
;
2665 tail
= tail
->u
.chain
;
2669 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2672 list1 (Lisp_Object arg1
)
2674 return Fcons (arg1
, Qnil
);
2678 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2680 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2685 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2687 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2692 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2694 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2699 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2701 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2702 Fcons (arg5
, Qnil
)))));
2706 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2707 doc
: /* Return a newly created list with specified arguments as elements.
2708 Any number of arguments, even zero arguments, are allowed.
2709 usage: (list &rest OBJECTS) */)
2710 (int nargs
, register Lisp_Object
*args
)
2712 register Lisp_Object val
;
2718 val
= Fcons (args
[nargs
], val
);
2724 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2725 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2726 (register Lisp_Object length
, Lisp_Object init
)
2728 register Lisp_Object val
;
2729 register EMACS_INT size
;
2731 CHECK_NATNUM (length
);
2732 size
= XFASTINT (length
);
2737 val
= Fcons (init
, val
);
2742 val
= Fcons (init
, val
);
2747 val
= Fcons (init
, val
);
2752 val
= Fcons (init
, val
);
2757 val
= Fcons (init
, val
);
2772 /***********************************************************************
2774 ***********************************************************************/
2776 /* Singly-linked list of all vectors. */
2778 static struct Lisp_Vector
*all_vectors
;
2780 /* Total number of vector-like objects now in use. */
2782 static int n_vectors
;
2785 /* Value is a pointer to a newly allocated Lisp_Vector structure
2786 with room for LEN Lisp_Objects. */
2788 static struct Lisp_Vector
*
2789 allocate_vectorlike (EMACS_INT len
)
2791 struct Lisp_Vector
*p
;
2796 #ifdef DOUG_LEA_MALLOC
2797 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
2798 because mapped region contents are not preserved in
2800 mallopt (M_MMAP_MAX
, 0);
2803 /* This gets triggered by code which I haven't bothered to fix. --Stef */
2804 /* eassert (!handling_signal); */
2806 nbytes
= sizeof *p
+ (len
- 1) * sizeof p
->contents
[0];
2807 p
= (struct Lisp_Vector
*) lisp_malloc (nbytes
, MEM_TYPE_VECTORLIKE
);
2809 #ifdef DOUG_LEA_MALLOC
2810 /* Back to a reasonable maximum of mmap'ed areas. */
2811 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2814 consing_since_gc
+= nbytes
;
2815 vector_cells_consed
+= len
;
2817 p
->next
= all_vectors
;
2820 MALLOC_UNBLOCK_INPUT
;
2827 /* Allocate a vector with NSLOTS slots. */
2829 struct Lisp_Vector
*
2830 allocate_vector (EMACS_INT nslots
)
2832 struct Lisp_Vector
*v
= allocate_vectorlike (nslots
);
2838 /* Allocate other vector-like structures. */
2840 struct Lisp_Vector
*
2841 allocate_pseudovector (int memlen
, int lisplen
, EMACS_INT tag
)
2843 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
2846 /* Only the first lisplen slots will be traced normally by the GC. */
2848 for (i
= 0; i
< lisplen
; ++i
)
2849 v
->contents
[i
] = Qnil
;
2851 XSETPVECTYPE (v
, tag
); /* Add the appropriate tag. */
2855 struct Lisp_Hash_Table
*
2856 allocate_hash_table (void)
2858 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
2863 allocate_window (void)
2865 return ALLOCATE_PSEUDOVECTOR(struct window
, current_matrix
, PVEC_WINDOW
);
2870 allocate_terminal (void)
2872 struct terminal
*t
= ALLOCATE_PSEUDOVECTOR (struct terminal
,
2873 next_terminal
, PVEC_TERMINAL
);
2874 /* Zero out the non-GC'd fields. FIXME: This should be made unnecessary. */
2875 memset (&t
->next_terminal
, 0,
2876 (char*) (t
+ 1) - (char*) &t
->next_terminal
);
2882 allocate_frame (void)
2884 struct frame
*f
= ALLOCATE_PSEUDOVECTOR (struct frame
,
2885 face_cache
, PVEC_FRAME
);
2886 /* Zero out the non-GC'd fields. FIXME: This should be made unnecessary. */
2887 memset (&f
->face_cache
, 0,
2888 (char *) (f
+ 1) - (char *) &f
->face_cache
);
2893 struct Lisp_Process
*
2894 allocate_process (void)
2896 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
2900 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
2901 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
2902 See also the function `vector'. */)
2903 (register Lisp_Object length
, Lisp_Object init
)
2906 register EMACS_INT sizei
;
2907 register EMACS_INT index
;
2908 register struct Lisp_Vector
*p
;
2910 CHECK_NATNUM (length
);
2911 sizei
= XFASTINT (length
);
2913 p
= allocate_vector (sizei
);
2914 for (index
= 0; index
< sizei
; index
++)
2915 p
->contents
[index
] = init
;
2917 XSETVECTOR (vector
, p
);
2922 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
2923 doc
: /* Return a newly created vector with specified arguments as elements.
2924 Any number of arguments, even zero arguments, are allowed.
2925 usage: (vector &rest OBJECTS) */)
2926 (register int nargs
, Lisp_Object
*args
)
2928 register Lisp_Object len
, val
;
2930 register struct Lisp_Vector
*p
;
2932 XSETFASTINT (len
, nargs
);
2933 val
= Fmake_vector (len
, Qnil
);
2935 for (index
= 0; index
< nargs
; index
++)
2936 p
->contents
[index
] = args
[index
];
2941 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
2942 doc
: /* Create a byte-code object with specified arguments as elements.
2943 The arguments should be the arglist, bytecode-string, constant vector,
2944 stack size, (optional) doc string, and (optional) interactive spec.
2945 The first four arguments are required; at most six have any
2947 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
2948 (register int nargs
, Lisp_Object
*args
)
2950 register Lisp_Object len
, val
;
2952 register struct Lisp_Vector
*p
;
2954 XSETFASTINT (len
, nargs
);
2955 if (!NILP (Vpurify_flag
))
2956 val
= make_pure_vector ((EMACS_INT
) nargs
);
2958 val
= Fmake_vector (len
, Qnil
);
2960 if (nargs
> 1 && STRINGP (args
[1]) && STRING_MULTIBYTE (args
[1]))
2961 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
2962 earlier because they produced a raw 8-bit string for byte-code
2963 and now such a byte-code string is loaded as multibyte while
2964 raw 8-bit characters converted to multibyte form. Thus, now we
2965 must convert them back to the original unibyte form. */
2966 args
[1] = Fstring_as_unibyte (args
[1]);
2969 for (index
= 0; index
< nargs
; index
++)
2971 if (!NILP (Vpurify_flag
))
2972 args
[index
] = Fpurecopy (args
[index
]);
2973 p
->contents
[index
] = args
[index
];
2975 XSETPVECTYPE (p
, PVEC_COMPILED
);
2976 XSETCOMPILED (val
, p
);
2982 /***********************************************************************
2984 ***********************************************************************/
2986 /* Each symbol_block is just under 1020 bytes long, since malloc
2987 really allocates in units of powers of two and uses 4 bytes for its
2990 #define SYMBOL_BLOCK_SIZE \
2991 ((1020 - sizeof (struct symbol_block *)) / sizeof (struct Lisp_Symbol))
2995 /* Place `symbols' first, to preserve alignment. */
2996 struct Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
2997 struct symbol_block
*next
;
3000 /* Current symbol block and index of first unused Lisp_Symbol
3003 static struct symbol_block
*symbol_block
;
3004 static int symbol_block_index
;
3006 /* List of free symbols. */
3008 static struct Lisp_Symbol
*symbol_free_list
;
3010 /* Total number of symbol blocks now in use. */
3012 static int n_symbol_blocks
;
3015 /* Initialize symbol allocation. */
3020 symbol_block
= NULL
;
3021 symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3022 symbol_free_list
= 0;
3023 n_symbol_blocks
= 0;
3027 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3028 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3029 Its value and function definition are void, and its property list is nil. */)
3032 register Lisp_Object val
;
3033 register struct Lisp_Symbol
*p
;
3035 CHECK_STRING (name
);
3037 /* eassert (!handling_signal); */
3041 if (symbol_free_list
)
3043 XSETSYMBOL (val
, symbol_free_list
);
3044 symbol_free_list
= symbol_free_list
->next
;
3048 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3050 struct symbol_block
*new;
3051 new = (struct symbol_block
*) lisp_malloc (sizeof *new,
3053 new->next
= symbol_block
;
3055 symbol_block_index
= 0;
3058 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
]);
3059 symbol_block_index
++;
3062 MALLOC_UNBLOCK_INPUT
;
3067 p
->redirect
= SYMBOL_PLAINVAL
;
3068 SET_SYMBOL_VAL (p
, Qunbound
);
3069 p
->function
= Qunbound
;
3072 p
->interned
= SYMBOL_UNINTERNED
;
3074 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3081 /***********************************************************************
3082 Marker (Misc) Allocation
3083 ***********************************************************************/
3085 /* Allocation of markers and other objects that share that structure.
3086 Works like allocation of conses. */
3088 #define MARKER_BLOCK_SIZE \
3089 ((1020 - sizeof (struct marker_block *)) / sizeof (union Lisp_Misc))
3093 /* Place `markers' first, to preserve alignment. */
3094 union Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3095 struct marker_block
*next
;
3098 static struct marker_block
*marker_block
;
3099 static int marker_block_index
;
3101 static union Lisp_Misc
*marker_free_list
;
3103 /* Total number of marker blocks now in use. */
3105 static int n_marker_blocks
;
3110 marker_block
= NULL
;
3111 marker_block_index
= MARKER_BLOCK_SIZE
;
3112 marker_free_list
= 0;
3113 n_marker_blocks
= 0;
3116 /* Return a newly allocated Lisp_Misc object, with no substructure. */
3119 allocate_misc (void)
3123 /* eassert (!handling_signal); */
3127 if (marker_free_list
)
3129 XSETMISC (val
, marker_free_list
);
3130 marker_free_list
= marker_free_list
->u_free
.chain
;
3134 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3136 struct marker_block
*new;
3137 new = (struct marker_block
*) lisp_malloc (sizeof *new,
3139 new->next
= marker_block
;
3141 marker_block_index
= 0;
3143 total_free_markers
+= MARKER_BLOCK_SIZE
;
3145 XSETMISC (val
, &marker_block
->markers
[marker_block_index
]);
3146 marker_block_index
++;
3149 MALLOC_UNBLOCK_INPUT
;
3151 --total_free_markers
;
3152 consing_since_gc
+= sizeof (union Lisp_Misc
);
3153 misc_objects_consed
++;
3154 XMISCANY (val
)->gcmarkbit
= 0;
3158 /* Free a Lisp_Misc object */
3161 free_misc (Lisp_Object misc
)
3163 XMISCTYPE (misc
) = Lisp_Misc_Free
;
3164 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3165 marker_free_list
= XMISC (misc
);
3167 total_free_markers
++;
3170 /* Return a Lisp_Misc_Save_Value object containing POINTER and
3171 INTEGER. This is used to package C values to call record_unwind_protect.
3172 The unwind function can get the C values back using XSAVE_VALUE. */
3175 make_save_value (void *pointer
, int integer
)
3177 register Lisp_Object val
;
3178 register struct Lisp_Save_Value
*p
;
3180 val
= allocate_misc ();
3181 XMISCTYPE (val
) = Lisp_Misc_Save_Value
;
3182 p
= XSAVE_VALUE (val
);
3183 p
->pointer
= pointer
;
3184 p
->integer
= integer
;
3189 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3190 doc
: /* Return a newly allocated marker which does not point at any place. */)
3193 register Lisp_Object val
;
3194 register struct Lisp_Marker
*p
;
3196 val
= allocate_misc ();
3197 XMISCTYPE (val
) = Lisp_Misc_Marker
;
3203 p
->insertion_type
= 0;
3207 /* Put MARKER back on the free list after using it temporarily. */
3210 free_marker (Lisp_Object marker
)
3212 unchain_marker (XMARKER (marker
));
3217 /* Return a newly created vector or string with specified arguments as
3218 elements. If all the arguments are characters that can fit
3219 in a string of events, make a string; otherwise, make a vector.
3221 Any number of arguments, even zero arguments, are allowed. */
3224 make_event_array (register int nargs
, Lisp_Object
*args
)
3228 for (i
= 0; i
< nargs
; i
++)
3229 /* The things that fit in a string
3230 are characters that are in 0...127,
3231 after discarding the meta bit and all the bits above it. */
3232 if (!INTEGERP (args
[i
])
3233 || (XUINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3234 return Fvector (nargs
, args
);
3236 /* Since the loop exited, we know that all the things in it are
3237 characters, so we can make a string. */
3241 result
= Fmake_string (make_number (nargs
), make_number (0));
3242 for (i
= 0; i
< nargs
; i
++)
3244 SSET (result
, i
, XINT (args
[i
]));
3245 /* Move the meta bit to the right place for a string char. */
3246 if (XINT (args
[i
]) & CHAR_META
)
3247 SSET (result
, i
, SREF (result
, i
) | 0x80);
3256 /************************************************************************
3257 Memory Full Handling
3258 ************************************************************************/
3261 /* Called if malloc returns zero. */
3270 memory_full_cons_threshold
= sizeof (struct cons_block
);
3272 /* The first time we get here, free the spare memory. */
3273 for (i
= 0; i
< sizeof (spare_memory
) / sizeof (char *); i
++)
3274 if (spare_memory
[i
])
3277 free (spare_memory
[i
]);
3278 else if (i
>= 1 && i
<= 4)
3279 lisp_align_free (spare_memory
[i
]);
3281 lisp_free (spare_memory
[i
]);
3282 spare_memory
[i
] = 0;
3285 /* Record the space now used. When it decreases substantially,
3286 we can refill the memory reserve. */
3287 #ifndef SYSTEM_MALLOC
3288 bytes_used_when_full
= BYTES_USED
;
3291 /* This used to call error, but if we've run out of memory, we could
3292 get infinite recursion trying to build the string. */
3293 xsignal (Qnil
, Vmemory_signal_data
);
3296 /* If we released our reserve (due to running out of memory),
3297 and we have a fair amount free once again,
3298 try to set aside another reserve in case we run out once more.
3300 This is called when a relocatable block is freed in ralloc.c,
3301 and also directly from this file, in case we're not using ralloc.c. */
3304 refill_memory_reserve (void)
3306 #ifndef SYSTEM_MALLOC
3307 if (spare_memory
[0] == 0)
3308 spare_memory
[0] = (char *) malloc ((size_t) SPARE_MEMORY
);
3309 if (spare_memory
[1] == 0)
3310 spare_memory
[1] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3312 if (spare_memory
[2] == 0)
3313 spare_memory
[2] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3315 if (spare_memory
[3] == 0)
3316 spare_memory
[3] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3318 if (spare_memory
[4] == 0)
3319 spare_memory
[4] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3321 if (spare_memory
[5] == 0)
3322 spare_memory
[5] = (char *) lisp_malloc (sizeof (struct string_block
),
3324 if (spare_memory
[6] == 0)
3325 spare_memory
[6] = (char *) lisp_malloc (sizeof (struct string_block
),
3327 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3328 Vmemory_full
= Qnil
;
3332 /************************************************************************
3334 ************************************************************************/
3336 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3338 /* Conservative C stack marking requires a method to identify possibly
3339 live Lisp objects given a pointer value. We do this by keeping
3340 track of blocks of Lisp data that are allocated in a red-black tree
3341 (see also the comment of mem_node which is the type of nodes in
3342 that tree). Function lisp_malloc adds information for an allocated
3343 block to the red-black tree with calls to mem_insert, and function
3344 lisp_free removes it with mem_delete. Functions live_string_p etc
3345 call mem_find to lookup information about a given pointer in the
3346 tree, and use that to determine if the pointer points to a Lisp
3349 /* Initialize this part of alloc.c. */
3354 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3355 mem_z
.parent
= NULL
;
3356 mem_z
.color
= MEM_BLACK
;
3357 mem_z
.start
= mem_z
.end
= NULL
;
3362 /* Value is a pointer to the mem_node containing START. Value is
3363 MEM_NIL if there is no node in the tree containing START. */
3365 static INLINE
struct mem_node
*
3366 mem_find (void *start
)
3370 if (start
< min_heap_address
|| start
> max_heap_address
)
3373 /* Make the search always successful to speed up the loop below. */
3374 mem_z
.start
= start
;
3375 mem_z
.end
= (char *) start
+ 1;
3378 while (start
< p
->start
|| start
>= p
->end
)
3379 p
= start
< p
->start
? p
->left
: p
->right
;
3384 /* Insert a new node into the tree for a block of memory with start
3385 address START, end address END, and type TYPE. Value is a
3386 pointer to the node that was inserted. */
3388 static struct mem_node
*
3389 mem_insert (void *start
, void *end
, enum mem_type type
)
3391 struct mem_node
*c
, *parent
, *x
;
3393 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3394 min_heap_address
= start
;
3395 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3396 max_heap_address
= end
;
3398 /* See where in the tree a node for START belongs. In this
3399 particular application, it shouldn't happen that a node is already
3400 present. For debugging purposes, let's check that. */
3404 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3406 while (c
!= MEM_NIL
)
3408 if (start
>= c
->start
&& start
< c
->end
)
3411 c
= start
< c
->start
? c
->left
: c
->right
;
3414 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3416 while (c
!= MEM_NIL
)
3419 c
= start
< c
->start
? c
->left
: c
->right
;
3422 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3424 /* Create a new node. */
3425 #ifdef GC_MALLOC_CHECK
3426 x
= (struct mem_node
*) _malloc_internal (sizeof *x
);
3430 x
= (struct mem_node
*) xmalloc (sizeof *x
);
3436 x
->left
= x
->right
= MEM_NIL
;
3439 /* Insert it as child of PARENT or install it as root. */
3442 if (start
< parent
->start
)
3450 /* Re-establish red-black tree properties. */
3451 mem_insert_fixup (x
);
3457 /* Re-establish the red-black properties of the tree, and thereby
3458 balance the tree, after node X has been inserted; X is always red. */
3461 mem_insert_fixup (struct mem_node
*x
)
3463 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3465 /* X is red and its parent is red. This is a violation of
3466 red-black tree property #3. */
3468 if (x
->parent
== x
->parent
->parent
->left
)
3470 /* We're on the left side of our grandparent, and Y is our
3472 struct mem_node
*y
= x
->parent
->parent
->right
;
3474 if (y
->color
== MEM_RED
)
3476 /* Uncle and parent are red but should be black because
3477 X is red. Change the colors accordingly and proceed
3478 with the grandparent. */
3479 x
->parent
->color
= MEM_BLACK
;
3480 y
->color
= MEM_BLACK
;
3481 x
->parent
->parent
->color
= MEM_RED
;
3482 x
= x
->parent
->parent
;
3486 /* Parent and uncle have different colors; parent is
3487 red, uncle is black. */
3488 if (x
== x
->parent
->right
)
3491 mem_rotate_left (x
);
3494 x
->parent
->color
= MEM_BLACK
;
3495 x
->parent
->parent
->color
= MEM_RED
;
3496 mem_rotate_right (x
->parent
->parent
);
3501 /* This is the symmetrical case of above. */
3502 struct mem_node
*y
= x
->parent
->parent
->left
;
3504 if (y
->color
== MEM_RED
)
3506 x
->parent
->color
= MEM_BLACK
;
3507 y
->color
= MEM_BLACK
;
3508 x
->parent
->parent
->color
= MEM_RED
;
3509 x
= x
->parent
->parent
;
3513 if (x
== x
->parent
->left
)
3516 mem_rotate_right (x
);
3519 x
->parent
->color
= MEM_BLACK
;
3520 x
->parent
->parent
->color
= MEM_RED
;
3521 mem_rotate_left (x
->parent
->parent
);
3526 /* The root may have been changed to red due to the algorithm. Set
3527 it to black so that property #5 is satisfied. */
3528 mem_root
->color
= MEM_BLACK
;
3539 mem_rotate_left (struct mem_node
*x
)
3543 /* Turn y's left sub-tree into x's right sub-tree. */
3546 if (y
->left
!= MEM_NIL
)
3547 y
->left
->parent
= x
;
3549 /* Y's parent was x's parent. */
3551 y
->parent
= x
->parent
;
3553 /* Get the parent to point to y instead of x. */
3556 if (x
== x
->parent
->left
)
3557 x
->parent
->left
= y
;
3559 x
->parent
->right
= y
;
3564 /* Put x on y's left. */
3578 mem_rotate_right (struct mem_node
*x
)
3580 struct mem_node
*y
= x
->left
;
3583 if (y
->right
!= MEM_NIL
)
3584 y
->right
->parent
= x
;
3587 y
->parent
= x
->parent
;
3590 if (x
== x
->parent
->right
)
3591 x
->parent
->right
= y
;
3593 x
->parent
->left
= y
;
3604 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
3607 mem_delete (struct mem_node
*z
)
3609 struct mem_node
*x
, *y
;
3611 if (!z
|| z
== MEM_NIL
)
3614 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
3619 while (y
->left
!= MEM_NIL
)
3623 if (y
->left
!= MEM_NIL
)
3628 x
->parent
= y
->parent
;
3631 if (y
== y
->parent
->left
)
3632 y
->parent
->left
= x
;
3634 y
->parent
->right
= x
;
3641 z
->start
= y
->start
;
3646 if (y
->color
== MEM_BLACK
)
3647 mem_delete_fixup (x
);
3649 #ifdef GC_MALLOC_CHECK
3657 /* Re-establish the red-black properties of the tree, after a
3661 mem_delete_fixup (struct mem_node
*x
)
3663 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
3665 if (x
== x
->parent
->left
)
3667 struct mem_node
*w
= x
->parent
->right
;
3669 if (w
->color
== MEM_RED
)
3671 w
->color
= MEM_BLACK
;
3672 x
->parent
->color
= MEM_RED
;
3673 mem_rotate_left (x
->parent
);
3674 w
= x
->parent
->right
;
3677 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
3684 if (w
->right
->color
== MEM_BLACK
)
3686 w
->left
->color
= MEM_BLACK
;
3688 mem_rotate_right (w
);
3689 w
= x
->parent
->right
;
3691 w
->color
= x
->parent
->color
;
3692 x
->parent
->color
= MEM_BLACK
;
3693 w
->right
->color
= MEM_BLACK
;
3694 mem_rotate_left (x
->parent
);
3700 struct mem_node
*w
= x
->parent
->left
;
3702 if (w
->color
== MEM_RED
)
3704 w
->color
= MEM_BLACK
;
3705 x
->parent
->color
= MEM_RED
;
3706 mem_rotate_right (x
->parent
);
3707 w
= x
->parent
->left
;
3710 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
3717 if (w
->left
->color
== MEM_BLACK
)
3719 w
->right
->color
= MEM_BLACK
;
3721 mem_rotate_left (w
);
3722 w
= x
->parent
->left
;
3725 w
->color
= x
->parent
->color
;
3726 x
->parent
->color
= MEM_BLACK
;
3727 w
->left
->color
= MEM_BLACK
;
3728 mem_rotate_right (x
->parent
);
3734 x
->color
= MEM_BLACK
;
3738 /* Value is non-zero if P is a pointer to a live Lisp string on
3739 the heap. M is a pointer to the mem_block for P. */
3742 live_string_p (struct mem_node
*m
, void *p
)
3744 if (m
->type
== MEM_TYPE_STRING
)
3746 struct string_block
*b
= (struct string_block
*) m
->start
;
3747 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
3749 /* P must point to the start of a Lisp_String structure, and it
3750 must not be on the free-list. */
3752 && offset
% sizeof b
->strings
[0] == 0
3753 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
3754 && ((struct Lisp_String
*) p
)->data
!= NULL
);
3761 /* Value is non-zero if P is a pointer to a live Lisp cons on
3762 the heap. M is a pointer to the mem_block for P. */
3765 live_cons_p (struct mem_node
*m
, void *p
)
3767 if (m
->type
== MEM_TYPE_CONS
)
3769 struct cons_block
*b
= (struct cons_block
*) m
->start
;
3770 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
3772 /* P must point to the start of a Lisp_Cons, not be
3773 one of the unused cells in the current cons block,
3774 and not be on the free-list. */
3776 && offset
% sizeof b
->conses
[0] == 0
3777 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
3779 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
3780 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
3787 /* Value is non-zero if P is a pointer to a live Lisp symbol on
3788 the heap. M is a pointer to the mem_block for P. */
3791 live_symbol_p (struct mem_node
*m
, void *p
)
3793 if (m
->type
== MEM_TYPE_SYMBOL
)
3795 struct symbol_block
*b
= (struct symbol_block
*) m
->start
;
3796 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
3798 /* P must point to the start of a Lisp_Symbol, not be
3799 one of the unused cells in the current symbol block,
3800 and not be on the free-list. */
3802 && offset
% sizeof b
->symbols
[0] == 0
3803 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
3804 && (b
!= symbol_block
3805 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
3806 && !EQ (((struct Lisp_Symbol
*) p
)->function
, Vdead
));
3813 /* Value is non-zero if P is a pointer to a live Lisp float on
3814 the heap. M is a pointer to the mem_block for P. */
3817 live_float_p (struct mem_node
*m
, void *p
)
3819 if (m
->type
== MEM_TYPE_FLOAT
)
3821 struct float_block
*b
= (struct float_block
*) m
->start
;
3822 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
3824 /* P must point to the start of a Lisp_Float and not be
3825 one of the unused cells in the current float block. */
3827 && offset
% sizeof b
->floats
[0] == 0
3828 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
3829 && (b
!= float_block
3830 || offset
/ sizeof b
->floats
[0] < float_block_index
));
3837 /* Value is non-zero if P is a pointer to a live Lisp Misc on
3838 the heap. M is a pointer to the mem_block for P. */
3841 live_misc_p (struct mem_node
*m
, void *p
)
3843 if (m
->type
== MEM_TYPE_MISC
)
3845 struct marker_block
*b
= (struct marker_block
*) m
->start
;
3846 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
3848 /* P must point to the start of a Lisp_Misc, not be
3849 one of the unused cells in the current misc block,
3850 and not be on the free-list. */
3852 && offset
% sizeof b
->markers
[0] == 0
3853 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
3854 && (b
!= marker_block
3855 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
3856 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
3863 /* Value is non-zero if P is a pointer to a live vector-like object.
3864 M is a pointer to the mem_block for P. */
3867 live_vector_p (struct mem_node
*m
, void *p
)
3869 return (p
== m
->start
&& m
->type
== MEM_TYPE_VECTORLIKE
);
3873 /* Value is non-zero if P is a pointer to a live buffer. M is a
3874 pointer to the mem_block for P. */
3877 live_buffer_p (struct mem_node
*m
, void *p
)
3879 /* P must point to the start of the block, and the buffer
3880 must not have been killed. */
3881 return (m
->type
== MEM_TYPE_BUFFER
3883 && !NILP (((struct buffer
*) p
)->BUFFER_INTERNAL_FIELD (name
)));
3886 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
3890 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
3892 /* Array of objects that are kept alive because the C stack contains
3893 a pattern that looks like a reference to them . */
3895 #define MAX_ZOMBIES 10
3896 static Lisp_Object zombies
[MAX_ZOMBIES
];
3898 /* Number of zombie objects. */
3900 static int nzombies
;
3902 /* Number of garbage collections. */
3906 /* Average percentage of zombies per collection. */
3908 static double avg_zombies
;
3910 /* Max. number of live and zombie objects. */
3912 static int max_live
, max_zombies
;
3914 /* Average number of live objects per GC. */
3916 static double avg_live
;
3918 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
3919 doc
: /* Show information about live and zombie objects. */)
3922 Lisp_Object args
[8], zombie_list
= Qnil
;
3924 for (i
= 0; i
< nzombies
; i
++)
3925 zombie_list
= Fcons (zombies
[i
], zombie_list
);
3926 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
3927 args
[1] = make_number (ngcs
);
3928 args
[2] = make_float (avg_live
);
3929 args
[3] = make_float (avg_zombies
);
3930 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
3931 args
[5] = make_number (max_live
);
3932 args
[6] = make_number (max_zombies
);
3933 args
[7] = zombie_list
;
3934 return Fmessage (8, args
);
3937 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
3940 /* Mark OBJ if we can prove it's a Lisp_Object. */
3943 mark_maybe_object (Lisp_Object obj
)
3951 po
= (void *) XPNTR (obj
);
3958 switch (XTYPE (obj
))
3961 mark_p
= (live_string_p (m
, po
)
3962 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
3966 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
3970 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
3974 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
3977 case Lisp_Vectorlike
:
3978 /* Note: can't check BUFFERP before we know it's a
3979 buffer because checking that dereferences the pointer
3980 PO which might point anywhere. */
3981 if (live_vector_p (m
, po
))
3982 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
3983 else if (live_buffer_p (m
, po
))
3984 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
3988 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
3997 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
3998 if (nzombies
< MAX_ZOMBIES
)
3999 zombies
[nzombies
] = obj
;
4008 /* If P points to Lisp data, mark that as live if it isn't already
4012 mark_maybe_pointer (void *p
)
4016 /* Quickly rule out some values which can't point to Lisp data. */
4019 8 /* USE_LSB_TAG needs Lisp data to be aligned on multiples of 8. */
4021 2 /* We assume that Lisp data is aligned on even addresses. */
4029 Lisp_Object obj
= Qnil
;
4033 case MEM_TYPE_NON_LISP
:
4034 /* Nothing to do; not a pointer to Lisp memory. */
4037 case MEM_TYPE_BUFFER
:
4038 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P((struct buffer
*)p
))
4039 XSETVECTOR (obj
, p
);
4043 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4047 case MEM_TYPE_STRING
:
4048 if (live_string_p (m
, p
)
4049 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4050 XSETSTRING (obj
, p
);
4054 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4058 case MEM_TYPE_SYMBOL
:
4059 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4060 XSETSYMBOL (obj
, p
);
4063 case MEM_TYPE_FLOAT
:
4064 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4068 case MEM_TYPE_VECTORLIKE
:
4069 if (live_vector_p (m
, p
))
4072 XSETVECTOR (tem
, p
);
4073 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4088 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4089 or END+OFFSET..START. */
4092 mark_memory (void *start
, void *end
, int offset
)
4097 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4101 /* Make START the pointer to the start of the memory region,
4102 if it isn't already. */
4110 /* Mark Lisp_Objects. */
4111 for (p
= (Lisp_Object
*) ((char *) start
+ offset
); (void *) p
< end
; ++p
)
4112 mark_maybe_object (*p
);
4114 /* Mark Lisp data pointed to. This is necessary because, in some
4115 situations, the C compiler optimizes Lisp objects away, so that
4116 only a pointer to them remains. Example:
4118 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4121 Lisp_Object obj = build_string ("test");
4122 struct Lisp_String *s = XSTRING (obj);
4123 Fgarbage_collect ();
4124 fprintf (stderr, "test `%s'\n", s->data);
4128 Here, `obj' isn't really used, and the compiler optimizes it
4129 away. The only reference to the life string is through the
4132 for (pp
= (void **) ((char *) start
+ offset
); (void *) pp
< end
; ++pp
)
4133 mark_maybe_pointer (*pp
);
4136 /* setjmp will work with GCC unless NON_SAVING_SETJMP is defined in
4137 the GCC system configuration. In gcc 3.2, the only systems for
4138 which this is so are i386-sco5 non-ELF, i386-sysv3 (maybe included
4139 by others?) and ns32k-pc532-min. */
4141 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4143 static int setjmp_tested_p
, longjmps_done
;
4145 #define SETJMP_WILL_LIKELY_WORK "\
4147 Emacs garbage collector has been changed to use conservative stack\n\
4148 marking. Emacs has determined that the method it uses to do the\n\
4149 marking will likely work on your system, but this isn't sure.\n\
4151 If you are a system-programmer, or can get the help of a local wizard\n\
4152 who is, please take a look at the function mark_stack in alloc.c, and\n\
4153 verify that the methods used are appropriate for your system.\n\
4155 Please mail the result to <emacs-devel@gnu.org>.\n\
4158 #define SETJMP_WILL_NOT_WORK "\
4160 Emacs garbage collector has been changed to use conservative stack\n\
4161 marking. Emacs has determined that the default method it uses to do the\n\
4162 marking will not work on your system. We will need a system-dependent\n\
4163 solution for your system.\n\
4165 Please take a look at the function mark_stack in alloc.c, and\n\
4166 try to find a way to make it work on your system.\n\
4168 Note that you may get false negatives, depending on the compiler.\n\
4169 In particular, you need to use -O with GCC for this test.\n\
4171 Please mail the result to <emacs-devel@gnu.org>.\n\
4175 /* Perform a quick check if it looks like setjmp saves registers in a
4176 jmp_buf. Print a message to stderr saying so. When this test
4177 succeeds, this is _not_ a proof that setjmp is sufficient for
4178 conservative stack marking. Only the sources or a disassembly
4189 /* Arrange for X to be put in a register. */
4195 if (longjmps_done
== 1)
4197 /* Came here after the longjmp at the end of the function.
4199 If x == 1, the longjmp has restored the register to its
4200 value before the setjmp, and we can hope that setjmp
4201 saves all such registers in the jmp_buf, although that
4204 For other values of X, either something really strange is
4205 taking place, or the setjmp just didn't save the register. */
4208 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4211 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4218 if (longjmps_done
== 1)
4222 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4225 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4227 /* Abort if anything GCPRO'd doesn't survive the GC. */
4235 for (p
= gcprolist
; p
; p
= p
->next
)
4236 for (i
= 0; i
< p
->nvars
; ++i
)
4237 if (!survives_gc_p (p
->var
[i
]))
4238 /* FIXME: It's not necessarily a bug. It might just be that the
4239 GCPRO is unnecessary or should release the object sooner. */
4243 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4250 fprintf (stderr
, "\nZombies kept alive = %d:\n", nzombies
);
4251 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4253 fprintf (stderr
, " %d = ", i
);
4254 debug_print (zombies
[i
]);
4258 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4261 /* Mark live Lisp objects on the C stack.
4263 There are several system-dependent problems to consider when
4264 porting this to new architectures:
4268 We have to mark Lisp objects in CPU registers that can hold local
4269 variables or are used to pass parameters.
4271 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4272 something that either saves relevant registers on the stack, or
4273 calls mark_maybe_object passing it each register's contents.
4275 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4276 implementation assumes that calling setjmp saves registers we need
4277 to see in a jmp_buf which itself lies on the stack. This doesn't
4278 have to be true! It must be verified for each system, possibly
4279 by taking a look at the source code of setjmp.
4281 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4282 can use it as a machine independent method to store all registers
4283 to the stack. In this case the macros described in the previous
4284 two paragraphs are not used.
4288 Architectures differ in the way their processor stack is organized.
4289 For example, the stack might look like this
4292 | Lisp_Object | size = 4
4294 | something else | size = 2
4296 | Lisp_Object | size = 4
4300 In such a case, not every Lisp_Object will be aligned equally. To
4301 find all Lisp_Object on the stack it won't be sufficient to walk
4302 the stack in steps of 4 bytes. Instead, two passes will be
4303 necessary, one starting at the start of the stack, and a second
4304 pass starting at the start of the stack + 2. Likewise, if the
4305 minimal alignment of Lisp_Objects on the stack is 1, four passes
4306 would be necessary, each one starting with one byte more offset
4307 from the stack start.
4309 The current code assumes by default that Lisp_Objects are aligned
4310 equally on the stack. */
4316 /* jmp_buf may not be aligned enough on darwin-ppc64 */
4317 union aligned_jmpbuf
{
4321 volatile int stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4324 #ifdef HAVE___BUILTIN_UNWIND_INIT
4325 /* Force callee-saved registers and register windows onto the stack.
4326 This is the preferred method if available, obviating the need for
4327 machine dependent methods. */
4328 __builtin_unwind_init ();
4330 #else /* not HAVE___BUILTIN_UNWIND_INIT */
4331 /* This trick flushes the register windows so that all the state of
4332 the process is contained in the stack. */
4333 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4334 needed on ia64 too. See mach_dep.c, where it also says inline
4335 assembler doesn't work with relevant proprietary compilers. */
4337 #if defined (__sparc64__) && defined (__FreeBSD__)
4338 /* FreeBSD does not have a ta 3 handler. */
4345 /* Save registers that we need to see on the stack. We need to see
4346 registers used to hold register variables and registers used to
4348 #ifdef GC_SAVE_REGISTERS_ON_STACK
4349 GC_SAVE_REGISTERS_ON_STACK (end
);
4350 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4352 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4353 setjmp will definitely work, test it
4354 and print a message with the result
4356 if (!setjmp_tested_p
)
4358 setjmp_tested_p
= 1;
4361 #endif /* GC_SETJMP_WORKS */
4364 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4365 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4366 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
4368 /* This assumes that the stack is a contiguous region in memory. If
4369 that's not the case, something has to be done here to iterate
4370 over the stack segments. */
4371 #ifndef GC_LISP_OBJECT_ALIGNMENT
4373 #define GC_LISP_OBJECT_ALIGNMENT __alignof__ (Lisp_Object)
4375 #define GC_LISP_OBJECT_ALIGNMENT sizeof (Lisp_Object)
4378 for (i
= 0; i
< sizeof (Lisp_Object
); i
+= GC_LISP_OBJECT_ALIGNMENT
)
4379 mark_memory (stack_base
, end
, i
);
4380 /* Allow for marking a secondary stack, like the register stack on the
4382 #ifdef GC_MARK_SECONDARY_STACK
4383 GC_MARK_SECONDARY_STACK ();
4386 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4391 #endif /* GC_MARK_STACK != 0 */
4394 /* Determine whether it is safe to access memory at address P. */
4396 valid_pointer_p (void *p
)
4399 return w32_valid_pointer_p (p
, 16);
4403 /* Obviously, we cannot just access it (we would SEGV trying), so we
4404 trick the o/s to tell us whether p is a valid pointer.
4405 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4406 not validate p in that case. */
4408 if ((fd
= emacs_open ("__Valid__Lisp__Object__", O_CREAT
| O_WRONLY
| O_TRUNC
, 0666)) >= 0)
4410 int valid
= (emacs_write (fd
, (char *)p
, 16) == 16);
4412 unlink ("__Valid__Lisp__Object__");
4420 /* Return 1 if OBJ is a valid lisp object.
4421 Return 0 if OBJ is NOT a valid lisp object.
4422 Return -1 if we cannot validate OBJ.
4423 This function can be quite slow,
4424 so it should only be used in code for manual debugging. */
4427 valid_lisp_object_p (Lisp_Object obj
)
4437 p
= (void *) XPNTR (obj
);
4438 if (PURE_POINTER_P (p
))
4442 return valid_pointer_p (p
);
4449 int valid
= valid_pointer_p (p
);
4461 case MEM_TYPE_NON_LISP
:
4464 case MEM_TYPE_BUFFER
:
4465 return live_buffer_p (m
, p
);
4468 return live_cons_p (m
, p
);
4470 case MEM_TYPE_STRING
:
4471 return live_string_p (m
, p
);
4474 return live_misc_p (m
, p
);
4476 case MEM_TYPE_SYMBOL
:
4477 return live_symbol_p (m
, p
);
4479 case MEM_TYPE_FLOAT
:
4480 return live_float_p (m
, p
);
4482 case MEM_TYPE_VECTORLIKE
:
4483 return live_vector_p (m
, p
);
4496 /***********************************************************************
4497 Pure Storage Management
4498 ***********************************************************************/
4500 /* Allocate room for SIZE bytes from pure Lisp storage and return a
4501 pointer to it. TYPE is the Lisp type for which the memory is
4502 allocated. TYPE < 0 means it's not used for a Lisp object. */
4504 static POINTER_TYPE
*
4505 pure_alloc (size_t size
, int type
)
4507 POINTER_TYPE
*result
;
4509 size_t alignment
= (1 << GCTYPEBITS
);
4511 size_t alignment
= sizeof (EMACS_INT
);
4513 /* Give Lisp_Floats an extra alignment. */
4514 if (type
== Lisp_Float
)
4516 #if defined __GNUC__ && __GNUC__ >= 2
4517 alignment
= __alignof (struct Lisp_Float
);
4519 alignment
= sizeof (struct Lisp_Float
);
4527 /* Allocate space for a Lisp object from the beginning of the free
4528 space with taking account of alignment. */
4529 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
4530 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
4534 /* Allocate space for a non-Lisp object from the end of the free
4536 pure_bytes_used_non_lisp
+= size
;
4537 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4539 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
4541 if (pure_bytes_used
<= pure_size
)
4544 /* Don't allocate a large amount here,
4545 because it might get mmap'd and then its address
4546 might not be usable. */
4547 purebeg
= (char *) xmalloc (10000);
4549 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
4550 pure_bytes_used
= 0;
4551 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
4556 /* Print a warning if PURESIZE is too small. */
4559 check_pure_size (void)
4561 if (pure_bytes_used_before_overflow
)
4562 message ("emacs:0:Pure Lisp storage overflow (approx. %d bytes needed)",
4563 (int) (pure_bytes_used
+ pure_bytes_used_before_overflow
));
4567 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
4568 the non-Lisp data pool of the pure storage, and return its start
4569 address. Return NULL if not found. */
4572 find_string_data_in_pure (const char *data
, EMACS_INT nbytes
)
4575 EMACS_INT skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
4576 const unsigned char *p
;
4579 if (pure_bytes_used_non_lisp
< nbytes
+ 1)
4582 /* Set up the Boyer-Moore table. */
4584 for (i
= 0; i
< 256; i
++)
4587 p
= (const unsigned char *) data
;
4589 bm_skip
[*p
++] = skip
;
4591 last_char_skip
= bm_skip
['\0'];
4593 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4594 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
4596 /* See the comments in the function `boyer_moore' (search.c) for the
4597 use of `infinity'. */
4598 infinity
= pure_bytes_used_non_lisp
+ 1;
4599 bm_skip
['\0'] = infinity
;
4601 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
4605 /* Check the last character (== '\0'). */
4608 start
+= bm_skip
[*(p
+ start
)];
4610 while (start
<= start_max
);
4612 if (start
< infinity
)
4613 /* Couldn't find the last character. */
4616 /* No less than `infinity' means we could find the last
4617 character at `p[start - infinity]'. */
4620 /* Check the remaining characters. */
4621 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
4623 return non_lisp_beg
+ start
;
4625 start
+= last_char_skip
;
4627 while (start
<= start_max
);
4633 /* Return a string allocated in pure space. DATA is a buffer holding
4634 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
4635 non-zero means make the result string multibyte.
4637 Must get an error if pure storage is full, since if it cannot hold
4638 a large string it may be able to hold conses that point to that
4639 string; then the string is not protected from gc. */
4642 make_pure_string (const char *data
,
4643 EMACS_INT nchars
, EMACS_INT nbytes
, int multibyte
)
4646 struct Lisp_String
*s
;
4648 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
4649 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
4650 if (s
->data
== NULL
)
4652 s
->data
= (unsigned char *) pure_alloc (nbytes
+ 1, -1);
4653 memcpy (s
->data
, data
, nbytes
);
4654 s
->data
[nbytes
] = '\0';
4657 s
->size_byte
= multibyte
? nbytes
: -1;
4658 s
->intervals
= NULL_INTERVAL
;
4659 XSETSTRING (string
, s
);
4663 /* Return a string a string allocated in pure space. Do not allocate
4664 the string data, just point to DATA. */
4667 make_pure_c_string (const char *data
)
4670 struct Lisp_String
*s
;
4671 EMACS_INT nchars
= strlen (data
);
4673 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
4676 s
->data
= (unsigned char *) data
;
4677 s
->intervals
= NULL_INTERVAL
;
4678 XSETSTRING (string
, s
);
4682 /* Return a cons allocated from pure space. Give it pure copies
4683 of CAR as car and CDR as cdr. */
4686 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
4688 register Lisp_Object
new;
4689 struct Lisp_Cons
*p
;
4691 p
= (struct Lisp_Cons
*) pure_alloc (sizeof *p
, Lisp_Cons
);
4693 XSETCAR (new, Fpurecopy (car
));
4694 XSETCDR (new, Fpurecopy (cdr
));
4699 /* Value is a float object with value NUM allocated from pure space. */
4702 make_pure_float (double num
)
4704 register Lisp_Object
new;
4705 struct Lisp_Float
*p
;
4707 p
= (struct Lisp_Float
*) pure_alloc (sizeof *p
, Lisp_Float
);
4709 XFLOAT_INIT (new, num
);
4714 /* Return a vector with room for LEN Lisp_Objects allocated from
4718 make_pure_vector (EMACS_INT len
)
4721 struct Lisp_Vector
*p
;
4722 size_t size
= sizeof *p
+ (len
- 1) * sizeof (Lisp_Object
);
4724 p
= (struct Lisp_Vector
*) pure_alloc (size
, Lisp_Vectorlike
);
4725 XSETVECTOR (new, p
);
4726 XVECTOR (new)->size
= len
;
4731 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
4732 doc
: /* Make a copy of object OBJ in pure storage.
4733 Recursively copies contents of vectors and cons cells.
4734 Does not copy symbols. Copies strings without text properties. */)
4735 (register Lisp_Object obj
)
4737 if (NILP (Vpurify_flag
))
4740 if (PURE_POINTER_P (XPNTR (obj
)))
4743 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
4745 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
4751 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
4752 else if (FLOATP (obj
))
4753 obj
= make_pure_float (XFLOAT_DATA (obj
));
4754 else if (STRINGP (obj
))
4755 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
4757 STRING_MULTIBYTE (obj
));
4758 else if (COMPILEDP (obj
) || VECTORP (obj
))
4760 register struct Lisp_Vector
*vec
;
4761 register EMACS_INT i
;
4764 size
= XVECTOR (obj
)->size
;
4765 if (size
& PSEUDOVECTOR_FLAG
)
4766 size
&= PSEUDOVECTOR_SIZE_MASK
;
4767 vec
= XVECTOR (make_pure_vector (size
));
4768 for (i
= 0; i
< size
; i
++)
4769 vec
->contents
[i
] = Fpurecopy (XVECTOR (obj
)->contents
[i
]);
4770 if (COMPILEDP (obj
))
4772 XSETPVECTYPE (vec
, PVEC_COMPILED
);
4773 XSETCOMPILED (obj
, vec
);
4776 XSETVECTOR (obj
, vec
);
4778 else if (MARKERP (obj
))
4779 error ("Attempt to copy a marker to pure storage");
4781 /* Not purified, don't hash-cons. */
4784 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
4785 Fputhash (obj
, obj
, Vpurify_flag
);
4792 /***********************************************************************
4794 ***********************************************************************/
4796 /* Put an entry in staticvec, pointing at the variable with address
4800 staticpro (Lisp_Object
*varaddress
)
4802 staticvec
[staticidx
++] = varaddress
;
4803 if (staticidx
>= NSTATICS
)
4808 /***********************************************************************
4810 ***********************************************************************/
4812 /* Temporarily prevent garbage collection. */
4815 inhibit_garbage_collection (void)
4817 int count
= SPECPDL_INDEX ();
4818 int nbits
= min (VALBITS
, BITS_PER_INT
);
4820 specbind (Qgc_cons_threshold
, make_number (((EMACS_INT
) 1 << (nbits
- 1)) - 1));
4825 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
4826 doc
: /* Reclaim storage for Lisp objects no longer needed.
4827 Garbage collection happens automatically if you cons more than
4828 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
4829 `garbage-collect' normally returns a list with info on amount of space in use:
4830 ((USED-CONSES . FREE-CONSES) (USED-SYMS . FREE-SYMS)
4831 (USED-MARKERS . FREE-MARKERS) USED-STRING-CHARS USED-VECTOR-SLOTS
4832 (USED-FLOATS . FREE-FLOATS) (USED-INTERVALS . FREE-INTERVALS)
4833 (USED-STRINGS . FREE-STRINGS))
4834 However, if there was overflow in pure space, `garbage-collect'
4835 returns nil, because real GC can't be done. */)
4838 register struct specbinding
*bind
;
4839 char stack_top_variable
;
4842 Lisp_Object total
[8];
4843 int count
= SPECPDL_INDEX ();
4844 EMACS_TIME t1
, t2
, t3
;
4849 /* Can't GC if pure storage overflowed because we can't determine
4850 if something is a pure object or not. */
4851 if (pure_bytes_used_before_overflow
)
4856 /* Don't keep undo information around forever.
4857 Do this early on, so it is no problem if the user quits. */
4859 register struct buffer
*nextb
= all_buffers
;
4863 /* If a buffer's undo list is Qt, that means that undo is
4864 turned off in that buffer. Calling truncate_undo_list on
4865 Qt tends to return NULL, which effectively turns undo back on.
4866 So don't call truncate_undo_list if undo_list is Qt. */
4867 if (! NILP (nextb
->BUFFER_INTERNAL_FIELD (name
)) && ! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
4868 truncate_undo_list (nextb
);
4870 /* Shrink buffer gaps, but skip indirect and dead buffers. */
4871 if (nextb
->base_buffer
== 0 && !NILP (nextb
->BUFFER_INTERNAL_FIELD (name
))
4872 && ! nextb
->text
->inhibit_shrinking
)
4874 /* If a buffer's gap size is more than 10% of the buffer
4875 size, or larger than 2000 bytes, then shrink it
4876 accordingly. Keep a minimum size of 20 bytes. */
4877 int size
= min (2000, max (20, (nextb
->text
->z_byte
/ 10)));
4879 if (nextb
->text
->gap_size
> size
)
4881 struct buffer
*save_current
= current_buffer
;
4882 current_buffer
= nextb
;
4883 make_gap (-(nextb
->text
->gap_size
- size
));
4884 current_buffer
= save_current
;
4888 nextb
= nextb
->next
;
4892 EMACS_GET_TIME (t1
);
4894 /* In case user calls debug_print during GC,
4895 don't let that cause a recursive GC. */
4896 consing_since_gc
= 0;
4898 /* Save what's currently displayed in the echo area. */
4899 message_p
= push_message ();
4900 record_unwind_protect (pop_message_unwind
, Qnil
);
4902 /* Save a copy of the contents of the stack, for debugging. */
4903 #if MAX_SAVE_STACK > 0
4904 if (NILP (Vpurify_flag
))
4906 i
= &stack_top_variable
- stack_bottom
;
4908 if (i
< MAX_SAVE_STACK
)
4910 if (stack_copy
== 0)
4911 stack_copy
= (char *) xmalloc (stack_copy_size
= i
);
4912 else if (stack_copy_size
< i
)
4913 stack_copy
= (char *) xrealloc (stack_copy
, (stack_copy_size
= i
));
4916 if ((EMACS_INT
) (&stack_top_variable
- stack_bottom
) > 0)
4917 memcpy (stack_copy
, stack_bottom
, i
);
4919 memcpy (stack_copy
, &stack_top_variable
, i
);
4923 #endif /* MAX_SAVE_STACK > 0 */
4925 if (garbage_collection_messages
)
4926 message1_nolog ("Garbage collecting...");
4930 shrink_regexp_cache ();
4934 /* clear_marks (); */
4936 /* Mark all the special slots that serve as the roots of accessibility. */
4938 for (i
= 0; i
< staticidx
; i
++)
4939 mark_object (*staticvec
[i
]);
4941 for (bind
= specpdl
; bind
!= specpdl_ptr
; bind
++)
4943 mark_object (bind
->symbol
);
4944 mark_object (bind
->old_value
);
4952 extern void xg_mark_data (void);
4957 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
4958 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
4962 register struct gcpro
*tail
;
4963 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
4964 for (i
= 0; i
< tail
->nvars
; i
++)
4965 mark_object (tail
->var
[i
]);
4969 struct catchtag
*catch;
4970 struct handler
*handler
;
4972 for (catch = catchlist
; catch; catch = catch->next
)
4974 mark_object (catch->tag
);
4975 mark_object (catch->val
);
4977 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
4979 mark_object (handler
->handler
);
4980 mark_object (handler
->var
);
4986 #ifdef HAVE_WINDOW_SYSTEM
4987 mark_fringe_data ();
4990 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4994 /* Everything is now marked, except for the things that require special
4995 finalization, i.e. the undo_list.
4996 Look thru every buffer's undo list
4997 for elements that update markers that were not marked,
5000 register struct buffer
*nextb
= all_buffers
;
5004 /* If a buffer's undo list is Qt, that means that undo is
5005 turned off in that buffer. Calling truncate_undo_list on
5006 Qt tends to return NULL, which effectively turns undo back on.
5007 So don't call truncate_undo_list if undo_list is Qt. */
5008 if (! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
5010 Lisp_Object tail
, prev
;
5011 tail
= nextb
->BUFFER_INTERNAL_FIELD (undo_list
);
5013 while (CONSP (tail
))
5015 if (CONSP (XCAR (tail
))
5016 && MARKERP (XCAR (XCAR (tail
)))
5017 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5020 nextb
->BUFFER_INTERNAL_FIELD (undo_list
) = tail
= XCDR (tail
);
5024 XSETCDR (prev
, tail
);
5034 /* Now that we have stripped the elements that need not be in the
5035 undo_list any more, we can finally mark the list. */
5036 mark_object (nextb
->BUFFER_INTERNAL_FIELD (undo_list
));
5038 nextb
= nextb
->next
;
5044 /* Clear the mark bits that we set in certain root slots. */
5046 unmark_byte_stack ();
5047 VECTOR_UNMARK (&buffer_defaults
);
5048 VECTOR_UNMARK (&buffer_local_symbols
);
5050 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5058 /* clear_marks (); */
5061 consing_since_gc
= 0;
5062 if (gc_cons_threshold
< 10000)
5063 gc_cons_threshold
= 10000;
5065 if (FLOATP (Vgc_cons_percentage
))
5066 { /* Set gc_cons_combined_threshold. */
5067 EMACS_INT total
= 0;
5069 total
+= total_conses
* sizeof (struct Lisp_Cons
);
5070 total
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5071 total
+= total_markers
* sizeof (union Lisp_Misc
);
5072 total
+= total_string_size
;
5073 total
+= total_vector_size
* sizeof (Lisp_Object
);
5074 total
+= total_floats
* sizeof (struct Lisp_Float
);
5075 total
+= total_intervals
* sizeof (struct interval
);
5076 total
+= total_strings
* sizeof (struct Lisp_String
);
5078 gc_relative_threshold
= total
* XFLOAT_DATA (Vgc_cons_percentage
);
5081 gc_relative_threshold
= 0;
5083 if (garbage_collection_messages
)
5085 if (message_p
|| minibuf_level
> 0)
5088 message1_nolog ("Garbage collecting...done");
5091 unbind_to (count
, Qnil
);
5093 total
[0] = Fcons (make_number (total_conses
),
5094 make_number (total_free_conses
));
5095 total
[1] = Fcons (make_number (total_symbols
),
5096 make_number (total_free_symbols
));
5097 total
[2] = Fcons (make_number (total_markers
),
5098 make_number (total_free_markers
));
5099 total
[3] = make_number (total_string_size
);
5100 total
[4] = make_number (total_vector_size
);
5101 total
[5] = Fcons (make_number (total_floats
),
5102 make_number (total_free_floats
));
5103 total
[6] = Fcons (make_number (total_intervals
),
5104 make_number (total_free_intervals
));
5105 total
[7] = Fcons (make_number (total_strings
),
5106 make_number (total_free_strings
));
5108 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5110 /* Compute average percentage of zombies. */
5113 for (i
= 0; i
< 7; ++i
)
5114 if (CONSP (total
[i
]))
5115 nlive
+= XFASTINT (XCAR (total
[i
]));
5117 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5118 max_live
= max (nlive
, max_live
);
5119 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5120 max_zombies
= max (nzombies
, max_zombies
);
5125 if (!NILP (Vpost_gc_hook
))
5127 int count
= inhibit_garbage_collection ();
5128 safe_run_hooks (Qpost_gc_hook
);
5129 unbind_to (count
, Qnil
);
5132 /* Accumulate statistics. */
5133 EMACS_GET_TIME (t2
);
5134 EMACS_SUB_TIME (t3
, t2
, t1
);
5135 if (FLOATP (Vgc_elapsed
))
5136 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
) +
5138 EMACS_USECS (t3
) * 1.0e-6);
5141 return Flist (sizeof total
/ sizeof *total
, total
);
5145 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5146 only interesting objects referenced from glyphs are strings. */
5149 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5151 struct glyph_row
*row
= matrix
->rows
;
5152 struct glyph_row
*end
= row
+ matrix
->nrows
;
5154 for (; row
< end
; ++row
)
5158 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5160 struct glyph
*glyph
= row
->glyphs
[area
];
5161 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5163 for (; glyph
< end_glyph
; ++glyph
)
5164 if (STRINGP (glyph
->object
)
5165 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5166 mark_object (glyph
->object
);
5172 /* Mark Lisp faces in the face cache C. */
5175 mark_face_cache (struct face_cache
*c
)
5180 for (i
= 0; i
< c
->used
; ++i
)
5182 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5186 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5187 mark_object (face
->lface
[j
]);
5195 /* Mark reference to a Lisp_Object.
5196 If the object referred to has not been seen yet, recursively mark
5197 all the references contained in it. */
5199 #define LAST_MARKED_SIZE 500
5200 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5201 int last_marked_index
;
5203 /* For debugging--call abort when we cdr down this many
5204 links of a list, in mark_object. In debugging,
5205 the call to abort will hit a breakpoint.
5206 Normally this is zero and the check never goes off. */
5207 static int mark_object_loop_halt
;
5210 mark_vectorlike (struct Lisp_Vector
*ptr
)
5212 register EMACS_UINT size
= ptr
->size
;
5213 register EMACS_UINT i
;
5215 eassert (!VECTOR_MARKED_P (ptr
));
5216 VECTOR_MARK (ptr
); /* Else mark it */
5217 if (size
& PSEUDOVECTOR_FLAG
)
5218 size
&= PSEUDOVECTOR_SIZE_MASK
;
5220 /* Note that this size is not the memory-footprint size, but only
5221 the number of Lisp_Object fields that we should trace.
5222 The distinction is used e.g. by Lisp_Process which places extra
5223 non-Lisp_Object fields at the end of the structure. */
5224 for (i
= 0; i
< size
; i
++) /* and then mark its elements */
5225 mark_object (ptr
->contents
[i
]);
5228 /* Like mark_vectorlike but optimized for char-tables (and
5229 sub-char-tables) assuming that the contents are mostly integers or
5233 mark_char_table (struct Lisp_Vector
*ptr
)
5235 register EMACS_UINT size
= ptr
->size
& PSEUDOVECTOR_SIZE_MASK
;
5236 register EMACS_UINT i
;
5238 eassert (!VECTOR_MARKED_P (ptr
));
5240 for (i
= 0; i
< size
; i
++)
5242 Lisp_Object val
= ptr
->contents
[i
];
5244 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5246 if (SUB_CHAR_TABLE_P (val
))
5248 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5249 mark_char_table (XVECTOR (val
));
5257 mark_object (Lisp_Object arg
)
5259 register Lisp_Object obj
= arg
;
5260 #ifdef GC_CHECK_MARKED_OBJECTS
5268 if (PURE_POINTER_P (XPNTR (obj
)))
5271 last_marked
[last_marked_index
++] = obj
;
5272 if (last_marked_index
== LAST_MARKED_SIZE
)
5273 last_marked_index
= 0;
5275 /* Perform some sanity checks on the objects marked here. Abort if
5276 we encounter an object we know is bogus. This increases GC time
5277 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5278 #ifdef GC_CHECK_MARKED_OBJECTS
5280 po
= (void *) XPNTR (obj
);
5282 /* Check that the object pointed to by PO is known to be a Lisp
5283 structure allocated from the heap. */
5284 #define CHECK_ALLOCATED() \
5286 m = mem_find (po); \
5291 /* Check that the object pointed to by PO is live, using predicate
5293 #define CHECK_LIVE(LIVEP) \
5295 if (!LIVEP (m, po)) \
5299 /* Check both of the above conditions. */
5300 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5302 CHECK_ALLOCATED (); \
5303 CHECK_LIVE (LIVEP); \
5306 #else /* not GC_CHECK_MARKED_OBJECTS */
5308 #define CHECK_ALLOCATED() (void) 0
5309 #define CHECK_LIVE(LIVEP) (void) 0
5310 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5312 #endif /* not GC_CHECK_MARKED_OBJECTS */
5314 switch (SWITCH_ENUM_CAST (XTYPE (obj
)))
5318 register struct Lisp_String
*ptr
= XSTRING (obj
);
5319 if (STRING_MARKED_P (ptr
))
5321 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
5322 MARK_INTERVAL_TREE (ptr
->intervals
);
5324 #ifdef GC_CHECK_STRING_BYTES
5325 /* Check that the string size recorded in the string is the
5326 same as the one recorded in the sdata structure. */
5327 CHECK_STRING_BYTES (ptr
);
5328 #endif /* GC_CHECK_STRING_BYTES */
5332 case Lisp_Vectorlike
:
5333 if (VECTOR_MARKED_P (XVECTOR (obj
)))
5335 #ifdef GC_CHECK_MARKED_OBJECTS
5337 if (m
== MEM_NIL
&& !SUBRP (obj
)
5338 && po
!= &buffer_defaults
5339 && po
!= &buffer_local_symbols
)
5341 #endif /* GC_CHECK_MARKED_OBJECTS */
5345 #ifdef GC_CHECK_MARKED_OBJECTS
5346 if (po
!= &buffer_defaults
&& po
!= &buffer_local_symbols
)
5349 for (b
= all_buffers
; b
&& b
!= po
; b
= b
->next
)
5354 #endif /* GC_CHECK_MARKED_OBJECTS */
5357 else if (SUBRP (obj
))
5359 else if (COMPILEDP (obj
))
5360 /* We could treat this just like a vector, but it is better to
5361 save the COMPILED_CONSTANTS element for last and avoid
5364 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5365 register EMACS_UINT size
= ptr
->size
;
5366 register EMACS_UINT i
;
5368 CHECK_LIVE (live_vector_p
);
5369 VECTOR_MARK (ptr
); /* Else mark it */
5370 size
&= PSEUDOVECTOR_SIZE_MASK
;
5371 for (i
= 0; i
< size
; i
++) /* and then mark its elements */
5373 if (i
!= COMPILED_CONSTANTS
)
5374 mark_object (ptr
->contents
[i
]);
5376 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
5379 else if (FRAMEP (obj
))
5381 register struct frame
*ptr
= XFRAME (obj
);
5382 mark_vectorlike (XVECTOR (obj
));
5383 mark_face_cache (ptr
->face_cache
);
5385 else if (WINDOWP (obj
))
5387 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5388 struct window
*w
= XWINDOW (obj
);
5389 mark_vectorlike (ptr
);
5390 /* Mark glyphs for leaf windows. Marking window matrices is
5391 sufficient because frame matrices use the same glyph
5393 if (NILP (w
->hchild
)
5395 && w
->current_matrix
)
5397 mark_glyph_matrix (w
->current_matrix
);
5398 mark_glyph_matrix (w
->desired_matrix
);
5401 else if (HASH_TABLE_P (obj
))
5403 struct Lisp_Hash_Table
*h
= XHASH_TABLE (obj
);
5404 mark_vectorlike ((struct Lisp_Vector
*)h
);
5405 /* If hash table is not weak, mark all keys and values.
5406 For weak tables, mark only the vector. */
5408 mark_object (h
->key_and_value
);
5410 VECTOR_MARK (XVECTOR (h
->key_and_value
));
5412 else if (CHAR_TABLE_P (obj
))
5413 mark_char_table (XVECTOR (obj
));
5415 mark_vectorlike (XVECTOR (obj
));
5420 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
5421 struct Lisp_Symbol
*ptrx
;
5425 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
5427 mark_object (ptr
->function
);
5428 mark_object (ptr
->plist
);
5429 switch (ptr
->redirect
)
5431 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
5432 case SYMBOL_VARALIAS
:
5435 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
5439 case SYMBOL_LOCALIZED
:
5441 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
5442 /* If the value is forwarded to a buffer or keyboard field,
5443 these are marked when we see the corresponding object.
5444 And if it's forwarded to a C variable, either it's not
5445 a Lisp_Object var, or it's staticpro'd already. */
5446 mark_object (blv
->where
);
5447 mark_object (blv
->valcell
);
5448 mark_object (blv
->defcell
);
5451 case SYMBOL_FORWARDED
:
5452 /* If the value is forwarded to a buffer or keyboard field,
5453 these are marked when we see the corresponding object.
5454 And if it's forwarded to a C variable, either it's not
5455 a Lisp_Object var, or it's staticpro'd already. */
5459 if (!PURE_POINTER_P (XSTRING (ptr
->xname
)))
5460 MARK_STRING (XSTRING (ptr
->xname
));
5461 MARK_INTERVAL_TREE (STRING_INTERVALS (ptr
->xname
));
5466 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun */
5467 XSETSYMBOL (obj
, ptrx
);
5474 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
5475 if (XMISCANY (obj
)->gcmarkbit
)
5477 XMISCANY (obj
)->gcmarkbit
= 1;
5479 switch (XMISCTYPE (obj
))
5482 case Lisp_Misc_Marker
:
5483 /* DO NOT mark thru the marker's chain.
5484 The buffer's markers chain does not preserve markers from gc;
5485 instead, markers are removed from the chain when freed by gc. */
5488 case Lisp_Misc_Save_Value
:
5491 register struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
5492 /* If DOGC is set, POINTER is the address of a memory
5493 area containing INTEGER potential Lisp_Objects. */
5496 Lisp_Object
*p
= (Lisp_Object
*) ptr
->pointer
;
5498 for (nelt
= ptr
->integer
; nelt
> 0; nelt
--, p
++)
5499 mark_maybe_object (*p
);
5505 case Lisp_Misc_Overlay
:
5507 struct Lisp_Overlay
*ptr
= XOVERLAY (obj
);
5508 mark_object (ptr
->start
);
5509 mark_object (ptr
->end
);
5510 mark_object (ptr
->plist
);
5513 XSETMISC (obj
, ptr
->next
);
5526 register struct Lisp_Cons
*ptr
= XCONS (obj
);
5527 if (CONS_MARKED_P (ptr
))
5529 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
5531 /* If the cdr is nil, avoid recursion for the car. */
5532 if (EQ (ptr
->u
.cdr
, Qnil
))
5538 mark_object (ptr
->car
);
5541 if (cdr_count
== mark_object_loop_halt
)
5547 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
5548 FLOAT_MARK (XFLOAT (obj
));
5559 #undef CHECK_ALLOCATED
5560 #undef CHECK_ALLOCATED_AND_LIVE
5563 /* Mark the pointers in a buffer structure. */
5566 mark_buffer (Lisp_Object buf
)
5568 register struct buffer
*buffer
= XBUFFER (buf
);
5569 register Lisp_Object
*ptr
, tmp
;
5570 Lisp_Object base_buffer
;
5572 eassert (!VECTOR_MARKED_P (buffer
));
5573 VECTOR_MARK (buffer
);
5575 MARK_INTERVAL_TREE (BUF_INTERVALS (buffer
));
5577 /* For now, we just don't mark the undo_list. It's done later in
5578 a special way just before the sweep phase, and after stripping
5579 some of its elements that are not needed any more. */
5581 if (buffer
->overlays_before
)
5583 XSETMISC (tmp
, buffer
->overlays_before
);
5586 if (buffer
->overlays_after
)
5588 XSETMISC (tmp
, buffer
->overlays_after
);
5592 /* buffer-local Lisp variables start at `undo_list',
5593 tho only the ones from `name' on are GC'd normally. */
5594 for (ptr
= &buffer
->BUFFER_INTERNAL_FIELD (name
);
5595 (char *)ptr
< (char *)buffer
+ sizeof (struct buffer
);
5599 /* If this is an indirect buffer, mark its base buffer. */
5600 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5602 XSETBUFFER (base_buffer
, buffer
->base_buffer
);
5603 mark_buffer (base_buffer
);
5607 /* Mark the Lisp pointers in the terminal objects.
5608 Called by the Fgarbage_collector. */
5611 mark_terminals (void)
5614 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5616 eassert (t
->name
!= NULL
);
5617 #ifdef HAVE_WINDOW_SYSTEM
5618 /* If a terminal object is reachable from a stacpro'ed object,
5619 it might have been marked already. Make sure the image cache
5621 mark_image_cache (t
->image_cache
);
5622 #endif /* HAVE_WINDOW_SYSTEM */
5623 if (!VECTOR_MARKED_P (t
))
5624 mark_vectorlike ((struct Lisp_Vector
*)t
);
5630 /* Value is non-zero if OBJ will survive the current GC because it's
5631 either marked or does not need to be marked to survive. */
5634 survives_gc_p (Lisp_Object obj
)
5638 switch (XTYPE (obj
))
5645 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
5649 survives_p
= XMISCANY (obj
)->gcmarkbit
;
5653 survives_p
= STRING_MARKED_P (XSTRING (obj
));
5656 case Lisp_Vectorlike
:
5657 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
5661 survives_p
= CONS_MARKED_P (XCONS (obj
));
5665 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
5672 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
5677 /* Sweep: find all structures not marked, and free them. */
5682 /* Remove or mark entries in weak hash tables.
5683 This must be done before any object is unmarked. */
5684 sweep_weak_hash_tables ();
5687 #ifdef GC_CHECK_STRING_BYTES
5688 if (!noninteractive
)
5689 check_string_bytes (1);
5692 /* Put all unmarked conses on free list */
5694 register struct cons_block
*cblk
;
5695 struct cons_block
**cprev
= &cons_block
;
5696 register int lim
= cons_block_index
;
5697 register int num_free
= 0, num_used
= 0;
5701 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
5705 int ilim
= (lim
+ BITS_PER_INT
- 1) / BITS_PER_INT
;
5707 /* Scan the mark bits an int at a time. */
5708 for (i
= 0; i
<= ilim
; i
++)
5710 if (cblk
->gcmarkbits
[i
] == -1)
5712 /* Fast path - all cons cells for this int are marked. */
5713 cblk
->gcmarkbits
[i
] = 0;
5714 num_used
+= BITS_PER_INT
;
5718 /* Some cons cells for this int are not marked.
5719 Find which ones, and free them. */
5720 int start
, pos
, stop
;
5722 start
= i
* BITS_PER_INT
;
5724 if (stop
> BITS_PER_INT
)
5725 stop
= BITS_PER_INT
;
5728 for (pos
= start
; pos
< stop
; pos
++)
5730 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
5733 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
5734 cons_free_list
= &cblk
->conses
[pos
];
5736 cons_free_list
->car
= Vdead
;
5742 CONS_UNMARK (&cblk
->conses
[pos
]);
5748 lim
= CONS_BLOCK_SIZE
;
5749 /* If this block contains only free conses and we have already
5750 seen more than two blocks worth of free conses then deallocate
5752 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
5754 *cprev
= cblk
->next
;
5755 /* Unhook from the free list. */
5756 cons_free_list
= cblk
->conses
[0].u
.chain
;
5757 lisp_align_free (cblk
);
5762 num_free
+= this_free
;
5763 cprev
= &cblk
->next
;
5766 total_conses
= num_used
;
5767 total_free_conses
= num_free
;
5770 /* Put all unmarked floats on free list */
5772 register struct float_block
*fblk
;
5773 struct float_block
**fprev
= &float_block
;
5774 register int lim
= float_block_index
;
5775 register int num_free
= 0, num_used
= 0;
5777 float_free_list
= 0;
5779 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
5783 for (i
= 0; i
< lim
; i
++)
5784 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
5787 fblk
->floats
[i
].u
.chain
= float_free_list
;
5788 float_free_list
= &fblk
->floats
[i
];
5793 FLOAT_UNMARK (&fblk
->floats
[i
]);
5795 lim
= FLOAT_BLOCK_SIZE
;
5796 /* If this block contains only free floats and we have already
5797 seen more than two blocks worth of free floats then deallocate
5799 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
5801 *fprev
= fblk
->next
;
5802 /* Unhook from the free list. */
5803 float_free_list
= fblk
->floats
[0].u
.chain
;
5804 lisp_align_free (fblk
);
5809 num_free
+= this_free
;
5810 fprev
= &fblk
->next
;
5813 total_floats
= num_used
;
5814 total_free_floats
= num_free
;
5817 /* Put all unmarked intervals on free list */
5819 register struct interval_block
*iblk
;
5820 struct interval_block
**iprev
= &interval_block
;
5821 register int lim
= interval_block_index
;
5822 register int num_free
= 0, num_used
= 0;
5824 interval_free_list
= 0;
5826 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
5831 for (i
= 0; i
< lim
; i
++)
5833 if (!iblk
->intervals
[i
].gcmarkbit
)
5835 SET_INTERVAL_PARENT (&iblk
->intervals
[i
], interval_free_list
);
5836 interval_free_list
= &iblk
->intervals
[i
];
5842 iblk
->intervals
[i
].gcmarkbit
= 0;
5845 lim
= INTERVAL_BLOCK_SIZE
;
5846 /* If this block contains only free intervals and we have already
5847 seen more than two blocks worth of free intervals then
5848 deallocate this block. */
5849 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
5851 *iprev
= iblk
->next
;
5852 /* Unhook from the free list. */
5853 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
5855 n_interval_blocks
--;
5859 num_free
+= this_free
;
5860 iprev
= &iblk
->next
;
5863 total_intervals
= num_used
;
5864 total_free_intervals
= num_free
;
5867 /* Put all unmarked symbols on free list */
5869 register struct symbol_block
*sblk
;
5870 struct symbol_block
**sprev
= &symbol_block
;
5871 register int lim
= symbol_block_index
;
5872 register int num_free
= 0, num_used
= 0;
5874 symbol_free_list
= NULL
;
5876 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
5879 struct Lisp_Symbol
*sym
= sblk
->symbols
;
5880 struct Lisp_Symbol
*end
= sym
+ lim
;
5882 for (; sym
< end
; ++sym
)
5884 /* Check if the symbol was created during loadup. In such a case
5885 it might be pointed to by pure bytecode which we don't trace,
5886 so we conservatively assume that it is live. */
5887 int pure_p
= PURE_POINTER_P (XSTRING (sym
->xname
));
5889 if (!sym
->gcmarkbit
&& !pure_p
)
5891 if (sym
->redirect
== SYMBOL_LOCALIZED
)
5892 xfree (SYMBOL_BLV (sym
));
5893 sym
->next
= symbol_free_list
;
5894 symbol_free_list
= sym
;
5896 symbol_free_list
->function
= Vdead
;
5904 UNMARK_STRING (XSTRING (sym
->xname
));
5909 lim
= SYMBOL_BLOCK_SIZE
;
5910 /* If this block contains only free symbols and we have already
5911 seen more than two blocks worth of free symbols then deallocate
5913 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
5915 *sprev
= sblk
->next
;
5916 /* Unhook from the free list. */
5917 symbol_free_list
= sblk
->symbols
[0].next
;
5923 num_free
+= this_free
;
5924 sprev
= &sblk
->next
;
5927 total_symbols
= num_used
;
5928 total_free_symbols
= num_free
;
5931 /* Put all unmarked misc's on free list.
5932 For a marker, first unchain it from the buffer it points into. */
5934 register struct marker_block
*mblk
;
5935 struct marker_block
**mprev
= &marker_block
;
5936 register int lim
= marker_block_index
;
5937 register int num_free
= 0, num_used
= 0;
5939 marker_free_list
= 0;
5941 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
5946 for (i
= 0; i
< lim
; i
++)
5948 if (!mblk
->markers
[i
].u_any
.gcmarkbit
)
5950 if (mblk
->markers
[i
].u_any
.type
== Lisp_Misc_Marker
)
5951 unchain_marker (&mblk
->markers
[i
].u_marker
);
5952 /* Set the type of the freed object to Lisp_Misc_Free.
5953 We could leave the type alone, since nobody checks it,
5954 but this might catch bugs faster. */
5955 mblk
->markers
[i
].u_marker
.type
= Lisp_Misc_Free
;
5956 mblk
->markers
[i
].u_free
.chain
= marker_free_list
;
5957 marker_free_list
= &mblk
->markers
[i
];
5963 mblk
->markers
[i
].u_any
.gcmarkbit
= 0;
5966 lim
= MARKER_BLOCK_SIZE
;
5967 /* If this block contains only free markers and we have already
5968 seen more than two blocks worth of free markers then deallocate
5970 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
5972 *mprev
= mblk
->next
;
5973 /* Unhook from the free list. */
5974 marker_free_list
= mblk
->markers
[0].u_free
.chain
;
5980 num_free
+= this_free
;
5981 mprev
= &mblk
->next
;
5985 total_markers
= num_used
;
5986 total_free_markers
= num_free
;
5989 /* Free all unmarked buffers */
5991 register struct buffer
*buffer
= all_buffers
, *prev
= 0, *next
;
5994 if (!VECTOR_MARKED_P (buffer
))
5997 prev
->next
= buffer
->next
;
5999 all_buffers
= buffer
->next
;
6000 next
= buffer
->next
;
6006 VECTOR_UNMARK (buffer
);
6007 UNMARK_BALANCE_INTERVALS (BUF_INTERVALS (buffer
));
6008 prev
= buffer
, buffer
= buffer
->next
;
6012 /* Free all unmarked vectors */
6014 register struct Lisp_Vector
*vector
= all_vectors
, *prev
= 0, *next
;
6015 total_vector_size
= 0;
6018 if (!VECTOR_MARKED_P (vector
))
6021 prev
->next
= vector
->next
;
6023 all_vectors
= vector
->next
;
6024 next
= vector
->next
;
6032 VECTOR_UNMARK (vector
);
6033 if (vector
->size
& PSEUDOVECTOR_FLAG
)
6034 total_vector_size
+= (PSEUDOVECTOR_SIZE_MASK
& vector
->size
);
6036 total_vector_size
+= vector
->size
;
6037 prev
= vector
, vector
= vector
->next
;
6041 #ifdef GC_CHECK_STRING_BYTES
6042 if (!noninteractive
)
6043 check_string_bytes (1);
6050 /* Debugging aids. */
6052 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6053 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6054 This may be helpful in debugging Emacs's memory usage.
6055 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6060 XSETINT (end
, (EMACS_INT
) sbrk (0) / 1024);
6065 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6066 doc
: /* Return a list of counters that measure how much consing there has been.
6067 Each of these counters increments for a certain kind of object.
6068 The counters wrap around from the largest positive integer to zero.
6069 Garbage collection does not decrease them.
6070 The elements of the value are as follows:
6071 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6072 All are in units of 1 = one object consed
6073 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6075 MISCS include overlays, markers, and some internal types.
6076 Frames, windows, buffers, and subprocesses count as vectors
6077 (but the contents of a buffer's text do not count here). */)
6080 Lisp_Object consed
[8];
6082 consed
[0] = make_number (min (MOST_POSITIVE_FIXNUM
, cons_cells_consed
));
6083 consed
[1] = make_number (min (MOST_POSITIVE_FIXNUM
, floats_consed
));
6084 consed
[2] = make_number (min (MOST_POSITIVE_FIXNUM
, vector_cells_consed
));
6085 consed
[3] = make_number (min (MOST_POSITIVE_FIXNUM
, symbols_consed
));
6086 consed
[4] = make_number (min (MOST_POSITIVE_FIXNUM
, string_chars_consed
));
6087 consed
[5] = make_number (min (MOST_POSITIVE_FIXNUM
, misc_objects_consed
));
6088 consed
[6] = make_number (min (MOST_POSITIVE_FIXNUM
, intervals_consed
));
6089 consed
[7] = make_number (min (MOST_POSITIVE_FIXNUM
, strings_consed
));
6091 return Flist (8, consed
);
6094 int suppress_checking
;
6097 die (const char *msg
, const char *file
, int line
)
6099 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: %s\r\n",
6104 /* Initialization */
6107 init_alloc_once (void)
6109 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6111 pure_size
= PURESIZE
;
6112 pure_bytes_used
= 0;
6113 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
6114 pure_bytes_used_before_overflow
= 0;
6116 /* Initialize the list of free aligned blocks. */
6119 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6121 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6125 ignore_warnings
= 1;
6126 #ifdef DOUG_LEA_MALLOC
6127 mallopt (M_TRIM_THRESHOLD
, 128*1024); /* trim threshold */
6128 mallopt (M_MMAP_THRESHOLD
, 64*1024); /* mmap threshold */
6129 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* max. number of mmap'ed areas */
6137 init_weak_hash_tables ();
6140 malloc_hysteresis
= 32;
6142 malloc_hysteresis
= 0;
6145 refill_memory_reserve ();
6147 ignore_warnings
= 0;
6149 byte_stack_list
= 0;
6151 consing_since_gc
= 0;
6152 gc_cons_threshold
= 100000 * sizeof (Lisp_Object
);
6153 gc_relative_threshold
= 0;
6160 byte_stack_list
= 0;
6162 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6163 setjmp_tested_p
= longjmps_done
= 0;
6166 Vgc_elapsed
= make_float (0.0);
6171 syms_of_alloc (void)
6173 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6174 doc
: /* *Number of bytes of consing between garbage collections.
6175 Garbage collection can happen automatically once this many bytes have been
6176 allocated since the last garbage collection. All data types count.
6178 Garbage collection happens automatically only when `eval' is called.
6180 By binding this temporarily to a large number, you can effectively
6181 prevent garbage collection during a part of the program.
6182 See also `gc-cons-percentage'. */);
6184 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6185 doc
: /* *Portion of the heap used for allocation.
6186 Garbage collection can happen automatically once this portion of the heap
6187 has been allocated since the last garbage collection.
6188 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6189 Vgc_cons_percentage
= make_float (0.1);
6191 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6192 doc
: /* Number of bytes of sharable Lisp data allocated so far. */);
6194 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6195 doc
: /* Number of cons cells that have been consed so far. */);
6197 DEFVAR_INT ("floats-consed", floats_consed
,
6198 doc
: /* Number of floats that have been consed so far. */);
6200 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
6201 doc
: /* Number of vector cells that have been consed so far. */);
6203 DEFVAR_INT ("symbols-consed", symbols_consed
,
6204 doc
: /* Number of symbols that have been consed so far. */);
6206 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
6207 doc
: /* Number of string characters that have been consed so far. */);
6209 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
6210 doc
: /* Number of miscellaneous objects that have been consed so far. */);
6212 DEFVAR_INT ("intervals-consed", intervals_consed
,
6213 doc
: /* Number of intervals that have been consed so far. */);
6215 DEFVAR_INT ("strings-consed", strings_consed
,
6216 doc
: /* Number of strings that have been consed so far. */);
6218 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
6219 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
6220 This means that certain objects should be allocated in shared (pure) space.
6221 It can also be set to a hash-table, in which case this table is used to
6222 do hash-consing of the objects allocated to pure space. */);
6224 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
6225 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
6226 garbage_collection_messages
= 0;
6228 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
6229 doc
: /* Hook run after garbage collection has finished. */);
6230 Vpost_gc_hook
= Qnil
;
6231 Qpost_gc_hook
= intern_c_string ("post-gc-hook");
6232 staticpro (&Qpost_gc_hook
);
6234 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
6235 doc
: /* Precomputed `signal' argument for memory-full error. */);
6236 /* We build this in advance because if we wait until we need it, we might
6237 not be able to allocate the memory to hold it. */
6239 = pure_cons (Qerror
,
6240 pure_cons (make_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"), Qnil
));
6242 DEFVAR_LISP ("memory-full", Vmemory_full
,
6243 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
6244 Vmemory_full
= Qnil
;
6246 staticpro (&Qgc_cons_threshold
);
6247 Qgc_cons_threshold
= intern_c_string ("gc-cons-threshold");
6249 staticpro (&Qchar_table_extra_slots
);
6250 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
6252 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
6253 doc
: /* Accumulated time elapsed in garbage collections.
6254 The time is in seconds as a floating point value. */);
6255 DEFVAR_INT ("gcs-done", gcs_done
,
6256 doc
: /* Accumulated number of garbage collections done. */);
6261 defsubr (&Smake_byte_code
);
6262 defsubr (&Smake_list
);
6263 defsubr (&Smake_vector
);
6264 defsubr (&Smake_string
);
6265 defsubr (&Smake_bool_vector
);
6266 defsubr (&Smake_symbol
);
6267 defsubr (&Smake_marker
);
6268 defsubr (&Spurecopy
);
6269 defsubr (&Sgarbage_collect
);
6270 defsubr (&Smemory_limit
);
6271 defsubr (&Smemory_use_counts
);
6273 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
6274 defsubr (&Sgc_status
);