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. */
27 #ifdef HAVE_GTK_AND_PTHREAD
31 /* This file is part of the core Lisp implementation, and thus must
32 deal with the real data structures. If the Lisp implementation is
33 replaced, this file likely will not be used. */
35 #undef HIDE_LISP_IMPLEMENTATION
38 #include "intervals.h"
44 #include "blockinput.h"
45 #include "character.h"
46 #include "syssignal.h"
47 #include "termhooks.h" /* For struct terminal. */
50 /* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
51 memory. Can do this only if using gmalloc.c. */
53 #if defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC
54 #undef GC_MALLOC_CHECK
59 extern POINTER_TYPE
*sbrk ();
68 #ifdef DOUG_LEA_MALLOC
71 /* malloc.h #defines this as size_t, at least in glibc2. */
72 #ifndef __malloc_size_t
73 #define __malloc_size_t int
76 /* Specify maximum number of areas to mmap. It would be nice to use a
77 value that explicitly means "no limit". */
79 #define MMAP_MAX_AREAS 100000000
81 #else /* not DOUG_LEA_MALLOC */
83 /* The following come from gmalloc.c. */
85 #define __malloc_size_t size_t
86 extern __malloc_size_t _bytes_used
;
87 extern __malloc_size_t __malloc_extra_blocks
;
89 #endif /* not DOUG_LEA_MALLOC */
91 #if ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT
92 #ifdef HAVE_GTK_AND_PTHREAD
94 /* When GTK uses the file chooser dialog, different backends can be loaded
95 dynamically. One such a backend is the Gnome VFS backend that gets loaded
96 if you run Gnome. That backend creates several threads and also allocates
99 If Emacs sets malloc hooks (! SYSTEM_MALLOC) and the emacs_blocked_*
100 functions below are called from malloc, there is a chance that one
101 of these threads preempts the Emacs main thread and the hook variables
102 end up in an inconsistent state. So we have a mutex to prevent that (note
103 that the backend handles concurrent access to malloc within its own threads
104 but Emacs code running in the main thread is not included in that control).
106 When UNBLOCK_INPUT is called, reinvoke_input_signal may be called. If this
107 happens in one of the backend threads we will have two threads that tries
108 to run Emacs code at once, and the code is not prepared for that.
109 To prevent that, we only call BLOCK/UNBLOCK from the main thread. */
111 static pthread_mutex_t alloc_mutex
;
113 #define BLOCK_INPUT_ALLOC \
116 if (pthread_equal (pthread_self (), main_thread)) \
118 pthread_mutex_lock (&alloc_mutex); \
121 #define UNBLOCK_INPUT_ALLOC \
124 pthread_mutex_unlock (&alloc_mutex); \
125 if (pthread_equal (pthread_self (), main_thread)) \
130 #else /* ! defined HAVE_GTK_AND_PTHREAD */
132 #define BLOCK_INPUT_ALLOC BLOCK_INPUT
133 #define UNBLOCK_INPUT_ALLOC UNBLOCK_INPUT
135 #endif /* ! defined HAVE_GTK_AND_PTHREAD */
136 #endif /* ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT */
138 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
139 to a struct Lisp_String. */
141 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
142 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
143 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
145 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
146 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
147 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
149 /* Value is the number of bytes of S, a pointer to a struct Lisp_String.
150 Be careful during GC, because S->size contains the mark bit for
153 #define GC_STRING_BYTES(S) (STRING_BYTES (S))
155 /* Global variables. */
156 struct emacs_globals globals
;
158 /* Number of bytes of consing done since the last gc. */
160 EMACS_INT consing_since_gc
;
162 /* Similar minimum, computed from Vgc_cons_percentage. */
164 EMACS_INT gc_relative_threshold
;
166 /* Minimum number of bytes of consing since GC before next GC,
167 when memory is full. */
169 EMACS_INT memory_full_cons_threshold
;
171 /* Nonzero during GC. */
175 /* Nonzero means abort if try to GC.
176 This is for code which is written on the assumption that
177 no GC will happen, so as to verify that assumption. */
181 /* Number of live and free conses etc. */
183 static int total_conses
, total_markers
, total_symbols
, total_vector_size
;
184 static int total_free_conses
, total_free_markers
, total_free_symbols
;
185 static int total_free_floats
, total_floats
;
187 /* Points to memory space allocated as "spare", to be freed if we run
188 out of memory. We keep one large block, four cons-blocks, and
189 two string blocks. */
191 static char *spare_memory
[7];
193 /* Amount of spare memory to keep in large reserve block, or to see
194 whether this much is available when malloc fails on a larger request. */
196 #define SPARE_MEMORY (1 << 14)
198 /* Number of extra blocks malloc should get when it needs more core. */
200 static int malloc_hysteresis
;
202 /* Initialize it to a nonzero value to force it into data space
203 (rather than bss space). That way unexec will remap it into text
204 space (pure), on some systems. We have not implemented the
205 remapping on more recent systems because this is less important
206 nowadays than in the days of small memories and timesharing. */
208 #ifndef VIRT_ADDR_VARIES
211 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
212 #define PUREBEG (char *) pure
214 /* Pointer to the pure area, and its size. */
216 static char *purebeg
;
217 static size_t pure_size
;
219 /* Number of bytes of pure storage used before pure storage overflowed.
220 If this is non-zero, this implies that an overflow occurred. */
222 static size_t pure_bytes_used_before_overflow
;
224 /* Value is non-zero if P points into pure space. */
226 #define PURE_POINTER_P(P) \
227 (((PNTR_COMPARISON_TYPE) (P) \
228 < (PNTR_COMPARISON_TYPE) ((char *) purebeg + pure_size)) \
229 && ((PNTR_COMPARISON_TYPE) (P) \
230 >= (PNTR_COMPARISON_TYPE) purebeg))
232 /* Index in pure at which next pure Lisp object will be allocated.. */
234 static EMACS_INT pure_bytes_used_lisp
;
236 /* Number of bytes allocated for non-Lisp objects in pure storage. */
238 static EMACS_INT pure_bytes_used_non_lisp
;
240 /* If nonzero, this is a warning delivered by malloc and not yet
243 const char *pending_malloc_warning
;
245 /* Maximum amount of C stack to save when a GC happens. */
247 #ifndef MAX_SAVE_STACK
248 #define MAX_SAVE_STACK 16000
251 /* Buffer in which we save a copy of the C stack at each GC. */
253 #if MAX_SAVE_STACK > 0
254 static char *stack_copy
;
255 static size_t stack_copy_size
;
258 /* Non-zero means ignore malloc warnings. Set during initialization.
259 Currently not used. */
261 static int ignore_warnings
;
263 static Lisp_Object Qgc_cons_threshold
;
264 Lisp_Object Qchar_table_extra_slots
;
266 /* Hook run after GC has finished. */
268 static Lisp_Object Qpost_gc_hook
;
270 static void mark_buffer (Lisp_Object
);
271 static void mark_terminals (void);
272 static void gc_sweep (void);
273 static void mark_glyph_matrix (struct glyph_matrix
*);
274 static void mark_face_cache (struct face_cache
*);
276 #if !defined REL_ALLOC || defined SYSTEM_MALLOC
277 static void refill_memory_reserve (void);
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);
283 static void free_misc (Lisp_Object
);
285 /* When scanning the C stack for live Lisp objects, Emacs keeps track
286 of what memory allocated via lisp_malloc is intended for what
287 purpose. This enumeration specifies the type of memory. */
298 /* We used to keep separate mem_types for subtypes of vectors such as
299 process, hash_table, frame, terminal, and window, but we never made
300 use of the distinction, so it only caused source-code complexity
301 and runtime slowdown. Minor but pointless. */
305 static POINTER_TYPE
*lisp_align_malloc (size_t, enum mem_type
);
306 static POINTER_TYPE
*lisp_malloc (size_t, enum mem_type
);
309 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
311 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
312 #include <stdio.h> /* For fprintf. */
315 /* A unique object in pure space used to make some Lisp objects
316 on free lists recognizable in O(1). */
318 static Lisp_Object Vdead
;
320 #ifdef GC_MALLOC_CHECK
322 enum mem_type allocated_mem_type
;
323 static int dont_register_blocks
;
325 #endif /* GC_MALLOC_CHECK */
327 /* A node in the red-black tree describing allocated memory containing
328 Lisp data. Each such block is recorded with its start and end
329 address when it is allocated, and removed from the tree when it
332 A red-black tree is a balanced binary tree with the following
335 1. Every node is either red or black.
336 2. Every leaf is black.
337 3. If a node is red, then both of its children are black.
338 4. Every simple path from a node to a descendant leaf contains
339 the same number of black nodes.
340 5. The root is always black.
342 When nodes are inserted into the tree, or deleted from the tree,
343 the tree is "fixed" so that these properties are always true.
345 A red-black tree with N internal nodes has height at most 2
346 log(N+1). Searches, insertions and deletions are done in O(log N).
347 Please see a text book about data structures for a detailed
348 description of red-black trees. Any book worth its salt should
353 /* Children of this node. These pointers are never NULL. When there
354 is no child, the value is MEM_NIL, which points to a dummy node. */
355 struct mem_node
*left
, *right
;
357 /* The parent of this node. In the root node, this is NULL. */
358 struct mem_node
*parent
;
360 /* Start and end of allocated region. */
364 enum {MEM_BLACK
, MEM_RED
} color
;
370 /* Base address of stack. Set in main. */
372 Lisp_Object
*stack_base
;
374 /* Root of the tree describing allocated Lisp memory. */
376 static struct mem_node
*mem_root
;
378 /* Lowest and highest known address in the heap. */
380 static void *min_heap_address
, *max_heap_address
;
382 /* Sentinel node of the tree. */
384 static struct mem_node mem_z
;
385 #define MEM_NIL &mem_z
387 static struct Lisp_Vector
*allocate_vectorlike (EMACS_INT
);
388 static void lisp_free (POINTER_TYPE
*);
389 static void mark_stack (void);
390 static int live_vector_p (struct mem_node
*, void *);
391 static int live_buffer_p (struct mem_node
*, void *);
392 static int live_string_p (struct mem_node
*, void *);
393 static int live_cons_p (struct mem_node
*, void *);
394 static int live_symbol_p (struct mem_node
*, void *);
395 static int live_float_p (struct mem_node
*, void *);
396 static int live_misc_p (struct mem_node
*, void *);
397 static void mark_maybe_object (Lisp_Object
);
398 static void mark_memory (void *, void *, int);
399 static void mem_init (void);
400 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
401 static void mem_insert_fixup (struct mem_node
*);
402 static void mem_rotate_left (struct mem_node
*);
403 static void mem_rotate_right (struct mem_node
*);
404 static void mem_delete (struct mem_node
*);
405 static void mem_delete_fixup (struct mem_node
*);
406 static inline struct mem_node
*mem_find (void *);
409 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
410 static void check_gcpros (void);
413 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
415 /* Recording what needs to be marked for gc. */
417 struct gcpro
*gcprolist
;
419 /* Addresses of staticpro'd variables. Initialize it to a nonzero
420 value; otherwise some compilers put it into BSS. */
422 #define NSTATICS 0x640
423 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
425 /* Index of next unused slot in staticvec. */
427 static int staticidx
= 0;
429 static POINTER_TYPE
*pure_alloc (size_t, int);
432 /* Value is SZ rounded up to the next multiple of ALIGNMENT.
433 ALIGNMENT must be a power of 2. */
435 #define ALIGN(ptr, ALIGNMENT) \
436 ((POINTER_TYPE *) ((((uintptr_t) (ptr)) + (ALIGNMENT) - 1) \
437 & ~((ALIGNMENT) - 1)))
441 /************************************************************************
443 ************************************************************************/
445 /* Function malloc calls this if it finds we are near exhausting storage. */
448 malloc_warning (const char *str
)
450 pending_malloc_warning
= str
;
454 /* Display an already-pending malloc warning. */
457 display_malloc_warning (void)
459 call3 (intern ("display-warning"),
461 build_string (pending_malloc_warning
),
462 intern ("emergency"));
463 pending_malloc_warning
= 0;
466 /* Called if we can't allocate relocatable space for a buffer. */
469 buffer_memory_full (EMACS_INT nbytes
)
471 /* If buffers use the relocating allocator, no need to free
472 spare_memory, because we may have plenty of malloc space left
473 that we could get, and if we don't, the malloc that fails will
474 itself cause spare_memory to be freed. If buffers don't use the
475 relocating allocator, treat this like any other failing
479 memory_full (nbytes
);
482 /* This used to call error, but if we've run out of memory, we could
483 get infinite recursion trying to build the string. */
484 xsignal (Qnil
, Vmemory_signal_data
);
488 #ifndef XMALLOC_OVERRUN_CHECK
489 #define XMALLOC_OVERRUN_CHECK_SIZE 0
492 /* Check for overrun in malloc'ed buffers by wrapping a 16 byte header
493 and a 16 byte trailer around each block.
495 The header consists of 12 fixed bytes + a 4 byte integer contaning the
496 original block size, while the trailer consists of 16 fixed bytes.
498 The header is used to detect whether this block has been allocated
499 through these functions -- as it seems that some low-level libc
500 functions may bypass the malloc hooks.
504 #define XMALLOC_OVERRUN_CHECK_SIZE 16
506 static char xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
-4] =
507 { 0x9a, 0x9b, 0xae, 0xaf,
508 0xbf, 0xbe, 0xce, 0xcf,
509 0xea, 0xeb, 0xec, 0xed };
511 static char xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
512 { 0xaa, 0xab, 0xac, 0xad,
513 0xba, 0xbb, 0xbc, 0xbd,
514 0xca, 0xcb, 0xcc, 0xcd,
515 0xda, 0xdb, 0xdc, 0xdd };
517 /* Macros to insert and extract the block size in the header. */
519 #define XMALLOC_PUT_SIZE(ptr, size) \
520 (ptr[-1] = (size & 0xff), \
521 ptr[-2] = ((size >> 8) & 0xff), \
522 ptr[-3] = ((size >> 16) & 0xff), \
523 ptr[-4] = ((size >> 24) & 0xff))
525 #define XMALLOC_GET_SIZE(ptr) \
526 (size_t)((unsigned)(ptr[-1]) | \
527 ((unsigned)(ptr[-2]) << 8) | \
528 ((unsigned)(ptr[-3]) << 16) | \
529 ((unsigned)(ptr[-4]) << 24))
532 /* The call depth in overrun_check functions. For example, this might happen:
534 overrun_check_malloc()
535 -> malloc -> (via hook)_-> emacs_blocked_malloc
536 -> overrun_check_malloc
537 call malloc (hooks are NULL, so real malloc is called).
538 malloc returns 10000.
539 add overhead, return 10016.
540 <- (back in overrun_check_malloc)
541 add overhead again, return 10032
542 xmalloc returns 10032.
547 overrun_check_free(10032)
549 free(10016) <- crash, because 10000 is the original pointer. */
551 static int check_depth
;
553 /* Like malloc, but wraps allocated block with header and trailer. */
555 static POINTER_TYPE
*
556 overrun_check_malloc (size_t size
)
558 register unsigned char *val
;
559 size_t overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_SIZE
*2 : 0;
561 val
= (unsigned char *) malloc (size
+ overhead
);
562 if (val
&& check_depth
== 1)
564 memcpy (val
, xmalloc_overrun_check_header
,
565 XMALLOC_OVERRUN_CHECK_SIZE
- 4);
566 val
+= XMALLOC_OVERRUN_CHECK_SIZE
;
567 XMALLOC_PUT_SIZE(val
, size
);
568 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
569 XMALLOC_OVERRUN_CHECK_SIZE
);
572 return (POINTER_TYPE
*)val
;
576 /* Like realloc, but checks old block for overrun, and wraps new block
577 with header and trailer. */
579 static POINTER_TYPE
*
580 overrun_check_realloc (POINTER_TYPE
*block
, size_t size
)
582 register unsigned char *val
= (unsigned char *) block
;
583 size_t overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_SIZE
*2 : 0;
587 && memcmp (xmalloc_overrun_check_header
,
588 val
- XMALLOC_OVERRUN_CHECK_SIZE
,
589 XMALLOC_OVERRUN_CHECK_SIZE
- 4) == 0)
591 size_t osize
= XMALLOC_GET_SIZE (val
);
592 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
593 XMALLOC_OVERRUN_CHECK_SIZE
))
595 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
596 val
-= XMALLOC_OVERRUN_CHECK_SIZE
;
597 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
600 val
= (unsigned char *) realloc ((POINTER_TYPE
*)val
, size
+ overhead
);
602 if (val
&& check_depth
== 1)
604 memcpy (val
, xmalloc_overrun_check_header
,
605 XMALLOC_OVERRUN_CHECK_SIZE
- 4);
606 val
+= XMALLOC_OVERRUN_CHECK_SIZE
;
607 XMALLOC_PUT_SIZE(val
, size
);
608 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
609 XMALLOC_OVERRUN_CHECK_SIZE
);
612 return (POINTER_TYPE
*)val
;
615 /* Like free, but checks block for overrun. */
618 overrun_check_free (POINTER_TYPE
*block
)
620 unsigned char *val
= (unsigned char *) block
;
625 && memcmp (xmalloc_overrun_check_header
,
626 val
- XMALLOC_OVERRUN_CHECK_SIZE
,
627 XMALLOC_OVERRUN_CHECK_SIZE
- 4) == 0)
629 size_t osize
= XMALLOC_GET_SIZE (val
);
630 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
631 XMALLOC_OVERRUN_CHECK_SIZE
))
633 #ifdef XMALLOC_CLEAR_FREE_MEMORY
634 val
-= XMALLOC_OVERRUN_CHECK_SIZE
;
635 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_SIZE
*2);
637 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
638 val
-= XMALLOC_OVERRUN_CHECK_SIZE
;
639 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
650 #define malloc overrun_check_malloc
651 #define realloc overrun_check_realloc
652 #define free overrun_check_free
656 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
657 there's no need to block input around malloc. */
658 #define MALLOC_BLOCK_INPUT ((void)0)
659 #define MALLOC_UNBLOCK_INPUT ((void)0)
661 #define MALLOC_BLOCK_INPUT BLOCK_INPUT
662 #define MALLOC_UNBLOCK_INPUT UNBLOCK_INPUT
665 /* Like malloc but check for no memory and block interrupt input.. */
668 xmalloc (size_t size
)
670 register POINTER_TYPE
*val
;
673 val
= (POINTER_TYPE
*) malloc (size
);
674 MALLOC_UNBLOCK_INPUT
;
682 /* Like realloc but check for no memory and block interrupt input.. */
685 xrealloc (POINTER_TYPE
*block
, size_t size
)
687 register POINTER_TYPE
*val
;
690 /* We must call malloc explicitly when BLOCK is 0, since some
691 reallocs don't do this. */
693 val
= (POINTER_TYPE
*) malloc (size
);
695 val
= (POINTER_TYPE
*) realloc (block
, size
);
696 MALLOC_UNBLOCK_INPUT
;
704 /* Like free but block interrupt input. */
707 xfree (POINTER_TYPE
*block
)
713 MALLOC_UNBLOCK_INPUT
;
714 /* We don't call refill_memory_reserve here
715 because that duplicates doing so in emacs_blocked_free
716 and the criterion should go there. */
720 /* Like strdup, but uses xmalloc. */
723 xstrdup (const char *s
)
725 size_t len
= strlen (s
) + 1;
726 char *p
= (char *) xmalloc (len
);
732 /* Unwind for SAFE_ALLOCA */
735 safe_alloca_unwind (Lisp_Object arg
)
737 register struct Lisp_Save_Value
*p
= XSAVE_VALUE (arg
);
747 /* Like malloc but used for allocating Lisp data. NBYTES is the
748 number of bytes to allocate, TYPE describes the intended use of the
749 allcated memory block (for strings, for conses, ...). */
752 static void *lisp_malloc_loser
;
755 static POINTER_TYPE
*
756 lisp_malloc (size_t nbytes
, enum mem_type type
)
762 #ifdef GC_MALLOC_CHECK
763 allocated_mem_type
= type
;
766 val
= (void *) malloc (nbytes
);
769 /* If the memory just allocated cannot be addressed thru a Lisp
770 object's pointer, and it needs to be,
771 that's equivalent to running out of memory. */
772 if (val
&& type
!= MEM_TYPE_NON_LISP
)
775 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
776 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
778 lisp_malloc_loser
= val
;
785 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
786 if (val
&& type
!= MEM_TYPE_NON_LISP
)
787 mem_insert (val
, (char *) val
+ nbytes
, type
);
790 MALLOC_UNBLOCK_INPUT
;
792 memory_full (nbytes
);
796 /* Free BLOCK. This must be called to free memory allocated with a
797 call to lisp_malloc. */
800 lisp_free (POINTER_TYPE
*block
)
804 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
805 mem_delete (mem_find (block
));
807 MALLOC_UNBLOCK_INPUT
;
810 /* Allocation of aligned blocks of memory to store Lisp data. */
811 /* The entry point is lisp_align_malloc which returns blocks of at most */
812 /* BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
814 /* Use posix_memalloc if the system has it and we're using the system's
815 malloc (because our gmalloc.c routines don't have posix_memalign although
816 its memalloc could be used). */
817 #if defined (HAVE_POSIX_MEMALIGN) && defined (SYSTEM_MALLOC)
818 #define USE_POSIX_MEMALIGN 1
821 /* BLOCK_ALIGN has to be a power of 2. */
822 #define BLOCK_ALIGN (1 << 10)
824 /* Padding to leave at the end of a malloc'd block. This is to give
825 malloc a chance to minimize the amount of memory wasted to alignment.
826 It should be tuned to the particular malloc library used.
827 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
828 posix_memalign on the other hand would ideally prefer a value of 4
829 because otherwise, there's 1020 bytes wasted between each ablocks.
830 In Emacs, testing shows that those 1020 can most of the time be
831 efficiently used by malloc to place other objects, so a value of 0 can
832 still preferable unless you have a lot of aligned blocks and virtually
834 #define BLOCK_PADDING 0
835 #define BLOCK_BYTES \
836 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
838 /* Internal data structures and constants. */
840 #define ABLOCKS_SIZE 16
842 /* An aligned block of memory. */
847 char payload
[BLOCK_BYTES
];
848 struct ablock
*next_free
;
850 /* `abase' is the aligned base of the ablocks. */
851 /* It is overloaded to hold the virtual `busy' field that counts
852 the number of used ablock in the parent ablocks.
853 The first ablock has the `busy' field, the others have the `abase'
854 field. To tell the difference, we assume that pointers will have
855 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
856 is used to tell whether the real base of the parent ablocks is `abase'
857 (if not, the word before the first ablock holds a pointer to the
859 struct ablocks
*abase
;
860 /* The padding of all but the last ablock is unused. The padding of
861 the last ablock in an ablocks is not allocated. */
863 char padding
[BLOCK_PADDING
];
867 /* A bunch of consecutive aligned blocks. */
870 struct ablock blocks
[ABLOCKS_SIZE
];
873 /* Size of the block requested from malloc or memalign. */
874 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
876 #define ABLOCK_ABASE(block) \
877 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
878 ? (struct ablocks *)(block) \
881 /* Virtual `busy' field. */
882 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
884 /* Pointer to the (not necessarily aligned) malloc block. */
885 #ifdef USE_POSIX_MEMALIGN
886 #define ABLOCKS_BASE(abase) (abase)
888 #define ABLOCKS_BASE(abase) \
889 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void**)abase)[-1])
892 /* The list of free ablock. */
893 static struct ablock
*free_ablock
;
895 /* Allocate an aligned block of nbytes.
896 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
897 smaller or equal to BLOCK_BYTES. */
898 static POINTER_TYPE
*
899 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
902 struct ablocks
*abase
;
904 eassert (nbytes
<= BLOCK_BYTES
);
908 #ifdef GC_MALLOC_CHECK
909 allocated_mem_type
= type
;
915 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
917 #ifdef DOUG_LEA_MALLOC
918 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
919 because mapped region contents are not preserved in
921 mallopt (M_MMAP_MAX
, 0);
924 #ifdef USE_POSIX_MEMALIGN
926 int err
= posix_memalign (&base
, BLOCK_ALIGN
, ABLOCKS_BYTES
);
932 base
= malloc (ABLOCKS_BYTES
);
933 abase
= ALIGN (base
, BLOCK_ALIGN
);
938 MALLOC_UNBLOCK_INPUT
;
939 memory_full (ABLOCKS_BYTES
);
942 aligned
= (base
== abase
);
944 ((void**)abase
)[-1] = base
;
946 #ifdef DOUG_LEA_MALLOC
947 /* Back to a reasonable maximum of mmap'ed areas. */
948 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
952 /* If the memory just allocated cannot be addressed thru a Lisp
953 object's pointer, and it needs to be, that's equivalent to
954 running out of memory. */
955 if (type
!= MEM_TYPE_NON_LISP
)
958 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
960 if ((char *) XCONS (tem
) != end
)
962 lisp_malloc_loser
= base
;
964 MALLOC_UNBLOCK_INPUT
;
965 memory_full (SIZE_MAX
);
970 /* Initialize the blocks and put them on the free list.
971 Is `base' was not properly aligned, we can't use the last block. */
972 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
974 abase
->blocks
[i
].abase
= abase
;
975 abase
->blocks
[i
].x
.next_free
= free_ablock
;
976 free_ablock
= &abase
->blocks
[i
];
978 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
980 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
981 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
982 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
983 eassert (ABLOCKS_BASE (abase
) == base
);
984 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
987 abase
= ABLOCK_ABASE (free_ablock
);
988 ABLOCKS_BUSY (abase
) =
989 (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
991 free_ablock
= free_ablock
->x
.next_free
;
993 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
994 if (type
!= MEM_TYPE_NON_LISP
)
995 mem_insert (val
, (char *) val
+ nbytes
, type
);
998 MALLOC_UNBLOCK_INPUT
;
1000 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1005 lisp_align_free (POINTER_TYPE
*block
)
1007 struct ablock
*ablock
= block
;
1008 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1011 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1012 mem_delete (mem_find (block
));
1014 /* Put on free list. */
1015 ablock
->x
.next_free
= free_ablock
;
1016 free_ablock
= ablock
;
1017 /* Update busy count. */
1018 ABLOCKS_BUSY (abase
) =
1019 (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1021 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1022 { /* All the blocks are free. */
1023 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1024 struct ablock
**tem
= &free_ablock
;
1025 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1029 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1032 *tem
= (*tem
)->x
.next_free
;
1035 tem
= &(*tem
)->x
.next_free
;
1037 eassert ((aligned
& 1) == aligned
);
1038 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1039 #ifdef USE_POSIX_MEMALIGN
1040 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1042 free (ABLOCKS_BASE (abase
));
1044 MALLOC_UNBLOCK_INPUT
;
1047 /* Return a new buffer structure allocated from the heap with
1048 a call to lisp_malloc. */
1051 allocate_buffer (void)
1054 = (struct buffer
*) lisp_malloc (sizeof (struct buffer
),
1056 XSETPVECTYPESIZE (b
, PVEC_BUFFER
,
1057 ((sizeof (struct buffer
) + sizeof (EMACS_INT
) - 1)
1058 / sizeof (EMACS_INT
)));
1063 #ifndef SYSTEM_MALLOC
1065 /* Arranging to disable input signals while we're in malloc.
1067 This only works with GNU malloc. To help out systems which can't
1068 use GNU malloc, all the calls to malloc, realloc, and free
1069 elsewhere in the code should be inside a BLOCK_INPUT/UNBLOCK_INPUT
1070 pair; unfortunately, we have no idea what C library functions
1071 might call malloc, so we can't really protect them unless you're
1072 using GNU malloc. Fortunately, most of the major operating systems
1073 can use GNU malloc. */
1076 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
1077 there's no need to block input around malloc. */
1079 #ifndef DOUG_LEA_MALLOC
1080 extern void * (*__malloc_hook
) (size_t, const void *);
1081 extern void * (*__realloc_hook
) (void *, size_t, const void *);
1082 extern void (*__free_hook
) (void *, const void *);
1083 /* Else declared in malloc.h, perhaps with an extra arg. */
1084 #endif /* DOUG_LEA_MALLOC */
1085 static void * (*old_malloc_hook
) (size_t, const void *);
1086 static void * (*old_realloc_hook
) (void *, size_t, const void*);
1087 static void (*old_free_hook
) (void*, const void*);
1089 #ifdef DOUG_LEA_MALLOC
1090 # define BYTES_USED (mallinfo ().uordblks)
1092 # define BYTES_USED _bytes_used
1095 static __malloc_size_t bytes_used_when_reconsidered
;
1097 /* Value of _bytes_used, when spare_memory was freed. */
1099 static __malloc_size_t bytes_used_when_full
;
1101 /* This function is used as the hook for free to call. */
1104 emacs_blocked_free (void *ptr
, const void *ptr2
)
1108 #ifdef GC_MALLOC_CHECK
1114 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1117 "Freeing `%p' which wasn't allocated with malloc\n", ptr
);
1122 /* fprintf (stderr, "free %p...%p (%p)\n", m->start, m->end, ptr); */
1126 #endif /* GC_MALLOC_CHECK */
1128 __free_hook
= old_free_hook
;
1131 /* If we released our reserve (due to running out of memory),
1132 and we have a fair amount free once again,
1133 try to set aside another reserve in case we run out once more. */
1134 if (! NILP (Vmemory_full
)
1135 /* Verify there is enough space that even with the malloc
1136 hysteresis this call won't run out again.
1137 The code here is correct as long as SPARE_MEMORY
1138 is substantially larger than the block size malloc uses. */
1139 && (bytes_used_when_full
1140 > ((bytes_used_when_reconsidered
= BYTES_USED
)
1141 + max (malloc_hysteresis
, 4) * SPARE_MEMORY
)))
1142 refill_memory_reserve ();
1144 __free_hook
= emacs_blocked_free
;
1145 UNBLOCK_INPUT_ALLOC
;
1149 /* This function is the malloc hook that Emacs uses. */
1152 emacs_blocked_malloc (size_t size
, const void *ptr
)
1157 __malloc_hook
= old_malloc_hook
;
1158 #ifdef DOUG_LEA_MALLOC
1159 /* Segfaults on my system. --lorentey */
1160 /* mallopt (M_TOP_PAD, malloc_hysteresis * 4096); */
1162 __malloc_extra_blocks
= malloc_hysteresis
;
1165 value
= (void *) malloc (size
);
1167 #ifdef GC_MALLOC_CHECK
1169 struct mem_node
*m
= mem_find (value
);
1172 fprintf (stderr
, "Malloc returned %p which is already in use\n",
1174 fprintf (stderr
, "Region in use is %p...%p, %u bytes, type %d\n",
1175 m
->start
, m
->end
, (char *) m
->end
- (char *) m
->start
,
1180 if (!dont_register_blocks
)
1182 mem_insert (value
, (char *) value
+ max (1, size
), allocated_mem_type
);
1183 allocated_mem_type
= MEM_TYPE_NON_LISP
;
1186 #endif /* GC_MALLOC_CHECK */
1188 __malloc_hook
= emacs_blocked_malloc
;
1189 UNBLOCK_INPUT_ALLOC
;
1191 /* fprintf (stderr, "%p malloc\n", value); */
1196 /* This function is the realloc hook that Emacs uses. */
1199 emacs_blocked_realloc (void *ptr
, size_t size
, const void *ptr2
)
1204 __realloc_hook
= old_realloc_hook
;
1206 #ifdef GC_MALLOC_CHECK
1209 struct mem_node
*m
= mem_find (ptr
);
1210 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1213 "Realloc of %p which wasn't allocated with malloc\n",
1221 /* fprintf (stderr, "%p -> realloc\n", ptr); */
1223 /* Prevent malloc from registering blocks. */
1224 dont_register_blocks
= 1;
1225 #endif /* GC_MALLOC_CHECK */
1227 value
= (void *) realloc (ptr
, size
);
1229 #ifdef GC_MALLOC_CHECK
1230 dont_register_blocks
= 0;
1233 struct mem_node
*m
= mem_find (value
);
1236 fprintf (stderr
, "Realloc returns memory that is already in use\n");
1240 /* Can't handle zero size regions in the red-black tree. */
1241 mem_insert (value
, (char *) value
+ max (size
, 1), MEM_TYPE_NON_LISP
);
1244 /* fprintf (stderr, "%p <- realloc\n", value); */
1245 #endif /* GC_MALLOC_CHECK */
1247 __realloc_hook
= emacs_blocked_realloc
;
1248 UNBLOCK_INPUT_ALLOC
;
1254 #ifdef HAVE_GTK_AND_PTHREAD
1255 /* Called from Fdump_emacs so that when the dumped Emacs starts, it has a
1256 normal malloc. Some thread implementations need this as they call
1257 malloc before main. The pthread_self call in BLOCK_INPUT_ALLOC then
1258 calls malloc because it is the first call, and we have an endless loop. */
1261 reset_malloc_hooks ()
1263 __free_hook
= old_free_hook
;
1264 __malloc_hook
= old_malloc_hook
;
1265 __realloc_hook
= old_realloc_hook
;
1267 #endif /* HAVE_GTK_AND_PTHREAD */
1270 /* Called from main to set up malloc to use our hooks. */
1273 uninterrupt_malloc (void)
1275 #ifdef HAVE_GTK_AND_PTHREAD
1276 #ifdef DOUG_LEA_MALLOC
1277 pthread_mutexattr_t attr
;
1279 /* GLIBC has a faster way to do this, but lets keep it portable.
1280 This is according to the Single UNIX Specification. */
1281 pthread_mutexattr_init (&attr
);
1282 pthread_mutexattr_settype (&attr
, PTHREAD_MUTEX_RECURSIVE
);
1283 pthread_mutex_init (&alloc_mutex
, &attr
);
1284 #else /* !DOUG_LEA_MALLOC */
1285 /* Some systems such as Solaris 2.6 don't have a recursive mutex,
1286 and the bundled gmalloc.c doesn't require it. */
1287 pthread_mutex_init (&alloc_mutex
, NULL
);
1288 #endif /* !DOUG_LEA_MALLOC */
1289 #endif /* HAVE_GTK_AND_PTHREAD */
1291 if (__free_hook
!= emacs_blocked_free
)
1292 old_free_hook
= __free_hook
;
1293 __free_hook
= emacs_blocked_free
;
1295 if (__malloc_hook
!= emacs_blocked_malloc
)
1296 old_malloc_hook
= __malloc_hook
;
1297 __malloc_hook
= emacs_blocked_malloc
;
1299 if (__realloc_hook
!= emacs_blocked_realloc
)
1300 old_realloc_hook
= __realloc_hook
;
1301 __realloc_hook
= emacs_blocked_realloc
;
1304 #endif /* not SYNC_INPUT */
1305 #endif /* not SYSTEM_MALLOC */
1309 /***********************************************************************
1311 ***********************************************************************/
1313 /* Number of intervals allocated in an interval_block structure.
1314 The 1020 is 1024 minus malloc overhead. */
1316 #define INTERVAL_BLOCK_SIZE \
1317 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1319 /* Intervals are allocated in chunks in form of an interval_block
1322 struct interval_block
1324 /* Place `intervals' first, to preserve alignment. */
1325 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1326 struct interval_block
*next
;
1329 /* Current interval block. Its `next' pointer points to older
1332 static struct interval_block
*interval_block
;
1334 /* Index in interval_block above of the next unused interval
1337 static int interval_block_index
;
1339 /* Number of free and live intervals. */
1341 static int total_free_intervals
, total_intervals
;
1343 /* List of free intervals. */
1345 static INTERVAL interval_free_list
;
1347 /* Total number of interval blocks now in use. */
1349 static int n_interval_blocks
;
1352 /* Initialize interval allocation. */
1355 init_intervals (void)
1357 interval_block
= NULL
;
1358 interval_block_index
= INTERVAL_BLOCK_SIZE
;
1359 interval_free_list
= 0;
1360 n_interval_blocks
= 0;
1364 /* Return a new interval. */
1367 make_interval (void)
1371 /* eassert (!handling_signal); */
1375 if (interval_free_list
)
1377 val
= interval_free_list
;
1378 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1382 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1384 register struct interval_block
*newi
;
1386 newi
= (struct interval_block
*) lisp_malloc (sizeof *newi
,
1389 newi
->next
= interval_block
;
1390 interval_block
= newi
;
1391 interval_block_index
= 0;
1392 n_interval_blocks
++;
1394 val
= &interval_block
->intervals
[interval_block_index
++];
1397 MALLOC_UNBLOCK_INPUT
;
1399 consing_since_gc
+= sizeof (struct interval
);
1401 RESET_INTERVAL (val
);
1407 /* Mark Lisp objects in interval I. */
1410 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1412 eassert (!i
->gcmarkbit
); /* Intervals are never shared. */
1414 mark_object (i
->plist
);
1418 /* Mark the interval tree rooted in TREE. Don't call this directly;
1419 use the macro MARK_INTERVAL_TREE instead. */
1422 mark_interval_tree (register INTERVAL tree
)
1424 /* No need to test if this tree has been marked already; this
1425 function is always called through the MARK_INTERVAL_TREE macro,
1426 which takes care of that. */
1428 traverse_intervals_noorder (tree
, mark_interval
, Qnil
);
1432 /* Mark the interval tree rooted in I. */
1434 #define MARK_INTERVAL_TREE(i) \
1436 if (!NULL_INTERVAL_P (i) && !i->gcmarkbit) \
1437 mark_interval_tree (i); \
1441 #define UNMARK_BALANCE_INTERVALS(i) \
1443 if (! NULL_INTERVAL_P (i)) \
1444 (i) = balance_intervals (i); \
1448 /* Number support. If USE_LISP_UNION_TYPE is in effect, we
1449 can't create number objects in macros. */
1452 make_number (EMACS_INT n
)
1456 obj
.s
.type
= Lisp_Int
;
1461 /***********************************************************************
1463 ***********************************************************************/
1465 /* Lisp_Strings are allocated in string_block structures. When a new
1466 string_block is allocated, all the Lisp_Strings it contains are
1467 added to a free-list string_free_list. When a new Lisp_String is
1468 needed, it is taken from that list. During the sweep phase of GC,
1469 string_blocks that are entirely free are freed, except two which
1472 String data is allocated from sblock structures. Strings larger
1473 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1474 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1476 Sblocks consist internally of sdata structures, one for each
1477 Lisp_String. The sdata structure points to the Lisp_String it
1478 belongs to. The Lisp_String points back to the `u.data' member of
1479 its sdata structure.
1481 When a Lisp_String is freed during GC, it is put back on
1482 string_free_list, and its `data' member and its sdata's `string'
1483 pointer is set to null. The size of the string is recorded in the
1484 `u.nbytes' member of the sdata. So, sdata structures that are no
1485 longer used, can be easily recognized, and it's easy to compact the
1486 sblocks of small strings which we do in compact_small_strings. */
1488 /* Size in bytes of an sblock structure used for small strings. This
1489 is 8192 minus malloc overhead. */
1491 #define SBLOCK_SIZE 8188
1493 /* Strings larger than this are considered large strings. String data
1494 for large strings is allocated from individual sblocks. */
1496 #define LARGE_STRING_BYTES 1024
1498 /* Structure describing string memory sub-allocated from an sblock.
1499 This is where the contents of Lisp strings are stored. */
1503 /* Back-pointer to the string this sdata belongs to. If null, this
1504 structure is free, and the NBYTES member of the union below
1505 contains the string's byte size (the same value that STRING_BYTES
1506 would return if STRING were non-null). If non-null, STRING_BYTES
1507 (STRING) is the size of the data, and DATA contains the string's
1509 struct Lisp_String
*string
;
1511 #ifdef GC_CHECK_STRING_BYTES
1514 unsigned char data
[1];
1516 #define SDATA_NBYTES(S) (S)->nbytes
1517 #define SDATA_DATA(S) (S)->data
1518 #define SDATA_SELECTOR(member) member
1520 #else /* not GC_CHECK_STRING_BYTES */
1524 /* When STRING is non-null. */
1525 unsigned char data
[1];
1527 /* When STRING is null. */
1531 #define SDATA_NBYTES(S) (S)->u.nbytes
1532 #define SDATA_DATA(S) (S)->u.data
1533 #define SDATA_SELECTOR(member) u.member
1535 #endif /* not GC_CHECK_STRING_BYTES */
1537 #define SDATA_DATA_OFFSET offsetof (struct sdata, SDATA_SELECTOR (data))
1541 /* Structure describing a block of memory which is sub-allocated to
1542 obtain string data memory for strings. Blocks for small strings
1543 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1544 as large as needed. */
1549 struct sblock
*next
;
1551 /* Pointer to the next free sdata block. This points past the end
1552 of the sblock if there isn't any space left in this block. */
1553 struct sdata
*next_free
;
1555 /* Start of data. */
1556 struct sdata first_data
;
1559 /* Number of Lisp strings in a string_block structure. The 1020 is
1560 1024 minus malloc overhead. */
1562 #define STRING_BLOCK_SIZE \
1563 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1565 /* Structure describing a block from which Lisp_String structures
1570 /* Place `strings' first, to preserve alignment. */
1571 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1572 struct string_block
*next
;
1575 /* Head and tail of the list of sblock structures holding Lisp string
1576 data. We always allocate from current_sblock. The NEXT pointers
1577 in the sblock structures go from oldest_sblock to current_sblock. */
1579 static struct sblock
*oldest_sblock
, *current_sblock
;
1581 /* List of sblocks for large strings. */
1583 static struct sblock
*large_sblocks
;
1585 /* List of string_block structures, and how many there are. */
1587 static struct string_block
*string_blocks
;
1588 static int n_string_blocks
;
1590 /* Free-list of Lisp_Strings. */
1592 static struct Lisp_String
*string_free_list
;
1594 /* Number of live and free Lisp_Strings. */
1596 static int total_strings
, total_free_strings
;
1598 /* Number of bytes used by live strings. */
1600 static EMACS_INT total_string_size
;
1602 /* Given a pointer to a Lisp_String S which is on the free-list
1603 string_free_list, return a pointer to its successor in the
1606 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1608 /* Return a pointer to the sdata structure belonging to Lisp string S.
1609 S must be live, i.e. S->data must not be null. S->data is actually
1610 a pointer to the `u.data' member of its sdata structure; the
1611 structure starts at a constant offset in front of that. */
1613 #define SDATA_OF_STRING(S) ((struct sdata *) ((S)->data - SDATA_DATA_OFFSET))
1616 #ifdef GC_CHECK_STRING_OVERRUN
1618 /* We check for overrun in string data blocks by appending a small
1619 "cookie" after each allocated string data block, and check for the
1620 presence of this cookie during GC. */
1622 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1623 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1624 { '\xde', '\xad', '\xbe', '\xef' };
1627 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1630 /* Value is the size of an sdata structure large enough to hold NBYTES
1631 bytes of string data. The value returned includes a terminating
1632 NUL byte, the size of the sdata structure, and padding. */
1634 #ifdef GC_CHECK_STRING_BYTES
1636 #define SDATA_SIZE(NBYTES) \
1637 ((SDATA_DATA_OFFSET \
1639 + sizeof (EMACS_INT) - 1) \
1640 & ~(sizeof (EMACS_INT) - 1))
1642 #else /* not GC_CHECK_STRING_BYTES */
1644 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1645 less than the size of that member. The 'max' is not needed when
1646 SDATA_DATA_OFFSET is a multiple of sizeof (EMACS_INT), because then the
1647 alignment code reserves enough space. */
1649 #define SDATA_SIZE(NBYTES) \
1650 ((SDATA_DATA_OFFSET \
1651 + (SDATA_DATA_OFFSET % sizeof (EMACS_INT) == 0 \
1653 : max (NBYTES, sizeof (EMACS_INT) - 1)) \
1655 + sizeof (EMACS_INT) - 1) \
1656 & ~(sizeof (EMACS_INT) - 1))
1658 #endif /* not GC_CHECK_STRING_BYTES */
1660 /* Extra bytes to allocate for each string. */
1662 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1664 /* Exact bound on the number of bytes in a string, not counting the
1665 terminating null. A string cannot contain more bytes than
1666 STRING_BYTES_BOUND, nor can it be so long that the size_t
1667 arithmetic in allocate_string_data would overflow while it is
1668 calculating a value to be passed to malloc. */
1669 #define STRING_BYTES_MAX \
1670 min (STRING_BYTES_BOUND, \
1671 ((SIZE_MAX - XMALLOC_OVERRUN_CHECK_SIZE - GC_STRING_EXTRA \
1672 - offsetof (struct sblock, first_data) \
1673 - SDATA_DATA_OFFSET) \
1674 & ~(sizeof (EMACS_INT) - 1)))
1676 /* Initialize string allocation. Called from init_alloc_once. */
1681 total_strings
= total_free_strings
= total_string_size
= 0;
1682 oldest_sblock
= current_sblock
= large_sblocks
= NULL
;
1683 string_blocks
= NULL
;
1684 n_string_blocks
= 0;
1685 string_free_list
= NULL
;
1686 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1687 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1691 #ifdef GC_CHECK_STRING_BYTES
1693 static int check_string_bytes_count
;
1695 #define CHECK_STRING_BYTES(S) STRING_BYTES (S)
1698 /* Like GC_STRING_BYTES, but with debugging check. */
1701 string_bytes (struct Lisp_String
*s
)
1704 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1706 if (!PURE_POINTER_P (s
)
1708 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1713 /* Check validity of Lisp strings' string_bytes member in B. */
1716 check_sblock (struct sblock
*b
)
1718 struct sdata
*from
, *end
, *from_end
;
1722 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1724 /* Compute the next FROM here because copying below may
1725 overwrite data we need to compute it. */
1728 /* Check that the string size recorded in the string is the
1729 same as the one recorded in the sdata structure. */
1731 CHECK_STRING_BYTES (from
->string
);
1734 nbytes
= GC_STRING_BYTES (from
->string
);
1736 nbytes
= SDATA_NBYTES (from
);
1738 nbytes
= SDATA_SIZE (nbytes
);
1739 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1744 /* Check validity of Lisp strings' string_bytes member. ALL_P
1745 non-zero means check all strings, otherwise check only most
1746 recently allocated strings. Used for hunting a bug. */
1749 check_string_bytes (int all_p
)
1755 for (b
= large_sblocks
; b
; b
= b
->next
)
1757 struct Lisp_String
*s
= b
->first_data
.string
;
1759 CHECK_STRING_BYTES (s
);
1762 for (b
= oldest_sblock
; b
; b
= b
->next
)
1766 check_sblock (current_sblock
);
1769 #endif /* GC_CHECK_STRING_BYTES */
1771 #ifdef GC_CHECK_STRING_FREE_LIST
1773 /* Walk through the string free list looking for bogus next pointers.
1774 This may catch buffer overrun from a previous string. */
1777 check_string_free_list (void)
1779 struct Lisp_String
*s
;
1781 /* Pop a Lisp_String off the free-list. */
1782 s
= string_free_list
;
1785 if ((uintptr_t) s
< 1024)
1787 s
= NEXT_FREE_LISP_STRING (s
);
1791 #define check_string_free_list()
1794 /* Return a new Lisp_String. */
1796 static struct Lisp_String
*
1797 allocate_string (void)
1799 struct Lisp_String
*s
;
1801 /* eassert (!handling_signal); */
1805 /* If the free-list is empty, allocate a new string_block, and
1806 add all the Lisp_Strings in it to the free-list. */
1807 if (string_free_list
== NULL
)
1809 struct string_block
*b
;
1812 b
= (struct string_block
*) lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1813 memset (b
, 0, sizeof *b
);
1814 b
->next
= string_blocks
;
1818 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1821 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1822 string_free_list
= s
;
1825 total_free_strings
+= STRING_BLOCK_SIZE
;
1828 check_string_free_list ();
1830 /* Pop a Lisp_String off the free-list. */
1831 s
= string_free_list
;
1832 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1834 MALLOC_UNBLOCK_INPUT
;
1836 /* Probably not strictly necessary, but play it safe. */
1837 memset (s
, 0, sizeof *s
);
1839 --total_free_strings
;
1842 consing_since_gc
+= sizeof *s
;
1844 #ifdef GC_CHECK_STRING_BYTES
1845 if (!noninteractive
)
1847 if (++check_string_bytes_count
== 200)
1849 check_string_bytes_count
= 0;
1850 check_string_bytes (1);
1853 check_string_bytes (0);
1855 #endif /* GC_CHECK_STRING_BYTES */
1861 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1862 plus a NUL byte at the end. Allocate an sdata structure for S, and
1863 set S->data to its `u.data' member. Store a NUL byte at the end of
1864 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1865 S->data if it was initially non-null. */
1868 allocate_string_data (struct Lisp_String
*s
,
1869 EMACS_INT nchars
, EMACS_INT nbytes
)
1871 struct sdata
*data
, *old_data
;
1873 EMACS_INT needed
, old_nbytes
;
1875 if (STRING_BYTES_MAX
< nbytes
)
1878 /* Determine the number of bytes needed to store NBYTES bytes
1880 needed
= SDATA_SIZE (nbytes
);
1881 old_data
= s
->data
? SDATA_OF_STRING (s
) : NULL
;
1882 old_nbytes
= GC_STRING_BYTES (s
);
1886 if (nbytes
> LARGE_STRING_BYTES
)
1888 size_t size
= offsetof (struct sblock
, first_data
) + needed
;
1890 #ifdef DOUG_LEA_MALLOC
1891 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1892 because mapped region contents are not preserved in
1895 In case you think of allowing it in a dumped Emacs at the
1896 cost of not being able to re-dump, there's another reason:
1897 mmap'ed data typically have an address towards the top of the
1898 address space, which won't fit into an EMACS_INT (at least on
1899 32-bit systems with the current tagging scheme). --fx */
1900 mallopt (M_MMAP_MAX
, 0);
1903 b
= (struct sblock
*) lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
1905 #ifdef DOUG_LEA_MALLOC
1906 /* Back to a reasonable maximum of mmap'ed areas. */
1907 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1910 b
->next_free
= &b
->first_data
;
1911 b
->first_data
.string
= NULL
;
1912 b
->next
= large_sblocks
;
1915 else if (current_sblock
== NULL
1916 || (((char *) current_sblock
+ SBLOCK_SIZE
1917 - (char *) current_sblock
->next_free
)
1918 < (needed
+ GC_STRING_EXTRA
)))
1920 /* Not enough room in the current sblock. */
1921 b
= (struct sblock
*) lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
1922 b
->next_free
= &b
->first_data
;
1923 b
->first_data
.string
= NULL
;
1927 current_sblock
->next
= b
;
1935 data
= b
->next_free
;
1936 b
->next_free
= (struct sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
1938 MALLOC_UNBLOCK_INPUT
;
1941 s
->data
= SDATA_DATA (data
);
1942 #ifdef GC_CHECK_STRING_BYTES
1943 SDATA_NBYTES (data
) = nbytes
;
1946 s
->size_byte
= nbytes
;
1947 s
->data
[nbytes
] = '\0';
1948 #ifdef GC_CHECK_STRING_OVERRUN
1949 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
1950 GC_STRING_OVERRUN_COOKIE_SIZE
);
1953 /* If S had already data assigned, mark that as free by setting its
1954 string back-pointer to null, and recording the size of the data
1958 SDATA_NBYTES (old_data
) = old_nbytes
;
1959 old_data
->string
= NULL
;
1962 consing_since_gc
+= needed
;
1966 /* Sweep and compact strings. */
1969 sweep_strings (void)
1971 struct string_block
*b
, *next
;
1972 struct string_block
*live_blocks
= NULL
;
1974 string_free_list
= NULL
;
1975 total_strings
= total_free_strings
= 0;
1976 total_string_size
= 0;
1978 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
1979 for (b
= string_blocks
; b
; b
= next
)
1982 struct Lisp_String
*free_list_before
= string_free_list
;
1986 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
1988 struct Lisp_String
*s
= b
->strings
+ i
;
1992 /* String was not on free-list before. */
1993 if (STRING_MARKED_P (s
))
1995 /* String is live; unmark it and its intervals. */
1998 if (!NULL_INTERVAL_P (s
->intervals
))
1999 UNMARK_BALANCE_INTERVALS (s
->intervals
);
2002 total_string_size
+= STRING_BYTES (s
);
2006 /* String is dead. Put it on the free-list. */
2007 struct sdata
*data
= SDATA_OF_STRING (s
);
2009 /* Save the size of S in its sdata so that we know
2010 how large that is. Reset the sdata's string
2011 back-pointer so that we know it's free. */
2012 #ifdef GC_CHECK_STRING_BYTES
2013 if (GC_STRING_BYTES (s
) != SDATA_NBYTES (data
))
2016 data
->u
.nbytes
= GC_STRING_BYTES (s
);
2018 data
->string
= NULL
;
2020 /* Reset the strings's `data' member so that we
2024 /* Put the string on the free-list. */
2025 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2026 string_free_list
= s
;
2032 /* S was on the free-list before. Put it there again. */
2033 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2034 string_free_list
= s
;
2039 /* Free blocks that contain free Lisp_Strings only, except
2040 the first two of them. */
2041 if (nfree
== STRING_BLOCK_SIZE
2042 && total_free_strings
> STRING_BLOCK_SIZE
)
2046 string_free_list
= free_list_before
;
2050 total_free_strings
+= nfree
;
2051 b
->next
= live_blocks
;
2056 check_string_free_list ();
2058 string_blocks
= live_blocks
;
2059 free_large_strings ();
2060 compact_small_strings ();
2062 check_string_free_list ();
2066 /* Free dead large strings. */
2069 free_large_strings (void)
2071 struct sblock
*b
, *next
;
2072 struct sblock
*live_blocks
= NULL
;
2074 for (b
= large_sblocks
; b
; b
= next
)
2078 if (b
->first_data
.string
== NULL
)
2082 b
->next
= live_blocks
;
2087 large_sblocks
= live_blocks
;
2091 /* Compact data of small strings. Free sblocks that don't contain
2092 data of live strings after compaction. */
2095 compact_small_strings (void)
2097 struct sblock
*b
, *tb
, *next
;
2098 struct sdata
*from
, *to
, *end
, *tb_end
;
2099 struct sdata
*to_end
, *from_end
;
2101 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2102 to, and TB_END is the end of TB. */
2104 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2105 to
= &tb
->first_data
;
2107 /* Step through the blocks from the oldest to the youngest. We
2108 expect that old blocks will stabilize over time, so that less
2109 copying will happen this way. */
2110 for (b
= oldest_sblock
; b
; b
= b
->next
)
2113 xassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2115 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
2117 /* Compute the next FROM here because copying below may
2118 overwrite data we need to compute it. */
2121 #ifdef GC_CHECK_STRING_BYTES
2122 /* Check that the string size recorded in the string is the
2123 same as the one recorded in the sdata structure. */
2125 && GC_STRING_BYTES (from
->string
) != SDATA_NBYTES (from
))
2127 #endif /* GC_CHECK_STRING_BYTES */
2130 nbytes
= GC_STRING_BYTES (from
->string
);
2132 nbytes
= SDATA_NBYTES (from
);
2134 if (nbytes
> LARGE_STRING_BYTES
)
2137 nbytes
= SDATA_SIZE (nbytes
);
2138 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2140 #ifdef GC_CHECK_STRING_OVERRUN
2141 if (memcmp (string_overrun_cookie
,
2142 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2143 GC_STRING_OVERRUN_COOKIE_SIZE
))
2147 /* FROM->string non-null means it's alive. Copy its data. */
2150 /* If TB is full, proceed with the next sblock. */
2151 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2152 if (to_end
> tb_end
)
2156 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2157 to
= &tb
->first_data
;
2158 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2161 /* Copy, and update the string's `data' pointer. */
2164 xassert (tb
!= b
|| to
< from
);
2165 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2166 to
->string
->data
= SDATA_DATA (to
);
2169 /* Advance past the sdata we copied to. */
2175 /* The rest of the sblocks following TB don't contain live data, so
2176 we can free them. */
2177 for (b
= tb
->next
; b
; b
= next
)
2185 current_sblock
= tb
;
2189 string_overflow (void)
2191 error ("Maximum string size exceeded");
2194 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2195 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2196 LENGTH must be an integer.
2197 INIT must be an integer that represents a character. */)
2198 (Lisp_Object length
, Lisp_Object init
)
2200 register Lisp_Object val
;
2201 register unsigned char *p
, *end
;
2205 CHECK_NATNUM (length
);
2206 CHECK_CHARACTER (init
);
2208 c
= XFASTINT (init
);
2209 if (ASCII_CHAR_P (c
))
2211 nbytes
= XINT (length
);
2212 val
= make_uninit_string (nbytes
);
2214 end
= p
+ SCHARS (val
);
2220 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2221 int len
= CHAR_STRING (c
, str
);
2222 EMACS_INT string_len
= XINT (length
);
2224 if (string_len
> STRING_BYTES_MAX
/ len
)
2226 nbytes
= len
* string_len
;
2227 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2232 memcpy (p
, str
, len
);
2242 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2243 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2244 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2245 (Lisp_Object length
, Lisp_Object init
)
2247 register Lisp_Object val
;
2248 struct Lisp_Bool_Vector
*p
;
2249 EMACS_INT length_in_chars
, length_in_elts
;
2252 CHECK_NATNUM (length
);
2254 bits_per_value
= sizeof (EMACS_INT
) * BOOL_VECTOR_BITS_PER_CHAR
;
2256 length_in_elts
= (XFASTINT (length
) + bits_per_value
- 1) / bits_per_value
;
2257 length_in_chars
= ((XFASTINT (length
) + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2258 / BOOL_VECTOR_BITS_PER_CHAR
);
2260 /* We must allocate one more elements than LENGTH_IN_ELTS for the
2261 slot `size' of the struct Lisp_Bool_Vector. */
2262 val
= Fmake_vector (make_number (length_in_elts
+ 1), Qnil
);
2264 /* No Lisp_Object to trace in there. */
2265 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0);
2267 p
= XBOOL_VECTOR (val
);
2268 p
->size
= XFASTINT (length
);
2270 memset (p
->data
, NILP (init
) ? 0 : -1, length_in_chars
);
2272 /* Clear the extraneous bits in the last byte. */
2273 if (XINT (length
) != length_in_chars
* BOOL_VECTOR_BITS_PER_CHAR
)
2274 p
->data
[length_in_chars
- 1]
2275 &= (1 << (XINT (length
) % BOOL_VECTOR_BITS_PER_CHAR
)) - 1;
2281 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2282 of characters from the contents. This string may be unibyte or
2283 multibyte, depending on the contents. */
2286 make_string (const char *contents
, EMACS_INT nbytes
)
2288 register Lisp_Object val
;
2289 EMACS_INT nchars
, multibyte_nbytes
;
2291 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2292 &nchars
, &multibyte_nbytes
);
2293 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2294 /* CONTENTS contains no multibyte sequences or contains an invalid
2295 multibyte sequence. We must make unibyte string. */
2296 val
= make_unibyte_string (contents
, nbytes
);
2298 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2303 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2306 make_unibyte_string (const char *contents
, EMACS_INT length
)
2308 register Lisp_Object val
;
2309 val
= make_uninit_string (length
);
2310 memcpy (SDATA (val
), contents
, length
);
2315 /* Make a multibyte string from NCHARS characters occupying NBYTES
2316 bytes at CONTENTS. */
2319 make_multibyte_string (const char *contents
,
2320 EMACS_INT nchars
, EMACS_INT nbytes
)
2322 register Lisp_Object val
;
2323 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2324 memcpy (SDATA (val
), contents
, nbytes
);
2329 /* Make a string from NCHARS characters occupying NBYTES bytes at
2330 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2333 make_string_from_bytes (const char *contents
,
2334 EMACS_INT nchars
, EMACS_INT nbytes
)
2336 register Lisp_Object val
;
2337 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2338 memcpy (SDATA (val
), contents
, nbytes
);
2339 if (SBYTES (val
) == SCHARS (val
))
2340 STRING_SET_UNIBYTE (val
);
2345 /* Make a string from NCHARS characters occupying NBYTES bytes at
2346 CONTENTS. The argument MULTIBYTE controls whether to label the
2347 string as multibyte. If NCHARS is negative, it counts the number of
2348 characters by itself. */
2351 make_specified_string (const char *contents
,
2352 EMACS_INT nchars
, EMACS_INT nbytes
, int multibyte
)
2354 register Lisp_Object val
;
2359 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2364 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2365 memcpy (SDATA (val
), contents
, nbytes
);
2367 STRING_SET_UNIBYTE (val
);
2372 /* Make a string from the data at STR, treating it as multibyte if the
2376 build_string (const char *str
)
2378 return make_string (str
, strlen (str
));
2382 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2383 occupying LENGTH bytes. */
2386 make_uninit_string (EMACS_INT length
)
2391 return empty_unibyte_string
;
2392 val
= make_uninit_multibyte_string (length
, length
);
2393 STRING_SET_UNIBYTE (val
);
2398 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2399 which occupy NBYTES bytes. */
2402 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2405 struct Lisp_String
*s
;
2410 return empty_multibyte_string
;
2412 s
= allocate_string ();
2413 allocate_string_data (s
, nchars
, nbytes
);
2414 XSETSTRING (string
, s
);
2415 string_chars_consed
+= nbytes
;
2421 /***********************************************************************
2423 ***********************************************************************/
2425 /* We store float cells inside of float_blocks, allocating a new
2426 float_block with malloc whenever necessary. Float cells reclaimed
2427 by GC are put on a free list to be reallocated before allocating
2428 any new float cells from the latest float_block. */
2430 #define FLOAT_BLOCK_SIZE \
2431 (((BLOCK_BYTES - sizeof (struct float_block *) \
2432 /* The compiler might add padding at the end. */ \
2433 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2434 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2436 #define GETMARKBIT(block,n) \
2437 (((block)->gcmarkbits[(n) / (sizeof(int) * CHAR_BIT)] \
2438 >> ((n) % (sizeof(int) * CHAR_BIT))) \
2441 #define SETMARKBIT(block,n) \
2442 (block)->gcmarkbits[(n) / (sizeof(int) * CHAR_BIT)] \
2443 |= 1 << ((n) % (sizeof(int) * CHAR_BIT))
2445 #define UNSETMARKBIT(block,n) \
2446 (block)->gcmarkbits[(n) / (sizeof(int) * CHAR_BIT)] \
2447 &= ~(1 << ((n) % (sizeof(int) * CHAR_BIT)))
2449 #define FLOAT_BLOCK(fptr) \
2450 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2452 #define FLOAT_INDEX(fptr) \
2453 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2457 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2458 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2459 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof(int) * CHAR_BIT
)];
2460 struct float_block
*next
;
2463 #define FLOAT_MARKED_P(fptr) \
2464 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2466 #define FLOAT_MARK(fptr) \
2467 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2469 #define FLOAT_UNMARK(fptr) \
2470 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2472 /* Current float_block. */
2474 static struct float_block
*float_block
;
2476 /* Index of first unused Lisp_Float in the current float_block. */
2478 static int float_block_index
;
2480 /* Total number of float blocks now in use. */
2482 static int n_float_blocks
;
2484 /* Free-list of Lisp_Floats. */
2486 static struct Lisp_Float
*float_free_list
;
2489 /* Initialize float allocation. */
2495 float_block_index
= FLOAT_BLOCK_SIZE
; /* Force alloc of new float_block. */
2496 float_free_list
= 0;
2501 /* Return a new float object with value FLOAT_VALUE. */
2504 make_float (double float_value
)
2506 register Lisp_Object val
;
2508 /* eassert (!handling_signal); */
2512 if (float_free_list
)
2514 /* We use the data field for chaining the free list
2515 so that we won't use the same field that has the mark bit. */
2516 XSETFLOAT (val
, float_free_list
);
2517 float_free_list
= float_free_list
->u
.chain
;
2521 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2523 register struct float_block
*new;
2525 new = (struct float_block
*) lisp_align_malloc (sizeof *new,
2527 new->next
= float_block
;
2528 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2530 float_block_index
= 0;
2533 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2534 float_block_index
++;
2537 MALLOC_UNBLOCK_INPUT
;
2539 XFLOAT_INIT (val
, float_value
);
2540 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2541 consing_since_gc
+= sizeof (struct Lisp_Float
);
2548 /***********************************************************************
2550 ***********************************************************************/
2552 /* We store cons cells inside of cons_blocks, allocating a new
2553 cons_block with malloc whenever necessary. Cons cells reclaimed by
2554 GC are put on a free list to be reallocated before allocating
2555 any new cons cells from the latest cons_block. */
2557 #define CONS_BLOCK_SIZE \
2558 (((BLOCK_BYTES - sizeof (struct cons_block *)) * CHAR_BIT) \
2559 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2561 #define CONS_BLOCK(fptr) \
2562 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2564 #define CONS_INDEX(fptr) \
2565 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2569 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2570 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2571 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof(int) * CHAR_BIT
)];
2572 struct cons_block
*next
;
2575 #define CONS_MARKED_P(fptr) \
2576 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2578 #define CONS_MARK(fptr) \
2579 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2581 #define CONS_UNMARK(fptr) \
2582 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2584 /* Current cons_block. */
2586 static struct cons_block
*cons_block
;
2588 /* Index of first unused Lisp_Cons in the current block. */
2590 static int cons_block_index
;
2592 /* Free-list of Lisp_Cons structures. */
2594 static struct Lisp_Cons
*cons_free_list
;
2596 /* Total number of cons blocks now in use. */
2598 static int n_cons_blocks
;
2601 /* Initialize cons allocation. */
2607 cons_block_index
= CONS_BLOCK_SIZE
; /* Force alloc of new cons_block. */
2613 /* Explicitly free a cons cell by putting it on the free-list. */
2616 free_cons (struct Lisp_Cons
*ptr
)
2618 ptr
->u
.chain
= cons_free_list
;
2622 cons_free_list
= ptr
;
2625 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2626 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2627 (Lisp_Object car
, Lisp_Object cdr
)
2629 register Lisp_Object val
;
2631 /* eassert (!handling_signal); */
2637 /* We use the cdr for chaining the free list
2638 so that we won't use the same field that has the mark bit. */
2639 XSETCONS (val
, cons_free_list
);
2640 cons_free_list
= cons_free_list
->u
.chain
;
2644 if (cons_block_index
== CONS_BLOCK_SIZE
)
2646 register struct cons_block
*new;
2647 new = (struct cons_block
*) lisp_align_malloc (sizeof *new,
2649 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2650 new->next
= cons_block
;
2652 cons_block_index
= 0;
2655 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2659 MALLOC_UNBLOCK_INPUT
;
2663 eassert (!CONS_MARKED_P (XCONS (val
)));
2664 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2665 cons_cells_consed
++;
2669 #ifdef GC_CHECK_CONS_LIST
2670 /* Get an error now if there's any junk in the cons free list. */
2672 check_cons_list (void)
2674 struct Lisp_Cons
*tail
= cons_free_list
;
2677 tail
= tail
->u
.chain
;
2681 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2684 list1 (Lisp_Object arg1
)
2686 return Fcons (arg1
, Qnil
);
2690 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2692 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2697 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2699 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2704 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2706 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2711 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2713 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2714 Fcons (arg5
, Qnil
)))));
2718 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2719 doc
: /* Return a newly created list with specified arguments as elements.
2720 Any number of arguments, even zero arguments, are allowed.
2721 usage: (list &rest OBJECTS) */)
2722 (size_t nargs
, register Lisp_Object
*args
)
2724 register Lisp_Object val
;
2730 val
= Fcons (args
[nargs
], val
);
2736 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2737 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2738 (register Lisp_Object length
, Lisp_Object init
)
2740 register Lisp_Object val
;
2741 register EMACS_INT size
;
2743 CHECK_NATNUM (length
);
2744 size
= XFASTINT (length
);
2749 val
= Fcons (init
, val
);
2754 val
= Fcons (init
, val
);
2759 val
= Fcons (init
, val
);
2764 val
= Fcons (init
, val
);
2769 val
= Fcons (init
, val
);
2784 /***********************************************************************
2786 ***********************************************************************/
2788 /* Singly-linked list of all vectors. */
2790 static struct Lisp_Vector
*all_vectors
;
2792 /* Total number of vector-like objects now in use. */
2794 static int n_vectors
;
2797 /* Value is a pointer to a newly allocated Lisp_Vector structure
2798 with room for LEN Lisp_Objects. */
2800 static struct Lisp_Vector
*
2801 allocate_vectorlike (EMACS_INT len
)
2803 struct Lisp_Vector
*p
;
2805 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
2806 int header_size
= offsetof (struct Lisp_Vector
, contents
);
2807 int word_size
= sizeof p
->contents
[0];
2809 if ((nbytes_max
- header_size
) / word_size
< len
)
2810 memory_full (SIZE_MAX
);
2814 #ifdef DOUG_LEA_MALLOC
2815 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
2816 because mapped region contents are not preserved in
2818 mallopt (M_MMAP_MAX
, 0);
2821 /* This gets triggered by code which I haven't bothered to fix. --Stef */
2822 /* eassert (!handling_signal); */
2824 nbytes
= header_size
+ len
* word_size
;
2825 p
= (struct Lisp_Vector
*) lisp_malloc (nbytes
, MEM_TYPE_VECTORLIKE
);
2827 #ifdef DOUG_LEA_MALLOC
2828 /* Back to a reasonable maximum of mmap'ed areas. */
2829 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2832 consing_since_gc
+= nbytes
;
2833 vector_cells_consed
+= len
;
2835 p
->header
.next
.vector
= all_vectors
;
2838 MALLOC_UNBLOCK_INPUT
;
2845 /* Allocate a vector with NSLOTS slots. */
2847 struct Lisp_Vector
*
2848 allocate_vector (EMACS_INT nslots
)
2850 struct Lisp_Vector
*v
= allocate_vectorlike (nslots
);
2851 v
->header
.size
= nslots
;
2856 /* Allocate other vector-like structures. */
2858 struct Lisp_Vector
*
2859 allocate_pseudovector (int memlen
, int lisplen
, EMACS_INT tag
)
2861 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
2864 /* Only the first lisplen slots will be traced normally by the GC. */
2865 for (i
= 0; i
< lisplen
; ++i
)
2866 v
->contents
[i
] = Qnil
;
2868 XSETPVECTYPESIZE (v
, tag
, lisplen
);
2872 struct Lisp_Hash_Table
*
2873 allocate_hash_table (void)
2875 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
2880 allocate_window (void)
2882 return ALLOCATE_PSEUDOVECTOR(struct window
, current_matrix
, PVEC_WINDOW
);
2887 allocate_terminal (void)
2889 struct terminal
*t
= ALLOCATE_PSEUDOVECTOR (struct terminal
,
2890 next_terminal
, PVEC_TERMINAL
);
2891 /* Zero out the non-GC'd fields. FIXME: This should be made unnecessary. */
2892 memset (&t
->next_terminal
, 0,
2893 (char*) (t
+ 1) - (char*) &t
->next_terminal
);
2899 allocate_frame (void)
2901 struct frame
*f
= ALLOCATE_PSEUDOVECTOR (struct frame
,
2902 face_cache
, PVEC_FRAME
);
2903 /* Zero out the non-GC'd fields. FIXME: This should be made unnecessary. */
2904 memset (&f
->face_cache
, 0,
2905 (char *) (f
+ 1) - (char *) &f
->face_cache
);
2910 struct Lisp_Process
*
2911 allocate_process (void)
2913 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
2917 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
2918 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
2919 See also the function `vector'. */)
2920 (register Lisp_Object length
, Lisp_Object init
)
2923 register EMACS_INT sizei
;
2924 register EMACS_INT i
;
2925 register struct Lisp_Vector
*p
;
2927 CHECK_NATNUM (length
);
2928 sizei
= XFASTINT (length
);
2930 p
= allocate_vector (sizei
);
2931 for (i
= 0; i
< sizei
; i
++)
2932 p
->contents
[i
] = init
;
2934 XSETVECTOR (vector
, p
);
2939 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
2940 doc
: /* Return a newly created vector with specified arguments as elements.
2941 Any number of arguments, even zero arguments, are allowed.
2942 usage: (vector &rest OBJECTS) */)
2943 (register size_t nargs
, Lisp_Object
*args
)
2945 register Lisp_Object len
, val
;
2947 register struct Lisp_Vector
*p
;
2949 XSETFASTINT (len
, nargs
);
2950 val
= Fmake_vector (len
, Qnil
);
2952 for (i
= 0; i
< nargs
; i
++)
2953 p
->contents
[i
] = args
[i
];
2958 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
2959 doc
: /* Create a byte-code object with specified arguments as elements.
2960 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
2961 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
2962 and (optional) INTERACTIVE-SPEC.
2963 The first four arguments are required; at most six have any
2965 The ARGLIST can be either like the one of `lambda', in which case the arguments
2966 will be dynamically bound before executing the byte code, or it can be an
2967 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
2968 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
2969 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
2970 argument to catch the left-over arguments. If such an integer is used, the
2971 arguments will not be dynamically bound but will be instead pushed on the
2972 stack before executing the byte-code.
2973 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
2974 (register size_t nargs
, Lisp_Object
*args
)
2976 register Lisp_Object len
, val
;
2978 register struct Lisp_Vector
*p
;
2980 XSETFASTINT (len
, nargs
);
2981 if (!NILP (Vpurify_flag
))
2982 val
= make_pure_vector ((EMACS_INT
) nargs
);
2984 val
= Fmake_vector (len
, Qnil
);
2986 if (nargs
> 1 && STRINGP (args
[1]) && STRING_MULTIBYTE (args
[1]))
2987 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
2988 earlier because they produced a raw 8-bit string for byte-code
2989 and now such a byte-code string is loaded as multibyte while
2990 raw 8-bit characters converted to multibyte form. Thus, now we
2991 must convert them back to the original unibyte form. */
2992 args
[1] = Fstring_as_unibyte (args
[1]);
2995 for (i
= 0; i
< nargs
; i
++)
2997 if (!NILP (Vpurify_flag
))
2998 args
[i
] = Fpurecopy (args
[i
]);
2999 p
->contents
[i
] = args
[i
];
3001 XSETPVECTYPE (p
, PVEC_COMPILED
);
3002 XSETCOMPILED (val
, p
);
3008 /***********************************************************************
3010 ***********************************************************************/
3012 /* Each symbol_block is just under 1020 bytes long, since malloc
3013 really allocates in units of powers of two and uses 4 bytes for its
3016 #define SYMBOL_BLOCK_SIZE \
3017 ((1020 - sizeof (struct symbol_block *)) / sizeof (struct Lisp_Symbol))
3021 /* Place `symbols' first, to preserve alignment. */
3022 struct Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3023 struct symbol_block
*next
;
3026 /* Current symbol block and index of first unused Lisp_Symbol
3029 static struct symbol_block
*symbol_block
;
3030 static int symbol_block_index
;
3032 /* List of free symbols. */
3034 static struct Lisp_Symbol
*symbol_free_list
;
3036 /* Total number of symbol blocks now in use. */
3038 static int n_symbol_blocks
;
3041 /* Initialize symbol allocation. */
3046 symbol_block
= NULL
;
3047 symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3048 symbol_free_list
= 0;
3049 n_symbol_blocks
= 0;
3053 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3054 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3055 Its value and function definition are void, and its property list is nil. */)
3058 register Lisp_Object val
;
3059 register struct Lisp_Symbol
*p
;
3061 CHECK_STRING (name
);
3063 /* eassert (!handling_signal); */
3067 if (symbol_free_list
)
3069 XSETSYMBOL (val
, symbol_free_list
);
3070 symbol_free_list
= symbol_free_list
->next
;
3074 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3076 struct symbol_block
*new;
3077 new = (struct symbol_block
*) lisp_malloc (sizeof *new,
3079 new->next
= symbol_block
;
3081 symbol_block_index
= 0;
3084 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
]);
3085 symbol_block_index
++;
3088 MALLOC_UNBLOCK_INPUT
;
3093 p
->redirect
= SYMBOL_PLAINVAL
;
3094 SET_SYMBOL_VAL (p
, Qunbound
);
3095 p
->function
= Qunbound
;
3098 p
->interned
= SYMBOL_UNINTERNED
;
3100 p
->declared_special
= 0;
3101 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3108 /***********************************************************************
3109 Marker (Misc) Allocation
3110 ***********************************************************************/
3112 /* Allocation of markers and other objects that share that structure.
3113 Works like allocation of conses. */
3115 #define MARKER_BLOCK_SIZE \
3116 ((1020 - sizeof (struct marker_block *)) / sizeof (union Lisp_Misc))
3120 /* Place `markers' first, to preserve alignment. */
3121 union Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3122 struct marker_block
*next
;
3125 static struct marker_block
*marker_block
;
3126 static int marker_block_index
;
3128 static union Lisp_Misc
*marker_free_list
;
3130 /* Total number of marker blocks now in use. */
3132 static int n_marker_blocks
;
3137 marker_block
= NULL
;
3138 marker_block_index
= MARKER_BLOCK_SIZE
;
3139 marker_free_list
= 0;
3140 n_marker_blocks
= 0;
3143 /* Return a newly allocated Lisp_Misc object, with no substructure. */
3146 allocate_misc (void)
3150 /* eassert (!handling_signal); */
3154 if (marker_free_list
)
3156 XSETMISC (val
, marker_free_list
);
3157 marker_free_list
= marker_free_list
->u_free
.chain
;
3161 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3163 struct marker_block
*new;
3164 new = (struct marker_block
*) lisp_malloc (sizeof *new,
3166 new->next
= marker_block
;
3168 marker_block_index
= 0;
3170 total_free_markers
+= MARKER_BLOCK_SIZE
;
3172 XSETMISC (val
, &marker_block
->markers
[marker_block_index
]);
3173 marker_block_index
++;
3176 MALLOC_UNBLOCK_INPUT
;
3178 --total_free_markers
;
3179 consing_since_gc
+= sizeof (union Lisp_Misc
);
3180 misc_objects_consed
++;
3181 XMISCANY (val
)->gcmarkbit
= 0;
3185 /* Free a Lisp_Misc object */
3188 free_misc (Lisp_Object misc
)
3190 XMISCTYPE (misc
) = Lisp_Misc_Free
;
3191 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3192 marker_free_list
= XMISC (misc
);
3194 total_free_markers
++;
3197 /* Return a Lisp_Misc_Save_Value object containing POINTER and
3198 INTEGER. This is used to package C values to call record_unwind_protect.
3199 The unwind function can get the C values back using XSAVE_VALUE. */
3202 make_save_value (void *pointer
, int integer
)
3204 register Lisp_Object val
;
3205 register struct Lisp_Save_Value
*p
;
3207 val
= allocate_misc ();
3208 XMISCTYPE (val
) = Lisp_Misc_Save_Value
;
3209 p
= XSAVE_VALUE (val
);
3210 p
->pointer
= pointer
;
3211 p
->integer
= integer
;
3216 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3217 doc
: /* Return a newly allocated marker which does not point at any place. */)
3220 register Lisp_Object val
;
3221 register struct Lisp_Marker
*p
;
3223 val
= allocate_misc ();
3224 XMISCTYPE (val
) = Lisp_Misc_Marker
;
3230 p
->insertion_type
= 0;
3234 /* Put MARKER back on the free list after using it temporarily. */
3237 free_marker (Lisp_Object marker
)
3239 unchain_marker (XMARKER (marker
));
3244 /* Return a newly created vector or string with specified arguments as
3245 elements. If all the arguments are characters that can fit
3246 in a string of events, make a string; otherwise, make a vector.
3248 Any number of arguments, even zero arguments, are allowed. */
3251 make_event_array (register int nargs
, Lisp_Object
*args
)
3255 for (i
= 0; i
< nargs
; i
++)
3256 /* The things that fit in a string
3257 are characters that are in 0...127,
3258 after discarding the meta bit and all the bits above it. */
3259 if (!INTEGERP (args
[i
])
3260 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3261 return Fvector (nargs
, args
);
3263 /* Since the loop exited, we know that all the things in it are
3264 characters, so we can make a string. */
3268 result
= Fmake_string (make_number (nargs
), make_number (0));
3269 for (i
= 0; i
< nargs
; i
++)
3271 SSET (result
, i
, XINT (args
[i
]));
3272 /* Move the meta bit to the right place for a string char. */
3273 if (XINT (args
[i
]) & CHAR_META
)
3274 SSET (result
, i
, SREF (result
, i
) | 0x80);
3283 /************************************************************************
3284 Memory Full Handling
3285 ************************************************************************/
3288 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3289 there may have been size_t overflow so that malloc was never
3290 called, or perhaps malloc was invoked successfully but the
3291 resulting pointer had problems fitting into a tagged EMACS_INT. In
3292 either case this counts as memory being full even though malloc did
3296 memory_full (size_t nbytes
)
3298 /* Do not go into hysterics merely because a large request failed. */
3299 int enough_free_memory
= 0;
3300 if (SPARE_MEMORY
< nbytes
)
3302 void *p
= malloc (SPARE_MEMORY
);
3306 enough_free_memory
= 1;
3310 if (! enough_free_memory
)
3316 memory_full_cons_threshold
= sizeof (struct cons_block
);
3318 /* The first time we get here, free the spare memory. */
3319 for (i
= 0; i
< sizeof (spare_memory
) / sizeof (char *); i
++)
3320 if (spare_memory
[i
])
3323 free (spare_memory
[i
]);
3324 else if (i
>= 1 && i
<= 4)
3325 lisp_align_free (spare_memory
[i
]);
3327 lisp_free (spare_memory
[i
]);
3328 spare_memory
[i
] = 0;
3331 /* Record the space now used. When it decreases substantially,
3332 we can refill the memory reserve. */
3333 #if !defined SYSTEM_MALLOC && !defined SYNC_INPUT
3334 bytes_used_when_full
= BYTES_USED
;
3338 /* This used to call error, but if we've run out of memory, we could
3339 get infinite recursion trying to build the string. */
3340 xsignal (Qnil
, Vmemory_signal_data
);
3343 /* If we released our reserve (due to running out of memory),
3344 and we have a fair amount free once again,
3345 try to set aside another reserve in case we run out once more.
3347 This is called when a relocatable block is freed in ralloc.c,
3348 and also directly from this file, in case we're not using ralloc.c. */
3351 refill_memory_reserve (void)
3353 #ifndef SYSTEM_MALLOC
3354 if (spare_memory
[0] == 0)
3355 spare_memory
[0] = (char *) malloc ((size_t) SPARE_MEMORY
);
3356 if (spare_memory
[1] == 0)
3357 spare_memory
[1] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3359 if (spare_memory
[2] == 0)
3360 spare_memory
[2] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3362 if (spare_memory
[3] == 0)
3363 spare_memory
[3] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3365 if (spare_memory
[4] == 0)
3366 spare_memory
[4] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3368 if (spare_memory
[5] == 0)
3369 spare_memory
[5] = (char *) lisp_malloc (sizeof (struct string_block
),
3371 if (spare_memory
[6] == 0)
3372 spare_memory
[6] = (char *) lisp_malloc (sizeof (struct string_block
),
3374 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3375 Vmemory_full
= Qnil
;
3379 /************************************************************************
3381 ************************************************************************/
3383 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3385 /* Conservative C stack marking requires a method to identify possibly
3386 live Lisp objects given a pointer value. We do this by keeping
3387 track of blocks of Lisp data that are allocated in a red-black tree
3388 (see also the comment of mem_node which is the type of nodes in
3389 that tree). Function lisp_malloc adds information for an allocated
3390 block to the red-black tree with calls to mem_insert, and function
3391 lisp_free removes it with mem_delete. Functions live_string_p etc
3392 call mem_find to lookup information about a given pointer in the
3393 tree, and use that to determine if the pointer points to a Lisp
3396 /* Initialize this part of alloc.c. */
3401 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3402 mem_z
.parent
= NULL
;
3403 mem_z
.color
= MEM_BLACK
;
3404 mem_z
.start
= mem_z
.end
= NULL
;
3409 /* Value is a pointer to the mem_node containing START. Value is
3410 MEM_NIL if there is no node in the tree containing START. */
3412 static inline struct mem_node
*
3413 mem_find (void *start
)
3417 if (start
< min_heap_address
|| start
> max_heap_address
)
3420 /* Make the search always successful to speed up the loop below. */
3421 mem_z
.start
= start
;
3422 mem_z
.end
= (char *) start
+ 1;
3425 while (start
< p
->start
|| start
>= p
->end
)
3426 p
= start
< p
->start
? p
->left
: p
->right
;
3431 /* Insert a new node into the tree for a block of memory with start
3432 address START, end address END, and type TYPE. Value is a
3433 pointer to the node that was inserted. */
3435 static struct mem_node
*
3436 mem_insert (void *start
, void *end
, enum mem_type type
)
3438 struct mem_node
*c
, *parent
, *x
;
3440 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3441 min_heap_address
= start
;
3442 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3443 max_heap_address
= end
;
3445 /* See where in the tree a node for START belongs. In this
3446 particular application, it shouldn't happen that a node is already
3447 present. For debugging purposes, let's check that. */
3451 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3453 while (c
!= MEM_NIL
)
3455 if (start
>= c
->start
&& start
< c
->end
)
3458 c
= start
< c
->start
? c
->left
: c
->right
;
3461 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3463 while (c
!= MEM_NIL
)
3466 c
= start
< c
->start
? c
->left
: c
->right
;
3469 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3471 /* Create a new node. */
3472 #ifdef GC_MALLOC_CHECK
3473 x
= (struct mem_node
*) _malloc_internal (sizeof *x
);
3477 x
= (struct mem_node
*) xmalloc (sizeof *x
);
3483 x
->left
= x
->right
= MEM_NIL
;
3486 /* Insert it as child of PARENT or install it as root. */
3489 if (start
< parent
->start
)
3497 /* Re-establish red-black tree properties. */
3498 mem_insert_fixup (x
);
3504 /* Re-establish the red-black properties of the tree, and thereby
3505 balance the tree, after node X has been inserted; X is always red. */
3508 mem_insert_fixup (struct mem_node
*x
)
3510 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3512 /* X is red and its parent is red. This is a violation of
3513 red-black tree property #3. */
3515 if (x
->parent
== x
->parent
->parent
->left
)
3517 /* We're on the left side of our grandparent, and Y is our
3519 struct mem_node
*y
= x
->parent
->parent
->right
;
3521 if (y
->color
== MEM_RED
)
3523 /* Uncle and parent are red but should be black because
3524 X is red. Change the colors accordingly and proceed
3525 with the grandparent. */
3526 x
->parent
->color
= MEM_BLACK
;
3527 y
->color
= MEM_BLACK
;
3528 x
->parent
->parent
->color
= MEM_RED
;
3529 x
= x
->parent
->parent
;
3533 /* Parent and uncle have different colors; parent is
3534 red, uncle is black. */
3535 if (x
== x
->parent
->right
)
3538 mem_rotate_left (x
);
3541 x
->parent
->color
= MEM_BLACK
;
3542 x
->parent
->parent
->color
= MEM_RED
;
3543 mem_rotate_right (x
->parent
->parent
);
3548 /* This is the symmetrical case of above. */
3549 struct mem_node
*y
= x
->parent
->parent
->left
;
3551 if (y
->color
== MEM_RED
)
3553 x
->parent
->color
= MEM_BLACK
;
3554 y
->color
= MEM_BLACK
;
3555 x
->parent
->parent
->color
= MEM_RED
;
3556 x
= x
->parent
->parent
;
3560 if (x
== x
->parent
->left
)
3563 mem_rotate_right (x
);
3566 x
->parent
->color
= MEM_BLACK
;
3567 x
->parent
->parent
->color
= MEM_RED
;
3568 mem_rotate_left (x
->parent
->parent
);
3573 /* The root may have been changed to red due to the algorithm. Set
3574 it to black so that property #5 is satisfied. */
3575 mem_root
->color
= MEM_BLACK
;
3586 mem_rotate_left (struct mem_node
*x
)
3590 /* Turn y's left sub-tree into x's right sub-tree. */
3593 if (y
->left
!= MEM_NIL
)
3594 y
->left
->parent
= x
;
3596 /* Y's parent was x's parent. */
3598 y
->parent
= x
->parent
;
3600 /* Get the parent to point to y instead of x. */
3603 if (x
== x
->parent
->left
)
3604 x
->parent
->left
= y
;
3606 x
->parent
->right
= y
;
3611 /* Put x on y's left. */
3625 mem_rotate_right (struct mem_node
*x
)
3627 struct mem_node
*y
= x
->left
;
3630 if (y
->right
!= MEM_NIL
)
3631 y
->right
->parent
= x
;
3634 y
->parent
= x
->parent
;
3637 if (x
== x
->parent
->right
)
3638 x
->parent
->right
= y
;
3640 x
->parent
->left
= y
;
3651 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
3654 mem_delete (struct mem_node
*z
)
3656 struct mem_node
*x
, *y
;
3658 if (!z
|| z
== MEM_NIL
)
3661 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
3666 while (y
->left
!= MEM_NIL
)
3670 if (y
->left
!= MEM_NIL
)
3675 x
->parent
= y
->parent
;
3678 if (y
== y
->parent
->left
)
3679 y
->parent
->left
= x
;
3681 y
->parent
->right
= x
;
3688 z
->start
= y
->start
;
3693 if (y
->color
== MEM_BLACK
)
3694 mem_delete_fixup (x
);
3696 #ifdef GC_MALLOC_CHECK
3704 /* Re-establish the red-black properties of the tree, after a
3708 mem_delete_fixup (struct mem_node
*x
)
3710 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
3712 if (x
== x
->parent
->left
)
3714 struct mem_node
*w
= x
->parent
->right
;
3716 if (w
->color
== MEM_RED
)
3718 w
->color
= MEM_BLACK
;
3719 x
->parent
->color
= MEM_RED
;
3720 mem_rotate_left (x
->parent
);
3721 w
= x
->parent
->right
;
3724 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
3731 if (w
->right
->color
== MEM_BLACK
)
3733 w
->left
->color
= MEM_BLACK
;
3735 mem_rotate_right (w
);
3736 w
= x
->parent
->right
;
3738 w
->color
= x
->parent
->color
;
3739 x
->parent
->color
= MEM_BLACK
;
3740 w
->right
->color
= MEM_BLACK
;
3741 mem_rotate_left (x
->parent
);
3747 struct mem_node
*w
= x
->parent
->left
;
3749 if (w
->color
== MEM_RED
)
3751 w
->color
= MEM_BLACK
;
3752 x
->parent
->color
= MEM_RED
;
3753 mem_rotate_right (x
->parent
);
3754 w
= x
->parent
->left
;
3757 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
3764 if (w
->left
->color
== MEM_BLACK
)
3766 w
->right
->color
= MEM_BLACK
;
3768 mem_rotate_left (w
);
3769 w
= x
->parent
->left
;
3772 w
->color
= x
->parent
->color
;
3773 x
->parent
->color
= MEM_BLACK
;
3774 w
->left
->color
= MEM_BLACK
;
3775 mem_rotate_right (x
->parent
);
3781 x
->color
= MEM_BLACK
;
3785 /* Value is non-zero if P is a pointer to a live Lisp string on
3786 the heap. M is a pointer to the mem_block for P. */
3789 live_string_p (struct mem_node
*m
, void *p
)
3791 if (m
->type
== MEM_TYPE_STRING
)
3793 struct string_block
*b
= (struct string_block
*) m
->start
;
3794 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
3796 /* P must point to the start of a Lisp_String structure, and it
3797 must not be on the free-list. */
3799 && offset
% sizeof b
->strings
[0] == 0
3800 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
3801 && ((struct Lisp_String
*) p
)->data
!= NULL
);
3808 /* Value is non-zero if P is a pointer to a live Lisp cons on
3809 the heap. M is a pointer to the mem_block for P. */
3812 live_cons_p (struct mem_node
*m
, void *p
)
3814 if (m
->type
== MEM_TYPE_CONS
)
3816 struct cons_block
*b
= (struct cons_block
*) m
->start
;
3817 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
3819 /* P must point to the start of a Lisp_Cons, not be
3820 one of the unused cells in the current cons block,
3821 and not be on the free-list. */
3823 && offset
% sizeof b
->conses
[0] == 0
3824 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
3826 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
3827 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
3834 /* Value is non-zero if P is a pointer to a live Lisp symbol on
3835 the heap. M is a pointer to the mem_block for P. */
3838 live_symbol_p (struct mem_node
*m
, void *p
)
3840 if (m
->type
== MEM_TYPE_SYMBOL
)
3842 struct symbol_block
*b
= (struct symbol_block
*) m
->start
;
3843 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
3845 /* P must point to the start of a Lisp_Symbol, not be
3846 one of the unused cells in the current symbol block,
3847 and not be on the free-list. */
3849 && offset
% sizeof b
->symbols
[0] == 0
3850 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
3851 && (b
!= symbol_block
3852 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
3853 && !EQ (((struct Lisp_Symbol
*) p
)->function
, Vdead
));
3860 /* Value is non-zero if P is a pointer to a live Lisp float on
3861 the heap. M is a pointer to the mem_block for P. */
3864 live_float_p (struct mem_node
*m
, void *p
)
3866 if (m
->type
== MEM_TYPE_FLOAT
)
3868 struct float_block
*b
= (struct float_block
*) m
->start
;
3869 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
3871 /* P must point to the start of a Lisp_Float and not be
3872 one of the unused cells in the current float block. */
3874 && offset
% sizeof b
->floats
[0] == 0
3875 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
3876 && (b
!= float_block
3877 || offset
/ sizeof b
->floats
[0] < float_block_index
));
3884 /* Value is non-zero if P is a pointer to a live Lisp Misc on
3885 the heap. M is a pointer to the mem_block for P. */
3888 live_misc_p (struct mem_node
*m
, void *p
)
3890 if (m
->type
== MEM_TYPE_MISC
)
3892 struct marker_block
*b
= (struct marker_block
*) m
->start
;
3893 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
3895 /* P must point to the start of a Lisp_Misc, not be
3896 one of the unused cells in the current misc block,
3897 and not be on the free-list. */
3899 && offset
% sizeof b
->markers
[0] == 0
3900 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
3901 && (b
!= marker_block
3902 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
3903 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
3910 /* Value is non-zero if P is a pointer to a live vector-like object.
3911 M is a pointer to the mem_block for P. */
3914 live_vector_p (struct mem_node
*m
, void *p
)
3916 return (p
== m
->start
&& m
->type
== MEM_TYPE_VECTORLIKE
);
3920 /* Value is non-zero if P is a pointer to a live buffer. M is a
3921 pointer to the mem_block for P. */
3924 live_buffer_p (struct mem_node
*m
, void *p
)
3926 /* P must point to the start of the block, and the buffer
3927 must not have been killed. */
3928 return (m
->type
== MEM_TYPE_BUFFER
3930 && !NILP (((struct buffer
*) p
)->BUFFER_INTERNAL_FIELD (name
)));
3933 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
3937 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
3939 /* Array of objects that are kept alive because the C stack contains
3940 a pattern that looks like a reference to them . */
3942 #define MAX_ZOMBIES 10
3943 static Lisp_Object zombies
[MAX_ZOMBIES
];
3945 /* Number of zombie objects. */
3947 static int nzombies
;
3949 /* Number of garbage collections. */
3953 /* Average percentage of zombies per collection. */
3955 static double avg_zombies
;
3957 /* Max. number of live and zombie objects. */
3959 static int max_live
, max_zombies
;
3961 /* Average number of live objects per GC. */
3963 static double avg_live
;
3965 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
3966 doc
: /* Show information about live and zombie objects. */)
3969 Lisp_Object args
[8], zombie_list
= Qnil
;
3971 for (i
= 0; i
< nzombies
; i
++)
3972 zombie_list
= Fcons (zombies
[i
], zombie_list
);
3973 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
3974 args
[1] = make_number (ngcs
);
3975 args
[2] = make_float (avg_live
);
3976 args
[3] = make_float (avg_zombies
);
3977 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
3978 args
[5] = make_number (max_live
);
3979 args
[6] = make_number (max_zombies
);
3980 args
[7] = zombie_list
;
3981 return Fmessage (8, args
);
3984 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
3987 /* Mark OBJ if we can prove it's a Lisp_Object. */
3990 mark_maybe_object (Lisp_Object obj
)
3998 po
= (void *) XPNTR (obj
);
4005 switch (XTYPE (obj
))
4008 mark_p
= (live_string_p (m
, po
)
4009 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
4013 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4017 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4021 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4024 case Lisp_Vectorlike
:
4025 /* Note: can't check BUFFERP before we know it's a
4026 buffer because checking that dereferences the pointer
4027 PO which might point anywhere. */
4028 if (live_vector_p (m
, po
))
4029 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4030 else if (live_buffer_p (m
, po
))
4031 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4035 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4044 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4045 if (nzombies
< MAX_ZOMBIES
)
4046 zombies
[nzombies
] = obj
;
4055 /* If P points to Lisp data, mark that as live if it isn't already
4059 mark_maybe_pointer (void *p
)
4063 /* Quickly rule out some values which can't point to Lisp data. */
4066 8 /* USE_LSB_TAG needs Lisp data to be aligned on multiples of 8. */
4068 2 /* We assume that Lisp data is aligned on even addresses. */
4076 Lisp_Object obj
= Qnil
;
4080 case MEM_TYPE_NON_LISP
:
4081 /* Nothing to do; not a pointer to Lisp memory. */
4084 case MEM_TYPE_BUFFER
:
4085 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P((struct buffer
*)p
))
4086 XSETVECTOR (obj
, p
);
4090 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4094 case MEM_TYPE_STRING
:
4095 if (live_string_p (m
, p
)
4096 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4097 XSETSTRING (obj
, p
);
4101 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4105 case MEM_TYPE_SYMBOL
:
4106 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4107 XSETSYMBOL (obj
, p
);
4110 case MEM_TYPE_FLOAT
:
4111 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4115 case MEM_TYPE_VECTORLIKE
:
4116 if (live_vector_p (m
, p
))
4119 XSETVECTOR (tem
, p
);
4120 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4135 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4136 or END+OFFSET..START. */
4139 mark_memory (void *start
, void *end
, int offset
)
4144 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4148 /* Make START the pointer to the start of the memory region,
4149 if it isn't already. */
4157 /* Mark Lisp_Objects. */
4158 for (p
= (Lisp_Object
*) ((char *) start
+ offset
); (void *) p
< end
; ++p
)
4159 mark_maybe_object (*p
);
4161 /* Mark Lisp data pointed to. This is necessary because, in some
4162 situations, the C compiler optimizes Lisp objects away, so that
4163 only a pointer to them remains. Example:
4165 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4168 Lisp_Object obj = build_string ("test");
4169 struct Lisp_String *s = XSTRING (obj);
4170 Fgarbage_collect ();
4171 fprintf (stderr, "test `%s'\n", s->data);
4175 Here, `obj' isn't really used, and the compiler optimizes it
4176 away. The only reference to the life string is through the
4179 for (pp
= (void **) ((char *) start
+ offset
); (void *) pp
< end
; ++pp
)
4180 mark_maybe_pointer (*pp
);
4183 /* setjmp will work with GCC unless NON_SAVING_SETJMP is defined in
4184 the GCC system configuration. In gcc 3.2, the only systems for
4185 which this is so are i386-sco5 non-ELF, i386-sysv3 (maybe included
4186 by others?) and ns32k-pc532-min. */
4188 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4190 static int setjmp_tested_p
, longjmps_done
;
4192 #define SETJMP_WILL_LIKELY_WORK "\
4194 Emacs garbage collector has been changed to use conservative stack\n\
4195 marking. Emacs has determined that the method it uses to do the\n\
4196 marking will likely work on your system, but this isn't sure.\n\
4198 If you are a system-programmer, or can get the help of a local wizard\n\
4199 who is, please take a look at the function mark_stack in alloc.c, and\n\
4200 verify that the methods used are appropriate for your system.\n\
4202 Please mail the result to <emacs-devel@gnu.org>.\n\
4205 #define SETJMP_WILL_NOT_WORK "\
4207 Emacs garbage collector has been changed to use conservative stack\n\
4208 marking. Emacs has determined that the default method it uses to do the\n\
4209 marking will not work on your system. We will need a system-dependent\n\
4210 solution for your system.\n\
4212 Please take a look at the function mark_stack in alloc.c, and\n\
4213 try to find a way to make it work on your system.\n\
4215 Note that you may get false negatives, depending on the compiler.\n\
4216 In particular, you need to use -O with GCC for this test.\n\
4218 Please mail the result to <emacs-devel@gnu.org>.\n\
4222 /* Perform a quick check if it looks like setjmp saves registers in a
4223 jmp_buf. Print a message to stderr saying so. When this test
4224 succeeds, this is _not_ a proof that setjmp is sufficient for
4225 conservative stack marking. Only the sources or a disassembly
4236 /* Arrange for X to be put in a register. */
4242 if (longjmps_done
== 1)
4244 /* Came here after the longjmp at the end of the function.
4246 If x == 1, the longjmp has restored the register to its
4247 value before the setjmp, and we can hope that setjmp
4248 saves all such registers in the jmp_buf, although that
4251 For other values of X, either something really strange is
4252 taking place, or the setjmp just didn't save the register. */
4255 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4258 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4265 if (longjmps_done
== 1)
4269 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4272 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4274 /* Abort if anything GCPRO'd doesn't survive the GC. */
4282 for (p
= gcprolist
; p
; p
= p
->next
)
4283 for (i
= 0; i
< p
->nvars
; ++i
)
4284 if (!survives_gc_p (p
->var
[i
]))
4285 /* FIXME: It's not necessarily a bug. It might just be that the
4286 GCPRO is unnecessary or should release the object sooner. */
4290 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4297 fprintf (stderr
, "\nZombies kept alive = %d:\n", nzombies
);
4298 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4300 fprintf (stderr
, " %d = ", i
);
4301 debug_print (zombies
[i
]);
4305 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4308 /* Mark live Lisp objects on the C stack.
4310 There are several system-dependent problems to consider when
4311 porting this to new architectures:
4315 We have to mark Lisp objects in CPU registers that can hold local
4316 variables or are used to pass parameters.
4318 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4319 something that either saves relevant registers on the stack, or
4320 calls mark_maybe_object passing it each register's contents.
4322 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4323 implementation assumes that calling setjmp saves registers we need
4324 to see in a jmp_buf which itself lies on the stack. This doesn't
4325 have to be true! It must be verified for each system, possibly
4326 by taking a look at the source code of setjmp.
4328 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4329 can use it as a machine independent method to store all registers
4330 to the stack. In this case the macros described in the previous
4331 two paragraphs are not used.
4335 Architectures differ in the way their processor stack is organized.
4336 For example, the stack might look like this
4339 | Lisp_Object | size = 4
4341 | something else | size = 2
4343 | Lisp_Object | size = 4
4347 In such a case, not every Lisp_Object will be aligned equally. To
4348 find all Lisp_Object on the stack it won't be sufficient to walk
4349 the stack in steps of 4 bytes. Instead, two passes will be
4350 necessary, one starting at the start of the stack, and a second
4351 pass starting at the start of the stack + 2. Likewise, if the
4352 minimal alignment of Lisp_Objects on the stack is 1, four passes
4353 would be necessary, each one starting with one byte more offset
4354 from the stack start.
4356 The current code assumes by default that Lisp_Objects are aligned
4357 equally on the stack. */
4365 #ifdef HAVE___BUILTIN_UNWIND_INIT
4366 /* Force callee-saved registers and register windows onto the stack.
4367 This is the preferred method if available, obviating the need for
4368 machine dependent methods. */
4369 __builtin_unwind_init ();
4371 #else /* not HAVE___BUILTIN_UNWIND_INIT */
4372 #ifndef GC_SAVE_REGISTERS_ON_STACK
4373 /* jmp_buf may not be aligned enough on darwin-ppc64 */
4374 union aligned_jmpbuf
{
4378 volatile int stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4380 /* This trick flushes the register windows so that all the state of
4381 the process is contained in the stack. */
4382 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4383 needed on ia64 too. See mach_dep.c, where it also says inline
4384 assembler doesn't work with relevant proprietary compilers. */
4386 #if defined (__sparc64__) && defined (__FreeBSD__)
4387 /* FreeBSD does not have a ta 3 handler. */
4394 /* Save registers that we need to see on the stack. We need to see
4395 registers used to hold register variables and registers used to
4397 #ifdef GC_SAVE_REGISTERS_ON_STACK
4398 GC_SAVE_REGISTERS_ON_STACK (end
);
4399 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4401 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4402 setjmp will definitely work, test it
4403 and print a message with the result
4405 if (!setjmp_tested_p
)
4407 setjmp_tested_p
= 1;
4410 #endif /* GC_SETJMP_WORKS */
4413 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4414 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4415 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
4417 /* This assumes that the stack is a contiguous region in memory. If
4418 that's not the case, something has to be done here to iterate
4419 over the stack segments. */
4420 #ifndef GC_LISP_OBJECT_ALIGNMENT
4422 #define GC_LISP_OBJECT_ALIGNMENT __alignof__ (Lisp_Object)
4424 #define GC_LISP_OBJECT_ALIGNMENT sizeof (Lisp_Object)
4427 for (i
= 0; i
< sizeof (Lisp_Object
); i
+= GC_LISP_OBJECT_ALIGNMENT
)
4428 mark_memory (stack_base
, end
, i
);
4429 /* Allow for marking a secondary stack, like the register stack on the
4431 #ifdef GC_MARK_SECONDARY_STACK
4432 GC_MARK_SECONDARY_STACK ();
4435 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4440 #endif /* GC_MARK_STACK != 0 */
4443 /* Determine whether it is safe to access memory at address P. */
4445 valid_pointer_p (void *p
)
4448 return w32_valid_pointer_p (p
, 16);
4452 /* Obviously, we cannot just access it (we would SEGV trying), so we
4453 trick the o/s to tell us whether p is a valid pointer.
4454 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4455 not validate p in that case. */
4457 if ((fd
= emacs_open ("__Valid__Lisp__Object__", O_CREAT
| O_WRONLY
| O_TRUNC
, 0666)) >= 0)
4459 int valid
= (emacs_write (fd
, (char *)p
, 16) == 16);
4461 unlink ("__Valid__Lisp__Object__");
4469 /* Return 1 if OBJ is a valid lisp object.
4470 Return 0 if OBJ is NOT a valid lisp object.
4471 Return -1 if we cannot validate OBJ.
4472 This function can be quite slow,
4473 so it should only be used in code for manual debugging. */
4476 valid_lisp_object_p (Lisp_Object obj
)
4486 p
= (void *) XPNTR (obj
);
4487 if (PURE_POINTER_P (p
))
4491 return valid_pointer_p (p
);
4498 int valid
= valid_pointer_p (p
);
4510 case MEM_TYPE_NON_LISP
:
4513 case MEM_TYPE_BUFFER
:
4514 return live_buffer_p (m
, p
);
4517 return live_cons_p (m
, p
);
4519 case MEM_TYPE_STRING
:
4520 return live_string_p (m
, p
);
4523 return live_misc_p (m
, p
);
4525 case MEM_TYPE_SYMBOL
:
4526 return live_symbol_p (m
, p
);
4528 case MEM_TYPE_FLOAT
:
4529 return live_float_p (m
, p
);
4531 case MEM_TYPE_VECTORLIKE
:
4532 return live_vector_p (m
, p
);
4545 /***********************************************************************
4546 Pure Storage Management
4547 ***********************************************************************/
4549 /* Allocate room for SIZE bytes from pure Lisp storage and return a
4550 pointer to it. TYPE is the Lisp type for which the memory is
4551 allocated. TYPE < 0 means it's not used for a Lisp object. */
4553 static POINTER_TYPE
*
4554 pure_alloc (size_t size
, int type
)
4556 POINTER_TYPE
*result
;
4558 size_t alignment
= (1 << GCTYPEBITS
);
4560 size_t alignment
= sizeof (EMACS_INT
);
4562 /* Give Lisp_Floats an extra alignment. */
4563 if (type
== Lisp_Float
)
4565 #if defined __GNUC__ && __GNUC__ >= 2
4566 alignment
= __alignof (struct Lisp_Float
);
4568 alignment
= sizeof (struct Lisp_Float
);
4576 /* Allocate space for a Lisp object from the beginning of the free
4577 space with taking account of alignment. */
4578 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
4579 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
4583 /* Allocate space for a non-Lisp object from the end of the free
4585 pure_bytes_used_non_lisp
+= size
;
4586 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4588 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
4590 if (pure_bytes_used
<= pure_size
)
4593 /* Don't allocate a large amount here,
4594 because it might get mmap'd and then its address
4595 might not be usable. */
4596 purebeg
= (char *) xmalloc (10000);
4598 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
4599 pure_bytes_used
= 0;
4600 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
4605 /* Print a warning if PURESIZE is too small. */
4608 check_pure_size (void)
4610 if (pure_bytes_used_before_overflow
)
4611 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
4613 pure_bytes_used
+ pure_bytes_used_before_overflow
);
4617 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
4618 the non-Lisp data pool of the pure storage, and return its start
4619 address. Return NULL if not found. */
4622 find_string_data_in_pure (const char *data
, EMACS_INT nbytes
)
4625 EMACS_INT skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
4626 const unsigned char *p
;
4629 if (pure_bytes_used_non_lisp
< nbytes
+ 1)
4632 /* Set up the Boyer-Moore table. */
4634 for (i
= 0; i
< 256; i
++)
4637 p
= (const unsigned char *) data
;
4639 bm_skip
[*p
++] = skip
;
4641 last_char_skip
= bm_skip
['\0'];
4643 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4644 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
4646 /* See the comments in the function `boyer_moore' (search.c) for the
4647 use of `infinity'. */
4648 infinity
= pure_bytes_used_non_lisp
+ 1;
4649 bm_skip
['\0'] = infinity
;
4651 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
4655 /* Check the last character (== '\0'). */
4658 start
+= bm_skip
[*(p
+ start
)];
4660 while (start
<= start_max
);
4662 if (start
< infinity
)
4663 /* Couldn't find the last character. */
4666 /* No less than `infinity' means we could find the last
4667 character at `p[start - infinity]'. */
4670 /* Check the remaining characters. */
4671 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
4673 return non_lisp_beg
+ start
;
4675 start
+= last_char_skip
;
4677 while (start
<= start_max
);
4683 /* Return a string allocated in pure space. DATA is a buffer holding
4684 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
4685 non-zero means make the result string multibyte.
4687 Must get an error if pure storage is full, since if it cannot hold
4688 a large string it may be able to hold conses that point to that
4689 string; then the string is not protected from gc. */
4692 make_pure_string (const char *data
,
4693 EMACS_INT nchars
, EMACS_INT nbytes
, int multibyte
)
4696 struct Lisp_String
*s
;
4698 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
4699 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
4700 if (s
->data
== NULL
)
4702 s
->data
= (unsigned char *) pure_alloc (nbytes
+ 1, -1);
4703 memcpy (s
->data
, data
, nbytes
);
4704 s
->data
[nbytes
] = '\0';
4707 s
->size_byte
= multibyte
? nbytes
: -1;
4708 s
->intervals
= NULL_INTERVAL
;
4709 XSETSTRING (string
, s
);
4713 /* Return a string a string allocated in pure space. Do not allocate
4714 the string data, just point to DATA. */
4717 make_pure_c_string (const char *data
)
4720 struct Lisp_String
*s
;
4721 EMACS_INT nchars
= strlen (data
);
4723 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
4726 s
->data
= (unsigned char *) data
;
4727 s
->intervals
= NULL_INTERVAL
;
4728 XSETSTRING (string
, s
);
4732 /* Return a cons allocated from pure space. Give it pure copies
4733 of CAR as car and CDR as cdr. */
4736 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
4738 register Lisp_Object
new;
4739 struct Lisp_Cons
*p
;
4741 p
= (struct Lisp_Cons
*) pure_alloc (sizeof *p
, Lisp_Cons
);
4743 XSETCAR (new, Fpurecopy (car
));
4744 XSETCDR (new, Fpurecopy (cdr
));
4749 /* Value is a float object with value NUM allocated from pure space. */
4752 make_pure_float (double num
)
4754 register Lisp_Object
new;
4755 struct Lisp_Float
*p
;
4757 p
= (struct Lisp_Float
*) pure_alloc (sizeof *p
, Lisp_Float
);
4759 XFLOAT_INIT (new, num
);
4764 /* Return a vector with room for LEN Lisp_Objects allocated from
4768 make_pure_vector (EMACS_INT len
)
4771 struct Lisp_Vector
*p
;
4772 size_t size
= (offsetof (struct Lisp_Vector
, contents
)
4773 + len
* sizeof (Lisp_Object
));
4775 p
= (struct Lisp_Vector
*) pure_alloc (size
, Lisp_Vectorlike
);
4776 XSETVECTOR (new, p
);
4777 XVECTOR (new)->header
.size
= len
;
4782 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
4783 doc
: /* Make a copy of object OBJ in pure storage.
4784 Recursively copies contents of vectors and cons cells.
4785 Does not copy symbols. Copies strings without text properties. */)
4786 (register Lisp_Object obj
)
4788 if (NILP (Vpurify_flag
))
4791 if (PURE_POINTER_P (XPNTR (obj
)))
4794 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
4796 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
4802 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
4803 else if (FLOATP (obj
))
4804 obj
= make_pure_float (XFLOAT_DATA (obj
));
4805 else if (STRINGP (obj
))
4806 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
4808 STRING_MULTIBYTE (obj
));
4809 else if (COMPILEDP (obj
) || VECTORP (obj
))
4811 register struct Lisp_Vector
*vec
;
4812 register EMACS_INT i
;
4816 if (size
& PSEUDOVECTOR_FLAG
)
4817 size
&= PSEUDOVECTOR_SIZE_MASK
;
4818 vec
= XVECTOR (make_pure_vector (size
));
4819 for (i
= 0; i
< size
; i
++)
4820 vec
->contents
[i
] = Fpurecopy (XVECTOR (obj
)->contents
[i
]);
4821 if (COMPILEDP (obj
))
4823 XSETPVECTYPE (vec
, PVEC_COMPILED
);
4824 XSETCOMPILED (obj
, vec
);
4827 XSETVECTOR (obj
, vec
);
4829 else if (MARKERP (obj
))
4830 error ("Attempt to copy a marker to pure storage");
4832 /* Not purified, don't hash-cons. */
4835 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
4836 Fputhash (obj
, obj
, Vpurify_flag
);
4843 /***********************************************************************
4845 ***********************************************************************/
4847 /* Put an entry in staticvec, pointing at the variable with address
4851 staticpro (Lisp_Object
*varaddress
)
4853 staticvec
[staticidx
++] = varaddress
;
4854 if (staticidx
>= NSTATICS
)
4859 /***********************************************************************
4861 ***********************************************************************/
4863 /* Temporarily prevent garbage collection. */
4866 inhibit_garbage_collection (void)
4868 int count
= SPECPDL_INDEX ();
4869 int nbits
= min (VALBITS
, BITS_PER_INT
);
4871 specbind (Qgc_cons_threshold
, make_number (((EMACS_INT
) 1 << (nbits
- 1)) - 1));
4876 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
4877 doc
: /* Reclaim storage for Lisp objects no longer needed.
4878 Garbage collection happens automatically if you cons more than
4879 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
4880 `garbage-collect' normally returns a list with info on amount of space in use:
4881 ((USED-CONSES . FREE-CONSES) (USED-SYMS . FREE-SYMS)
4882 (USED-MARKERS . FREE-MARKERS) USED-STRING-CHARS USED-VECTOR-SLOTS
4883 (USED-FLOATS . FREE-FLOATS) (USED-INTERVALS . FREE-INTERVALS)
4884 (USED-STRINGS . FREE-STRINGS))
4885 However, if there was overflow in pure space, `garbage-collect'
4886 returns nil, because real GC can't be done. */)
4889 register struct specbinding
*bind
;
4890 char stack_top_variable
;
4893 Lisp_Object total
[8];
4894 int count
= SPECPDL_INDEX ();
4895 EMACS_TIME t1
, t2
, t3
;
4900 /* Can't GC if pure storage overflowed because we can't determine
4901 if something is a pure object or not. */
4902 if (pure_bytes_used_before_overflow
)
4907 /* Don't keep undo information around forever.
4908 Do this early on, so it is no problem if the user quits. */
4910 register struct buffer
*nextb
= all_buffers
;
4914 /* If a buffer's undo list is Qt, that means that undo is
4915 turned off in that buffer. Calling truncate_undo_list on
4916 Qt tends to return NULL, which effectively turns undo back on.
4917 So don't call truncate_undo_list if undo_list is Qt. */
4918 if (! NILP (nextb
->BUFFER_INTERNAL_FIELD (name
)) && ! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
4919 truncate_undo_list (nextb
);
4921 /* Shrink buffer gaps, but skip indirect and dead buffers. */
4922 if (nextb
->base_buffer
== 0 && !NILP (nextb
->BUFFER_INTERNAL_FIELD (name
))
4923 && ! nextb
->text
->inhibit_shrinking
)
4925 /* If a buffer's gap size is more than 10% of the buffer
4926 size, or larger than 2000 bytes, then shrink it
4927 accordingly. Keep a minimum size of 20 bytes. */
4928 int size
= min (2000, max (20, (nextb
->text
->z_byte
/ 10)));
4930 if (nextb
->text
->gap_size
> size
)
4932 struct buffer
*save_current
= current_buffer
;
4933 current_buffer
= nextb
;
4934 make_gap (-(nextb
->text
->gap_size
- size
));
4935 current_buffer
= save_current
;
4939 nextb
= nextb
->header
.next
.buffer
;
4943 EMACS_GET_TIME (t1
);
4945 /* In case user calls debug_print during GC,
4946 don't let that cause a recursive GC. */
4947 consing_since_gc
= 0;
4949 /* Save what's currently displayed in the echo area. */
4950 message_p
= push_message ();
4951 record_unwind_protect (pop_message_unwind
, Qnil
);
4953 /* Save a copy of the contents of the stack, for debugging. */
4954 #if MAX_SAVE_STACK > 0
4955 if (NILP (Vpurify_flag
))
4959 if (&stack_top_variable
< stack_bottom
)
4961 stack
= &stack_top_variable
;
4962 stack_size
= stack_bottom
- &stack_top_variable
;
4966 stack
= stack_bottom
;
4967 stack_size
= &stack_top_variable
- stack_bottom
;
4969 if (stack_size
<= MAX_SAVE_STACK
)
4971 if (stack_copy_size
< stack_size
)
4973 stack_copy
= (char *) xrealloc (stack_copy
, stack_size
);
4974 stack_copy_size
= stack_size
;
4976 memcpy (stack_copy
, stack
, stack_size
);
4979 #endif /* MAX_SAVE_STACK > 0 */
4981 if (garbage_collection_messages
)
4982 message1_nolog ("Garbage collecting...");
4986 shrink_regexp_cache ();
4990 /* clear_marks (); */
4992 /* Mark all the special slots that serve as the roots of accessibility. */
4994 for (i
= 0; i
< staticidx
; i
++)
4995 mark_object (*staticvec
[i
]);
4997 for (bind
= specpdl
; bind
!= specpdl_ptr
; bind
++)
4999 mark_object (bind
->symbol
);
5000 mark_object (bind
->old_value
);
5008 extern void xg_mark_data (void);
5013 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5014 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5018 register struct gcpro
*tail
;
5019 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5020 for (i
= 0; i
< tail
->nvars
; i
++)
5021 mark_object (tail
->var
[i
]);
5025 struct catchtag
*catch;
5026 struct handler
*handler
;
5028 for (catch = catchlist
; catch; catch = catch->next
)
5030 mark_object (catch->tag
);
5031 mark_object (catch->val
);
5033 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5035 mark_object (handler
->handler
);
5036 mark_object (handler
->var
);
5042 #ifdef HAVE_WINDOW_SYSTEM
5043 mark_fringe_data ();
5046 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5050 /* Everything is now marked, except for the things that require special
5051 finalization, i.e. the undo_list.
5052 Look thru every buffer's undo list
5053 for elements that update markers that were not marked,
5056 register struct buffer
*nextb
= all_buffers
;
5060 /* If a buffer's undo list is Qt, that means that undo is
5061 turned off in that buffer. Calling truncate_undo_list on
5062 Qt tends to return NULL, which effectively turns undo back on.
5063 So don't call truncate_undo_list if undo_list is Qt. */
5064 if (! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
5066 Lisp_Object tail
, prev
;
5067 tail
= nextb
->BUFFER_INTERNAL_FIELD (undo_list
);
5069 while (CONSP (tail
))
5071 if (CONSP (XCAR (tail
))
5072 && MARKERP (XCAR (XCAR (tail
)))
5073 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5076 nextb
->BUFFER_INTERNAL_FIELD (undo_list
) = tail
= XCDR (tail
);
5080 XSETCDR (prev
, tail
);
5090 /* Now that we have stripped the elements that need not be in the
5091 undo_list any more, we can finally mark the list. */
5092 mark_object (nextb
->BUFFER_INTERNAL_FIELD (undo_list
));
5094 nextb
= nextb
->header
.next
.buffer
;
5100 /* Clear the mark bits that we set in certain root slots. */
5102 unmark_byte_stack ();
5103 VECTOR_UNMARK (&buffer_defaults
);
5104 VECTOR_UNMARK (&buffer_local_symbols
);
5106 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5114 /* clear_marks (); */
5117 consing_since_gc
= 0;
5118 if (gc_cons_threshold
< 10000)
5119 gc_cons_threshold
= 10000;
5121 if (FLOATP (Vgc_cons_percentage
))
5122 { /* Set gc_cons_combined_threshold. */
5125 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5126 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5127 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5128 tot
+= total_string_size
;
5129 tot
+= total_vector_size
* sizeof (Lisp_Object
);
5130 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5131 tot
+= total_intervals
* sizeof (struct interval
);
5132 tot
+= total_strings
* sizeof (struct Lisp_String
);
5134 gc_relative_threshold
= tot
* XFLOAT_DATA (Vgc_cons_percentage
);
5137 gc_relative_threshold
= 0;
5139 if (garbage_collection_messages
)
5141 if (message_p
|| minibuf_level
> 0)
5144 message1_nolog ("Garbage collecting...done");
5147 unbind_to (count
, Qnil
);
5149 total
[0] = Fcons (make_number (total_conses
),
5150 make_number (total_free_conses
));
5151 total
[1] = Fcons (make_number (total_symbols
),
5152 make_number (total_free_symbols
));
5153 total
[2] = Fcons (make_number (total_markers
),
5154 make_number (total_free_markers
));
5155 total
[3] = make_number (total_string_size
);
5156 total
[4] = make_number (total_vector_size
);
5157 total
[5] = Fcons (make_number (total_floats
),
5158 make_number (total_free_floats
));
5159 total
[6] = Fcons (make_number (total_intervals
),
5160 make_number (total_free_intervals
));
5161 total
[7] = Fcons (make_number (total_strings
),
5162 make_number (total_free_strings
));
5164 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5166 /* Compute average percentage of zombies. */
5169 for (i
= 0; i
< 7; ++i
)
5170 if (CONSP (total
[i
]))
5171 nlive
+= XFASTINT (XCAR (total
[i
]));
5173 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5174 max_live
= max (nlive
, max_live
);
5175 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5176 max_zombies
= max (nzombies
, max_zombies
);
5181 if (!NILP (Vpost_gc_hook
))
5183 int gc_count
= inhibit_garbage_collection ();
5184 safe_run_hooks (Qpost_gc_hook
);
5185 unbind_to (gc_count
, Qnil
);
5188 /* Accumulate statistics. */
5189 EMACS_GET_TIME (t2
);
5190 EMACS_SUB_TIME (t3
, t2
, t1
);
5191 if (FLOATP (Vgc_elapsed
))
5192 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
) +
5194 EMACS_USECS (t3
) * 1.0e-6);
5197 return Flist (sizeof total
/ sizeof *total
, total
);
5201 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5202 only interesting objects referenced from glyphs are strings. */
5205 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5207 struct glyph_row
*row
= matrix
->rows
;
5208 struct glyph_row
*end
= row
+ matrix
->nrows
;
5210 for (; row
< end
; ++row
)
5214 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5216 struct glyph
*glyph
= row
->glyphs
[area
];
5217 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5219 for (; glyph
< end_glyph
; ++glyph
)
5220 if (STRINGP (glyph
->object
)
5221 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5222 mark_object (glyph
->object
);
5228 /* Mark Lisp faces in the face cache C. */
5231 mark_face_cache (struct face_cache
*c
)
5236 for (i
= 0; i
< c
->used
; ++i
)
5238 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5242 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5243 mark_object (face
->lface
[j
]);
5251 /* Mark reference to a Lisp_Object.
5252 If the object referred to has not been seen yet, recursively mark
5253 all the references contained in it. */
5255 #define LAST_MARKED_SIZE 500
5256 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5257 static int last_marked_index
;
5259 /* For debugging--call abort when we cdr down this many
5260 links of a list, in mark_object. In debugging,
5261 the call to abort will hit a breakpoint.
5262 Normally this is zero and the check never goes off. */
5263 static size_t mark_object_loop_halt
;
5266 mark_vectorlike (struct Lisp_Vector
*ptr
)
5268 register EMACS_UINT size
= ptr
->header
.size
;
5269 register EMACS_UINT i
;
5271 eassert (!VECTOR_MARKED_P (ptr
));
5272 VECTOR_MARK (ptr
); /* Else mark it */
5273 if (size
& PSEUDOVECTOR_FLAG
)
5274 size
&= PSEUDOVECTOR_SIZE_MASK
;
5276 /* Note that this size is not the memory-footprint size, but only
5277 the number of Lisp_Object fields that we should trace.
5278 The distinction is used e.g. by Lisp_Process which places extra
5279 non-Lisp_Object fields at the end of the structure. */
5280 for (i
= 0; i
< size
; i
++) /* and then mark its elements */
5281 mark_object (ptr
->contents
[i
]);
5284 /* Like mark_vectorlike but optimized for char-tables (and
5285 sub-char-tables) assuming that the contents are mostly integers or
5289 mark_char_table (struct Lisp_Vector
*ptr
)
5291 register EMACS_UINT size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5292 register EMACS_UINT i
;
5294 eassert (!VECTOR_MARKED_P (ptr
));
5296 for (i
= 0; i
< size
; i
++)
5298 Lisp_Object val
= ptr
->contents
[i
];
5300 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5302 if (SUB_CHAR_TABLE_P (val
))
5304 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5305 mark_char_table (XVECTOR (val
));
5313 mark_object (Lisp_Object arg
)
5315 register Lisp_Object obj
= arg
;
5316 #ifdef GC_CHECK_MARKED_OBJECTS
5320 size_t cdr_count
= 0;
5324 if (PURE_POINTER_P (XPNTR (obj
)))
5327 last_marked
[last_marked_index
++] = obj
;
5328 if (last_marked_index
== LAST_MARKED_SIZE
)
5329 last_marked_index
= 0;
5331 /* Perform some sanity checks on the objects marked here. Abort if
5332 we encounter an object we know is bogus. This increases GC time
5333 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5334 #ifdef GC_CHECK_MARKED_OBJECTS
5336 po
= (void *) XPNTR (obj
);
5338 /* Check that the object pointed to by PO is known to be a Lisp
5339 structure allocated from the heap. */
5340 #define CHECK_ALLOCATED() \
5342 m = mem_find (po); \
5347 /* Check that the object pointed to by PO is live, using predicate
5349 #define CHECK_LIVE(LIVEP) \
5351 if (!LIVEP (m, po)) \
5355 /* Check both of the above conditions. */
5356 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5358 CHECK_ALLOCATED (); \
5359 CHECK_LIVE (LIVEP); \
5362 #else /* not GC_CHECK_MARKED_OBJECTS */
5364 #define CHECK_LIVE(LIVEP) (void) 0
5365 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5367 #endif /* not GC_CHECK_MARKED_OBJECTS */
5369 switch (SWITCH_ENUM_CAST (XTYPE (obj
)))
5373 register struct Lisp_String
*ptr
= XSTRING (obj
);
5374 if (STRING_MARKED_P (ptr
))
5376 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
5377 MARK_INTERVAL_TREE (ptr
->intervals
);
5379 #ifdef GC_CHECK_STRING_BYTES
5380 /* Check that the string size recorded in the string is the
5381 same as the one recorded in the sdata structure. */
5382 CHECK_STRING_BYTES (ptr
);
5383 #endif /* GC_CHECK_STRING_BYTES */
5387 case Lisp_Vectorlike
:
5388 if (VECTOR_MARKED_P (XVECTOR (obj
)))
5390 #ifdef GC_CHECK_MARKED_OBJECTS
5392 if (m
== MEM_NIL
&& !SUBRP (obj
)
5393 && po
!= &buffer_defaults
5394 && po
!= &buffer_local_symbols
)
5396 #endif /* GC_CHECK_MARKED_OBJECTS */
5400 #ifdef GC_CHECK_MARKED_OBJECTS
5401 if (po
!= &buffer_defaults
&& po
!= &buffer_local_symbols
)
5404 for (b
= all_buffers
; b
&& b
!= po
; b
= b
->header
.next
.buffer
)
5409 #endif /* GC_CHECK_MARKED_OBJECTS */
5412 else if (SUBRP (obj
))
5414 else if (COMPILEDP (obj
))
5415 /* We could treat this just like a vector, but it is better to
5416 save the COMPILED_CONSTANTS element for last and avoid
5419 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5420 register EMACS_UINT size
= ptr
->header
.size
;
5421 register EMACS_UINT i
;
5423 CHECK_LIVE (live_vector_p
);
5424 VECTOR_MARK (ptr
); /* Else mark it */
5425 size
&= PSEUDOVECTOR_SIZE_MASK
;
5426 for (i
= 0; i
< size
; i
++) /* and then mark its elements */
5428 if (i
!= COMPILED_CONSTANTS
)
5429 mark_object (ptr
->contents
[i
]);
5431 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
5434 else if (FRAMEP (obj
))
5436 register struct frame
*ptr
= XFRAME (obj
);
5437 mark_vectorlike (XVECTOR (obj
));
5438 mark_face_cache (ptr
->face_cache
);
5440 else if (WINDOWP (obj
))
5442 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5443 struct window
*w
= XWINDOW (obj
);
5444 mark_vectorlike (ptr
);
5445 /* Mark glyphs for leaf windows. Marking window matrices is
5446 sufficient because frame matrices use the same glyph
5448 if (NILP (w
->hchild
)
5450 && w
->current_matrix
)
5452 mark_glyph_matrix (w
->current_matrix
);
5453 mark_glyph_matrix (w
->desired_matrix
);
5456 else if (HASH_TABLE_P (obj
))
5458 struct Lisp_Hash_Table
*h
= XHASH_TABLE (obj
);
5459 mark_vectorlike ((struct Lisp_Vector
*)h
);
5460 /* If hash table is not weak, mark all keys and values.
5461 For weak tables, mark only the vector. */
5463 mark_object (h
->key_and_value
);
5465 VECTOR_MARK (XVECTOR (h
->key_and_value
));
5467 else if (CHAR_TABLE_P (obj
))
5468 mark_char_table (XVECTOR (obj
));
5470 mark_vectorlike (XVECTOR (obj
));
5475 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
5476 struct Lisp_Symbol
*ptrx
;
5480 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
5482 mark_object (ptr
->function
);
5483 mark_object (ptr
->plist
);
5484 switch (ptr
->redirect
)
5486 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
5487 case SYMBOL_VARALIAS
:
5490 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
5494 case SYMBOL_LOCALIZED
:
5496 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
5497 /* If the value is forwarded to a buffer or keyboard field,
5498 these are marked when we see the corresponding object.
5499 And if it's forwarded to a C variable, either it's not
5500 a Lisp_Object var, or it's staticpro'd already. */
5501 mark_object (blv
->where
);
5502 mark_object (blv
->valcell
);
5503 mark_object (blv
->defcell
);
5506 case SYMBOL_FORWARDED
:
5507 /* If the value is forwarded to a buffer or keyboard field,
5508 these are marked when we see the corresponding object.
5509 And if it's forwarded to a C variable, either it's not
5510 a Lisp_Object var, or it's staticpro'd already. */
5514 if (!PURE_POINTER_P (XSTRING (ptr
->xname
)))
5515 MARK_STRING (XSTRING (ptr
->xname
));
5516 MARK_INTERVAL_TREE (STRING_INTERVALS (ptr
->xname
));
5521 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun */
5522 XSETSYMBOL (obj
, ptrx
);
5529 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
5530 if (XMISCANY (obj
)->gcmarkbit
)
5532 XMISCANY (obj
)->gcmarkbit
= 1;
5534 switch (XMISCTYPE (obj
))
5537 case Lisp_Misc_Marker
:
5538 /* DO NOT mark thru the marker's chain.
5539 The buffer's markers chain does not preserve markers from gc;
5540 instead, markers are removed from the chain when freed by gc. */
5543 case Lisp_Misc_Save_Value
:
5546 register struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
5547 /* If DOGC is set, POINTER is the address of a memory
5548 area containing INTEGER potential Lisp_Objects. */
5551 Lisp_Object
*p
= (Lisp_Object
*) ptr
->pointer
;
5553 for (nelt
= ptr
->integer
; nelt
> 0; nelt
--, p
++)
5554 mark_maybe_object (*p
);
5560 case Lisp_Misc_Overlay
:
5562 struct Lisp_Overlay
*ptr
= XOVERLAY (obj
);
5563 mark_object (ptr
->start
);
5564 mark_object (ptr
->end
);
5565 mark_object (ptr
->plist
);
5568 XSETMISC (obj
, ptr
->next
);
5581 register struct Lisp_Cons
*ptr
= XCONS (obj
);
5582 if (CONS_MARKED_P (ptr
))
5584 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
5586 /* If the cdr is nil, avoid recursion for the car. */
5587 if (EQ (ptr
->u
.cdr
, Qnil
))
5593 mark_object (ptr
->car
);
5596 if (cdr_count
== mark_object_loop_halt
)
5602 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
5603 FLOAT_MARK (XFLOAT (obj
));
5614 #undef CHECK_ALLOCATED
5615 #undef CHECK_ALLOCATED_AND_LIVE
5618 /* Mark the pointers in a buffer structure. */
5621 mark_buffer (Lisp_Object buf
)
5623 register struct buffer
*buffer
= XBUFFER (buf
);
5624 register Lisp_Object
*ptr
, tmp
;
5625 Lisp_Object base_buffer
;
5627 eassert (!VECTOR_MARKED_P (buffer
));
5628 VECTOR_MARK (buffer
);
5630 MARK_INTERVAL_TREE (BUF_INTERVALS (buffer
));
5632 /* For now, we just don't mark the undo_list. It's done later in
5633 a special way just before the sweep phase, and after stripping
5634 some of its elements that are not needed any more. */
5636 if (buffer
->overlays_before
)
5638 XSETMISC (tmp
, buffer
->overlays_before
);
5641 if (buffer
->overlays_after
)
5643 XSETMISC (tmp
, buffer
->overlays_after
);
5647 /* buffer-local Lisp variables start at `undo_list',
5648 tho only the ones from `name' on are GC'd normally. */
5649 for (ptr
= &buffer
->BUFFER_INTERNAL_FIELD (name
);
5650 (char *)ptr
< (char *)buffer
+ sizeof (struct buffer
);
5654 /* If this is an indirect buffer, mark its base buffer. */
5655 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5657 XSETBUFFER (base_buffer
, buffer
->base_buffer
);
5658 mark_buffer (base_buffer
);
5662 /* Mark the Lisp pointers in the terminal objects.
5663 Called by the Fgarbage_collector. */
5666 mark_terminals (void)
5669 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5671 eassert (t
->name
!= NULL
);
5672 #ifdef HAVE_WINDOW_SYSTEM
5673 /* If a terminal object is reachable from a stacpro'ed object,
5674 it might have been marked already. Make sure the image cache
5676 mark_image_cache (t
->image_cache
);
5677 #endif /* HAVE_WINDOW_SYSTEM */
5678 if (!VECTOR_MARKED_P (t
))
5679 mark_vectorlike ((struct Lisp_Vector
*)t
);
5685 /* Value is non-zero if OBJ will survive the current GC because it's
5686 either marked or does not need to be marked to survive. */
5689 survives_gc_p (Lisp_Object obj
)
5693 switch (XTYPE (obj
))
5700 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
5704 survives_p
= XMISCANY (obj
)->gcmarkbit
;
5708 survives_p
= STRING_MARKED_P (XSTRING (obj
));
5711 case Lisp_Vectorlike
:
5712 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
5716 survives_p
= CONS_MARKED_P (XCONS (obj
));
5720 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
5727 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
5732 /* Sweep: find all structures not marked, and free them. */
5737 /* Remove or mark entries in weak hash tables.
5738 This must be done before any object is unmarked. */
5739 sweep_weak_hash_tables ();
5742 #ifdef GC_CHECK_STRING_BYTES
5743 if (!noninteractive
)
5744 check_string_bytes (1);
5747 /* Put all unmarked conses on free list */
5749 register struct cons_block
*cblk
;
5750 struct cons_block
**cprev
= &cons_block
;
5751 register int lim
= cons_block_index
;
5752 register int num_free
= 0, num_used
= 0;
5756 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
5760 int ilim
= (lim
+ BITS_PER_INT
- 1) / BITS_PER_INT
;
5762 /* Scan the mark bits an int at a time. */
5763 for (i
= 0; i
<= ilim
; i
++)
5765 if (cblk
->gcmarkbits
[i
] == -1)
5767 /* Fast path - all cons cells for this int are marked. */
5768 cblk
->gcmarkbits
[i
] = 0;
5769 num_used
+= BITS_PER_INT
;
5773 /* Some cons cells for this int are not marked.
5774 Find which ones, and free them. */
5775 int start
, pos
, stop
;
5777 start
= i
* BITS_PER_INT
;
5779 if (stop
> BITS_PER_INT
)
5780 stop
= BITS_PER_INT
;
5783 for (pos
= start
; pos
< stop
; pos
++)
5785 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
5788 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
5789 cons_free_list
= &cblk
->conses
[pos
];
5791 cons_free_list
->car
= Vdead
;
5797 CONS_UNMARK (&cblk
->conses
[pos
]);
5803 lim
= CONS_BLOCK_SIZE
;
5804 /* If this block contains only free conses and we have already
5805 seen more than two blocks worth of free conses then deallocate
5807 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
5809 *cprev
= cblk
->next
;
5810 /* Unhook from the free list. */
5811 cons_free_list
= cblk
->conses
[0].u
.chain
;
5812 lisp_align_free (cblk
);
5817 num_free
+= this_free
;
5818 cprev
= &cblk
->next
;
5821 total_conses
= num_used
;
5822 total_free_conses
= num_free
;
5825 /* Put all unmarked floats on free list */
5827 register struct float_block
*fblk
;
5828 struct float_block
**fprev
= &float_block
;
5829 register int lim
= float_block_index
;
5830 register int num_free
= 0, num_used
= 0;
5832 float_free_list
= 0;
5834 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
5838 for (i
= 0; i
< lim
; i
++)
5839 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
5842 fblk
->floats
[i
].u
.chain
= float_free_list
;
5843 float_free_list
= &fblk
->floats
[i
];
5848 FLOAT_UNMARK (&fblk
->floats
[i
]);
5850 lim
= FLOAT_BLOCK_SIZE
;
5851 /* If this block contains only free floats and we have already
5852 seen more than two blocks worth of free floats then deallocate
5854 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
5856 *fprev
= fblk
->next
;
5857 /* Unhook from the free list. */
5858 float_free_list
= fblk
->floats
[0].u
.chain
;
5859 lisp_align_free (fblk
);
5864 num_free
+= this_free
;
5865 fprev
= &fblk
->next
;
5868 total_floats
= num_used
;
5869 total_free_floats
= num_free
;
5872 /* Put all unmarked intervals on free list */
5874 register struct interval_block
*iblk
;
5875 struct interval_block
**iprev
= &interval_block
;
5876 register int lim
= interval_block_index
;
5877 register int num_free
= 0, num_used
= 0;
5879 interval_free_list
= 0;
5881 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
5886 for (i
= 0; i
< lim
; i
++)
5888 if (!iblk
->intervals
[i
].gcmarkbit
)
5890 SET_INTERVAL_PARENT (&iblk
->intervals
[i
], interval_free_list
);
5891 interval_free_list
= &iblk
->intervals
[i
];
5897 iblk
->intervals
[i
].gcmarkbit
= 0;
5900 lim
= INTERVAL_BLOCK_SIZE
;
5901 /* If this block contains only free intervals and we have already
5902 seen more than two blocks worth of free intervals then
5903 deallocate this block. */
5904 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
5906 *iprev
= iblk
->next
;
5907 /* Unhook from the free list. */
5908 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
5910 n_interval_blocks
--;
5914 num_free
+= this_free
;
5915 iprev
= &iblk
->next
;
5918 total_intervals
= num_used
;
5919 total_free_intervals
= num_free
;
5922 /* Put all unmarked symbols on free list */
5924 register struct symbol_block
*sblk
;
5925 struct symbol_block
**sprev
= &symbol_block
;
5926 register int lim
= symbol_block_index
;
5927 register int num_free
= 0, num_used
= 0;
5929 symbol_free_list
= NULL
;
5931 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
5934 struct Lisp_Symbol
*sym
= sblk
->symbols
;
5935 struct Lisp_Symbol
*end
= sym
+ lim
;
5937 for (; sym
< end
; ++sym
)
5939 /* Check if the symbol was created during loadup. In such a case
5940 it might be pointed to by pure bytecode which we don't trace,
5941 so we conservatively assume that it is live. */
5942 int pure_p
= PURE_POINTER_P (XSTRING (sym
->xname
));
5944 if (!sym
->gcmarkbit
&& !pure_p
)
5946 if (sym
->redirect
== SYMBOL_LOCALIZED
)
5947 xfree (SYMBOL_BLV (sym
));
5948 sym
->next
= symbol_free_list
;
5949 symbol_free_list
= sym
;
5951 symbol_free_list
->function
= Vdead
;
5959 UNMARK_STRING (XSTRING (sym
->xname
));
5964 lim
= SYMBOL_BLOCK_SIZE
;
5965 /* If this block contains only free symbols and we have already
5966 seen more than two blocks worth of free symbols then deallocate
5968 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
5970 *sprev
= sblk
->next
;
5971 /* Unhook from the free list. */
5972 symbol_free_list
= sblk
->symbols
[0].next
;
5978 num_free
+= this_free
;
5979 sprev
= &sblk
->next
;
5982 total_symbols
= num_used
;
5983 total_free_symbols
= num_free
;
5986 /* Put all unmarked misc's on free list.
5987 For a marker, first unchain it from the buffer it points into. */
5989 register struct marker_block
*mblk
;
5990 struct marker_block
**mprev
= &marker_block
;
5991 register int lim
= marker_block_index
;
5992 register int num_free
= 0, num_used
= 0;
5994 marker_free_list
= 0;
5996 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
6001 for (i
= 0; i
< lim
; i
++)
6003 if (!mblk
->markers
[i
].u_any
.gcmarkbit
)
6005 if (mblk
->markers
[i
].u_any
.type
== Lisp_Misc_Marker
)
6006 unchain_marker (&mblk
->markers
[i
].u_marker
);
6007 /* Set the type of the freed object to Lisp_Misc_Free.
6008 We could leave the type alone, since nobody checks it,
6009 but this might catch bugs faster. */
6010 mblk
->markers
[i
].u_marker
.type
= Lisp_Misc_Free
;
6011 mblk
->markers
[i
].u_free
.chain
= marker_free_list
;
6012 marker_free_list
= &mblk
->markers
[i
];
6018 mblk
->markers
[i
].u_any
.gcmarkbit
= 0;
6021 lim
= MARKER_BLOCK_SIZE
;
6022 /* If this block contains only free markers and we have already
6023 seen more than two blocks worth of free markers then deallocate
6025 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6027 *mprev
= mblk
->next
;
6028 /* Unhook from the free list. */
6029 marker_free_list
= mblk
->markers
[0].u_free
.chain
;
6035 num_free
+= this_free
;
6036 mprev
= &mblk
->next
;
6040 total_markers
= num_used
;
6041 total_free_markers
= num_free
;
6044 /* Free all unmarked buffers */
6046 register struct buffer
*buffer
= all_buffers
, *prev
= 0, *next
;
6049 if (!VECTOR_MARKED_P (buffer
))
6052 prev
->header
.next
= buffer
->header
.next
;
6054 all_buffers
= buffer
->header
.next
.buffer
;
6055 next
= buffer
->header
.next
.buffer
;
6061 VECTOR_UNMARK (buffer
);
6062 UNMARK_BALANCE_INTERVALS (BUF_INTERVALS (buffer
));
6063 prev
= buffer
, buffer
= buffer
->header
.next
.buffer
;
6067 /* Free all unmarked vectors */
6069 register struct Lisp_Vector
*vector
= all_vectors
, *prev
= 0, *next
;
6070 total_vector_size
= 0;
6073 if (!VECTOR_MARKED_P (vector
))
6076 prev
->header
.next
= vector
->header
.next
;
6078 all_vectors
= vector
->header
.next
.vector
;
6079 next
= vector
->header
.next
.vector
;
6087 VECTOR_UNMARK (vector
);
6088 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
6089 total_vector_size
+= PSEUDOVECTOR_SIZE_MASK
& vector
->header
.size
;
6091 total_vector_size
+= vector
->header
.size
;
6092 prev
= vector
, vector
= vector
->header
.next
.vector
;
6096 #ifdef GC_CHECK_STRING_BYTES
6097 if (!noninteractive
)
6098 check_string_bytes (1);
6105 /* Debugging aids. */
6107 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6108 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6109 This may be helpful in debugging Emacs's memory usage.
6110 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6115 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6120 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6121 doc
: /* Return a list of counters that measure how much consing there has been.
6122 Each of these counters increments for a certain kind of object.
6123 The counters wrap around from the largest positive integer to zero.
6124 Garbage collection does not decrease them.
6125 The elements of the value are as follows:
6126 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6127 All are in units of 1 = one object consed
6128 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6130 MISCS include overlays, markers, and some internal types.
6131 Frames, windows, buffers, and subprocesses count as vectors
6132 (but the contents of a buffer's text do not count here). */)
6135 Lisp_Object consed
[8];
6137 consed
[0] = make_number (min (MOST_POSITIVE_FIXNUM
, cons_cells_consed
));
6138 consed
[1] = make_number (min (MOST_POSITIVE_FIXNUM
, floats_consed
));
6139 consed
[2] = make_number (min (MOST_POSITIVE_FIXNUM
, vector_cells_consed
));
6140 consed
[3] = make_number (min (MOST_POSITIVE_FIXNUM
, symbols_consed
));
6141 consed
[4] = make_number (min (MOST_POSITIVE_FIXNUM
, string_chars_consed
));
6142 consed
[5] = make_number (min (MOST_POSITIVE_FIXNUM
, misc_objects_consed
));
6143 consed
[6] = make_number (min (MOST_POSITIVE_FIXNUM
, intervals_consed
));
6144 consed
[7] = make_number (min (MOST_POSITIVE_FIXNUM
, strings_consed
));
6146 return Flist (8, consed
);
6149 #ifdef ENABLE_CHECKING
6150 int suppress_checking
;
6153 die (const char *msg
, const char *file
, int line
)
6155 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: %s\r\n",
6161 /* Initialization */
6164 init_alloc_once (void)
6166 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6168 pure_size
= PURESIZE
;
6169 pure_bytes_used
= 0;
6170 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
6171 pure_bytes_used_before_overflow
= 0;
6173 /* Initialize the list of free aligned blocks. */
6176 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6178 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6182 ignore_warnings
= 1;
6183 #ifdef DOUG_LEA_MALLOC
6184 mallopt (M_TRIM_THRESHOLD
, 128*1024); /* trim threshold */
6185 mallopt (M_MMAP_THRESHOLD
, 64*1024); /* mmap threshold */
6186 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* max. number of mmap'ed areas */
6194 init_weak_hash_tables ();
6197 malloc_hysteresis
= 32;
6199 malloc_hysteresis
= 0;
6202 refill_memory_reserve ();
6204 ignore_warnings
= 0;
6206 byte_stack_list
= 0;
6208 consing_since_gc
= 0;
6209 gc_cons_threshold
= 100000 * sizeof (Lisp_Object
);
6210 gc_relative_threshold
= 0;
6217 byte_stack_list
= 0;
6219 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6220 setjmp_tested_p
= longjmps_done
= 0;
6223 Vgc_elapsed
= make_float (0.0);
6228 syms_of_alloc (void)
6230 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6231 doc
: /* *Number of bytes of consing between garbage collections.
6232 Garbage collection can happen automatically once this many bytes have been
6233 allocated since the last garbage collection. All data types count.
6235 Garbage collection happens automatically only when `eval' is called.
6237 By binding this temporarily to a large number, you can effectively
6238 prevent garbage collection during a part of the program.
6239 See also `gc-cons-percentage'. */);
6241 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6242 doc
: /* *Portion of the heap used for allocation.
6243 Garbage collection can happen automatically once this portion of the heap
6244 has been allocated since the last garbage collection.
6245 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6246 Vgc_cons_percentage
= make_float (0.1);
6248 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6249 doc
: /* Number of bytes of sharable Lisp data allocated so far. */);
6251 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6252 doc
: /* Number of cons cells that have been consed so far. */);
6254 DEFVAR_INT ("floats-consed", floats_consed
,
6255 doc
: /* Number of floats that have been consed so far. */);
6257 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
6258 doc
: /* Number of vector cells that have been consed so far. */);
6260 DEFVAR_INT ("symbols-consed", symbols_consed
,
6261 doc
: /* Number of symbols that have been consed so far. */);
6263 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
6264 doc
: /* Number of string characters that have been consed so far. */);
6266 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
6267 doc
: /* Number of miscellaneous objects that have been consed so far. */);
6269 DEFVAR_INT ("intervals-consed", intervals_consed
,
6270 doc
: /* Number of intervals that have been consed so far. */);
6272 DEFVAR_INT ("strings-consed", strings_consed
,
6273 doc
: /* Number of strings that have been consed so far. */);
6275 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
6276 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
6277 This means that certain objects should be allocated in shared (pure) space.
6278 It can also be set to a hash-table, in which case this table is used to
6279 do hash-consing of the objects allocated to pure space. */);
6281 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
6282 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
6283 garbage_collection_messages
= 0;
6285 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
6286 doc
: /* Hook run after garbage collection has finished. */);
6287 Vpost_gc_hook
= Qnil
;
6288 Qpost_gc_hook
= intern_c_string ("post-gc-hook");
6289 staticpro (&Qpost_gc_hook
);
6291 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
6292 doc
: /* Precomputed `signal' argument for memory-full error. */);
6293 /* We build this in advance because if we wait until we need it, we might
6294 not be able to allocate the memory to hold it. */
6296 = pure_cons (Qerror
,
6297 pure_cons (make_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"), Qnil
));
6299 DEFVAR_LISP ("memory-full", Vmemory_full
,
6300 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
6301 Vmemory_full
= Qnil
;
6303 staticpro (&Qgc_cons_threshold
);
6304 Qgc_cons_threshold
= intern_c_string ("gc-cons-threshold");
6306 staticpro (&Qchar_table_extra_slots
);
6307 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
6309 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
6310 doc
: /* Accumulated time elapsed in garbage collections.
6311 The time is in seconds as a floating point value. */);
6312 DEFVAR_INT ("gcs-done", gcs_done
,
6313 doc
: /* Accumulated number of garbage collections done. */);
6318 defsubr (&Smake_byte_code
);
6319 defsubr (&Smake_list
);
6320 defsubr (&Smake_vector
);
6321 defsubr (&Smake_string
);
6322 defsubr (&Smake_bool_vector
);
6323 defsubr (&Smake_symbol
);
6324 defsubr (&Smake_marker
);
6325 defsubr (&Spurecopy
);
6326 defsubr (&Sgarbage_collect
);
6327 defsubr (&Smemory_limit
);
6328 defsubr (&Smemory_use_counts
);
6330 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
6331 defsubr (&Sgc_status
);