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
72 /* Specify maximum number of areas to mmap. It would be nice to use a
73 value that explicitly means "no limit". */
75 #define MMAP_MAX_AREAS 100000000
77 #else /* not DOUG_LEA_MALLOC */
79 /* The following come from gmalloc.c. */
81 extern size_t _bytes_used
;
82 extern size_t __malloc_extra_blocks
;
84 #endif /* not DOUG_LEA_MALLOC */
86 #if ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT
87 #ifdef HAVE_GTK_AND_PTHREAD
89 /* When GTK uses the file chooser dialog, different backends can be loaded
90 dynamically. One such a backend is the Gnome VFS backend that gets loaded
91 if you run Gnome. That backend creates several threads and also allocates
94 If Emacs sets malloc hooks (! SYSTEM_MALLOC) and the emacs_blocked_*
95 functions below are called from malloc, there is a chance that one
96 of these threads preempts the Emacs main thread and the hook variables
97 end up in an inconsistent state. So we have a mutex to prevent that (note
98 that the backend handles concurrent access to malloc within its own threads
99 but Emacs code running in the main thread is not included in that control).
101 When UNBLOCK_INPUT is called, reinvoke_input_signal may be called. If this
102 happens in one of the backend threads we will have two threads that tries
103 to run Emacs code at once, and the code is not prepared for that.
104 To prevent that, we only call BLOCK/UNBLOCK from the main thread. */
106 static pthread_mutex_t alloc_mutex
;
108 #define BLOCK_INPUT_ALLOC \
111 if (pthread_equal (pthread_self (), main_thread)) \
113 pthread_mutex_lock (&alloc_mutex); \
116 #define UNBLOCK_INPUT_ALLOC \
119 pthread_mutex_unlock (&alloc_mutex); \
120 if (pthread_equal (pthread_self (), main_thread)) \
125 #else /* ! defined HAVE_GTK_AND_PTHREAD */
127 #define BLOCK_INPUT_ALLOC BLOCK_INPUT
128 #define UNBLOCK_INPUT_ALLOC UNBLOCK_INPUT
130 #endif /* ! defined HAVE_GTK_AND_PTHREAD */
131 #endif /* ! defined SYSTEM_MALLOC && ! defined SYNC_INPUT */
133 /* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
134 to a struct Lisp_String. */
136 #define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
137 #define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
138 #define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
140 #define VECTOR_MARK(V) ((V)->header.size |= ARRAY_MARK_FLAG)
141 #define VECTOR_UNMARK(V) ((V)->header.size &= ~ARRAY_MARK_FLAG)
142 #define VECTOR_MARKED_P(V) (((V)->header.size & ARRAY_MARK_FLAG) != 0)
144 /* Value is the number of bytes of S, a pointer to a struct Lisp_String.
145 Be careful during GC, because S->size contains the mark bit for
148 #define GC_STRING_BYTES(S) (STRING_BYTES (S))
150 /* Global variables. */
151 struct emacs_globals globals
;
153 /* Number of bytes of consing done since the last gc. */
155 EMACS_INT consing_since_gc
;
157 /* Similar minimum, computed from Vgc_cons_percentage. */
159 EMACS_INT gc_relative_threshold
;
161 /* Minimum number of bytes of consing since GC before next GC,
162 when memory is full. */
164 EMACS_INT memory_full_cons_threshold
;
166 /* Nonzero during GC. */
170 /* Nonzero means abort if try to GC.
171 This is for code which is written on the assumption that
172 no GC will happen, so as to verify that assumption. */
176 /* Number of live and free conses etc. */
178 static EMACS_INT total_conses
, total_markers
, total_symbols
, total_vector_size
;
179 static EMACS_INT total_free_conses
, total_free_markers
, total_free_symbols
;
180 static EMACS_INT total_free_floats
, total_floats
;
182 /* Points to memory space allocated as "spare", to be freed if we run
183 out of memory. We keep one large block, four cons-blocks, and
184 two string blocks. */
186 static char *spare_memory
[7];
188 /* Amount of spare memory to keep in large reserve block, or to see
189 whether this much is available when malloc fails on a larger request. */
191 #define SPARE_MEMORY (1 << 14)
193 /* Number of extra blocks malloc should get when it needs more core. */
195 static int malloc_hysteresis
;
197 /* Initialize it to a nonzero value to force it into data space
198 (rather than bss space). That way unexec will remap it into text
199 space (pure), on some systems. We have not implemented the
200 remapping on more recent systems because this is less important
201 nowadays than in the days of small memories and timesharing. */
203 #ifndef VIRT_ADDR_VARIES
206 EMACS_INT pure
[(PURESIZE
+ sizeof (EMACS_INT
) - 1) / sizeof (EMACS_INT
)] = {1,};
207 #define PUREBEG (char *) pure
209 /* Pointer to the pure area, and its size. */
211 static char *purebeg
;
212 static ptrdiff_t pure_size
;
214 /* Number of bytes of pure storage used before pure storage overflowed.
215 If this is non-zero, this implies that an overflow occurred. */
217 static ptrdiff_t pure_bytes_used_before_overflow
;
219 /* Value is non-zero if P points into pure space. */
221 #define PURE_POINTER_P(P) \
222 (((PNTR_COMPARISON_TYPE) (P) \
223 < (PNTR_COMPARISON_TYPE) ((char *) purebeg + pure_size)) \
224 && ((PNTR_COMPARISON_TYPE) (P) \
225 >= (PNTR_COMPARISON_TYPE) purebeg))
227 /* Index in pure at which next pure Lisp object will be allocated.. */
229 static EMACS_INT pure_bytes_used_lisp
;
231 /* Number of bytes allocated for non-Lisp objects in pure storage. */
233 static EMACS_INT pure_bytes_used_non_lisp
;
235 /* If nonzero, this is a warning delivered by malloc and not yet
238 const char *pending_malloc_warning
;
240 /* Maximum amount of C stack to save when a GC happens. */
242 #ifndef MAX_SAVE_STACK
243 #define MAX_SAVE_STACK 16000
246 /* Buffer in which we save a copy of the C stack at each GC. */
248 #if MAX_SAVE_STACK > 0
249 static char *stack_copy
;
250 static ptrdiff_t stack_copy_size
;
253 /* Non-zero means ignore malloc warnings. Set during initialization.
254 Currently not used. */
256 static int ignore_warnings
;
258 static Lisp_Object Qgc_cons_threshold
;
259 Lisp_Object Qchar_table_extra_slots
;
261 /* Hook run after GC has finished. */
263 static Lisp_Object Qpost_gc_hook
;
265 static void mark_buffer (Lisp_Object
);
266 static void mark_terminals (void);
267 static void gc_sweep (void);
268 static void mark_glyph_matrix (struct glyph_matrix
*);
269 static void mark_face_cache (struct face_cache
*);
271 #if !defined REL_ALLOC || defined SYSTEM_MALLOC
272 static void refill_memory_reserve (void);
274 static struct Lisp_String
*allocate_string (void);
275 static void compact_small_strings (void);
276 static void free_large_strings (void);
277 static void sweep_strings (void);
278 static void free_misc (Lisp_Object
);
280 /* When scanning the C stack for live Lisp objects, Emacs keeps track
281 of what memory allocated via lisp_malloc is intended for what
282 purpose. This enumeration specifies the type of memory. */
293 /* We used to keep separate mem_types for subtypes of vectors such as
294 process, hash_table, frame, terminal, and window, but we never made
295 use of the distinction, so it only caused source-code complexity
296 and runtime slowdown. Minor but pointless. */
300 static POINTER_TYPE
*lisp_align_malloc (size_t, enum mem_type
);
301 static POINTER_TYPE
*lisp_malloc (size_t, enum mem_type
);
304 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
306 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
307 #include <stdio.h> /* For fprintf. */
310 /* A unique object in pure space used to make some Lisp objects
311 on free lists recognizable in O(1). */
313 static Lisp_Object Vdead
;
315 #ifdef GC_MALLOC_CHECK
317 enum mem_type allocated_mem_type
;
318 static int dont_register_blocks
;
320 #endif /* GC_MALLOC_CHECK */
322 /* A node in the red-black tree describing allocated memory containing
323 Lisp data. Each such block is recorded with its start and end
324 address when it is allocated, and removed from the tree when it
327 A red-black tree is a balanced binary tree with the following
330 1. Every node is either red or black.
331 2. Every leaf is black.
332 3. If a node is red, then both of its children are black.
333 4. Every simple path from a node to a descendant leaf contains
334 the same number of black nodes.
335 5. The root is always black.
337 When nodes are inserted into the tree, or deleted from the tree,
338 the tree is "fixed" so that these properties are always true.
340 A red-black tree with N internal nodes has height at most 2
341 log(N+1). Searches, insertions and deletions are done in O(log N).
342 Please see a text book about data structures for a detailed
343 description of red-black trees. Any book worth its salt should
348 /* Children of this node. These pointers are never NULL. When there
349 is no child, the value is MEM_NIL, which points to a dummy node. */
350 struct mem_node
*left
, *right
;
352 /* The parent of this node. In the root node, this is NULL. */
353 struct mem_node
*parent
;
355 /* Start and end of allocated region. */
359 enum {MEM_BLACK
, MEM_RED
} color
;
365 /* Base address of stack. Set in main. */
367 Lisp_Object
*stack_base
;
369 /* Root of the tree describing allocated Lisp memory. */
371 static struct mem_node
*mem_root
;
373 /* Lowest and highest known address in the heap. */
375 static void *min_heap_address
, *max_heap_address
;
377 /* Sentinel node of the tree. */
379 static struct mem_node mem_z
;
380 #define MEM_NIL &mem_z
382 static struct Lisp_Vector
*allocate_vectorlike (EMACS_INT
);
383 static void lisp_free (POINTER_TYPE
*);
384 static void mark_stack (void);
385 static int live_vector_p (struct mem_node
*, void *);
386 static int live_buffer_p (struct mem_node
*, void *);
387 static int live_string_p (struct mem_node
*, void *);
388 static int live_cons_p (struct mem_node
*, void *);
389 static int live_symbol_p (struct mem_node
*, void *);
390 static int live_float_p (struct mem_node
*, void *);
391 static int live_misc_p (struct mem_node
*, void *);
392 static void mark_maybe_object (Lisp_Object
);
393 static void mark_memory (void *, void *, int);
394 static void mem_init (void);
395 static struct mem_node
*mem_insert (void *, void *, enum mem_type
);
396 static void mem_insert_fixup (struct mem_node
*);
397 static void mem_rotate_left (struct mem_node
*);
398 static void mem_rotate_right (struct mem_node
*);
399 static void mem_delete (struct mem_node
*);
400 static void mem_delete_fixup (struct mem_node
*);
401 static inline struct mem_node
*mem_find (void *);
404 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
405 static void check_gcpros (void);
408 #endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
410 /* Recording what needs to be marked for gc. */
412 struct gcpro
*gcprolist
;
414 /* Addresses of staticpro'd variables. Initialize it to a nonzero
415 value; otherwise some compilers put it into BSS. */
417 #define NSTATICS 0x640
418 static Lisp_Object
*staticvec
[NSTATICS
] = {&Vpurify_flag
};
420 /* Index of next unused slot in staticvec. */
422 static int staticidx
= 0;
424 static POINTER_TYPE
*pure_alloc (size_t, int);
427 /* Value is SZ rounded up to the next multiple of ALIGNMENT.
428 ALIGNMENT must be a power of 2. */
430 #define ALIGN(ptr, ALIGNMENT) \
431 ((POINTER_TYPE *) ((((uintptr_t) (ptr)) + (ALIGNMENT) - 1) \
432 & ~((ALIGNMENT) - 1)))
436 /************************************************************************
438 ************************************************************************/
440 /* Function malloc calls this if it finds we are near exhausting storage. */
443 malloc_warning (const char *str
)
445 pending_malloc_warning
= str
;
449 /* Display an already-pending malloc warning. */
452 display_malloc_warning (void)
454 call3 (intern ("display-warning"),
456 build_string (pending_malloc_warning
),
457 intern ("emergency"));
458 pending_malloc_warning
= 0;
461 /* Called if we can't allocate relocatable space for a buffer. */
464 buffer_memory_full (EMACS_INT nbytes
)
466 /* If buffers use the relocating allocator, no need to free
467 spare_memory, because we may have plenty of malloc space left
468 that we could get, and if we don't, the malloc that fails will
469 itself cause spare_memory to be freed. If buffers don't use the
470 relocating allocator, treat this like any other failing
474 memory_full (nbytes
);
477 /* This used to call error, but if we've run out of memory, we could
478 get infinite recursion trying to build the string. */
479 xsignal (Qnil
, Vmemory_signal_data
);
483 #ifndef XMALLOC_OVERRUN_CHECK
484 #define XMALLOC_OVERRUN_CHECK_OVERHEAD 0
487 /* Check for overrun in malloc'ed buffers by wrapping a header and trailer
490 The header consists of 16 fixed bytes followed by sizeof (size_t) bytes
491 containing the original block size in little-endian order,
492 while the trailer consists of 16 fixed bytes.
494 The header is used to detect whether this block has been allocated
495 through these functions -- as it seems that some low-level libc
496 functions may bypass the malloc hooks.
500 #define XMALLOC_OVERRUN_CHECK_SIZE 16
501 #define XMALLOC_OVERRUN_CHECK_OVERHEAD \
502 (2 * XMALLOC_OVERRUN_CHECK_SIZE + sizeof (size_t))
504 static char const xmalloc_overrun_check_header
[XMALLOC_OVERRUN_CHECK_SIZE
] =
505 { '\x9a', '\x9b', '\xae', '\xaf',
506 '\xbf', '\xbe', '\xce', '\xcf',
507 '\xea', '\xeb', '\xec', '\xed',
508 '\xdf', '\xde', '\x9c', '\x9d' };
510 static char const xmalloc_overrun_check_trailer
[XMALLOC_OVERRUN_CHECK_SIZE
] =
511 { '\xaa', '\xab', '\xac', '\xad',
512 '\xba', '\xbb', '\xbc', '\xbd',
513 '\xca', '\xcb', '\xcc', '\xcd',
514 '\xda', '\xdb', '\xdc', '\xdd' };
516 /* Insert and extract the block size in the header. */
519 xmalloc_put_size (unsigned char *ptr
, size_t size
)
522 for (i
= 0; i
< sizeof (size_t); i
++)
524 *--ptr
= size
& (1 << CHAR_BIT
) - 1;
530 xmalloc_get_size (unsigned char *ptr
)
534 ptr
-= sizeof (size_t);
535 for (i
= 0; i
< sizeof (size_t); i
++)
544 /* The call depth in overrun_check functions. For example, this might happen:
546 overrun_check_malloc()
547 -> malloc -> (via hook)_-> emacs_blocked_malloc
548 -> overrun_check_malloc
549 call malloc (hooks are NULL, so real malloc is called).
550 malloc returns 10000.
551 add overhead, return 10016.
552 <- (back in overrun_check_malloc)
553 add overhead again, return 10032
554 xmalloc returns 10032.
559 overrun_check_free(10032)
561 free(10016) <- crash, because 10000 is the original pointer. */
563 static ptrdiff_t check_depth
;
565 /* Like malloc, but wraps allocated block with header and trailer. */
567 static POINTER_TYPE
*
568 overrun_check_malloc (size_t size
)
570 register unsigned char *val
;
571 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
572 if (SIZE_MAX
- overhead
< size
)
575 val
= (unsigned char *) malloc (size
+ overhead
);
576 if (val
&& check_depth
== 1)
578 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
579 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ sizeof (size_t);
580 xmalloc_put_size (val
, size
);
581 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
582 XMALLOC_OVERRUN_CHECK_SIZE
);
585 return (POINTER_TYPE
*)val
;
589 /* Like realloc, but checks old block for overrun, and wraps new block
590 with header and trailer. */
592 static POINTER_TYPE
*
593 overrun_check_realloc (POINTER_TYPE
*block
, size_t size
)
595 register unsigned char *val
= (unsigned char *) block
;
596 int overhead
= ++check_depth
== 1 ? XMALLOC_OVERRUN_CHECK_OVERHEAD
: 0;
597 if (SIZE_MAX
- overhead
< size
)
602 && memcmp (xmalloc_overrun_check_header
,
603 val
- XMALLOC_OVERRUN_CHECK_SIZE
- sizeof (size_t),
604 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
606 size_t osize
= xmalloc_get_size (val
);
607 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
608 XMALLOC_OVERRUN_CHECK_SIZE
))
610 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
611 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ sizeof (size_t);
612 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ sizeof (size_t));
615 val
= (unsigned char *) realloc ((POINTER_TYPE
*)val
, size
+ overhead
);
617 if (val
&& check_depth
== 1)
619 memcpy (val
, xmalloc_overrun_check_header
, XMALLOC_OVERRUN_CHECK_SIZE
);
620 val
+= XMALLOC_OVERRUN_CHECK_SIZE
+ sizeof (size_t);
621 xmalloc_put_size (val
, size
);
622 memcpy (val
+ size
, xmalloc_overrun_check_trailer
,
623 XMALLOC_OVERRUN_CHECK_SIZE
);
626 return (POINTER_TYPE
*)val
;
629 /* Like free, but checks block for overrun. */
632 overrun_check_free (POINTER_TYPE
*block
)
634 unsigned char *val
= (unsigned char *) block
;
639 && memcmp (xmalloc_overrun_check_header
,
640 val
- XMALLOC_OVERRUN_CHECK_SIZE
- sizeof (size_t),
641 XMALLOC_OVERRUN_CHECK_SIZE
) == 0)
643 size_t osize
= xmalloc_get_size (val
);
644 if (memcmp (xmalloc_overrun_check_trailer
, val
+ osize
,
645 XMALLOC_OVERRUN_CHECK_SIZE
))
647 #ifdef XMALLOC_CLEAR_FREE_MEMORY
648 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ sizeof (size_t);
649 memset (val
, 0xff, osize
+ XMALLOC_OVERRUN_CHECK_OVERHEAD
);
651 memset (val
+ osize
, 0, XMALLOC_OVERRUN_CHECK_SIZE
);
652 val
-= XMALLOC_OVERRUN_CHECK_SIZE
+ sizeof (size_t);
653 memset (val
, 0, XMALLOC_OVERRUN_CHECK_SIZE
+ sizeof (size_t));
664 #define malloc overrun_check_malloc
665 #define realloc overrun_check_realloc
666 #define free overrun_check_free
670 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
671 there's no need to block input around malloc. */
672 #define MALLOC_BLOCK_INPUT ((void)0)
673 #define MALLOC_UNBLOCK_INPUT ((void)0)
675 #define MALLOC_BLOCK_INPUT BLOCK_INPUT
676 #define MALLOC_UNBLOCK_INPUT UNBLOCK_INPUT
679 /* Like malloc but check for no memory and block interrupt input.. */
682 xmalloc (size_t size
)
684 register POINTER_TYPE
*val
;
687 val
= (POINTER_TYPE
*) malloc (size
);
688 MALLOC_UNBLOCK_INPUT
;
696 /* Like realloc but check for no memory and block interrupt input.. */
699 xrealloc (POINTER_TYPE
*block
, size_t size
)
701 register POINTER_TYPE
*val
;
704 /* We must call malloc explicitly when BLOCK is 0, since some
705 reallocs don't do this. */
707 val
= (POINTER_TYPE
*) malloc (size
);
709 val
= (POINTER_TYPE
*) realloc (block
, size
);
710 MALLOC_UNBLOCK_INPUT
;
718 /* Like free but block interrupt input. */
721 xfree (POINTER_TYPE
*block
)
727 MALLOC_UNBLOCK_INPUT
;
728 /* We don't call refill_memory_reserve here
729 because that duplicates doing so in emacs_blocked_free
730 and the criterion should go there. */
734 /* Like strdup, but uses xmalloc. */
737 xstrdup (const char *s
)
739 size_t len
= strlen (s
) + 1;
740 char *p
= (char *) xmalloc (len
);
746 /* Unwind for SAFE_ALLOCA */
749 safe_alloca_unwind (Lisp_Object arg
)
751 register struct Lisp_Save_Value
*p
= XSAVE_VALUE (arg
);
761 /* Like malloc but used for allocating Lisp data. NBYTES is the
762 number of bytes to allocate, TYPE describes the intended use of the
763 allcated memory block (for strings, for conses, ...). */
766 static void *lisp_malloc_loser
;
769 static POINTER_TYPE
*
770 lisp_malloc (size_t nbytes
, enum mem_type type
)
776 #ifdef GC_MALLOC_CHECK
777 allocated_mem_type
= type
;
780 val
= (void *) malloc (nbytes
);
783 /* If the memory just allocated cannot be addressed thru a Lisp
784 object's pointer, and it needs to be,
785 that's equivalent to running out of memory. */
786 if (val
&& type
!= MEM_TYPE_NON_LISP
)
789 XSETCONS (tem
, (char *) val
+ nbytes
- 1);
790 if ((char *) XCONS (tem
) != (char *) val
+ nbytes
- 1)
792 lisp_malloc_loser
= val
;
799 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
800 if (val
&& type
!= MEM_TYPE_NON_LISP
)
801 mem_insert (val
, (char *) val
+ nbytes
, type
);
804 MALLOC_UNBLOCK_INPUT
;
806 memory_full (nbytes
);
810 /* Free BLOCK. This must be called to free memory allocated with a
811 call to lisp_malloc. */
814 lisp_free (POINTER_TYPE
*block
)
818 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
819 mem_delete (mem_find (block
));
821 MALLOC_UNBLOCK_INPUT
;
824 /* Allocation of aligned blocks of memory to store Lisp data. */
825 /* The entry point is lisp_align_malloc which returns blocks of at most */
826 /* BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
828 /* Use posix_memalloc if the system has it and we're using the system's
829 malloc (because our gmalloc.c routines don't have posix_memalign although
830 its memalloc could be used). */
831 #if defined (HAVE_POSIX_MEMALIGN) && defined (SYSTEM_MALLOC)
832 #define USE_POSIX_MEMALIGN 1
835 /* BLOCK_ALIGN has to be a power of 2. */
836 #define BLOCK_ALIGN (1 << 10)
838 /* Padding to leave at the end of a malloc'd block. This is to give
839 malloc a chance to minimize the amount of memory wasted to alignment.
840 It should be tuned to the particular malloc library used.
841 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
842 posix_memalign on the other hand would ideally prefer a value of 4
843 because otherwise, there's 1020 bytes wasted between each ablocks.
844 In Emacs, testing shows that those 1020 can most of the time be
845 efficiently used by malloc to place other objects, so a value of 0 can
846 still preferable unless you have a lot of aligned blocks and virtually
848 #define BLOCK_PADDING 0
849 #define BLOCK_BYTES \
850 (BLOCK_ALIGN - sizeof (struct ablocks *) - BLOCK_PADDING)
852 /* Internal data structures and constants. */
854 #define ABLOCKS_SIZE 16
856 /* An aligned block of memory. */
861 char payload
[BLOCK_BYTES
];
862 struct ablock
*next_free
;
864 /* `abase' is the aligned base of the ablocks. */
865 /* It is overloaded to hold the virtual `busy' field that counts
866 the number of used ablock in the parent ablocks.
867 The first ablock has the `busy' field, the others have the `abase'
868 field. To tell the difference, we assume that pointers will have
869 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
870 is used to tell whether the real base of the parent ablocks is `abase'
871 (if not, the word before the first ablock holds a pointer to the
873 struct ablocks
*abase
;
874 /* The padding of all but the last ablock is unused. The padding of
875 the last ablock in an ablocks is not allocated. */
877 char padding
[BLOCK_PADDING
];
881 /* A bunch of consecutive aligned blocks. */
884 struct ablock blocks
[ABLOCKS_SIZE
];
887 /* Size of the block requested from malloc or memalign. */
888 #define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
890 #define ABLOCK_ABASE(block) \
891 (((uintptr_t) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
892 ? (struct ablocks *)(block) \
895 /* Virtual `busy' field. */
896 #define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
898 /* Pointer to the (not necessarily aligned) malloc block. */
899 #ifdef USE_POSIX_MEMALIGN
900 #define ABLOCKS_BASE(abase) (abase)
902 #define ABLOCKS_BASE(abase) \
903 (1 & (intptr_t) ABLOCKS_BUSY (abase) ? abase : ((void**)abase)[-1])
906 /* The list of free ablock. */
907 static struct ablock
*free_ablock
;
909 /* Allocate an aligned block of nbytes.
910 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
911 smaller or equal to BLOCK_BYTES. */
912 static POINTER_TYPE
*
913 lisp_align_malloc (size_t nbytes
, enum mem_type type
)
916 struct ablocks
*abase
;
918 eassert (nbytes
<= BLOCK_BYTES
);
922 #ifdef GC_MALLOC_CHECK
923 allocated_mem_type
= type
;
929 intptr_t aligned
; /* int gets warning casting to 64-bit pointer. */
931 #ifdef DOUG_LEA_MALLOC
932 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
933 because mapped region contents are not preserved in
935 mallopt (M_MMAP_MAX
, 0);
938 #ifdef USE_POSIX_MEMALIGN
940 int err
= posix_memalign (&base
, BLOCK_ALIGN
, ABLOCKS_BYTES
);
946 base
= malloc (ABLOCKS_BYTES
);
947 abase
= ALIGN (base
, BLOCK_ALIGN
);
952 MALLOC_UNBLOCK_INPUT
;
953 memory_full (ABLOCKS_BYTES
);
956 aligned
= (base
== abase
);
958 ((void**)abase
)[-1] = base
;
960 #ifdef DOUG_LEA_MALLOC
961 /* Back to a reasonable maximum of mmap'ed areas. */
962 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
966 /* If the memory just allocated cannot be addressed thru a Lisp
967 object's pointer, and it needs to be, that's equivalent to
968 running out of memory. */
969 if (type
!= MEM_TYPE_NON_LISP
)
972 char *end
= (char *) base
+ ABLOCKS_BYTES
- 1;
974 if ((char *) XCONS (tem
) != end
)
976 lisp_malloc_loser
= base
;
978 MALLOC_UNBLOCK_INPUT
;
979 memory_full (SIZE_MAX
);
984 /* Initialize the blocks and put them on the free list.
985 Is `base' was not properly aligned, we can't use the last block. */
986 for (i
= 0; i
< (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1); i
++)
988 abase
->blocks
[i
].abase
= abase
;
989 abase
->blocks
[i
].x
.next_free
= free_ablock
;
990 free_ablock
= &abase
->blocks
[i
];
992 ABLOCKS_BUSY (abase
) = (struct ablocks
*) aligned
;
994 eassert (0 == ((uintptr_t) abase
) % BLOCK_ALIGN
);
995 eassert (ABLOCK_ABASE (&abase
->blocks
[3]) == abase
); /* 3 is arbitrary */
996 eassert (ABLOCK_ABASE (&abase
->blocks
[0]) == abase
);
997 eassert (ABLOCKS_BASE (abase
) == base
);
998 eassert (aligned
== (intptr_t) ABLOCKS_BUSY (abase
));
1001 abase
= ABLOCK_ABASE (free_ablock
);
1002 ABLOCKS_BUSY (abase
) =
1003 (struct ablocks
*) (2 + (intptr_t) ABLOCKS_BUSY (abase
));
1005 free_ablock
= free_ablock
->x
.next_free
;
1007 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1008 if (type
!= MEM_TYPE_NON_LISP
)
1009 mem_insert (val
, (char *) val
+ nbytes
, type
);
1012 MALLOC_UNBLOCK_INPUT
;
1014 eassert (0 == ((uintptr_t) val
) % BLOCK_ALIGN
);
1019 lisp_align_free (POINTER_TYPE
*block
)
1021 struct ablock
*ablock
= block
;
1022 struct ablocks
*abase
= ABLOCK_ABASE (ablock
);
1025 #if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1026 mem_delete (mem_find (block
));
1028 /* Put on free list. */
1029 ablock
->x
.next_free
= free_ablock
;
1030 free_ablock
= ablock
;
1031 /* Update busy count. */
1032 ABLOCKS_BUSY (abase
) =
1033 (struct ablocks
*) (-2 + (intptr_t) ABLOCKS_BUSY (abase
));
1035 if (2 > (intptr_t) ABLOCKS_BUSY (abase
))
1036 { /* All the blocks are free. */
1037 int i
= 0, aligned
= (intptr_t) ABLOCKS_BUSY (abase
);
1038 struct ablock
**tem
= &free_ablock
;
1039 struct ablock
*atop
= &abase
->blocks
[aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1];
1043 if (*tem
>= (struct ablock
*) abase
&& *tem
< atop
)
1046 *tem
= (*tem
)->x
.next_free
;
1049 tem
= &(*tem
)->x
.next_free
;
1051 eassert ((aligned
& 1) == aligned
);
1052 eassert (i
== (aligned
? ABLOCKS_SIZE
: ABLOCKS_SIZE
- 1));
1053 #ifdef USE_POSIX_MEMALIGN
1054 eassert ((uintptr_t) ABLOCKS_BASE (abase
) % BLOCK_ALIGN
== 0);
1056 free (ABLOCKS_BASE (abase
));
1058 MALLOC_UNBLOCK_INPUT
;
1061 /* Return a new buffer structure allocated from the heap with
1062 a call to lisp_malloc. */
1065 allocate_buffer (void)
1068 = (struct buffer
*) lisp_malloc (sizeof (struct buffer
),
1070 XSETPVECTYPESIZE (b
, PVEC_BUFFER
,
1071 ((sizeof (struct buffer
) + sizeof (EMACS_INT
) - 1)
1072 / sizeof (EMACS_INT
)));
1077 #ifndef SYSTEM_MALLOC
1079 /* Arranging to disable input signals while we're in malloc.
1081 This only works with GNU malloc. To help out systems which can't
1082 use GNU malloc, all the calls to malloc, realloc, and free
1083 elsewhere in the code should be inside a BLOCK_INPUT/UNBLOCK_INPUT
1084 pair; unfortunately, we have no idea what C library functions
1085 might call malloc, so we can't really protect them unless you're
1086 using GNU malloc. Fortunately, most of the major operating systems
1087 can use GNU malloc. */
1090 /* When using SYNC_INPUT, we don't call malloc from a signal handler, so
1091 there's no need to block input around malloc. */
1093 #ifndef DOUG_LEA_MALLOC
1094 extern void * (*__malloc_hook
) (size_t, const void *);
1095 extern void * (*__realloc_hook
) (void *, size_t, const void *);
1096 extern void (*__free_hook
) (void *, const void *);
1097 /* Else declared in malloc.h, perhaps with an extra arg. */
1098 #endif /* DOUG_LEA_MALLOC */
1099 static void * (*old_malloc_hook
) (size_t, const void *);
1100 static void * (*old_realloc_hook
) (void *, size_t, const void*);
1101 static void (*old_free_hook
) (void*, const void*);
1103 #ifdef DOUG_LEA_MALLOC
1104 # define BYTES_USED (mallinfo ().uordblks)
1106 # define BYTES_USED _bytes_used
1109 static size_t bytes_used_when_reconsidered
;
1111 /* Value of _bytes_used, when spare_memory was freed. */
1113 static size_t bytes_used_when_full
;
1115 /* This function is used as the hook for free to call. */
1118 emacs_blocked_free (void *ptr
, const void *ptr2
)
1122 #ifdef GC_MALLOC_CHECK
1128 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1131 "Freeing `%p' which wasn't allocated with malloc\n", ptr
);
1136 /* fprintf (stderr, "free %p...%p (%p)\n", m->start, m->end, ptr); */
1140 #endif /* GC_MALLOC_CHECK */
1142 __free_hook
= old_free_hook
;
1145 /* If we released our reserve (due to running out of memory),
1146 and we have a fair amount free once again,
1147 try to set aside another reserve in case we run out once more. */
1148 if (! NILP (Vmemory_full
)
1149 /* Verify there is enough space that even with the malloc
1150 hysteresis this call won't run out again.
1151 The code here is correct as long as SPARE_MEMORY
1152 is substantially larger than the block size malloc uses. */
1153 && (bytes_used_when_full
1154 > ((bytes_used_when_reconsidered
= BYTES_USED
)
1155 + max (malloc_hysteresis
, 4) * SPARE_MEMORY
)))
1156 refill_memory_reserve ();
1158 __free_hook
= emacs_blocked_free
;
1159 UNBLOCK_INPUT_ALLOC
;
1163 /* This function is the malloc hook that Emacs uses. */
1166 emacs_blocked_malloc (size_t size
, const void *ptr
)
1171 __malloc_hook
= old_malloc_hook
;
1172 #ifdef DOUG_LEA_MALLOC
1173 /* Segfaults on my system. --lorentey */
1174 /* mallopt (M_TOP_PAD, malloc_hysteresis * 4096); */
1176 __malloc_extra_blocks
= malloc_hysteresis
;
1179 value
= (void *) malloc (size
);
1181 #ifdef GC_MALLOC_CHECK
1183 struct mem_node
*m
= mem_find (value
);
1186 fprintf (stderr
, "Malloc returned %p which is already in use\n",
1188 fprintf (stderr
, "Region in use is %p...%p, %u bytes, type %d\n",
1189 m
->start
, m
->end
, (char *) m
->end
- (char *) m
->start
,
1194 if (!dont_register_blocks
)
1196 mem_insert (value
, (char *) value
+ max (1, size
), allocated_mem_type
);
1197 allocated_mem_type
= MEM_TYPE_NON_LISP
;
1200 #endif /* GC_MALLOC_CHECK */
1202 __malloc_hook
= emacs_blocked_malloc
;
1203 UNBLOCK_INPUT_ALLOC
;
1205 /* fprintf (stderr, "%p malloc\n", value); */
1210 /* This function is the realloc hook that Emacs uses. */
1213 emacs_blocked_realloc (void *ptr
, size_t size
, const void *ptr2
)
1218 __realloc_hook
= old_realloc_hook
;
1220 #ifdef GC_MALLOC_CHECK
1223 struct mem_node
*m
= mem_find (ptr
);
1224 if (m
== MEM_NIL
|| m
->start
!= ptr
)
1227 "Realloc of %p which wasn't allocated with malloc\n",
1235 /* fprintf (stderr, "%p -> realloc\n", ptr); */
1237 /* Prevent malloc from registering blocks. */
1238 dont_register_blocks
= 1;
1239 #endif /* GC_MALLOC_CHECK */
1241 value
= (void *) realloc (ptr
, size
);
1243 #ifdef GC_MALLOC_CHECK
1244 dont_register_blocks
= 0;
1247 struct mem_node
*m
= mem_find (value
);
1250 fprintf (stderr
, "Realloc returns memory that is already in use\n");
1254 /* Can't handle zero size regions in the red-black tree. */
1255 mem_insert (value
, (char *) value
+ max (size
, 1), MEM_TYPE_NON_LISP
);
1258 /* fprintf (stderr, "%p <- realloc\n", value); */
1259 #endif /* GC_MALLOC_CHECK */
1261 __realloc_hook
= emacs_blocked_realloc
;
1262 UNBLOCK_INPUT_ALLOC
;
1268 #ifdef HAVE_GTK_AND_PTHREAD
1269 /* Called from Fdump_emacs so that when the dumped Emacs starts, it has a
1270 normal malloc. Some thread implementations need this as they call
1271 malloc before main. The pthread_self call in BLOCK_INPUT_ALLOC then
1272 calls malloc because it is the first call, and we have an endless loop. */
1275 reset_malloc_hooks (void)
1277 __free_hook
= old_free_hook
;
1278 __malloc_hook
= old_malloc_hook
;
1279 __realloc_hook
= old_realloc_hook
;
1281 #endif /* HAVE_GTK_AND_PTHREAD */
1284 /* Called from main to set up malloc to use our hooks. */
1287 uninterrupt_malloc (void)
1289 #ifdef HAVE_GTK_AND_PTHREAD
1290 #ifdef DOUG_LEA_MALLOC
1291 pthread_mutexattr_t attr
;
1293 /* GLIBC has a faster way to do this, but lets keep it portable.
1294 This is according to the Single UNIX Specification. */
1295 pthread_mutexattr_init (&attr
);
1296 pthread_mutexattr_settype (&attr
, PTHREAD_MUTEX_RECURSIVE
);
1297 pthread_mutex_init (&alloc_mutex
, &attr
);
1298 #else /* !DOUG_LEA_MALLOC */
1299 /* Some systems such as Solaris 2.6 don't have a recursive mutex,
1300 and the bundled gmalloc.c doesn't require it. */
1301 pthread_mutex_init (&alloc_mutex
, NULL
);
1302 #endif /* !DOUG_LEA_MALLOC */
1303 #endif /* HAVE_GTK_AND_PTHREAD */
1305 if (__free_hook
!= emacs_blocked_free
)
1306 old_free_hook
= __free_hook
;
1307 __free_hook
= emacs_blocked_free
;
1309 if (__malloc_hook
!= emacs_blocked_malloc
)
1310 old_malloc_hook
= __malloc_hook
;
1311 __malloc_hook
= emacs_blocked_malloc
;
1313 if (__realloc_hook
!= emacs_blocked_realloc
)
1314 old_realloc_hook
= __realloc_hook
;
1315 __realloc_hook
= emacs_blocked_realloc
;
1318 #endif /* not SYNC_INPUT */
1319 #endif /* not SYSTEM_MALLOC */
1323 /***********************************************************************
1325 ***********************************************************************/
1327 /* Number of intervals allocated in an interval_block structure.
1328 The 1020 is 1024 minus malloc overhead. */
1330 #define INTERVAL_BLOCK_SIZE \
1331 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1333 /* Intervals are allocated in chunks in form of an interval_block
1336 struct interval_block
1338 /* Place `intervals' first, to preserve alignment. */
1339 struct interval intervals
[INTERVAL_BLOCK_SIZE
];
1340 struct interval_block
*next
;
1343 /* Current interval block. Its `next' pointer points to older
1346 static struct interval_block
*interval_block
;
1348 /* Index in interval_block above of the next unused interval
1351 static int interval_block_index
;
1353 /* Number of free and live intervals. */
1355 static EMACS_INT total_free_intervals
, total_intervals
;
1357 /* List of free intervals. */
1359 static INTERVAL interval_free_list
;
1362 /* Initialize interval allocation. */
1365 init_intervals (void)
1367 interval_block
= NULL
;
1368 interval_block_index
= INTERVAL_BLOCK_SIZE
;
1369 interval_free_list
= 0;
1373 /* Return a new interval. */
1376 make_interval (void)
1380 /* eassert (!handling_signal); */
1384 if (interval_free_list
)
1386 val
= interval_free_list
;
1387 interval_free_list
= INTERVAL_PARENT (interval_free_list
);
1391 if (interval_block_index
== INTERVAL_BLOCK_SIZE
)
1393 register struct interval_block
*newi
;
1395 newi
= (struct interval_block
*) lisp_malloc (sizeof *newi
,
1398 newi
->next
= interval_block
;
1399 interval_block
= newi
;
1400 interval_block_index
= 0;
1402 val
= &interval_block
->intervals
[interval_block_index
++];
1405 MALLOC_UNBLOCK_INPUT
;
1407 consing_since_gc
+= sizeof (struct interval
);
1409 RESET_INTERVAL (val
);
1415 /* Mark Lisp objects in interval I. */
1418 mark_interval (register INTERVAL i
, Lisp_Object dummy
)
1420 eassert (!i
->gcmarkbit
); /* Intervals are never shared. */
1422 mark_object (i
->plist
);
1426 /* Mark the interval tree rooted in TREE. Don't call this directly;
1427 use the macro MARK_INTERVAL_TREE instead. */
1430 mark_interval_tree (register INTERVAL tree
)
1432 /* No need to test if this tree has been marked already; this
1433 function is always called through the MARK_INTERVAL_TREE macro,
1434 which takes care of that. */
1436 traverse_intervals_noorder (tree
, mark_interval
, Qnil
);
1440 /* Mark the interval tree rooted in I. */
1442 #define MARK_INTERVAL_TREE(i) \
1444 if (!NULL_INTERVAL_P (i) && !i->gcmarkbit) \
1445 mark_interval_tree (i); \
1449 #define UNMARK_BALANCE_INTERVALS(i) \
1451 if (! NULL_INTERVAL_P (i)) \
1452 (i) = balance_intervals (i); \
1456 /* Number support. If USE_LISP_UNION_TYPE is in effect, we
1457 can't create number objects in macros. */
1460 make_number (EMACS_INT n
)
1464 obj
.s
.type
= Lisp_Int
;
1469 /***********************************************************************
1471 ***********************************************************************/
1473 /* Lisp_Strings are allocated in string_block structures. When a new
1474 string_block is allocated, all the Lisp_Strings it contains are
1475 added to a free-list string_free_list. When a new Lisp_String is
1476 needed, it is taken from that list. During the sweep phase of GC,
1477 string_blocks that are entirely free are freed, except two which
1480 String data is allocated from sblock structures. Strings larger
1481 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1482 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1484 Sblocks consist internally of sdata structures, one for each
1485 Lisp_String. The sdata structure points to the Lisp_String it
1486 belongs to. The Lisp_String points back to the `u.data' member of
1487 its sdata structure.
1489 When a Lisp_String is freed during GC, it is put back on
1490 string_free_list, and its `data' member and its sdata's `string'
1491 pointer is set to null. The size of the string is recorded in the
1492 `u.nbytes' member of the sdata. So, sdata structures that are no
1493 longer used, can be easily recognized, and it's easy to compact the
1494 sblocks of small strings which we do in compact_small_strings. */
1496 /* Size in bytes of an sblock structure used for small strings. This
1497 is 8192 minus malloc overhead. */
1499 #define SBLOCK_SIZE 8188
1501 /* Strings larger than this are considered large strings. String data
1502 for large strings is allocated from individual sblocks. */
1504 #define LARGE_STRING_BYTES 1024
1506 /* Structure describing string memory sub-allocated from an sblock.
1507 This is where the contents of Lisp strings are stored. */
1511 /* Back-pointer to the string this sdata belongs to. If null, this
1512 structure is free, and the NBYTES member of the union below
1513 contains the string's byte size (the same value that STRING_BYTES
1514 would return if STRING were non-null). If non-null, STRING_BYTES
1515 (STRING) is the size of the data, and DATA contains the string's
1517 struct Lisp_String
*string
;
1519 #ifdef GC_CHECK_STRING_BYTES
1522 unsigned char data
[1];
1524 #define SDATA_NBYTES(S) (S)->nbytes
1525 #define SDATA_DATA(S) (S)->data
1526 #define SDATA_SELECTOR(member) member
1528 #else /* not GC_CHECK_STRING_BYTES */
1532 /* When STRING is non-null. */
1533 unsigned char data
[1];
1535 /* When STRING is null. */
1539 #define SDATA_NBYTES(S) (S)->u.nbytes
1540 #define SDATA_DATA(S) (S)->u.data
1541 #define SDATA_SELECTOR(member) u.member
1543 #endif /* not GC_CHECK_STRING_BYTES */
1545 #define SDATA_DATA_OFFSET offsetof (struct sdata, SDATA_SELECTOR (data))
1549 /* Structure describing a block of memory which is sub-allocated to
1550 obtain string data memory for strings. Blocks for small strings
1551 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1552 as large as needed. */
1557 struct sblock
*next
;
1559 /* Pointer to the next free sdata block. This points past the end
1560 of the sblock if there isn't any space left in this block. */
1561 struct sdata
*next_free
;
1563 /* Start of data. */
1564 struct sdata first_data
;
1567 /* Number of Lisp strings in a string_block structure. The 1020 is
1568 1024 minus malloc overhead. */
1570 #define STRING_BLOCK_SIZE \
1571 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1573 /* Structure describing a block from which Lisp_String structures
1578 /* Place `strings' first, to preserve alignment. */
1579 struct Lisp_String strings
[STRING_BLOCK_SIZE
];
1580 struct string_block
*next
;
1583 /* Head and tail of the list of sblock structures holding Lisp string
1584 data. We always allocate from current_sblock. The NEXT pointers
1585 in the sblock structures go from oldest_sblock to current_sblock. */
1587 static struct sblock
*oldest_sblock
, *current_sblock
;
1589 /* List of sblocks for large strings. */
1591 static struct sblock
*large_sblocks
;
1593 /* List of string_block structures. */
1595 static struct string_block
*string_blocks
;
1597 /* Free-list of Lisp_Strings. */
1599 static struct Lisp_String
*string_free_list
;
1601 /* Number of live and free Lisp_Strings. */
1603 static EMACS_INT total_strings
, total_free_strings
;
1605 /* Number of bytes used by live strings. */
1607 static EMACS_INT total_string_size
;
1609 /* Given a pointer to a Lisp_String S which is on the free-list
1610 string_free_list, return a pointer to its successor in the
1613 #define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1615 /* Return a pointer to the sdata structure belonging to Lisp string S.
1616 S must be live, i.e. S->data must not be null. S->data is actually
1617 a pointer to the `u.data' member of its sdata structure; the
1618 structure starts at a constant offset in front of that. */
1620 #define SDATA_OF_STRING(S) ((struct sdata *) ((S)->data - SDATA_DATA_OFFSET))
1623 #ifdef GC_CHECK_STRING_OVERRUN
1625 /* We check for overrun in string data blocks by appending a small
1626 "cookie" after each allocated string data block, and check for the
1627 presence of this cookie during GC. */
1629 #define GC_STRING_OVERRUN_COOKIE_SIZE 4
1630 static char const string_overrun_cookie
[GC_STRING_OVERRUN_COOKIE_SIZE
] =
1631 { '\xde', '\xad', '\xbe', '\xef' };
1634 #define GC_STRING_OVERRUN_COOKIE_SIZE 0
1637 /* Value is the size of an sdata structure large enough to hold NBYTES
1638 bytes of string data. The value returned includes a terminating
1639 NUL byte, the size of the sdata structure, and padding. */
1641 #ifdef GC_CHECK_STRING_BYTES
1643 #define SDATA_SIZE(NBYTES) \
1644 ((SDATA_DATA_OFFSET \
1646 + sizeof (EMACS_INT) - 1) \
1647 & ~(sizeof (EMACS_INT) - 1))
1649 #else /* not GC_CHECK_STRING_BYTES */
1651 /* The 'max' reserves space for the nbytes union member even when NBYTES + 1 is
1652 less than the size of that member. The 'max' is not needed when
1653 SDATA_DATA_OFFSET is a multiple of sizeof (EMACS_INT), because then the
1654 alignment code reserves enough space. */
1656 #define SDATA_SIZE(NBYTES) \
1657 ((SDATA_DATA_OFFSET \
1658 + (SDATA_DATA_OFFSET % sizeof (EMACS_INT) == 0 \
1660 : max (NBYTES, sizeof (EMACS_INT) - 1)) \
1662 + sizeof (EMACS_INT) - 1) \
1663 & ~(sizeof (EMACS_INT) - 1))
1665 #endif /* not GC_CHECK_STRING_BYTES */
1667 /* Extra bytes to allocate for each string. */
1669 #define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1671 /* Exact bound on the number of bytes in a string, not counting the
1672 terminating null. A string cannot contain more bytes than
1673 STRING_BYTES_BOUND, nor can it be so long that the size_t
1674 arithmetic in allocate_string_data would overflow while it is
1675 calculating a value to be passed to malloc. */
1676 #define STRING_BYTES_MAX \
1677 min (STRING_BYTES_BOUND, \
1678 ((SIZE_MAX - XMALLOC_OVERRUN_CHECK_OVERHEAD \
1680 - offsetof (struct sblock, first_data) \
1681 - SDATA_DATA_OFFSET) \
1682 & ~(sizeof (EMACS_INT) - 1)))
1684 /* Initialize string allocation. Called from init_alloc_once. */
1689 total_strings
= total_free_strings
= total_string_size
= 0;
1690 oldest_sblock
= current_sblock
= large_sblocks
= NULL
;
1691 string_blocks
= NULL
;
1692 string_free_list
= NULL
;
1693 empty_unibyte_string
= make_pure_string ("", 0, 0, 0);
1694 empty_multibyte_string
= make_pure_string ("", 0, 0, 1);
1698 #ifdef GC_CHECK_STRING_BYTES
1700 static int check_string_bytes_count
;
1702 #define CHECK_STRING_BYTES(S) STRING_BYTES (S)
1705 /* Like GC_STRING_BYTES, but with debugging check. */
1708 string_bytes (struct Lisp_String
*s
)
1711 (s
->size_byte
< 0 ? s
->size
& ~ARRAY_MARK_FLAG
: s
->size_byte
);
1713 if (!PURE_POINTER_P (s
)
1715 && nbytes
!= SDATA_NBYTES (SDATA_OF_STRING (s
)))
1720 /* Check validity of Lisp strings' string_bytes member in B. */
1723 check_sblock (struct sblock
*b
)
1725 struct sdata
*from
, *end
, *from_end
;
1729 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
1731 /* Compute the next FROM here because copying below may
1732 overwrite data we need to compute it. */
1735 /* Check that the string size recorded in the string is the
1736 same as the one recorded in the sdata structure. */
1738 CHECK_STRING_BYTES (from
->string
);
1741 nbytes
= GC_STRING_BYTES (from
->string
);
1743 nbytes
= SDATA_NBYTES (from
);
1745 nbytes
= SDATA_SIZE (nbytes
);
1746 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
1751 /* Check validity of Lisp strings' string_bytes member. ALL_P
1752 non-zero means check all strings, otherwise check only most
1753 recently allocated strings. Used for hunting a bug. */
1756 check_string_bytes (int all_p
)
1762 for (b
= large_sblocks
; b
; b
= b
->next
)
1764 struct Lisp_String
*s
= b
->first_data
.string
;
1766 CHECK_STRING_BYTES (s
);
1769 for (b
= oldest_sblock
; b
; b
= b
->next
)
1773 check_sblock (current_sblock
);
1776 #endif /* GC_CHECK_STRING_BYTES */
1778 #ifdef GC_CHECK_STRING_FREE_LIST
1780 /* Walk through the string free list looking for bogus next pointers.
1781 This may catch buffer overrun from a previous string. */
1784 check_string_free_list (void)
1786 struct Lisp_String
*s
;
1788 /* Pop a Lisp_String off the free-list. */
1789 s
= string_free_list
;
1792 if ((uintptr_t) s
< 1024)
1794 s
= NEXT_FREE_LISP_STRING (s
);
1798 #define check_string_free_list()
1801 /* Return a new Lisp_String. */
1803 static struct Lisp_String
*
1804 allocate_string (void)
1806 struct Lisp_String
*s
;
1808 /* eassert (!handling_signal); */
1812 /* If the free-list is empty, allocate a new string_block, and
1813 add all the Lisp_Strings in it to the free-list. */
1814 if (string_free_list
== NULL
)
1816 struct string_block
*b
;
1819 b
= (struct string_block
*) lisp_malloc (sizeof *b
, MEM_TYPE_STRING
);
1820 memset (b
, 0, sizeof *b
);
1821 b
->next
= string_blocks
;
1824 for (i
= STRING_BLOCK_SIZE
- 1; i
>= 0; --i
)
1827 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
1828 string_free_list
= s
;
1831 total_free_strings
+= STRING_BLOCK_SIZE
;
1834 check_string_free_list ();
1836 /* Pop a Lisp_String off the free-list. */
1837 s
= string_free_list
;
1838 string_free_list
= NEXT_FREE_LISP_STRING (s
);
1840 MALLOC_UNBLOCK_INPUT
;
1842 /* Probably not strictly necessary, but play it safe. */
1843 memset (s
, 0, sizeof *s
);
1845 --total_free_strings
;
1848 consing_since_gc
+= sizeof *s
;
1850 #ifdef GC_CHECK_STRING_BYTES
1851 if (!noninteractive
)
1853 if (++check_string_bytes_count
== 200)
1855 check_string_bytes_count
= 0;
1856 check_string_bytes (1);
1859 check_string_bytes (0);
1861 #endif /* GC_CHECK_STRING_BYTES */
1867 /* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1868 plus a NUL byte at the end. Allocate an sdata structure for S, and
1869 set S->data to its `u.data' member. Store a NUL byte at the end of
1870 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1871 S->data if it was initially non-null. */
1874 allocate_string_data (struct Lisp_String
*s
,
1875 EMACS_INT nchars
, EMACS_INT nbytes
)
1877 struct sdata
*data
, *old_data
;
1879 EMACS_INT needed
, old_nbytes
;
1881 if (STRING_BYTES_MAX
< nbytes
)
1884 /* Determine the number of bytes needed to store NBYTES bytes
1886 needed
= SDATA_SIZE (nbytes
);
1887 old_data
= s
->data
? SDATA_OF_STRING (s
) : NULL
;
1888 old_nbytes
= GC_STRING_BYTES (s
);
1892 if (nbytes
> LARGE_STRING_BYTES
)
1894 size_t size
= offsetof (struct sblock
, first_data
) + needed
;
1896 #ifdef DOUG_LEA_MALLOC
1897 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1898 because mapped region contents are not preserved in
1901 In case you think of allowing it in a dumped Emacs at the
1902 cost of not being able to re-dump, there's another reason:
1903 mmap'ed data typically have an address towards the top of the
1904 address space, which won't fit into an EMACS_INT (at least on
1905 32-bit systems with the current tagging scheme). --fx */
1906 mallopt (M_MMAP_MAX
, 0);
1909 b
= (struct sblock
*) lisp_malloc (size
+ GC_STRING_EXTRA
, MEM_TYPE_NON_LISP
);
1911 #ifdef DOUG_LEA_MALLOC
1912 /* Back to a reasonable maximum of mmap'ed areas. */
1913 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
1916 b
->next_free
= &b
->first_data
;
1917 b
->first_data
.string
= NULL
;
1918 b
->next
= large_sblocks
;
1921 else if (current_sblock
== NULL
1922 || (((char *) current_sblock
+ SBLOCK_SIZE
1923 - (char *) current_sblock
->next_free
)
1924 < (needed
+ GC_STRING_EXTRA
)))
1926 /* Not enough room in the current sblock. */
1927 b
= (struct sblock
*) lisp_malloc (SBLOCK_SIZE
, MEM_TYPE_NON_LISP
);
1928 b
->next_free
= &b
->first_data
;
1929 b
->first_data
.string
= NULL
;
1933 current_sblock
->next
= b
;
1941 data
= b
->next_free
;
1942 b
->next_free
= (struct sdata
*) ((char *) data
+ needed
+ GC_STRING_EXTRA
);
1944 MALLOC_UNBLOCK_INPUT
;
1947 s
->data
= SDATA_DATA (data
);
1948 #ifdef GC_CHECK_STRING_BYTES
1949 SDATA_NBYTES (data
) = nbytes
;
1952 s
->size_byte
= nbytes
;
1953 s
->data
[nbytes
] = '\0';
1954 #ifdef GC_CHECK_STRING_OVERRUN
1955 memcpy ((char *) data
+ needed
, string_overrun_cookie
,
1956 GC_STRING_OVERRUN_COOKIE_SIZE
);
1959 /* If S had already data assigned, mark that as free by setting its
1960 string back-pointer to null, and recording the size of the data
1964 SDATA_NBYTES (old_data
) = old_nbytes
;
1965 old_data
->string
= NULL
;
1968 consing_since_gc
+= needed
;
1972 /* Sweep and compact strings. */
1975 sweep_strings (void)
1977 struct string_block
*b
, *next
;
1978 struct string_block
*live_blocks
= NULL
;
1980 string_free_list
= NULL
;
1981 total_strings
= total_free_strings
= 0;
1982 total_string_size
= 0;
1984 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
1985 for (b
= string_blocks
; b
; b
= next
)
1988 struct Lisp_String
*free_list_before
= string_free_list
;
1992 for (i
= 0; i
< STRING_BLOCK_SIZE
; ++i
)
1994 struct Lisp_String
*s
= b
->strings
+ i
;
1998 /* String was not on free-list before. */
1999 if (STRING_MARKED_P (s
))
2001 /* String is live; unmark it and its intervals. */
2004 if (!NULL_INTERVAL_P (s
->intervals
))
2005 UNMARK_BALANCE_INTERVALS (s
->intervals
);
2008 total_string_size
+= STRING_BYTES (s
);
2012 /* String is dead. Put it on the free-list. */
2013 struct sdata
*data
= SDATA_OF_STRING (s
);
2015 /* Save the size of S in its sdata so that we know
2016 how large that is. Reset the sdata's string
2017 back-pointer so that we know it's free. */
2018 #ifdef GC_CHECK_STRING_BYTES
2019 if (GC_STRING_BYTES (s
) != SDATA_NBYTES (data
))
2022 data
->u
.nbytes
= GC_STRING_BYTES (s
);
2024 data
->string
= NULL
;
2026 /* Reset the strings's `data' member so that we
2030 /* Put the string on the free-list. */
2031 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2032 string_free_list
= s
;
2038 /* S was on the free-list before. Put it there again. */
2039 NEXT_FREE_LISP_STRING (s
) = string_free_list
;
2040 string_free_list
= s
;
2045 /* Free blocks that contain free Lisp_Strings only, except
2046 the first two of them. */
2047 if (nfree
== STRING_BLOCK_SIZE
2048 && total_free_strings
> STRING_BLOCK_SIZE
)
2051 string_free_list
= free_list_before
;
2055 total_free_strings
+= nfree
;
2056 b
->next
= live_blocks
;
2061 check_string_free_list ();
2063 string_blocks
= live_blocks
;
2064 free_large_strings ();
2065 compact_small_strings ();
2067 check_string_free_list ();
2071 /* Free dead large strings. */
2074 free_large_strings (void)
2076 struct sblock
*b
, *next
;
2077 struct sblock
*live_blocks
= NULL
;
2079 for (b
= large_sblocks
; b
; b
= next
)
2083 if (b
->first_data
.string
== NULL
)
2087 b
->next
= live_blocks
;
2092 large_sblocks
= live_blocks
;
2096 /* Compact data of small strings. Free sblocks that don't contain
2097 data of live strings after compaction. */
2100 compact_small_strings (void)
2102 struct sblock
*b
, *tb
, *next
;
2103 struct sdata
*from
, *to
, *end
, *tb_end
;
2104 struct sdata
*to_end
, *from_end
;
2106 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2107 to, and TB_END is the end of TB. */
2109 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2110 to
= &tb
->first_data
;
2112 /* Step through the blocks from the oldest to the youngest. We
2113 expect that old blocks will stabilize over time, so that less
2114 copying will happen this way. */
2115 for (b
= oldest_sblock
; b
; b
= b
->next
)
2118 xassert ((char *) end
<= (char *) b
+ SBLOCK_SIZE
);
2120 for (from
= &b
->first_data
; from
< end
; from
= from_end
)
2122 /* Compute the next FROM here because copying below may
2123 overwrite data we need to compute it. */
2126 #ifdef GC_CHECK_STRING_BYTES
2127 /* Check that the string size recorded in the string is the
2128 same as the one recorded in the sdata structure. */
2130 && GC_STRING_BYTES (from
->string
) != SDATA_NBYTES (from
))
2132 #endif /* GC_CHECK_STRING_BYTES */
2135 nbytes
= GC_STRING_BYTES (from
->string
);
2137 nbytes
= SDATA_NBYTES (from
);
2139 if (nbytes
> LARGE_STRING_BYTES
)
2142 nbytes
= SDATA_SIZE (nbytes
);
2143 from_end
= (struct sdata
*) ((char *) from
+ nbytes
+ GC_STRING_EXTRA
);
2145 #ifdef GC_CHECK_STRING_OVERRUN
2146 if (memcmp (string_overrun_cookie
,
2147 (char *) from_end
- GC_STRING_OVERRUN_COOKIE_SIZE
,
2148 GC_STRING_OVERRUN_COOKIE_SIZE
))
2152 /* FROM->string non-null means it's alive. Copy its data. */
2155 /* If TB is full, proceed with the next sblock. */
2156 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2157 if (to_end
> tb_end
)
2161 tb_end
= (struct sdata
*) ((char *) tb
+ SBLOCK_SIZE
);
2162 to
= &tb
->first_data
;
2163 to_end
= (struct sdata
*) ((char *) to
+ nbytes
+ GC_STRING_EXTRA
);
2166 /* Copy, and update the string's `data' pointer. */
2169 xassert (tb
!= b
|| to
< from
);
2170 memmove (to
, from
, nbytes
+ GC_STRING_EXTRA
);
2171 to
->string
->data
= SDATA_DATA (to
);
2174 /* Advance past the sdata we copied to. */
2180 /* The rest of the sblocks following TB don't contain live data, so
2181 we can free them. */
2182 for (b
= tb
->next
; b
; b
= next
)
2190 current_sblock
= tb
;
2194 string_overflow (void)
2196 error ("Maximum string size exceeded");
2199 DEFUN ("make-string", Fmake_string
, Smake_string
, 2, 2, 0,
2200 doc
: /* Return a newly created string of length LENGTH, with INIT in each element.
2201 LENGTH must be an integer.
2202 INIT must be an integer that represents a character. */)
2203 (Lisp_Object length
, Lisp_Object init
)
2205 register Lisp_Object val
;
2206 register unsigned char *p
, *end
;
2210 CHECK_NATNUM (length
);
2211 CHECK_CHARACTER (init
);
2213 c
= XFASTINT (init
);
2214 if (ASCII_CHAR_P (c
))
2216 nbytes
= XINT (length
);
2217 val
= make_uninit_string (nbytes
);
2219 end
= p
+ SCHARS (val
);
2225 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2226 int len
= CHAR_STRING (c
, str
);
2227 EMACS_INT string_len
= XINT (length
);
2229 if (string_len
> STRING_BYTES_MAX
/ len
)
2231 nbytes
= len
* string_len
;
2232 val
= make_uninit_multibyte_string (string_len
, nbytes
);
2237 memcpy (p
, str
, len
);
2247 DEFUN ("make-bool-vector", Fmake_bool_vector
, Smake_bool_vector
, 2, 2, 0,
2248 doc
: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2249 LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2250 (Lisp_Object length
, Lisp_Object init
)
2252 register Lisp_Object val
;
2253 struct Lisp_Bool_Vector
*p
;
2254 EMACS_INT length_in_chars
, length_in_elts
;
2257 CHECK_NATNUM (length
);
2259 bits_per_value
= sizeof (EMACS_INT
) * BOOL_VECTOR_BITS_PER_CHAR
;
2261 length_in_elts
= (XFASTINT (length
) + bits_per_value
- 1) / bits_per_value
;
2262 length_in_chars
= ((XFASTINT (length
) + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2263 / BOOL_VECTOR_BITS_PER_CHAR
);
2265 /* We must allocate one more elements than LENGTH_IN_ELTS for the
2266 slot `size' of the struct Lisp_Bool_Vector. */
2267 val
= Fmake_vector (make_number (length_in_elts
+ 1), Qnil
);
2269 /* No Lisp_Object to trace in there. */
2270 XSETPVECTYPESIZE (XVECTOR (val
), PVEC_BOOL_VECTOR
, 0);
2272 p
= XBOOL_VECTOR (val
);
2273 p
->size
= XFASTINT (length
);
2275 if (length_in_chars
)
2277 memset (p
->data
, ! NILP (init
) ? -1 : 0, length_in_chars
);
2279 /* Clear any extraneous bits in the last byte. */
2280 p
->data
[length_in_chars
- 1]
2281 &= (1 << (XINT (length
) % BOOL_VECTOR_BITS_PER_CHAR
)) - 1;
2288 /* Make a string from NBYTES bytes at CONTENTS, and compute the number
2289 of characters from the contents. This string may be unibyte or
2290 multibyte, depending on the contents. */
2293 make_string (const char *contents
, EMACS_INT nbytes
)
2295 register Lisp_Object val
;
2296 EMACS_INT nchars
, multibyte_nbytes
;
2298 parse_str_as_multibyte ((const unsigned char *) contents
, nbytes
,
2299 &nchars
, &multibyte_nbytes
);
2300 if (nbytes
== nchars
|| nbytes
!= multibyte_nbytes
)
2301 /* CONTENTS contains no multibyte sequences or contains an invalid
2302 multibyte sequence. We must make unibyte string. */
2303 val
= make_unibyte_string (contents
, nbytes
);
2305 val
= make_multibyte_string (contents
, nchars
, nbytes
);
2310 /* Make an unibyte string from LENGTH bytes at CONTENTS. */
2313 make_unibyte_string (const char *contents
, EMACS_INT length
)
2315 register Lisp_Object val
;
2316 val
= make_uninit_string (length
);
2317 memcpy (SDATA (val
), contents
, length
);
2322 /* Make a multibyte string from NCHARS characters occupying NBYTES
2323 bytes at CONTENTS. */
2326 make_multibyte_string (const char *contents
,
2327 EMACS_INT nchars
, EMACS_INT nbytes
)
2329 register Lisp_Object val
;
2330 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2331 memcpy (SDATA (val
), contents
, nbytes
);
2336 /* Make a string from NCHARS characters occupying NBYTES bytes at
2337 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2340 make_string_from_bytes (const char *contents
,
2341 EMACS_INT nchars
, EMACS_INT nbytes
)
2343 register Lisp_Object val
;
2344 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2345 memcpy (SDATA (val
), contents
, nbytes
);
2346 if (SBYTES (val
) == SCHARS (val
))
2347 STRING_SET_UNIBYTE (val
);
2352 /* Make a string from NCHARS characters occupying NBYTES bytes at
2353 CONTENTS. The argument MULTIBYTE controls whether to label the
2354 string as multibyte. If NCHARS is negative, it counts the number of
2355 characters by itself. */
2358 make_specified_string (const char *contents
,
2359 EMACS_INT nchars
, EMACS_INT nbytes
, int multibyte
)
2361 register Lisp_Object val
;
2366 nchars
= multibyte_chars_in_text ((const unsigned char *) contents
,
2371 val
= make_uninit_multibyte_string (nchars
, nbytes
);
2372 memcpy (SDATA (val
), contents
, nbytes
);
2374 STRING_SET_UNIBYTE (val
);
2379 /* Make a string from the data at STR, treating it as multibyte if the
2383 build_string (const char *str
)
2385 return make_string (str
, strlen (str
));
2389 /* Return an unibyte Lisp_String set up to hold LENGTH characters
2390 occupying LENGTH bytes. */
2393 make_uninit_string (EMACS_INT length
)
2398 return empty_unibyte_string
;
2399 val
= make_uninit_multibyte_string (length
, length
);
2400 STRING_SET_UNIBYTE (val
);
2405 /* Return a multibyte Lisp_String set up to hold NCHARS characters
2406 which occupy NBYTES bytes. */
2409 make_uninit_multibyte_string (EMACS_INT nchars
, EMACS_INT nbytes
)
2412 struct Lisp_String
*s
;
2417 return empty_multibyte_string
;
2419 s
= allocate_string ();
2420 allocate_string_data (s
, nchars
, nbytes
);
2421 XSETSTRING (string
, s
);
2422 string_chars_consed
+= nbytes
;
2428 /***********************************************************************
2430 ***********************************************************************/
2432 /* We store float cells inside of float_blocks, allocating a new
2433 float_block with malloc whenever necessary. Float cells reclaimed
2434 by GC are put on a free list to be reallocated before allocating
2435 any new float cells from the latest float_block. */
2437 #define FLOAT_BLOCK_SIZE \
2438 (((BLOCK_BYTES - sizeof (struct float_block *) \
2439 /* The compiler might add padding at the end. */ \
2440 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2441 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2443 #define GETMARKBIT(block,n) \
2444 (((block)->gcmarkbits[(n) / (sizeof(int) * CHAR_BIT)] \
2445 >> ((n) % (sizeof(int) * CHAR_BIT))) \
2448 #define SETMARKBIT(block,n) \
2449 (block)->gcmarkbits[(n) / (sizeof(int) * CHAR_BIT)] \
2450 |= 1 << ((n) % (sizeof(int) * CHAR_BIT))
2452 #define UNSETMARKBIT(block,n) \
2453 (block)->gcmarkbits[(n) / (sizeof(int) * CHAR_BIT)] \
2454 &= ~(1 << ((n) % (sizeof(int) * CHAR_BIT)))
2456 #define FLOAT_BLOCK(fptr) \
2457 ((struct float_block *) (((uintptr_t) (fptr)) & ~(BLOCK_ALIGN - 1)))
2459 #define FLOAT_INDEX(fptr) \
2460 ((((uintptr_t) (fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2464 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2465 struct Lisp_Float floats
[FLOAT_BLOCK_SIZE
];
2466 int gcmarkbits
[1 + FLOAT_BLOCK_SIZE
/ (sizeof(int) * CHAR_BIT
)];
2467 struct float_block
*next
;
2470 #define FLOAT_MARKED_P(fptr) \
2471 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2473 #define FLOAT_MARK(fptr) \
2474 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2476 #define FLOAT_UNMARK(fptr) \
2477 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2479 /* Current float_block. */
2481 static struct float_block
*float_block
;
2483 /* Index of first unused Lisp_Float in the current float_block. */
2485 static int float_block_index
;
2487 /* Free-list of Lisp_Floats. */
2489 static struct Lisp_Float
*float_free_list
;
2492 /* Initialize float allocation. */
2498 float_block_index
= FLOAT_BLOCK_SIZE
; /* Force alloc of new float_block. */
2499 float_free_list
= 0;
2503 /* Return a new float object with value FLOAT_VALUE. */
2506 make_float (double float_value
)
2508 register Lisp_Object val
;
2510 /* eassert (!handling_signal); */
2514 if (float_free_list
)
2516 /* We use the data field for chaining the free list
2517 so that we won't use the same field that has the mark bit. */
2518 XSETFLOAT (val
, float_free_list
);
2519 float_free_list
= float_free_list
->u
.chain
;
2523 if (float_block_index
== FLOAT_BLOCK_SIZE
)
2525 register struct float_block
*new;
2527 new = (struct float_block
*) lisp_align_malloc (sizeof *new,
2529 new->next
= float_block
;
2530 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2532 float_block_index
= 0;
2534 XSETFLOAT (val
, &float_block
->floats
[float_block_index
]);
2535 float_block_index
++;
2538 MALLOC_UNBLOCK_INPUT
;
2540 XFLOAT_INIT (val
, float_value
);
2541 eassert (!FLOAT_MARKED_P (XFLOAT (val
)));
2542 consing_since_gc
+= sizeof (struct Lisp_Float
);
2549 /***********************************************************************
2551 ***********************************************************************/
2553 /* We store cons cells inside of cons_blocks, allocating a new
2554 cons_block with malloc whenever necessary. Cons cells reclaimed by
2555 GC are put on a free list to be reallocated before allocating
2556 any new cons cells from the latest cons_block. */
2558 #define CONS_BLOCK_SIZE \
2559 (((BLOCK_BYTES - sizeof (struct cons_block *)) * CHAR_BIT) \
2560 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2562 #define CONS_BLOCK(fptr) \
2563 ((struct cons_block *) ((uintptr_t) (fptr) & ~(BLOCK_ALIGN - 1)))
2565 #define CONS_INDEX(fptr) \
2566 (((uintptr_t) (fptr) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2570 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2571 struct Lisp_Cons conses
[CONS_BLOCK_SIZE
];
2572 int gcmarkbits
[1 + CONS_BLOCK_SIZE
/ (sizeof(int) * CHAR_BIT
)];
2573 struct cons_block
*next
;
2576 #define CONS_MARKED_P(fptr) \
2577 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2579 #define CONS_MARK(fptr) \
2580 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2582 #define CONS_UNMARK(fptr) \
2583 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2585 /* Current cons_block. */
2587 static struct cons_block
*cons_block
;
2589 /* Index of first unused Lisp_Cons in the current block. */
2591 static int cons_block_index
;
2593 /* Free-list of Lisp_Cons structures. */
2595 static struct Lisp_Cons
*cons_free_list
;
2598 /* Initialize cons allocation. */
2604 cons_block_index
= CONS_BLOCK_SIZE
; /* Force alloc of new cons_block. */
2609 /* Explicitly free a cons cell by putting it on the free-list. */
2612 free_cons (struct Lisp_Cons
*ptr
)
2614 ptr
->u
.chain
= cons_free_list
;
2618 cons_free_list
= ptr
;
2621 DEFUN ("cons", Fcons
, Scons
, 2, 2, 0,
2622 doc
: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2623 (Lisp_Object car
, Lisp_Object cdr
)
2625 register Lisp_Object val
;
2627 /* eassert (!handling_signal); */
2633 /* We use the cdr for chaining the free list
2634 so that we won't use the same field that has the mark bit. */
2635 XSETCONS (val
, cons_free_list
);
2636 cons_free_list
= cons_free_list
->u
.chain
;
2640 if (cons_block_index
== CONS_BLOCK_SIZE
)
2642 register struct cons_block
*new;
2643 new = (struct cons_block
*) lisp_align_malloc (sizeof *new,
2645 memset (new->gcmarkbits
, 0, sizeof new->gcmarkbits
);
2646 new->next
= cons_block
;
2648 cons_block_index
= 0;
2650 XSETCONS (val
, &cons_block
->conses
[cons_block_index
]);
2654 MALLOC_UNBLOCK_INPUT
;
2658 eassert (!CONS_MARKED_P (XCONS (val
)));
2659 consing_since_gc
+= sizeof (struct Lisp_Cons
);
2660 cons_cells_consed
++;
2664 #ifdef GC_CHECK_CONS_LIST
2665 /* Get an error now if there's any junk in the cons free list. */
2667 check_cons_list (void)
2669 struct Lisp_Cons
*tail
= cons_free_list
;
2672 tail
= tail
->u
.chain
;
2676 /* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2679 list1 (Lisp_Object arg1
)
2681 return Fcons (arg1
, Qnil
);
2685 list2 (Lisp_Object arg1
, Lisp_Object arg2
)
2687 return Fcons (arg1
, Fcons (arg2
, Qnil
));
2692 list3 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2694 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Qnil
)));
2699 list4 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
)
2701 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
, Qnil
))));
2706 list5 (Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
, Lisp_Object arg4
, Lisp_Object arg5
)
2708 return Fcons (arg1
, Fcons (arg2
, Fcons (arg3
, Fcons (arg4
,
2709 Fcons (arg5
, Qnil
)))));
2713 DEFUN ("list", Flist
, Slist
, 0, MANY
, 0,
2714 doc
: /* Return a newly created list with specified arguments as elements.
2715 Any number of arguments, even zero arguments, are allowed.
2716 usage: (list &rest OBJECTS) */)
2717 (ptrdiff_t nargs
, Lisp_Object
*args
)
2719 register Lisp_Object val
;
2725 val
= Fcons (args
[nargs
], val
);
2731 DEFUN ("make-list", Fmake_list
, Smake_list
, 2, 2, 0,
2732 doc
: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2733 (register Lisp_Object length
, Lisp_Object init
)
2735 register Lisp_Object val
;
2736 register EMACS_INT size
;
2738 CHECK_NATNUM (length
);
2739 size
= XFASTINT (length
);
2744 val
= Fcons (init
, val
);
2749 val
= Fcons (init
, val
);
2754 val
= Fcons (init
, val
);
2759 val
= Fcons (init
, val
);
2764 val
= Fcons (init
, val
);
2779 /***********************************************************************
2781 ***********************************************************************/
2783 /* Singly-linked list of all vectors. */
2785 static struct Lisp_Vector
*all_vectors
;
2787 /* Handy constants for vectorlike objects. */
2790 header_size
= offsetof (struct Lisp_Vector
, contents
),
2791 word_size
= sizeof (Lisp_Object
)
2794 /* Value is a pointer to a newly allocated Lisp_Vector structure
2795 with room for LEN Lisp_Objects. */
2797 static struct Lisp_Vector
*
2798 allocate_vectorlike (EMACS_INT len
)
2800 struct Lisp_Vector
*p
;
2805 #ifdef DOUG_LEA_MALLOC
2806 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
2807 because mapped region contents are not preserved in
2809 mallopt (M_MMAP_MAX
, 0);
2812 /* This gets triggered by code which I haven't bothered to fix. --Stef */
2813 /* eassert (!handling_signal); */
2815 nbytes
= header_size
+ len
* word_size
;
2816 p
= (struct Lisp_Vector
*) lisp_malloc (nbytes
, MEM_TYPE_VECTORLIKE
);
2818 #ifdef DOUG_LEA_MALLOC
2819 /* Back to a reasonable maximum of mmap'ed areas. */
2820 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
);
2823 consing_since_gc
+= nbytes
;
2824 vector_cells_consed
+= len
;
2826 p
->header
.next
.vector
= all_vectors
;
2829 MALLOC_UNBLOCK_INPUT
;
2835 /* Allocate a vector with LEN slots. */
2837 struct Lisp_Vector
*
2838 allocate_vector (EMACS_INT len
)
2840 struct Lisp_Vector
*v
;
2841 ptrdiff_t nbytes_max
= min (PTRDIFF_MAX
, SIZE_MAX
);
2843 if (min ((nbytes_max
- header_size
) / word_size
, MOST_POSITIVE_FIXNUM
) < len
)
2844 memory_full (SIZE_MAX
);
2845 v
= allocate_vectorlike (len
);
2846 v
->header
.size
= len
;
2851 /* Allocate other vector-like structures. */
2853 struct Lisp_Vector
*
2854 allocate_pseudovector (int memlen
, int lisplen
, EMACS_INT tag
)
2856 struct Lisp_Vector
*v
= allocate_vectorlike (memlen
);
2859 /* Only the first lisplen slots will be traced normally by the GC. */
2860 for (i
= 0; i
< lisplen
; ++i
)
2861 v
->contents
[i
] = Qnil
;
2863 XSETPVECTYPESIZE (v
, tag
, lisplen
);
2867 struct Lisp_Hash_Table
*
2868 allocate_hash_table (void)
2870 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Hash_Table
, count
, PVEC_HASH_TABLE
);
2875 allocate_window (void)
2877 return ALLOCATE_PSEUDOVECTOR(struct window
, current_matrix
, PVEC_WINDOW
);
2882 allocate_terminal (void)
2884 struct terminal
*t
= ALLOCATE_PSEUDOVECTOR (struct terminal
,
2885 next_terminal
, PVEC_TERMINAL
);
2886 /* Zero out the non-GC'd fields. FIXME: This should be made unnecessary. */
2887 memset (&t
->next_terminal
, 0,
2888 (char*) (t
+ 1) - (char*) &t
->next_terminal
);
2894 allocate_frame (void)
2896 struct frame
*f
= ALLOCATE_PSEUDOVECTOR (struct frame
,
2897 face_cache
, PVEC_FRAME
);
2898 /* Zero out the non-GC'd fields. FIXME: This should be made unnecessary. */
2899 memset (&f
->face_cache
, 0,
2900 (char *) (f
+ 1) - (char *) &f
->face_cache
);
2905 struct Lisp_Process
*
2906 allocate_process (void)
2908 return ALLOCATE_PSEUDOVECTOR (struct Lisp_Process
, pid
, PVEC_PROCESS
);
2912 DEFUN ("make-vector", Fmake_vector
, Smake_vector
, 2, 2, 0,
2913 doc
: /* Return a newly created vector of length LENGTH, with each element being INIT.
2914 See also the function `vector'. */)
2915 (register Lisp_Object length
, Lisp_Object init
)
2918 register EMACS_INT sizei
;
2919 register EMACS_INT i
;
2920 register struct Lisp_Vector
*p
;
2922 CHECK_NATNUM (length
);
2923 sizei
= XFASTINT (length
);
2925 p
= allocate_vector (sizei
);
2926 for (i
= 0; i
< sizei
; i
++)
2927 p
->contents
[i
] = init
;
2929 XSETVECTOR (vector
, p
);
2934 DEFUN ("vector", Fvector
, Svector
, 0, MANY
, 0,
2935 doc
: /* Return a newly created vector with specified arguments as elements.
2936 Any number of arguments, even zero arguments, are allowed.
2937 usage: (vector &rest OBJECTS) */)
2938 (ptrdiff_t nargs
, Lisp_Object
*args
)
2940 register Lisp_Object len
, val
;
2942 register struct Lisp_Vector
*p
;
2944 XSETFASTINT (len
, nargs
);
2945 val
= Fmake_vector (len
, Qnil
);
2947 for (i
= 0; i
< nargs
; i
++)
2948 p
->contents
[i
] = args
[i
];
2953 DEFUN ("make-byte-code", Fmake_byte_code
, Smake_byte_code
, 4, MANY
, 0,
2954 doc
: /* Create a byte-code object with specified arguments as elements.
2955 The arguments should be the ARGLIST, bytecode-string BYTE-CODE, constant
2956 vector CONSTANTS, maximum stack size DEPTH, (optional) DOCSTRING,
2957 and (optional) INTERACTIVE-SPEC.
2958 The first four arguments are required; at most six have any
2960 The ARGLIST can be either like the one of `lambda', in which case the arguments
2961 will be dynamically bound before executing the byte code, or it can be an
2962 integer of the form NNNNNNNRMMMMMMM where the 7bit MMMMMMM specifies the
2963 minimum number of arguments, the 7-bit NNNNNNN specifies the maximum number
2964 of arguments (ignoring &rest) and the R bit specifies whether there is a &rest
2965 argument to catch the left-over arguments. If such an integer is used, the
2966 arguments will not be dynamically bound but will be instead pushed on the
2967 stack before executing the byte-code.
2968 usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
2969 (ptrdiff_t nargs
, Lisp_Object
*args
)
2971 register Lisp_Object len
, val
;
2973 register struct Lisp_Vector
*p
;
2975 XSETFASTINT (len
, nargs
);
2976 if (!NILP (Vpurify_flag
))
2977 val
= make_pure_vector (nargs
);
2979 val
= Fmake_vector (len
, Qnil
);
2981 if (nargs
> 1 && STRINGP (args
[1]) && STRING_MULTIBYTE (args
[1]))
2982 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
2983 earlier because they produced a raw 8-bit string for byte-code
2984 and now such a byte-code string is loaded as multibyte while
2985 raw 8-bit characters converted to multibyte form. Thus, now we
2986 must convert them back to the original unibyte form. */
2987 args
[1] = Fstring_as_unibyte (args
[1]);
2990 for (i
= 0; i
< nargs
; i
++)
2992 if (!NILP (Vpurify_flag
))
2993 args
[i
] = Fpurecopy (args
[i
]);
2994 p
->contents
[i
] = args
[i
];
2996 XSETPVECTYPE (p
, PVEC_COMPILED
);
2997 XSETCOMPILED (val
, p
);
3003 /***********************************************************************
3005 ***********************************************************************/
3007 /* Each symbol_block is just under 1020 bytes long, since malloc
3008 really allocates in units of powers of two and uses 4 bytes for its
3011 #define SYMBOL_BLOCK_SIZE \
3012 ((1020 - sizeof (struct symbol_block *)) / sizeof (struct Lisp_Symbol))
3016 /* Place `symbols' first, to preserve alignment. */
3017 struct Lisp_Symbol symbols
[SYMBOL_BLOCK_SIZE
];
3018 struct symbol_block
*next
;
3021 /* Current symbol block and index of first unused Lisp_Symbol
3024 static struct symbol_block
*symbol_block
;
3025 static int symbol_block_index
;
3027 /* List of free symbols. */
3029 static struct Lisp_Symbol
*symbol_free_list
;
3032 /* Initialize symbol allocation. */
3037 symbol_block
= NULL
;
3038 symbol_block_index
= SYMBOL_BLOCK_SIZE
;
3039 symbol_free_list
= 0;
3043 DEFUN ("make-symbol", Fmake_symbol
, Smake_symbol
, 1, 1, 0,
3044 doc
: /* Return a newly allocated uninterned symbol whose name is NAME.
3045 Its value and function definition are void, and its property list is nil. */)
3048 register Lisp_Object val
;
3049 register struct Lisp_Symbol
*p
;
3051 CHECK_STRING (name
);
3053 /* eassert (!handling_signal); */
3057 if (symbol_free_list
)
3059 XSETSYMBOL (val
, symbol_free_list
);
3060 symbol_free_list
= symbol_free_list
->next
;
3064 if (symbol_block_index
== SYMBOL_BLOCK_SIZE
)
3066 struct symbol_block
*new;
3067 new = (struct symbol_block
*) lisp_malloc (sizeof *new,
3069 new->next
= symbol_block
;
3071 symbol_block_index
= 0;
3073 XSETSYMBOL (val
, &symbol_block
->symbols
[symbol_block_index
]);
3074 symbol_block_index
++;
3077 MALLOC_UNBLOCK_INPUT
;
3082 p
->redirect
= SYMBOL_PLAINVAL
;
3083 SET_SYMBOL_VAL (p
, Qunbound
);
3084 p
->function
= Qunbound
;
3087 p
->interned
= SYMBOL_UNINTERNED
;
3089 p
->declared_special
= 0;
3090 consing_since_gc
+= sizeof (struct Lisp_Symbol
);
3097 /***********************************************************************
3098 Marker (Misc) Allocation
3099 ***********************************************************************/
3101 /* Allocation of markers and other objects that share that structure.
3102 Works like allocation of conses. */
3104 #define MARKER_BLOCK_SIZE \
3105 ((1020 - sizeof (struct marker_block *)) / sizeof (union Lisp_Misc))
3109 /* Place `markers' first, to preserve alignment. */
3110 union Lisp_Misc markers
[MARKER_BLOCK_SIZE
];
3111 struct marker_block
*next
;
3114 static struct marker_block
*marker_block
;
3115 static int marker_block_index
;
3117 static union Lisp_Misc
*marker_free_list
;
3122 marker_block
= NULL
;
3123 marker_block_index
= MARKER_BLOCK_SIZE
;
3124 marker_free_list
= 0;
3127 /* Return a newly allocated Lisp_Misc object, with no substructure. */
3130 allocate_misc (void)
3134 /* eassert (!handling_signal); */
3138 if (marker_free_list
)
3140 XSETMISC (val
, marker_free_list
);
3141 marker_free_list
= marker_free_list
->u_free
.chain
;
3145 if (marker_block_index
== MARKER_BLOCK_SIZE
)
3147 struct marker_block
*new;
3148 new = (struct marker_block
*) lisp_malloc (sizeof *new,
3150 new->next
= marker_block
;
3152 marker_block_index
= 0;
3153 total_free_markers
+= MARKER_BLOCK_SIZE
;
3155 XSETMISC (val
, &marker_block
->markers
[marker_block_index
]);
3156 marker_block_index
++;
3159 MALLOC_UNBLOCK_INPUT
;
3161 --total_free_markers
;
3162 consing_since_gc
+= sizeof (union Lisp_Misc
);
3163 misc_objects_consed
++;
3164 XMISCANY (val
)->gcmarkbit
= 0;
3168 /* Free a Lisp_Misc object */
3171 free_misc (Lisp_Object misc
)
3173 XMISCTYPE (misc
) = Lisp_Misc_Free
;
3174 XMISC (misc
)->u_free
.chain
= marker_free_list
;
3175 marker_free_list
= XMISC (misc
);
3177 total_free_markers
++;
3180 /* Return a Lisp_Misc_Save_Value object containing POINTER and
3181 INTEGER. This is used to package C values to call record_unwind_protect.
3182 The unwind function can get the C values back using XSAVE_VALUE. */
3185 make_save_value (void *pointer
, ptrdiff_t integer
)
3187 register Lisp_Object val
;
3188 register struct Lisp_Save_Value
*p
;
3190 val
= allocate_misc ();
3191 XMISCTYPE (val
) = Lisp_Misc_Save_Value
;
3192 p
= XSAVE_VALUE (val
);
3193 p
->pointer
= pointer
;
3194 p
->integer
= integer
;
3199 DEFUN ("make-marker", Fmake_marker
, Smake_marker
, 0, 0, 0,
3200 doc
: /* Return a newly allocated marker which does not point at any place. */)
3203 register Lisp_Object val
;
3204 register struct Lisp_Marker
*p
;
3206 val
= allocate_misc ();
3207 XMISCTYPE (val
) = Lisp_Misc_Marker
;
3213 p
->insertion_type
= 0;
3217 /* Put MARKER back on the free list after using it temporarily. */
3220 free_marker (Lisp_Object marker
)
3222 unchain_marker (XMARKER (marker
));
3227 /* Return a newly created vector or string with specified arguments as
3228 elements. If all the arguments are characters that can fit
3229 in a string of events, make a string; otherwise, make a vector.
3231 Any number of arguments, even zero arguments, are allowed. */
3234 make_event_array (register int nargs
, Lisp_Object
*args
)
3238 for (i
= 0; i
< nargs
; i
++)
3239 /* The things that fit in a string
3240 are characters that are in 0...127,
3241 after discarding the meta bit and all the bits above it. */
3242 if (!INTEGERP (args
[i
])
3243 || (XINT (args
[i
]) & ~(-CHAR_META
)) >= 0200)
3244 return Fvector (nargs
, args
);
3246 /* Since the loop exited, we know that all the things in it are
3247 characters, so we can make a string. */
3251 result
= Fmake_string (make_number (nargs
), make_number (0));
3252 for (i
= 0; i
< nargs
; i
++)
3254 SSET (result
, i
, XINT (args
[i
]));
3255 /* Move the meta bit to the right place for a string char. */
3256 if (XINT (args
[i
]) & CHAR_META
)
3257 SSET (result
, i
, SREF (result
, i
) | 0x80);
3266 /************************************************************************
3267 Memory Full Handling
3268 ************************************************************************/
3271 /* Called if malloc (NBYTES) returns zero. If NBYTES == SIZE_MAX,
3272 there may have been size_t overflow so that malloc was never
3273 called, or perhaps malloc was invoked successfully but the
3274 resulting pointer had problems fitting into a tagged EMACS_INT. In
3275 either case this counts as memory being full even though malloc did
3279 memory_full (size_t nbytes
)
3281 /* Do not go into hysterics merely because a large request failed. */
3282 int enough_free_memory
= 0;
3283 if (SPARE_MEMORY
< nbytes
)
3285 void *p
= malloc (SPARE_MEMORY
);
3289 enough_free_memory
= 1;
3293 if (! enough_free_memory
)
3299 memory_full_cons_threshold
= sizeof (struct cons_block
);
3301 /* The first time we get here, free the spare memory. */
3302 for (i
= 0; i
< sizeof (spare_memory
) / sizeof (char *); i
++)
3303 if (spare_memory
[i
])
3306 free (spare_memory
[i
]);
3307 else if (i
>= 1 && i
<= 4)
3308 lisp_align_free (spare_memory
[i
]);
3310 lisp_free (spare_memory
[i
]);
3311 spare_memory
[i
] = 0;
3314 /* Record the space now used. When it decreases substantially,
3315 we can refill the memory reserve. */
3316 #if !defined SYSTEM_MALLOC && !defined SYNC_INPUT
3317 bytes_used_when_full
= BYTES_USED
;
3321 /* This used to call error, but if we've run out of memory, we could
3322 get infinite recursion trying to build the string. */
3323 xsignal (Qnil
, Vmemory_signal_data
);
3326 /* If we released our reserve (due to running out of memory),
3327 and we have a fair amount free once again,
3328 try to set aside another reserve in case we run out once more.
3330 This is called when a relocatable block is freed in ralloc.c,
3331 and also directly from this file, in case we're not using ralloc.c. */
3334 refill_memory_reserve (void)
3336 #ifndef SYSTEM_MALLOC
3337 if (spare_memory
[0] == 0)
3338 spare_memory
[0] = (char *) malloc (SPARE_MEMORY
);
3339 if (spare_memory
[1] == 0)
3340 spare_memory
[1] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3342 if (spare_memory
[2] == 0)
3343 spare_memory
[2] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3345 if (spare_memory
[3] == 0)
3346 spare_memory
[3] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3348 if (spare_memory
[4] == 0)
3349 spare_memory
[4] = (char *) lisp_align_malloc (sizeof (struct cons_block
),
3351 if (spare_memory
[5] == 0)
3352 spare_memory
[5] = (char *) lisp_malloc (sizeof (struct string_block
),
3354 if (spare_memory
[6] == 0)
3355 spare_memory
[6] = (char *) lisp_malloc (sizeof (struct string_block
),
3357 if (spare_memory
[0] && spare_memory
[1] && spare_memory
[5])
3358 Vmemory_full
= Qnil
;
3362 /************************************************************************
3364 ************************************************************************/
3366 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
3368 /* Conservative C stack marking requires a method to identify possibly
3369 live Lisp objects given a pointer value. We do this by keeping
3370 track of blocks of Lisp data that are allocated in a red-black tree
3371 (see also the comment of mem_node which is the type of nodes in
3372 that tree). Function lisp_malloc adds information for an allocated
3373 block to the red-black tree with calls to mem_insert, and function
3374 lisp_free removes it with mem_delete. Functions live_string_p etc
3375 call mem_find to lookup information about a given pointer in the
3376 tree, and use that to determine if the pointer points to a Lisp
3379 /* Initialize this part of alloc.c. */
3384 mem_z
.left
= mem_z
.right
= MEM_NIL
;
3385 mem_z
.parent
= NULL
;
3386 mem_z
.color
= MEM_BLACK
;
3387 mem_z
.start
= mem_z
.end
= NULL
;
3392 /* Value is a pointer to the mem_node containing START. Value is
3393 MEM_NIL if there is no node in the tree containing START. */
3395 static inline struct mem_node
*
3396 mem_find (void *start
)
3400 if (start
< min_heap_address
|| start
> max_heap_address
)
3403 /* Make the search always successful to speed up the loop below. */
3404 mem_z
.start
= start
;
3405 mem_z
.end
= (char *) start
+ 1;
3408 while (start
< p
->start
|| start
>= p
->end
)
3409 p
= start
< p
->start
? p
->left
: p
->right
;
3414 /* Insert a new node into the tree for a block of memory with start
3415 address START, end address END, and type TYPE. Value is a
3416 pointer to the node that was inserted. */
3418 static struct mem_node
*
3419 mem_insert (void *start
, void *end
, enum mem_type type
)
3421 struct mem_node
*c
, *parent
, *x
;
3423 if (min_heap_address
== NULL
|| start
< min_heap_address
)
3424 min_heap_address
= start
;
3425 if (max_heap_address
== NULL
|| end
> max_heap_address
)
3426 max_heap_address
= end
;
3428 /* See where in the tree a node for START belongs. In this
3429 particular application, it shouldn't happen that a node is already
3430 present. For debugging purposes, let's check that. */
3434 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3436 while (c
!= MEM_NIL
)
3438 if (start
>= c
->start
&& start
< c
->end
)
3441 c
= start
< c
->start
? c
->left
: c
->right
;
3444 #else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3446 while (c
!= MEM_NIL
)
3449 c
= start
< c
->start
? c
->left
: c
->right
;
3452 #endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3454 /* Create a new node. */
3455 #ifdef GC_MALLOC_CHECK
3456 x
= (struct mem_node
*) _malloc_internal (sizeof *x
);
3460 x
= (struct mem_node
*) xmalloc (sizeof *x
);
3466 x
->left
= x
->right
= MEM_NIL
;
3469 /* Insert it as child of PARENT or install it as root. */
3472 if (start
< parent
->start
)
3480 /* Re-establish red-black tree properties. */
3481 mem_insert_fixup (x
);
3487 /* Re-establish the red-black properties of the tree, and thereby
3488 balance the tree, after node X has been inserted; X is always red. */
3491 mem_insert_fixup (struct mem_node
*x
)
3493 while (x
!= mem_root
&& x
->parent
->color
== MEM_RED
)
3495 /* X is red and its parent is red. This is a violation of
3496 red-black tree property #3. */
3498 if (x
->parent
== x
->parent
->parent
->left
)
3500 /* We're on the left side of our grandparent, and Y is our
3502 struct mem_node
*y
= x
->parent
->parent
->right
;
3504 if (y
->color
== MEM_RED
)
3506 /* Uncle and parent are red but should be black because
3507 X is red. Change the colors accordingly and proceed
3508 with the grandparent. */
3509 x
->parent
->color
= MEM_BLACK
;
3510 y
->color
= MEM_BLACK
;
3511 x
->parent
->parent
->color
= MEM_RED
;
3512 x
= x
->parent
->parent
;
3516 /* Parent and uncle have different colors; parent is
3517 red, uncle is black. */
3518 if (x
== x
->parent
->right
)
3521 mem_rotate_left (x
);
3524 x
->parent
->color
= MEM_BLACK
;
3525 x
->parent
->parent
->color
= MEM_RED
;
3526 mem_rotate_right (x
->parent
->parent
);
3531 /* This is the symmetrical case of above. */
3532 struct mem_node
*y
= x
->parent
->parent
->left
;
3534 if (y
->color
== MEM_RED
)
3536 x
->parent
->color
= MEM_BLACK
;
3537 y
->color
= MEM_BLACK
;
3538 x
->parent
->parent
->color
= MEM_RED
;
3539 x
= x
->parent
->parent
;
3543 if (x
== x
->parent
->left
)
3546 mem_rotate_right (x
);
3549 x
->parent
->color
= MEM_BLACK
;
3550 x
->parent
->parent
->color
= MEM_RED
;
3551 mem_rotate_left (x
->parent
->parent
);
3556 /* The root may have been changed to red due to the algorithm. Set
3557 it to black so that property #5 is satisfied. */
3558 mem_root
->color
= MEM_BLACK
;
3569 mem_rotate_left (struct mem_node
*x
)
3573 /* Turn y's left sub-tree into x's right sub-tree. */
3576 if (y
->left
!= MEM_NIL
)
3577 y
->left
->parent
= x
;
3579 /* Y's parent was x's parent. */
3581 y
->parent
= x
->parent
;
3583 /* Get the parent to point to y instead of x. */
3586 if (x
== x
->parent
->left
)
3587 x
->parent
->left
= y
;
3589 x
->parent
->right
= y
;
3594 /* Put x on y's left. */
3608 mem_rotate_right (struct mem_node
*x
)
3610 struct mem_node
*y
= x
->left
;
3613 if (y
->right
!= MEM_NIL
)
3614 y
->right
->parent
= x
;
3617 y
->parent
= x
->parent
;
3620 if (x
== x
->parent
->right
)
3621 x
->parent
->right
= y
;
3623 x
->parent
->left
= y
;
3634 /* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
3637 mem_delete (struct mem_node
*z
)
3639 struct mem_node
*x
, *y
;
3641 if (!z
|| z
== MEM_NIL
)
3644 if (z
->left
== MEM_NIL
|| z
->right
== MEM_NIL
)
3649 while (y
->left
!= MEM_NIL
)
3653 if (y
->left
!= MEM_NIL
)
3658 x
->parent
= y
->parent
;
3661 if (y
== y
->parent
->left
)
3662 y
->parent
->left
= x
;
3664 y
->parent
->right
= x
;
3671 z
->start
= y
->start
;
3676 if (y
->color
== MEM_BLACK
)
3677 mem_delete_fixup (x
);
3679 #ifdef GC_MALLOC_CHECK
3687 /* Re-establish the red-black properties of the tree, after a
3691 mem_delete_fixup (struct mem_node
*x
)
3693 while (x
!= mem_root
&& x
->color
== MEM_BLACK
)
3695 if (x
== x
->parent
->left
)
3697 struct mem_node
*w
= x
->parent
->right
;
3699 if (w
->color
== MEM_RED
)
3701 w
->color
= MEM_BLACK
;
3702 x
->parent
->color
= MEM_RED
;
3703 mem_rotate_left (x
->parent
);
3704 w
= x
->parent
->right
;
3707 if (w
->left
->color
== MEM_BLACK
&& w
->right
->color
== MEM_BLACK
)
3714 if (w
->right
->color
== MEM_BLACK
)
3716 w
->left
->color
= MEM_BLACK
;
3718 mem_rotate_right (w
);
3719 w
= x
->parent
->right
;
3721 w
->color
= x
->parent
->color
;
3722 x
->parent
->color
= MEM_BLACK
;
3723 w
->right
->color
= MEM_BLACK
;
3724 mem_rotate_left (x
->parent
);
3730 struct mem_node
*w
= x
->parent
->left
;
3732 if (w
->color
== MEM_RED
)
3734 w
->color
= MEM_BLACK
;
3735 x
->parent
->color
= MEM_RED
;
3736 mem_rotate_right (x
->parent
);
3737 w
= x
->parent
->left
;
3740 if (w
->right
->color
== MEM_BLACK
&& w
->left
->color
== MEM_BLACK
)
3747 if (w
->left
->color
== MEM_BLACK
)
3749 w
->right
->color
= MEM_BLACK
;
3751 mem_rotate_left (w
);
3752 w
= x
->parent
->left
;
3755 w
->color
= x
->parent
->color
;
3756 x
->parent
->color
= MEM_BLACK
;
3757 w
->left
->color
= MEM_BLACK
;
3758 mem_rotate_right (x
->parent
);
3764 x
->color
= MEM_BLACK
;
3768 /* Value is non-zero if P is a pointer to a live Lisp string on
3769 the heap. M is a pointer to the mem_block for P. */
3772 live_string_p (struct mem_node
*m
, void *p
)
3774 if (m
->type
== MEM_TYPE_STRING
)
3776 struct string_block
*b
= (struct string_block
*) m
->start
;
3777 ptrdiff_t offset
= (char *) p
- (char *) &b
->strings
[0];
3779 /* P must point to the start of a Lisp_String structure, and it
3780 must not be on the free-list. */
3782 && offset
% sizeof b
->strings
[0] == 0
3783 && offset
< (STRING_BLOCK_SIZE
* sizeof b
->strings
[0])
3784 && ((struct Lisp_String
*) p
)->data
!= NULL
);
3791 /* Value is non-zero if P is a pointer to a live Lisp cons on
3792 the heap. M is a pointer to the mem_block for P. */
3795 live_cons_p (struct mem_node
*m
, void *p
)
3797 if (m
->type
== MEM_TYPE_CONS
)
3799 struct cons_block
*b
= (struct cons_block
*) m
->start
;
3800 ptrdiff_t offset
= (char *) p
- (char *) &b
->conses
[0];
3802 /* P must point to the start of a Lisp_Cons, not be
3803 one of the unused cells in the current cons block,
3804 and not be on the free-list. */
3806 && offset
% sizeof b
->conses
[0] == 0
3807 && offset
< (CONS_BLOCK_SIZE
* sizeof b
->conses
[0])
3809 || offset
/ sizeof b
->conses
[0] < cons_block_index
)
3810 && !EQ (((struct Lisp_Cons
*) p
)->car
, Vdead
));
3817 /* Value is non-zero if P is a pointer to a live Lisp symbol on
3818 the heap. M is a pointer to the mem_block for P. */
3821 live_symbol_p (struct mem_node
*m
, void *p
)
3823 if (m
->type
== MEM_TYPE_SYMBOL
)
3825 struct symbol_block
*b
= (struct symbol_block
*) m
->start
;
3826 ptrdiff_t offset
= (char *) p
- (char *) &b
->symbols
[0];
3828 /* P must point to the start of a Lisp_Symbol, not be
3829 one of the unused cells in the current symbol block,
3830 and not be on the free-list. */
3832 && offset
% sizeof b
->symbols
[0] == 0
3833 && offset
< (SYMBOL_BLOCK_SIZE
* sizeof b
->symbols
[0])
3834 && (b
!= symbol_block
3835 || offset
/ sizeof b
->symbols
[0] < symbol_block_index
)
3836 && !EQ (((struct Lisp_Symbol
*) p
)->function
, Vdead
));
3843 /* Value is non-zero if P is a pointer to a live Lisp float on
3844 the heap. M is a pointer to the mem_block for P. */
3847 live_float_p (struct mem_node
*m
, void *p
)
3849 if (m
->type
== MEM_TYPE_FLOAT
)
3851 struct float_block
*b
= (struct float_block
*) m
->start
;
3852 ptrdiff_t offset
= (char *) p
- (char *) &b
->floats
[0];
3854 /* P must point to the start of a Lisp_Float and not be
3855 one of the unused cells in the current float block. */
3857 && offset
% sizeof b
->floats
[0] == 0
3858 && offset
< (FLOAT_BLOCK_SIZE
* sizeof b
->floats
[0])
3859 && (b
!= float_block
3860 || offset
/ sizeof b
->floats
[0] < float_block_index
));
3867 /* Value is non-zero if P is a pointer to a live Lisp Misc on
3868 the heap. M is a pointer to the mem_block for P. */
3871 live_misc_p (struct mem_node
*m
, void *p
)
3873 if (m
->type
== MEM_TYPE_MISC
)
3875 struct marker_block
*b
= (struct marker_block
*) m
->start
;
3876 ptrdiff_t offset
= (char *) p
- (char *) &b
->markers
[0];
3878 /* P must point to the start of a Lisp_Misc, not be
3879 one of the unused cells in the current misc block,
3880 and not be on the free-list. */
3882 && offset
% sizeof b
->markers
[0] == 0
3883 && offset
< (MARKER_BLOCK_SIZE
* sizeof b
->markers
[0])
3884 && (b
!= marker_block
3885 || offset
/ sizeof b
->markers
[0] < marker_block_index
)
3886 && ((union Lisp_Misc
*) p
)->u_any
.type
!= Lisp_Misc_Free
);
3893 /* Value is non-zero if P is a pointer to a live vector-like object.
3894 M is a pointer to the mem_block for P. */
3897 live_vector_p (struct mem_node
*m
, void *p
)
3899 return (p
== m
->start
&& m
->type
== MEM_TYPE_VECTORLIKE
);
3903 /* Value is non-zero if P is a pointer to a live buffer. M is a
3904 pointer to the mem_block for P. */
3907 live_buffer_p (struct mem_node
*m
, void *p
)
3909 /* P must point to the start of the block, and the buffer
3910 must not have been killed. */
3911 return (m
->type
== MEM_TYPE_BUFFER
3913 && !NILP (((struct buffer
*) p
)->BUFFER_INTERNAL_FIELD (name
)));
3916 #endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
3920 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
3922 /* Array of objects that are kept alive because the C stack contains
3923 a pattern that looks like a reference to them . */
3925 #define MAX_ZOMBIES 10
3926 static Lisp_Object zombies
[MAX_ZOMBIES
];
3928 /* Number of zombie objects. */
3930 static EMACS_INT nzombies
;
3932 /* Number of garbage collections. */
3934 static EMACS_INT ngcs
;
3936 /* Average percentage of zombies per collection. */
3938 static double avg_zombies
;
3940 /* Max. number of live and zombie objects. */
3942 static EMACS_INT max_live
, max_zombies
;
3944 /* Average number of live objects per GC. */
3946 static double avg_live
;
3948 DEFUN ("gc-status", Fgc_status
, Sgc_status
, 0, 0, "",
3949 doc
: /* Show information about live and zombie objects. */)
3952 Lisp_Object args
[8], zombie_list
= Qnil
;
3954 for (i
= 0; i
< nzombies
; i
++)
3955 zombie_list
= Fcons (zombies
[i
], zombie_list
);
3956 args
[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
3957 args
[1] = make_number (ngcs
);
3958 args
[2] = make_float (avg_live
);
3959 args
[3] = make_float (avg_zombies
);
3960 args
[4] = make_float (avg_zombies
/ avg_live
/ 100);
3961 args
[5] = make_number (max_live
);
3962 args
[6] = make_number (max_zombies
);
3963 args
[7] = zombie_list
;
3964 return Fmessage (8, args
);
3967 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
3970 /* Mark OBJ if we can prove it's a Lisp_Object. */
3973 mark_maybe_object (Lisp_Object obj
)
3981 po
= (void *) XPNTR (obj
);
3988 switch (XTYPE (obj
))
3991 mark_p
= (live_string_p (m
, po
)
3992 && !STRING_MARKED_P ((struct Lisp_String
*) po
));
3996 mark_p
= (live_cons_p (m
, po
) && !CONS_MARKED_P (XCONS (obj
)));
4000 mark_p
= (live_symbol_p (m
, po
) && !XSYMBOL (obj
)->gcmarkbit
);
4004 mark_p
= (live_float_p (m
, po
) && !FLOAT_MARKED_P (XFLOAT (obj
)));
4007 case Lisp_Vectorlike
:
4008 /* Note: can't check BUFFERP before we know it's a
4009 buffer because checking that dereferences the pointer
4010 PO which might point anywhere. */
4011 if (live_vector_p (m
, po
))
4012 mark_p
= !SUBRP (obj
) && !VECTOR_MARKED_P (XVECTOR (obj
));
4013 else if (live_buffer_p (m
, po
))
4014 mark_p
= BUFFERP (obj
) && !VECTOR_MARKED_P (XBUFFER (obj
));
4018 mark_p
= (live_misc_p (m
, po
) && !XMISCANY (obj
)->gcmarkbit
);
4027 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4028 if (nzombies
< MAX_ZOMBIES
)
4029 zombies
[nzombies
] = obj
;
4038 /* If P points to Lisp data, mark that as live if it isn't already
4042 mark_maybe_pointer (void *p
)
4046 /* Quickly rule out some values which can't point to Lisp data. */
4049 8 /* USE_LSB_TAG needs Lisp data to be aligned on multiples of 8. */
4051 2 /* We assume that Lisp data is aligned on even addresses. */
4059 Lisp_Object obj
= Qnil
;
4063 case MEM_TYPE_NON_LISP
:
4064 /* Nothing to do; not a pointer to Lisp memory. */
4067 case MEM_TYPE_BUFFER
:
4068 if (live_buffer_p (m
, p
) && !VECTOR_MARKED_P((struct buffer
*)p
))
4069 XSETVECTOR (obj
, p
);
4073 if (live_cons_p (m
, p
) && !CONS_MARKED_P ((struct Lisp_Cons
*) p
))
4077 case MEM_TYPE_STRING
:
4078 if (live_string_p (m
, p
)
4079 && !STRING_MARKED_P ((struct Lisp_String
*) p
))
4080 XSETSTRING (obj
, p
);
4084 if (live_misc_p (m
, p
) && !((struct Lisp_Free
*) p
)->gcmarkbit
)
4088 case MEM_TYPE_SYMBOL
:
4089 if (live_symbol_p (m
, p
) && !((struct Lisp_Symbol
*) p
)->gcmarkbit
)
4090 XSETSYMBOL (obj
, p
);
4093 case MEM_TYPE_FLOAT
:
4094 if (live_float_p (m
, p
) && !FLOAT_MARKED_P (p
))
4098 case MEM_TYPE_VECTORLIKE
:
4099 if (live_vector_p (m
, p
))
4102 XSETVECTOR (tem
, p
);
4103 if (!SUBRP (tem
) && !VECTOR_MARKED_P (XVECTOR (tem
)))
4118 /* Mark Lisp objects referenced from the address range START+OFFSET..END
4119 or END+OFFSET..START. */
4122 mark_memory (void *start
, void *end
, int offset
)
4127 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4131 /* Make START the pointer to the start of the memory region,
4132 if it isn't already. */
4140 /* Mark Lisp_Objects. */
4141 for (p
= (Lisp_Object
*) ((char *) start
+ offset
); (void *) p
< end
; ++p
)
4142 mark_maybe_object (*p
);
4144 /* Mark Lisp data pointed to. This is necessary because, in some
4145 situations, the C compiler optimizes Lisp objects away, so that
4146 only a pointer to them remains. Example:
4148 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4151 Lisp_Object obj = build_string ("test");
4152 struct Lisp_String *s = XSTRING (obj);
4153 Fgarbage_collect ();
4154 fprintf (stderr, "test `%s'\n", s->data);
4158 Here, `obj' isn't really used, and the compiler optimizes it
4159 away. The only reference to the life string is through the
4162 for (pp
= (void **) ((char *) start
+ offset
); (void *) pp
< end
; ++pp
)
4163 mark_maybe_pointer (*pp
);
4166 /* setjmp will work with GCC unless NON_SAVING_SETJMP is defined in
4167 the GCC system configuration. In gcc 3.2, the only systems for
4168 which this is so are i386-sco5 non-ELF, i386-sysv3 (maybe included
4169 by others?) and ns32k-pc532-min. */
4171 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4173 static int setjmp_tested_p
, longjmps_done
;
4175 #define SETJMP_WILL_LIKELY_WORK "\
4177 Emacs garbage collector has been changed to use conservative stack\n\
4178 marking. Emacs has determined that the method it uses to do the\n\
4179 marking will likely work on your system, but this isn't sure.\n\
4181 If you are a system-programmer, or can get the help of a local wizard\n\
4182 who is, please take a look at the function mark_stack in alloc.c, and\n\
4183 verify that the methods used are appropriate for your system.\n\
4185 Please mail the result to <emacs-devel@gnu.org>.\n\
4188 #define SETJMP_WILL_NOT_WORK "\
4190 Emacs garbage collector has been changed to use conservative stack\n\
4191 marking. Emacs has determined that the default method it uses to do the\n\
4192 marking will not work on your system. We will need a system-dependent\n\
4193 solution for your system.\n\
4195 Please take a look at the function mark_stack in alloc.c, and\n\
4196 try to find a way to make it work on your system.\n\
4198 Note that you may get false negatives, depending on the compiler.\n\
4199 In particular, you need to use -O with GCC for this test.\n\
4201 Please mail the result to <emacs-devel@gnu.org>.\n\
4205 /* Perform a quick check if it looks like setjmp saves registers in a
4206 jmp_buf. Print a message to stderr saying so. When this test
4207 succeeds, this is _not_ a proof that setjmp is sufficient for
4208 conservative stack marking. Only the sources or a disassembly
4219 /* Arrange for X to be put in a register. */
4225 if (longjmps_done
== 1)
4227 /* Came here after the longjmp at the end of the function.
4229 If x == 1, the longjmp has restored the register to its
4230 value before the setjmp, and we can hope that setjmp
4231 saves all such registers in the jmp_buf, although that
4234 For other values of X, either something really strange is
4235 taking place, or the setjmp just didn't save the register. */
4238 fprintf (stderr
, SETJMP_WILL_LIKELY_WORK
);
4241 fprintf (stderr
, SETJMP_WILL_NOT_WORK
);
4248 if (longjmps_done
== 1)
4252 #endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4255 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4257 /* Abort if anything GCPRO'd doesn't survive the GC. */
4265 for (p
= gcprolist
; p
; p
= p
->next
)
4266 for (i
= 0; i
< p
->nvars
; ++i
)
4267 if (!survives_gc_p (p
->var
[i
]))
4268 /* FIXME: It's not necessarily a bug. It might just be that the
4269 GCPRO is unnecessary or should release the object sooner. */
4273 #elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4280 fprintf (stderr
, "\nZombies kept alive = %"pI
":\n", nzombies
);
4281 for (i
= 0; i
< min (MAX_ZOMBIES
, nzombies
); ++i
)
4283 fprintf (stderr
, " %d = ", i
);
4284 debug_print (zombies
[i
]);
4288 #endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4291 /* Mark live Lisp objects on the C stack.
4293 There are several system-dependent problems to consider when
4294 porting this to new architectures:
4298 We have to mark Lisp objects in CPU registers that can hold local
4299 variables or are used to pass parameters.
4301 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4302 something that either saves relevant registers on the stack, or
4303 calls mark_maybe_object passing it each register's contents.
4305 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4306 implementation assumes that calling setjmp saves registers we need
4307 to see in a jmp_buf which itself lies on the stack. This doesn't
4308 have to be true! It must be verified for each system, possibly
4309 by taking a look at the source code of setjmp.
4311 If __builtin_unwind_init is available (defined by GCC >= 2.8) we
4312 can use it as a machine independent method to store all registers
4313 to the stack. In this case the macros described in the previous
4314 two paragraphs are not used.
4318 Architectures differ in the way their processor stack is organized.
4319 For example, the stack might look like this
4322 | Lisp_Object | size = 4
4324 | something else | size = 2
4326 | Lisp_Object | size = 4
4330 In such a case, not every Lisp_Object will be aligned equally. To
4331 find all Lisp_Object on the stack it won't be sufficient to walk
4332 the stack in steps of 4 bytes. Instead, two passes will be
4333 necessary, one starting at the start of the stack, and a second
4334 pass starting at the start of the stack + 2. Likewise, if the
4335 minimal alignment of Lisp_Objects on the stack is 1, four passes
4336 would be necessary, each one starting with one byte more offset
4337 from the stack start.
4339 The current code assumes by default that Lisp_Objects are aligned
4340 equally on the stack. */
4348 #ifdef HAVE___BUILTIN_UNWIND_INIT
4349 /* Force callee-saved registers and register windows onto the stack.
4350 This is the preferred method if available, obviating the need for
4351 machine dependent methods. */
4352 __builtin_unwind_init ();
4354 #else /* not HAVE___BUILTIN_UNWIND_INIT */
4355 #ifndef GC_SAVE_REGISTERS_ON_STACK
4356 /* jmp_buf may not be aligned enough on darwin-ppc64 */
4357 union aligned_jmpbuf
{
4361 volatile int stack_grows_down_p
= (char *) &j
> (char *) stack_base
;
4363 /* This trick flushes the register windows so that all the state of
4364 the process is contained in the stack. */
4365 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4366 needed on ia64 too. See mach_dep.c, where it also says inline
4367 assembler doesn't work with relevant proprietary compilers. */
4369 #if defined (__sparc64__) && defined (__FreeBSD__)
4370 /* FreeBSD does not have a ta 3 handler. */
4377 /* Save registers that we need to see on the stack. We need to see
4378 registers used to hold register variables and registers used to
4380 #ifdef GC_SAVE_REGISTERS_ON_STACK
4381 GC_SAVE_REGISTERS_ON_STACK (end
);
4382 #else /* not GC_SAVE_REGISTERS_ON_STACK */
4384 #ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4385 setjmp will definitely work, test it
4386 and print a message with the result
4388 if (!setjmp_tested_p
)
4390 setjmp_tested_p
= 1;
4393 #endif /* GC_SETJMP_WORKS */
4396 end
= stack_grows_down_p
? (char *) &j
+ sizeof j
: (char *) &j
;
4397 #endif /* not GC_SAVE_REGISTERS_ON_STACK */
4398 #endif /* not HAVE___BUILTIN_UNWIND_INIT */
4400 /* This assumes that the stack is a contiguous region in memory. If
4401 that's not the case, something has to be done here to iterate
4402 over the stack segments. */
4403 #ifndef GC_LISP_OBJECT_ALIGNMENT
4405 #define GC_LISP_OBJECT_ALIGNMENT __alignof__ (Lisp_Object)
4407 #define GC_LISP_OBJECT_ALIGNMENT sizeof (Lisp_Object)
4410 for (i
= 0; i
< sizeof (Lisp_Object
); i
+= GC_LISP_OBJECT_ALIGNMENT
)
4411 mark_memory (stack_base
, end
, i
);
4412 /* Allow for marking a secondary stack, like the register stack on the
4414 #ifdef GC_MARK_SECONDARY_STACK
4415 GC_MARK_SECONDARY_STACK ();
4418 #if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4423 #endif /* GC_MARK_STACK != 0 */
4426 /* Determine whether it is safe to access memory at address P. */
4428 valid_pointer_p (void *p
)
4431 return w32_valid_pointer_p (p
, 16);
4435 /* Obviously, we cannot just access it (we would SEGV trying), so we
4436 trick the o/s to tell us whether p is a valid pointer.
4437 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4438 not validate p in that case. */
4442 int valid
= (emacs_write (fd
[1], (char *) p
, 16) == 16);
4443 emacs_close (fd
[1]);
4444 emacs_close (fd
[0]);
4452 /* Return 1 if OBJ is a valid lisp object.
4453 Return 0 if OBJ is NOT a valid lisp object.
4454 Return -1 if we cannot validate OBJ.
4455 This function can be quite slow,
4456 so it should only be used in code for manual debugging. */
4459 valid_lisp_object_p (Lisp_Object obj
)
4469 p
= (void *) XPNTR (obj
);
4470 if (PURE_POINTER_P (p
))
4474 return valid_pointer_p (p
);
4481 int valid
= valid_pointer_p (p
);
4493 case MEM_TYPE_NON_LISP
:
4496 case MEM_TYPE_BUFFER
:
4497 return live_buffer_p (m
, p
);
4500 return live_cons_p (m
, p
);
4502 case MEM_TYPE_STRING
:
4503 return live_string_p (m
, p
);
4506 return live_misc_p (m
, p
);
4508 case MEM_TYPE_SYMBOL
:
4509 return live_symbol_p (m
, p
);
4511 case MEM_TYPE_FLOAT
:
4512 return live_float_p (m
, p
);
4514 case MEM_TYPE_VECTORLIKE
:
4515 return live_vector_p (m
, p
);
4528 /***********************************************************************
4529 Pure Storage Management
4530 ***********************************************************************/
4532 /* Allocate room for SIZE bytes from pure Lisp storage and return a
4533 pointer to it. TYPE is the Lisp type for which the memory is
4534 allocated. TYPE < 0 means it's not used for a Lisp object. */
4536 static POINTER_TYPE
*
4537 pure_alloc (size_t size
, int type
)
4539 POINTER_TYPE
*result
;
4541 size_t alignment
= (1 << GCTYPEBITS
);
4543 size_t alignment
= sizeof (EMACS_INT
);
4545 /* Give Lisp_Floats an extra alignment. */
4546 if (type
== Lisp_Float
)
4548 #if defined __GNUC__ && __GNUC__ >= 2
4549 alignment
= __alignof (struct Lisp_Float
);
4551 alignment
= sizeof (struct Lisp_Float
);
4559 /* Allocate space for a Lisp object from the beginning of the free
4560 space with taking account of alignment. */
4561 result
= ALIGN (purebeg
+ pure_bytes_used_lisp
, alignment
);
4562 pure_bytes_used_lisp
= ((char *)result
- (char *)purebeg
) + size
;
4566 /* Allocate space for a non-Lisp object from the end of the free
4568 pure_bytes_used_non_lisp
+= size
;
4569 result
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4571 pure_bytes_used
= pure_bytes_used_lisp
+ pure_bytes_used_non_lisp
;
4573 if (pure_bytes_used
<= pure_size
)
4576 /* Don't allocate a large amount here,
4577 because it might get mmap'd and then its address
4578 might not be usable. */
4579 purebeg
= (char *) xmalloc (10000);
4581 pure_bytes_used_before_overflow
+= pure_bytes_used
- size
;
4582 pure_bytes_used
= 0;
4583 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
4588 /* Print a warning if PURESIZE is too small. */
4591 check_pure_size (void)
4593 if (pure_bytes_used_before_overflow
)
4594 message (("emacs:0:Pure Lisp storage overflow (approx. %"pI
"d"
4596 pure_bytes_used
+ pure_bytes_used_before_overflow
);
4600 /* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
4601 the non-Lisp data pool of the pure storage, and return its start
4602 address. Return NULL if not found. */
4605 find_string_data_in_pure (const char *data
, EMACS_INT nbytes
)
4608 EMACS_INT skip
, bm_skip
[256], last_char_skip
, infinity
, start
, start_max
;
4609 const unsigned char *p
;
4612 if (pure_bytes_used_non_lisp
< nbytes
+ 1)
4615 /* Set up the Boyer-Moore table. */
4617 for (i
= 0; i
< 256; i
++)
4620 p
= (const unsigned char *) data
;
4622 bm_skip
[*p
++] = skip
;
4624 last_char_skip
= bm_skip
['\0'];
4626 non_lisp_beg
= purebeg
+ pure_size
- pure_bytes_used_non_lisp
;
4627 start_max
= pure_bytes_used_non_lisp
- (nbytes
+ 1);
4629 /* See the comments in the function `boyer_moore' (search.c) for the
4630 use of `infinity'. */
4631 infinity
= pure_bytes_used_non_lisp
+ 1;
4632 bm_skip
['\0'] = infinity
;
4634 p
= (const unsigned char *) non_lisp_beg
+ nbytes
;
4638 /* Check the last character (== '\0'). */
4641 start
+= bm_skip
[*(p
+ start
)];
4643 while (start
<= start_max
);
4645 if (start
< infinity
)
4646 /* Couldn't find the last character. */
4649 /* No less than `infinity' means we could find the last
4650 character at `p[start - infinity]'. */
4653 /* Check the remaining characters. */
4654 if (memcmp (data
, non_lisp_beg
+ start
, nbytes
) == 0)
4656 return non_lisp_beg
+ start
;
4658 start
+= last_char_skip
;
4660 while (start
<= start_max
);
4666 /* Return a string allocated in pure space. DATA is a buffer holding
4667 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
4668 non-zero means make the result string multibyte.
4670 Must get an error if pure storage is full, since if it cannot hold
4671 a large string it may be able to hold conses that point to that
4672 string; then the string is not protected from gc. */
4675 make_pure_string (const char *data
,
4676 EMACS_INT nchars
, EMACS_INT nbytes
, int multibyte
)
4679 struct Lisp_String
*s
;
4681 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
4682 s
->data
= (unsigned char *) find_string_data_in_pure (data
, nbytes
);
4683 if (s
->data
== NULL
)
4685 s
->data
= (unsigned char *) pure_alloc (nbytes
+ 1, -1);
4686 memcpy (s
->data
, data
, nbytes
);
4687 s
->data
[nbytes
] = '\0';
4690 s
->size_byte
= multibyte
? nbytes
: -1;
4691 s
->intervals
= NULL_INTERVAL
;
4692 XSETSTRING (string
, s
);
4696 /* Return a string a string allocated in pure space. Do not allocate
4697 the string data, just point to DATA. */
4700 make_pure_c_string (const char *data
)
4703 struct Lisp_String
*s
;
4704 EMACS_INT nchars
= strlen (data
);
4706 s
= (struct Lisp_String
*) pure_alloc (sizeof *s
, Lisp_String
);
4709 s
->data
= (unsigned char *) data
;
4710 s
->intervals
= NULL_INTERVAL
;
4711 XSETSTRING (string
, s
);
4715 /* Return a cons allocated from pure space. Give it pure copies
4716 of CAR as car and CDR as cdr. */
4719 pure_cons (Lisp_Object car
, Lisp_Object cdr
)
4721 register Lisp_Object
new;
4722 struct Lisp_Cons
*p
;
4724 p
= (struct Lisp_Cons
*) pure_alloc (sizeof *p
, Lisp_Cons
);
4726 XSETCAR (new, Fpurecopy (car
));
4727 XSETCDR (new, Fpurecopy (cdr
));
4732 /* Value is a float object with value NUM allocated from pure space. */
4735 make_pure_float (double num
)
4737 register Lisp_Object
new;
4738 struct Lisp_Float
*p
;
4740 p
= (struct Lisp_Float
*) pure_alloc (sizeof *p
, Lisp_Float
);
4742 XFLOAT_INIT (new, num
);
4747 /* Return a vector with room for LEN Lisp_Objects allocated from
4751 make_pure_vector (EMACS_INT len
)
4754 struct Lisp_Vector
*p
;
4755 size_t size
= (offsetof (struct Lisp_Vector
, contents
)
4756 + len
* sizeof (Lisp_Object
));
4758 p
= (struct Lisp_Vector
*) pure_alloc (size
, Lisp_Vectorlike
);
4759 XSETVECTOR (new, p
);
4760 XVECTOR (new)->header
.size
= len
;
4765 DEFUN ("purecopy", Fpurecopy
, Spurecopy
, 1, 1, 0,
4766 doc
: /* Make a copy of object OBJ in pure storage.
4767 Recursively copies contents of vectors and cons cells.
4768 Does not copy symbols. Copies strings without text properties. */)
4769 (register Lisp_Object obj
)
4771 if (NILP (Vpurify_flag
))
4774 if (PURE_POINTER_P (XPNTR (obj
)))
4777 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
4779 Lisp_Object tmp
= Fgethash (obj
, Vpurify_flag
, Qnil
);
4785 obj
= pure_cons (XCAR (obj
), XCDR (obj
));
4786 else if (FLOATP (obj
))
4787 obj
= make_pure_float (XFLOAT_DATA (obj
));
4788 else if (STRINGP (obj
))
4789 obj
= make_pure_string (SSDATA (obj
), SCHARS (obj
),
4791 STRING_MULTIBYTE (obj
));
4792 else if (COMPILEDP (obj
) || VECTORP (obj
))
4794 register struct Lisp_Vector
*vec
;
4795 register EMACS_INT i
;
4799 if (size
& PSEUDOVECTOR_FLAG
)
4800 size
&= PSEUDOVECTOR_SIZE_MASK
;
4801 vec
= XVECTOR (make_pure_vector (size
));
4802 for (i
= 0; i
< size
; i
++)
4803 vec
->contents
[i
] = Fpurecopy (XVECTOR (obj
)->contents
[i
]);
4804 if (COMPILEDP (obj
))
4806 XSETPVECTYPE (vec
, PVEC_COMPILED
);
4807 XSETCOMPILED (obj
, vec
);
4810 XSETVECTOR (obj
, vec
);
4812 else if (MARKERP (obj
))
4813 error ("Attempt to copy a marker to pure storage");
4815 /* Not purified, don't hash-cons. */
4818 if (HASH_TABLE_P (Vpurify_flag
)) /* Hash consing. */
4819 Fputhash (obj
, obj
, Vpurify_flag
);
4826 /***********************************************************************
4828 ***********************************************************************/
4830 /* Put an entry in staticvec, pointing at the variable with address
4834 staticpro (Lisp_Object
*varaddress
)
4836 staticvec
[staticidx
++] = varaddress
;
4837 if (staticidx
>= NSTATICS
)
4842 /***********************************************************************
4844 ***********************************************************************/
4846 /* Temporarily prevent garbage collection. */
4849 inhibit_garbage_collection (void)
4851 int count
= SPECPDL_INDEX ();
4853 specbind (Qgc_cons_threshold
, make_number (MOST_POSITIVE_FIXNUM
));
4858 DEFUN ("garbage-collect", Fgarbage_collect
, Sgarbage_collect
, 0, 0, "",
4859 doc
: /* Reclaim storage for Lisp objects no longer needed.
4860 Garbage collection happens automatically if you cons more than
4861 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
4862 `garbage-collect' normally returns a list with info on amount of space in use:
4863 ((USED-CONSES . FREE-CONSES) (USED-SYMS . FREE-SYMS)
4864 (USED-MARKERS . FREE-MARKERS) USED-STRING-CHARS USED-VECTOR-SLOTS
4865 (USED-FLOATS . FREE-FLOATS) (USED-INTERVALS . FREE-INTERVALS)
4866 (USED-STRINGS . FREE-STRINGS))
4867 However, if there was overflow in pure space, `garbage-collect'
4868 returns nil, because real GC can't be done. */)
4871 register struct specbinding
*bind
;
4872 char stack_top_variable
;
4875 Lisp_Object total
[8];
4876 int count
= SPECPDL_INDEX ();
4877 EMACS_TIME t1
, t2
, t3
;
4882 /* Can't GC if pure storage overflowed because we can't determine
4883 if something is a pure object or not. */
4884 if (pure_bytes_used_before_overflow
)
4889 /* Don't keep undo information around forever.
4890 Do this early on, so it is no problem if the user quits. */
4892 register struct buffer
*nextb
= all_buffers
;
4896 /* If a buffer's undo list is Qt, that means that undo is
4897 turned off in that buffer. Calling truncate_undo_list on
4898 Qt tends to return NULL, which effectively turns undo back on.
4899 So don't call truncate_undo_list if undo_list is Qt. */
4900 if (! NILP (nextb
->BUFFER_INTERNAL_FIELD (name
)) && ! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
4901 truncate_undo_list (nextb
);
4903 /* Shrink buffer gaps, but skip indirect and dead buffers. */
4904 if (nextb
->base_buffer
== 0 && !NILP (nextb
->BUFFER_INTERNAL_FIELD (name
))
4905 && ! nextb
->text
->inhibit_shrinking
)
4907 /* If a buffer's gap size is more than 10% of the buffer
4908 size, or larger than 2000 bytes, then shrink it
4909 accordingly. Keep a minimum size of 20 bytes. */
4910 int size
= min (2000, max (20, (nextb
->text
->z_byte
/ 10)));
4912 if (nextb
->text
->gap_size
> size
)
4914 struct buffer
*save_current
= current_buffer
;
4915 current_buffer
= nextb
;
4916 make_gap (-(nextb
->text
->gap_size
- size
));
4917 current_buffer
= save_current
;
4921 nextb
= nextb
->header
.next
.buffer
;
4925 EMACS_GET_TIME (t1
);
4927 /* In case user calls debug_print during GC,
4928 don't let that cause a recursive GC. */
4929 consing_since_gc
= 0;
4931 /* Save what's currently displayed in the echo area. */
4932 message_p
= push_message ();
4933 record_unwind_protect (pop_message_unwind
, Qnil
);
4935 /* Save a copy of the contents of the stack, for debugging. */
4936 #if MAX_SAVE_STACK > 0
4937 if (NILP (Vpurify_flag
))
4940 ptrdiff_t stack_size
;
4941 if (&stack_top_variable
< stack_bottom
)
4943 stack
= &stack_top_variable
;
4944 stack_size
= stack_bottom
- &stack_top_variable
;
4948 stack
= stack_bottom
;
4949 stack_size
= &stack_top_variable
- stack_bottom
;
4951 if (stack_size
<= MAX_SAVE_STACK
)
4953 if (stack_copy_size
< stack_size
)
4955 stack_copy
= (char *) xrealloc (stack_copy
, stack_size
);
4956 stack_copy_size
= stack_size
;
4958 memcpy (stack_copy
, stack
, stack_size
);
4961 #endif /* MAX_SAVE_STACK > 0 */
4963 if (garbage_collection_messages
)
4964 message1_nolog ("Garbage collecting...");
4968 shrink_regexp_cache ();
4972 /* clear_marks (); */
4974 /* Mark all the special slots that serve as the roots of accessibility. */
4976 for (i
= 0; i
< staticidx
; i
++)
4977 mark_object (*staticvec
[i
]);
4979 for (bind
= specpdl
; bind
!= specpdl_ptr
; bind
++)
4981 mark_object (bind
->symbol
);
4982 mark_object (bind
->old_value
);
4990 extern void xg_mark_data (void);
4995 #if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
4996 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5000 register struct gcpro
*tail
;
5001 for (tail
= gcprolist
; tail
; tail
= tail
->next
)
5002 for (i
= 0; i
< tail
->nvars
; i
++)
5003 mark_object (tail
->var
[i
]);
5007 struct catchtag
*catch;
5008 struct handler
*handler
;
5010 for (catch = catchlist
; catch; catch = catch->next
)
5012 mark_object (catch->tag
);
5013 mark_object (catch->val
);
5015 for (handler
= handlerlist
; handler
; handler
= handler
->next
)
5017 mark_object (handler
->handler
);
5018 mark_object (handler
->var
);
5024 #ifdef HAVE_WINDOW_SYSTEM
5025 mark_fringe_data ();
5028 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5032 /* Everything is now marked, except for the things that require special
5033 finalization, i.e. the undo_list.
5034 Look thru every buffer's undo list
5035 for elements that update markers that were not marked,
5038 register struct buffer
*nextb
= all_buffers
;
5042 /* If a buffer's undo list is Qt, that means that undo is
5043 turned off in that buffer. Calling truncate_undo_list on
5044 Qt tends to return NULL, which effectively turns undo back on.
5045 So don't call truncate_undo_list if undo_list is Qt. */
5046 if (! EQ (nextb
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
5048 Lisp_Object tail
, prev
;
5049 tail
= nextb
->BUFFER_INTERNAL_FIELD (undo_list
);
5051 while (CONSP (tail
))
5053 if (CONSP (XCAR (tail
))
5054 && MARKERP (XCAR (XCAR (tail
)))
5055 && !XMARKER (XCAR (XCAR (tail
)))->gcmarkbit
)
5058 nextb
->BUFFER_INTERNAL_FIELD (undo_list
) = tail
= XCDR (tail
);
5062 XSETCDR (prev
, tail
);
5072 /* Now that we have stripped the elements that need not be in the
5073 undo_list any more, we can finally mark the list. */
5074 mark_object (nextb
->BUFFER_INTERNAL_FIELD (undo_list
));
5076 nextb
= nextb
->header
.next
.buffer
;
5082 /* Clear the mark bits that we set in certain root slots. */
5084 unmark_byte_stack ();
5085 VECTOR_UNMARK (&buffer_defaults
);
5086 VECTOR_UNMARK (&buffer_local_symbols
);
5088 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5096 /* clear_marks (); */
5099 consing_since_gc
= 0;
5100 if (gc_cons_threshold
< 10000)
5101 gc_cons_threshold
= 10000;
5103 gc_relative_threshold
= 0;
5104 if (FLOATP (Vgc_cons_percentage
))
5105 { /* Set gc_cons_combined_threshold. */
5108 tot
+= total_conses
* sizeof (struct Lisp_Cons
);
5109 tot
+= total_symbols
* sizeof (struct Lisp_Symbol
);
5110 tot
+= total_markers
* sizeof (union Lisp_Misc
);
5111 tot
+= total_string_size
;
5112 tot
+= total_vector_size
* sizeof (Lisp_Object
);
5113 tot
+= total_floats
* sizeof (struct Lisp_Float
);
5114 tot
+= total_intervals
* sizeof (struct interval
);
5115 tot
+= total_strings
* sizeof (struct Lisp_String
);
5117 tot
*= XFLOAT_DATA (Vgc_cons_percentage
);
5120 if (tot
< TYPE_MAXIMUM (EMACS_INT
))
5121 gc_relative_threshold
= tot
;
5123 gc_relative_threshold
= TYPE_MAXIMUM (EMACS_INT
);
5127 if (garbage_collection_messages
)
5129 if (message_p
|| minibuf_level
> 0)
5132 message1_nolog ("Garbage collecting...done");
5135 unbind_to (count
, Qnil
);
5137 total
[0] = Fcons (make_number (total_conses
),
5138 make_number (total_free_conses
));
5139 total
[1] = Fcons (make_number (total_symbols
),
5140 make_number (total_free_symbols
));
5141 total
[2] = Fcons (make_number (total_markers
),
5142 make_number (total_free_markers
));
5143 total
[3] = make_number (total_string_size
);
5144 total
[4] = make_number (total_vector_size
);
5145 total
[5] = Fcons (make_number (total_floats
),
5146 make_number (total_free_floats
));
5147 total
[6] = Fcons (make_number (total_intervals
),
5148 make_number (total_free_intervals
));
5149 total
[7] = Fcons (make_number (total_strings
),
5150 make_number (total_free_strings
));
5152 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5154 /* Compute average percentage of zombies. */
5157 for (i
= 0; i
< 7; ++i
)
5158 if (CONSP (total
[i
]))
5159 nlive
+= XFASTINT (XCAR (total
[i
]));
5161 avg_live
= (avg_live
* ngcs
+ nlive
) / (ngcs
+ 1);
5162 max_live
= max (nlive
, max_live
);
5163 avg_zombies
= (avg_zombies
* ngcs
+ nzombies
) / (ngcs
+ 1);
5164 max_zombies
= max (nzombies
, max_zombies
);
5169 if (!NILP (Vpost_gc_hook
))
5171 int gc_count
= inhibit_garbage_collection ();
5172 safe_run_hooks (Qpost_gc_hook
);
5173 unbind_to (gc_count
, Qnil
);
5176 /* Accumulate statistics. */
5177 EMACS_GET_TIME (t2
);
5178 EMACS_SUB_TIME (t3
, t2
, t1
);
5179 if (FLOATP (Vgc_elapsed
))
5180 Vgc_elapsed
= make_float (XFLOAT_DATA (Vgc_elapsed
) +
5182 EMACS_USECS (t3
) * 1.0e-6);
5185 return Flist (sizeof total
/ sizeof *total
, total
);
5189 /* Mark Lisp objects in glyph matrix MATRIX. Currently the
5190 only interesting objects referenced from glyphs are strings. */
5193 mark_glyph_matrix (struct glyph_matrix
*matrix
)
5195 struct glyph_row
*row
= matrix
->rows
;
5196 struct glyph_row
*end
= row
+ matrix
->nrows
;
5198 for (; row
< end
; ++row
)
5202 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
5204 struct glyph
*glyph
= row
->glyphs
[area
];
5205 struct glyph
*end_glyph
= glyph
+ row
->used
[area
];
5207 for (; glyph
< end_glyph
; ++glyph
)
5208 if (STRINGP (glyph
->object
)
5209 && !STRING_MARKED_P (XSTRING (glyph
->object
)))
5210 mark_object (glyph
->object
);
5216 /* Mark Lisp faces in the face cache C. */
5219 mark_face_cache (struct face_cache
*c
)
5224 for (i
= 0; i
< c
->used
; ++i
)
5226 struct face
*face
= FACE_FROM_ID (c
->f
, i
);
5230 for (j
= 0; j
< LFACE_VECTOR_SIZE
; ++j
)
5231 mark_object (face
->lface
[j
]);
5239 /* Mark reference to a Lisp_Object.
5240 If the object referred to has not been seen yet, recursively mark
5241 all the references contained in it. */
5243 #define LAST_MARKED_SIZE 500
5244 static Lisp_Object last_marked
[LAST_MARKED_SIZE
];
5245 static int last_marked_index
;
5247 /* For debugging--call abort when we cdr down this many
5248 links of a list, in mark_object. In debugging,
5249 the call to abort will hit a breakpoint.
5250 Normally this is zero and the check never goes off. */
5251 ptrdiff_t mark_object_loop_halt EXTERNALLY_VISIBLE
;
5254 mark_vectorlike (struct Lisp_Vector
*ptr
)
5256 EMACS_INT size
= ptr
->header
.size
;
5259 eassert (!VECTOR_MARKED_P (ptr
));
5260 VECTOR_MARK (ptr
); /* Else mark it */
5261 if (size
& PSEUDOVECTOR_FLAG
)
5262 size
&= PSEUDOVECTOR_SIZE_MASK
;
5264 /* Note that this size is not the memory-footprint size, but only
5265 the number of Lisp_Object fields that we should trace.
5266 The distinction is used e.g. by Lisp_Process which places extra
5267 non-Lisp_Object fields at the end of the structure. */
5268 for (i
= 0; i
< size
; i
++) /* and then mark its elements */
5269 mark_object (ptr
->contents
[i
]);
5272 /* Like mark_vectorlike but optimized for char-tables (and
5273 sub-char-tables) assuming that the contents are mostly integers or
5277 mark_char_table (struct Lisp_Vector
*ptr
)
5279 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5282 eassert (!VECTOR_MARKED_P (ptr
));
5284 for (i
= 0; i
< size
; i
++)
5286 Lisp_Object val
= ptr
->contents
[i
];
5288 if (INTEGERP (val
) || (SYMBOLP (val
) && XSYMBOL (val
)->gcmarkbit
))
5290 if (SUB_CHAR_TABLE_P (val
))
5292 if (! VECTOR_MARKED_P (XVECTOR (val
)))
5293 mark_char_table (XVECTOR (val
));
5301 mark_object (Lisp_Object arg
)
5303 register Lisp_Object obj
= arg
;
5304 #ifdef GC_CHECK_MARKED_OBJECTS
5308 ptrdiff_t cdr_count
= 0;
5312 if (PURE_POINTER_P (XPNTR (obj
)))
5315 last_marked
[last_marked_index
++] = obj
;
5316 if (last_marked_index
== LAST_MARKED_SIZE
)
5317 last_marked_index
= 0;
5319 /* Perform some sanity checks on the objects marked here. Abort if
5320 we encounter an object we know is bogus. This increases GC time
5321 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5322 #ifdef GC_CHECK_MARKED_OBJECTS
5324 po
= (void *) XPNTR (obj
);
5326 /* Check that the object pointed to by PO is known to be a Lisp
5327 structure allocated from the heap. */
5328 #define CHECK_ALLOCATED() \
5330 m = mem_find (po); \
5335 /* Check that the object pointed to by PO is live, using predicate
5337 #define CHECK_LIVE(LIVEP) \
5339 if (!LIVEP (m, po)) \
5343 /* Check both of the above conditions. */
5344 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5346 CHECK_ALLOCATED (); \
5347 CHECK_LIVE (LIVEP); \
5350 #else /* not GC_CHECK_MARKED_OBJECTS */
5352 #define CHECK_LIVE(LIVEP) (void) 0
5353 #define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5355 #endif /* not GC_CHECK_MARKED_OBJECTS */
5357 switch (SWITCH_ENUM_CAST (XTYPE (obj
)))
5361 register struct Lisp_String
*ptr
= XSTRING (obj
);
5362 if (STRING_MARKED_P (ptr
))
5364 CHECK_ALLOCATED_AND_LIVE (live_string_p
);
5365 MARK_INTERVAL_TREE (ptr
->intervals
);
5367 #ifdef GC_CHECK_STRING_BYTES
5368 /* Check that the string size recorded in the string is the
5369 same as the one recorded in the sdata structure. */
5370 CHECK_STRING_BYTES (ptr
);
5371 #endif /* GC_CHECK_STRING_BYTES */
5375 case Lisp_Vectorlike
:
5376 if (VECTOR_MARKED_P (XVECTOR (obj
)))
5378 #ifdef GC_CHECK_MARKED_OBJECTS
5380 if (m
== MEM_NIL
&& !SUBRP (obj
)
5381 && po
!= &buffer_defaults
5382 && po
!= &buffer_local_symbols
)
5384 #endif /* GC_CHECK_MARKED_OBJECTS */
5388 #ifdef GC_CHECK_MARKED_OBJECTS
5389 if (po
!= &buffer_defaults
&& po
!= &buffer_local_symbols
)
5392 for (b
= all_buffers
; b
&& b
!= po
; b
= b
->header
.next
.buffer
)
5397 #endif /* GC_CHECK_MARKED_OBJECTS */
5400 else if (SUBRP (obj
))
5402 else if (COMPILEDP (obj
))
5403 /* We could treat this just like a vector, but it is better to
5404 save the COMPILED_CONSTANTS element for last and avoid
5407 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5408 int size
= ptr
->header
.size
& PSEUDOVECTOR_SIZE_MASK
;
5411 CHECK_LIVE (live_vector_p
);
5412 VECTOR_MARK (ptr
); /* Else mark it */
5413 for (i
= 0; i
< size
; i
++) /* and then mark its elements */
5415 if (i
!= COMPILED_CONSTANTS
)
5416 mark_object (ptr
->contents
[i
]);
5418 obj
= ptr
->contents
[COMPILED_CONSTANTS
];
5421 else if (FRAMEP (obj
))
5423 register struct frame
*ptr
= XFRAME (obj
);
5424 mark_vectorlike (XVECTOR (obj
));
5425 mark_face_cache (ptr
->face_cache
);
5427 else if (WINDOWP (obj
))
5429 register struct Lisp_Vector
*ptr
= XVECTOR (obj
);
5430 struct window
*w
= XWINDOW (obj
);
5431 mark_vectorlike (ptr
);
5432 /* Mark glyphs for leaf windows. Marking window matrices is
5433 sufficient because frame matrices use the same glyph
5435 if (NILP (w
->hchild
)
5437 && w
->current_matrix
)
5439 mark_glyph_matrix (w
->current_matrix
);
5440 mark_glyph_matrix (w
->desired_matrix
);
5443 else if (HASH_TABLE_P (obj
))
5445 struct Lisp_Hash_Table
*h
= XHASH_TABLE (obj
);
5446 mark_vectorlike ((struct Lisp_Vector
*)h
);
5447 /* If hash table is not weak, mark all keys and values.
5448 For weak tables, mark only the vector. */
5450 mark_object (h
->key_and_value
);
5452 VECTOR_MARK (XVECTOR (h
->key_and_value
));
5454 else if (CHAR_TABLE_P (obj
))
5455 mark_char_table (XVECTOR (obj
));
5457 mark_vectorlike (XVECTOR (obj
));
5462 register struct Lisp_Symbol
*ptr
= XSYMBOL (obj
);
5463 struct Lisp_Symbol
*ptrx
;
5467 CHECK_ALLOCATED_AND_LIVE (live_symbol_p
);
5469 mark_object (ptr
->function
);
5470 mark_object (ptr
->plist
);
5471 switch (ptr
->redirect
)
5473 case SYMBOL_PLAINVAL
: mark_object (SYMBOL_VAL (ptr
)); break;
5474 case SYMBOL_VARALIAS
:
5477 XSETSYMBOL (tem
, SYMBOL_ALIAS (ptr
));
5481 case SYMBOL_LOCALIZED
:
5483 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (ptr
);
5484 /* If the value is forwarded to a buffer or keyboard field,
5485 these are marked when we see the corresponding object.
5486 And if it's forwarded to a C variable, either it's not
5487 a Lisp_Object var, or it's staticpro'd already. */
5488 mark_object (blv
->where
);
5489 mark_object (blv
->valcell
);
5490 mark_object (blv
->defcell
);
5493 case SYMBOL_FORWARDED
:
5494 /* If the value is forwarded to a buffer or keyboard field,
5495 these are marked when we see the corresponding object.
5496 And if it's forwarded to a C variable, either it's not
5497 a Lisp_Object var, or it's staticpro'd already. */
5501 if (!PURE_POINTER_P (XSTRING (ptr
->xname
)))
5502 MARK_STRING (XSTRING (ptr
->xname
));
5503 MARK_INTERVAL_TREE (STRING_INTERVALS (ptr
->xname
));
5508 ptrx
= ptr
; /* Use of ptrx avoids compiler bug on Sun */
5509 XSETSYMBOL (obj
, ptrx
);
5516 CHECK_ALLOCATED_AND_LIVE (live_misc_p
);
5517 if (XMISCANY (obj
)->gcmarkbit
)
5519 XMISCANY (obj
)->gcmarkbit
= 1;
5521 switch (XMISCTYPE (obj
))
5524 case Lisp_Misc_Marker
:
5525 /* DO NOT mark thru the marker's chain.
5526 The buffer's markers chain does not preserve markers from gc;
5527 instead, markers are removed from the chain when freed by gc. */
5530 case Lisp_Misc_Save_Value
:
5533 register struct Lisp_Save_Value
*ptr
= XSAVE_VALUE (obj
);
5534 /* If DOGC is set, POINTER is the address of a memory
5535 area containing INTEGER potential Lisp_Objects. */
5538 Lisp_Object
*p
= (Lisp_Object
*) ptr
->pointer
;
5540 for (nelt
= ptr
->integer
; nelt
> 0; nelt
--, p
++)
5541 mark_maybe_object (*p
);
5547 case Lisp_Misc_Overlay
:
5549 struct Lisp_Overlay
*ptr
= XOVERLAY (obj
);
5550 mark_object (ptr
->start
);
5551 mark_object (ptr
->end
);
5552 mark_object (ptr
->plist
);
5555 XSETMISC (obj
, ptr
->next
);
5568 register struct Lisp_Cons
*ptr
= XCONS (obj
);
5569 if (CONS_MARKED_P (ptr
))
5571 CHECK_ALLOCATED_AND_LIVE (live_cons_p
);
5573 /* If the cdr is nil, avoid recursion for the car. */
5574 if (EQ (ptr
->u
.cdr
, Qnil
))
5580 mark_object (ptr
->car
);
5583 if (cdr_count
== mark_object_loop_halt
)
5589 CHECK_ALLOCATED_AND_LIVE (live_float_p
);
5590 FLOAT_MARK (XFLOAT (obj
));
5601 #undef CHECK_ALLOCATED
5602 #undef CHECK_ALLOCATED_AND_LIVE
5605 /* Mark the pointers in a buffer structure. */
5608 mark_buffer (Lisp_Object buf
)
5610 register struct buffer
*buffer
= XBUFFER (buf
);
5611 register Lisp_Object
*ptr
, tmp
;
5612 Lisp_Object base_buffer
;
5614 eassert (!VECTOR_MARKED_P (buffer
));
5615 VECTOR_MARK (buffer
);
5617 MARK_INTERVAL_TREE (BUF_INTERVALS (buffer
));
5619 /* For now, we just don't mark the undo_list. It's done later in
5620 a special way just before the sweep phase, and after stripping
5621 some of its elements that are not needed any more. */
5623 if (buffer
->overlays_before
)
5625 XSETMISC (tmp
, buffer
->overlays_before
);
5628 if (buffer
->overlays_after
)
5630 XSETMISC (tmp
, buffer
->overlays_after
);
5634 /* buffer-local Lisp variables start at `undo_list',
5635 tho only the ones from `name' on are GC'd normally. */
5636 for (ptr
= &buffer
->BUFFER_INTERNAL_FIELD (name
);
5637 ptr
<= &PER_BUFFER_VALUE (buffer
,
5638 PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER
));
5642 /* If this is an indirect buffer, mark its base buffer. */
5643 if (buffer
->base_buffer
&& !VECTOR_MARKED_P (buffer
->base_buffer
))
5645 XSETBUFFER (base_buffer
, buffer
->base_buffer
);
5646 mark_buffer (base_buffer
);
5650 /* Mark the Lisp pointers in the terminal objects.
5651 Called by the Fgarbage_collector. */
5654 mark_terminals (void)
5657 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
5659 eassert (t
->name
!= NULL
);
5660 #ifdef HAVE_WINDOW_SYSTEM
5661 /* If a terminal object is reachable from a stacpro'ed object,
5662 it might have been marked already. Make sure the image cache
5664 mark_image_cache (t
->image_cache
);
5665 #endif /* HAVE_WINDOW_SYSTEM */
5666 if (!VECTOR_MARKED_P (t
))
5667 mark_vectorlike ((struct Lisp_Vector
*)t
);
5673 /* Value is non-zero if OBJ will survive the current GC because it's
5674 either marked or does not need to be marked to survive. */
5677 survives_gc_p (Lisp_Object obj
)
5681 switch (XTYPE (obj
))
5688 survives_p
= XSYMBOL (obj
)->gcmarkbit
;
5692 survives_p
= XMISCANY (obj
)->gcmarkbit
;
5696 survives_p
= STRING_MARKED_P (XSTRING (obj
));
5699 case Lisp_Vectorlike
:
5700 survives_p
= SUBRP (obj
) || VECTOR_MARKED_P (XVECTOR (obj
));
5704 survives_p
= CONS_MARKED_P (XCONS (obj
));
5708 survives_p
= FLOAT_MARKED_P (XFLOAT (obj
));
5715 return survives_p
|| PURE_POINTER_P ((void *) XPNTR (obj
));
5720 /* Sweep: find all structures not marked, and free them. */
5725 /* Remove or mark entries in weak hash tables.
5726 This must be done before any object is unmarked. */
5727 sweep_weak_hash_tables ();
5730 #ifdef GC_CHECK_STRING_BYTES
5731 if (!noninteractive
)
5732 check_string_bytes (1);
5735 /* Put all unmarked conses on free list */
5737 register struct cons_block
*cblk
;
5738 struct cons_block
**cprev
= &cons_block
;
5739 register int lim
= cons_block_index
;
5740 EMACS_INT num_free
= 0, num_used
= 0;
5744 for (cblk
= cons_block
; cblk
; cblk
= *cprev
)
5748 int ilim
= (lim
+ BITS_PER_INT
- 1) / BITS_PER_INT
;
5750 /* Scan the mark bits an int at a time. */
5751 for (i
= 0; i
< ilim
; i
++)
5753 if (cblk
->gcmarkbits
[i
] == -1)
5755 /* Fast path - all cons cells for this int are marked. */
5756 cblk
->gcmarkbits
[i
] = 0;
5757 num_used
+= BITS_PER_INT
;
5761 /* Some cons cells for this int are not marked.
5762 Find which ones, and free them. */
5763 int start
, pos
, stop
;
5765 start
= i
* BITS_PER_INT
;
5767 if (stop
> BITS_PER_INT
)
5768 stop
= BITS_PER_INT
;
5771 for (pos
= start
; pos
< stop
; pos
++)
5773 if (!CONS_MARKED_P (&cblk
->conses
[pos
]))
5776 cblk
->conses
[pos
].u
.chain
= cons_free_list
;
5777 cons_free_list
= &cblk
->conses
[pos
];
5779 cons_free_list
->car
= Vdead
;
5785 CONS_UNMARK (&cblk
->conses
[pos
]);
5791 lim
= CONS_BLOCK_SIZE
;
5792 /* If this block contains only free conses and we have already
5793 seen more than two blocks worth of free conses then deallocate
5795 if (this_free
== CONS_BLOCK_SIZE
&& num_free
> CONS_BLOCK_SIZE
)
5797 *cprev
= cblk
->next
;
5798 /* Unhook from the free list. */
5799 cons_free_list
= cblk
->conses
[0].u
.chain
;
5800 lisp_align_free (cblk
);
5804 num_free
+= this_free
;
5805 cprev
= &cblk
->next
;
5808 total_conses
= num_used
;
5809 total_free_conses
= num_free
;
5812 /* Put all unmarked floats on free list */
5814 register struct float_block
*fblk
;
5815 struct float_block
**fprev
= &float_block
;
5816 register int lim
= float_block_index
;
5817 EMACS_INT num_free
= 0, num_used
= 0;
5819 float_free_list
= 0;
5821 for (fblk
= float_block
; fblk
; fblk
= *fprev
)
5825 for (i
= 0; i
< lim
; i
++)
5826 if (!FLOAT_MARKED_P (&fblk
->floats
[i
]))
5829 fblk
->floats
[i
].u
.chain
= float_free_list
;
5830 float_free_list
= &fblk
->floats
[i
];
5835 FLOAT_UNMARK (&fblk
->floats
[i
]);
5837 lim
= FLOAT_BLOCK_SIZE
;
5838 /* If this block contains only free floats and we have already
5839 seen more than two blocks worth of free floats then deallocate
5841 if (this_free
== FLOAT_BLOCK_SIZE
&& num_free
> FLOAT_BLOCK_SIZE
)
5843 *fprev
= fblk
->next
;
5844 /* Unhook from the free list. */
5845 float_free_list
= fblk
->floats
[0].u
.chain
;
5846 lisp_align_free (fblk
);
5850 num_free
+= this_free
;
5851 fprev
= &fblk
->next
;
5854 total_floats
= num_used
;
5855 total_free_floats
= num_free
;
5858 /* Put all unmarked intervals on free list */
5860 register struct interval_block
*iblk
;
5861 struct interval_block
**iprev
= &interval_block
;
5862 register int lim
= interval_block_index
;
5863 EMACS_INT num_free
= 0, num_used
= 0;
5865 interval_free_list
= 0;
5867 for (iblk
= interval_block
; iblk
; iblk
= *iprev
)
5872 for (i
= 0; i
< lim
; i
++)
5874 if (!iblk
->intervals
[i
].gcmarkbit
)
5876 SET_INTERVAL_PARENT (&iblk
->intervals
[i
], interval_free_list
);
5877 interval_free_list
= &iblk
->intervals
[i
];
5883 iblk
->intervals
[i
].gcmarkbit
= 0;
5886 lim
= INTERVAL_BLOCK_SIZE
;
5887 /* If this block contains only free intervals and we have already
5888 seen more than two blocks worth of free intervals then
5889 deallocate this block. */
5890 if (this_free
== INTERVAL_BLOCK_SIZE
&& num_free
> INTERVAL_BLOCK_SIZE
)
5892 *iprev
= iblk
->next
;
5893 /* Unhook from the free list. */
5894 interval_free_list
= INTERVAL_PARENT (&iblk
->intervals
[0]);
5899 num_free
+= this_free
;
5900 iprev
= &iblk
->next
;
5903 total_intervals
= num_used
;
5904 total_free_intervals
= num_free
;
5907 /* Put all unmarked symbols on free list */
5909 register struct symbol_block
*sblk
;
5910 struct symbol_block
**sprev
= &symbol_block
;
5911 register int lim
= symbol_block_index
;
5912 EMACS_INT num_free
= 0, num_used
= 0;
5914 symbol_free_list
= NULL
;
5916 for (sblk
= symbol_block
; sblk
; sblk
= *sprev
)
5919 struct Lisp_Symbol
*sym
= sblk
->symbols
;
5920 struct Lisp_Symbol
*end
= sym
+ lim
;
5922 for (; sym
< end
; ++sym
)
5924 /* Check if the symbol was created during loadup. In such a case
5925 it might be pointed to by pure bytecode which we don't trace,
5926 so we conservatively assume that it is live. */
5927 int pure_p
= PURE_POINTER_P (XSTRING (sym
->xname
));
5929 if (!sym
->gcmarkbit
&& !pure_p
)
5931 if (sym
->redirect
== SYMBOL_LOCALIZED
)
5932 xfree (SYMBOL_BLV (sym
));
5933 sym
->next
= symbol_free_list
;
5934 symbol_free_list
= sym
;
5936 symbol_free_list
->function
= Vdead
;
5944 UNMARK_STRING (XSTRING (sym
->xname
));
5949 lim
= SYMBOL_BLOCK_SIZE
;
5950 /* If this block contains only free symbols and we have already
5951 seen more than two blocks worth of free symbols then deallocate
5953 if (this_free
== SYMBOL_BLOCK_SIZE
&& num_free
> SYMBOL_BLOCK_SIZE
)
5955 *sprev
= sblk
->next
;
5956 /* Unhook from the free list. */
5957 symbol_free_list
= sblk
->symbols
[0].next
;
5962 num_free
+= this_free
;
5963 sprev
= &sblk
->next
;
5966 total_symbols
= num_used
;
5967 total_free_symbols
= num_free
;
5970 /* Put all unmarked misc's on free list.
5971 For a marker, first unchain it from the buffer it points into. */
5973 register struct marker_block
*mblk
;
5974 struct marker_block
**mprev
= &marker_block
;
5975 register int lim
= marker_block_index
;
5976 EMACS_INT num_free
= 0, num_used
= 0;
5978 marker_free_list
= 0;
5980 for (mblk
= marker_block
; mblk
; mblk
= *mprev
)
5985 for (i
= 0; i
< lim
; i
++)
5987 if (!mblk
->markers
[i
].u_any
.gcmarkbit
)
5989 if (mblk
->markers
[i
].u_any
.type
== Lisp_Misc_Marker
)
5990 unchain_marker (&mblk
->markers
[i
].u_marker
);
5991 /* Set the type of the freed object to Lisp_Misc_Free.
5992 We could leave the type alone, since nobody checks it,
5993 but this might catch bugs faster. */
5994 mblk
->markers
[i
].u_marker
.type
= Lisp_Misc_Free
;
5995 mblk
->markers
[i
].u_free
.chain
= marker_free_list
;
5996 marker_free_list
= &mblk
->markers
[i
];
6002 mblk
->markers
[i
].u_any
.gcmarkbit
= 0;
6005 lim
= MARKER_BLOCK_SIZE
;
6006 /* If this block contains only free markers and we have already
6007 seen more than two blocks worth of free markers then deallocate
6009 if (this_free
== MARKER_BLOCK_SIZE
&& num_free
> MARKER_BLOCK_SIZE
)
6011 *mprev
= mblk
->next
;
6012 /* Unhook from the free list. */
6013 marker_free_list
= mblk
->markers
[0].u_free
.chain
;
6018 num_free
+= this_free
;
6019 mprev
= &mblk
->next
;
6023 total_markers
= num_used
;
6024 total_free_markers
= num_free
;
6027 /* Free all unmarked buffers */
6029 register struct buffer
*buffer
= all_buffers
, *prev
= 0, *next
;
6032 if (!VECTOR_MARKED_P (buffer
))
6035 prev
->header
.next
= buffer
->header
.next
;
6037 all_buffers
= buffer
->header
.next
.buffer
;
6038 next
= buffer
->header
.next
.buffer
;
6044 VECTOR_UNMARK (buffer
);
6045 UNMARK_BALANCE_INTERVALS (BUF_INTERVALS (buffer
));
6046 prev
= buffer
, buffer
= buffer
->header
.next
.buffer
;
6050 /* Free all unmarked vectors */
6052 register struct Lisp_Vector
*vector
= all_vectors
, *prev
= 0, *next
;
6053 total_vector_size
= 0;
6056 if (!VECTOR_MARKED_P (vector
))
6059 prev
->header
.next
= vector
->header
.next
;
6061 all_vectors
= vector
->header
.next
.vector
;
6062 next
= vector
->header
.next
.vector
;
6069 VECTOR_UNMARK (vector
);
6070 if (vector
->header
.size
& PSEUDOVECTOR_FLAG
)
6071 total_vector_size
+= PSEUDOVECTOR_SIZE_MASK
& vector
->header
.size
;
6073 total_vector_size
+= vector
->header
.size
;
6074 prev
= vector
, vector
= vector
->header
.next
.vector
;
6078 #ifdef GC_CHECK_STRING_BYTES
6079 if (!noninteractive
)
6080 check_string_bytes (1);
6087 /* Debugging aids. */
6089 DEFUN ("memory-limit", Fmemory_limit
, Smemory_limit
, 0, 0, 0,
6090 doc
: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6091 This may be helpful in debugging Emacs's memory usage.
6092 We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6097 XSETINT (end
, (intptr_t) (char *) sbrk (0) / 1024);
6102 DEFUN ("memory-use-counts", Fmemory_use_counts
, Smemory_use_counts
, 0, 0, 0,
6103 doc
: /* Return a list of counters that measure how much consing there has been.
6104 Each of these counters increments for a certain kind of object.
6105 The counters wrap around from the largest positive integer to zero.
6106 Garbage collection does not decrease them.
6107 The elements of the value are as follows:
6108 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6109 All are in units of 1 = one object consed
6110 except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6112 MISCS include overlays, markers, and some internal types.
6113 Frames, windows, buffers, and subprocesses count as vectors
6114 (but the contents of a buffer's text do not count here). */)
6117 Lisp_Object consed
[8];
6119 consed
[0] = make_number (min (MOST_POSITIVE_FIXNUM
, cons_cells_consed
));
6120 consed
[1] = make_number (min (MOST_POSITIVE_FIXNUM
, floats_consed
));
6121 consed
[2] = make_number (min (MOST_POSITIVE_FIXNUM
, vector_cells_consed
));
6122 consed
[3] = make_number (min (MOST_POSITIVE_FIXNUM
, symbols_consed
));
6123 consed
[4] = make_number (min (MOST_POSITIVE_FIXNUM
, string_chars_consed
));
6124 consed
[5] = make_number (min (MOST_POSITIVE_FIXNUM
, misc_objects_consed
));
6125 consed
[6] = make_number (min (MOST_POSITIVE_FIXNUM
, intervals_consed
));
6126 consed
[7] = make_number (min (MOST_POSITIVE_FIXNUM
, strings_consed
));
6128 return Flist (8, consed
);
6131 #ifdef ENABLE_CHECKING
6132 int suppress_checking
;
6135 die (const char *msg
, const char *file
, int line
)
6137 fprintf (stderr
, "\r\n%s:%d: Emacs fatal error: %s\r\n",
6143 /* Initialization */
6146 init_alloc_once (void)
6148 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6150 pure_size
= PURESIZE
;
6151 pure_bytes_used
= 0;
6152 pure_bytes_used_lisp
= pure_bytes_used_non_lisp
= 0;
6153 pure_bytes_used_before_overflow
= 0;
6155 /* Initialize the list of free aligned blocks. */
6158 #if GC_MARK_STACK || defined GC_MALLOC_CHECK
6160 Vdead
= make_pure_string ("DEAD", 4, 4, 0);
6164 ignore_warnings
= 1;
6165 #ifdef DOUG_LEA_MALLOC
6166 mallopt (M_TRIM_THRESHOLD
, 128*1024); /* trim threshold */
6167 mallopt (M_MMAP_THRESHOLD
, 64*1024); /* mmap threshold */
6168 mallopt (M_MMAP_MAX
, MMAP_MAX_AREAS
); /* max. number of mmap'ed areas */
6176 init_weak_hash_tables ();
6179 malloc_hysteresis
= 32;
6181 malloc_hysteresis
= 0;
6184 refill_memory_reserve ();
6186 ignore_warnings
= 0;
6188 byte_stack_list
= 0;
6190 consing_since_gc
= 0;
6191 gc_cons_threshold
= 100000 * sizeof (Lisp_Object
);
6192 gc_relative_threshold
= 0;
6199 byte_stack_list
= 0;
6201 #if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6202 setjmp_tested_p
= longjmps_done
= 0;
6205 Vgc_elapsed
= make_float (0.0);
6210 syms_of_alloc (void)
6212 DEFVAR_INT ("gc-cons-threshold", gc_cons_threshold
,
6213 doc
: /* *Number of bytes of consing between garbage collections.
6214 Garbage collection can happen automatically once this many bytes have been
6215 allocated since the last garbage collection. All data types count.
6217 Garbage collection happens automatically only when `eval' is called.
6219 By binding this temporarily to a large number, you can effectively
6220 prevent garbage collection during a part of the program.
6221 See also `gc-cons-percentage'. */);
6223 DEFVAR_LISP ("gc-cons-percentage", Vgc_cons_percentage
,
6224 doc
: /* *Portion of the heap used for allocation.
6225 Garbage collection can happen automatically once this portion of the heap
6226 has been allocated since the last garbage collection.
6227 If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6228 Vgc_cons_percentage
= make_float (0.1);
6230 DEFVAR_INT ("pure-bytes-used", pure_bytes_used
,
6231 doc
: /* Number of bytes of sharable Lisp data allocated so far. */);
6233 DEFVAR_INT ("cons-cells-consed", cons_cells_consed
,
6234 doc
: /* Number of cons cells that have been consed so far. */);
6236 DEFVAR_INT ("floats-consed", floats_consed
,
6237 doc
: /* Number of floats that have been consed so far. */);
6239 DEFVAR_INT ("vector-cells-consed", vector_cells_consed
,
6240 doc
: /* Number of vector cells that have been consed so far. */);
6242 DEFVAR_INT ("symbols-consed", symbols_consed
,
6243 doc
: /* Number of symbols that have been consed so far. */);
6245 DEFVAR_INT ("string-chars-consed", string_chars_consed
,
6246 doc
: /* Number of string characters that have been consed so far. */);
6248 DEFVAR_INT ("misc-objects-consed", misc_objects_consed
,
6249 doc
: /* Number of miscellaneous objects that have been consed so far. */);
6251 DEFVAR_INT ("intervals-consed", intervals_consed
,
6252 doc
: /* Number of intervals that have been consed so far. */);
6254 DEFVAR_INT ("strings-consed", strings_consed
,
6255 doc
: /* Number of strings that have been consed so far. */);
6257 DEFVAR_LISP ("purify-flag", Vpurify_flag
,
6258 doc
: /* Non-nil means loading Lisp code in order to dump an executable.
6259 This means that certain objects should be allocated in shared (pure) space.
6260 It can also be set to a hash-table, in which case this table is used to
6261 do hash-consing of the objects allocated to pure space. */);
6263 DEFVAR_BOOL ("garbage-collection-messages", garbage_collection_messages
,
6264 doc
: /* Non-nil means display messages at start and end of garbage collection. */);
6265 garbage_collection_messages
= 0;
6267 DEFVAR_LISP ("post-gc-hook", Vpost_gc_hook
,
6268 doc
: /* Hook run after garbage collection has finished. */);
6269 Vpost_gc_hook
= Qnil
;
6270 DEFSYM (Qpost_gc_hook
, "post-gc-hook");
6272 DEFVAR_LISP ("memory-signal-data", Vmemory_signal_data
,
6273 doc
: /* Precomputed `signal' argument for memory-full error. */);
6274 /* We build this in advance because if we wait until we need it, we might
6275 not be able to allocate the memory to hold it. */
6277 = pure_cons (Qerror
,
6278 pure_cons (make_pure_c_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"), Qnil
));
6280 DEFVAR_LISP ("memory-full", Vmemory_full
,
6281 doc
: /* Non-nil means Emacs cannot get much more Lisp memory. */);
6282 Vmemory_full
= Qnil
;
6284 DEFSYM (Qgc_cons_threshold
, "gc-cons-threshold");
6285 DEFSYM (Qchar_table_extra_slots
, "char-table-extra-slots");
6287 DEFVAR_LISP ("gc-elapsed", Vgc_elapsed
,
6288 doc
: /* Accumulated time elapsed in garbage collections.
6289 The time is in seconds as a floating point value. */);
6290 DEFVAR_INT ("gcs-done", gcs_done
,
6291 doc
: /* Accumulated number of garbage collections done. */);
6296 defsubr (&Smake_byte_code
);
6297 defsubr (&Smake_list
);
6298 defsubr (&Smake_vector
);
6299 defsubr (&Smake_string
);
6300 defsubr (&Smake_bool_vector
);
6301 defsubr (&Smake_symbol
);
6302 defsubr (&Smake_marker
);
6303 defsubr (&Spurecopy
);
6304 defsubr (&Sgarbage_collect
);
6305 defsubr (&Smemory_limit
);
6306 defsubr (&Smemory_use_counts
);
6308 #if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
6309 defsubr (&Sgc_status
);