*** empty log message ***
[bpt/emacs.git] / src / alloc.c
... / ...
CommitLineData
1/* Storage allocation and gc for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985, 1986, 1988, 1993, 1994, 1995, 1997, 1998, 1999,
3 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
4
5This file is part of GNU Emacs.
6
7GNU Emacs is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
9the Free Software Foundation; either version 2, or (at your option)
10any later version.
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GNU Emacs; see the file COPYING. If not, write to
19the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20Boston, MA 02110-1301, USA. */
21
22#include <config.h>
23#include <stdio.h>
24#include <limits.h> /* For CHAR_BIT. */
25
26#ifdef STDC_HEADERS
27#include <stddef.h> /* For offsetof, used by PSEUDOVECSIZE. */
28#endif
29
30#ifdef ALLOC_DEBUG
31#undef INLINE
32#endif
33
34/* Note that this declares bzero on OSF/1. How dumb. */
35
36#include <signal.h>
37
38#ifdef HAVE_GTK_AND_PTHREAD
39#include <pthread.h>
40#endif
41
42/* This file is part of the core Lisp implementation, and thus must
43 deal with the real data structures. If the Lisp implementation is
44 replaced, this file likely will not be used. */
45
46#undef HIDE_LISP_IMPLEMENTATION
47#include "lisp.h"
48#include "process.h"
49#include "intervals.h"
50#include "puresize.h"
51#include "buffer.h"
52#include "window.h"
53#include "keyboard.h"
54#include "frame.h"
55#include "blockinput.h"
56#include "charset.h"
57#include "syssignal.h"
58#include <setjmp.h>
59
60/* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
61 memory. Can do this only if using gmalloc.c. */
62
63#if defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC
64#undef GC_MALLOC_CHECK
65#endif
66
67#ifdef HAVE_UNISTD_H
68#include <unistd.h>
69#else
70extern POINTER_TYPE *sbrk ();
71#endif
72
73#ifdef HAVE_FCNTL_H
74#define INCLUDED_FCNTL
75#include <fcntl.h>
76#endif
77#ifndef O_WRONLY
78#define O_WRONLY 1
79#endif
80
81#ifdef DOUG_LEA_MALLOC
82
83#include <malloc.h>
84/* malloc.h #defines this as size_t, at least in glibc2. */
85#ifndef __malloc_size_t
86#define __malloc_size_t int
87#endif
88
89/* Specify maximum number of areas to mmap. It would be nice to use a
90 value that explicitly means "no limit". */
91
92#define MMAP_MAX_AREAS 100000000
93
94#else /* not DOUG_LEA_MALLOC */
95
96/* The following come from gmalloc.c. */
97
98#define __malloc_size_t size_t
99extern __malloc_size_t _bytes_used;
100extern __malloc_size_t __malloc_extra_blocks;
101
102#endif /* not DOUG_LEA_MALLOC */
103
104#if ! defined (SYSTEM_MALLOC) && defined (HAVE_GTK_AND_PTHREAD)
105
106/* When GTK uses the file chooser dialog, different backends can be loaded
107 dynamically. One such a backend is the Gnome VFS backend that gets loaded
108 if you run Gnome. That backend creates several threads and also allocates
109 memory with malloc.
110
111 If Emacs sets malloc hooks (! SYSTEM_MALLOC) and the emacs_blocked_*
112 functions below are called from malloc, there is a chance that one
113 of these threads preempts the Emacs main thread and the hook variables
114 end up in an inconsistent state. So we have a mutex to prevent that (note
115 that the backend handles concurrent access to malloc within its own threads
116 but Emacs code running in the main thread is not included in that control).
117
118 When UNBLOCK_INPUT is called, reinvoke_input_signal may be called. If this
119 happens in one of the backend threads we will have two threads that tries
120 to run Emacs code at once, and the code is not prepared for that.
121 To prevent that, we only call BLOCK/UNBLOCK from the main thread. */
122
123static pthread_mutex_t alloc_mutex;
124
125#define BLOCK_INPUT_ALLOC \
126 do \
127 { \
128 pthread_mutex_lock (&alloc_mutex); \
129 if (pthread_self () == main_thread) \
130 BLOCK_INPUT; \
131 } \
132 while (0)
133#define UNBLOCK_INPUT_ALLOC \
134 do \
135 { \
136 if (pthread_self () == main_thread) \
137 UNBLOCK_INPUT; \
138 pthread_mutex_unlock (&alloc_mutex); \
139 } \
140 while (0)
141
142#else /* SYSTEM_MALLOC || not HAVE_GTK_AND_PTHREAD */
143
144#define BLOCK_INPUT_ALLOC BLOCK_INPUT
145#define UNBLOCK_INPUT_ALLOC UNBLOCK_INPUT
146
147#endif /* SYSTEM_MALLOC || not HAVE_GTK_AND_PTHREAD */
148
149/* Value of _bytes_used, when spare_memory was freed. */
150
151static __malloc_size_t bytes_used_when_full;
152
153static __malloc_size_t bytes_used_when_reconsidered;
154
155/* Mark, unmark, query mark bit of a Lisp string. S must be a pointer
156 to a struct Lisp_String. */
157
158#define MARK_STRING(S) ((S)->size |= ARRAY_MARK_FLAG)
159#define UNMARK_STRING(S) ((S)->size &= ~ARRAY_MARK_FLAG)
160#define STRING_MARKED_P(S) (((S)->size & ARRAY_MARK_FLAG) != 0)
161
162#define VECTOR_MARK(V) ((V)->size |= ARRAY_MARK_FLAG)
163#define VECTOR_UNMARK(V) ((V)->size &= ~ARRAY_MARK_FLAG)
164#define VECTOR_MARKED_P(V) (((V)->size & ARRAY_MARK_FLAG) != 0)
165
166/* Value is the number of bytes/chars of S, a pointer to a struct
167 Lisp_String. This must be used instead of STRING_BYTES (S) or
168 S->size during GC, because S->size contains the mark bit for
169 strings. */
170
171#define GC_STRING_BYTES(S) (STRING_BYTES (S))
172#define GC_STRING_CHARS(S) ((S)->size & ~ARRAY_MARK_FLAG)
173
174/* Number of bytes of consing done since the last gc. */
175
176int consing_since_gc;
177
178/* Count the amount of consing of various sorts of space. */
179
180EMACS_INT cons_cells_consed;
181EMACS_INT floats_consed;
182EMACS_INT vector_cells_consed;
183EMACS_INT symbols_consed;
184EMACS_INT string_chars_consed;
185EMACS_INT misc_objects_consed;
186EMACS_INT intervals_consed;
187EMACS_INT strings_consed;
188
189/* Minimum number of bytes of consing since GC before next GC. */
190
191EMACS_INT gc_cons_threshold;
192
193/* Similar minimum, computed from Vgc_cons_percentage. */
194
195EMACS_INT gc_relative_threshold;
196
197static Lisp_Object Vgc_cons_percentage;
198
199/* Minimum number of bytes of consing since GC before next GC,
200 when memory is full. */
201
202EMACS_INT memory_full_cons_threshold;
203
204/* Nonzero during GC. */
205
206int gc_in_progress;
207
208/* Nonzero means abort if try to GC.
209 This is for code which is written on the assumption that
210 no GC will happen, so as to verify that assumption. */
211
212int abort_on_gc;
213
214/* Nonzero means display messages at beginning and end of GC. */
215
216int garbage_collection_messages;
217
218#ifndef VIRT_ADDR_VARIES
219extern
220#endif /* VIRT_ADDR_VARIES */
221int malloc_sbrk_used;
222
223#ifndef VIRT_ADDR_VARIES
224extern
225#endif /* VIRT_ADDR_VARIES */
226int malloc_sbrk_unused;
227
228/* Number of live and free conses etc. */
229
230static int total_conses, total_markers, total_symbols, total_vector_size;
231static int total_free_conses, total_free_markers, total_free_symbols;
232static int total_free_floats, total_floats;
233
234/* Points to memory space allocated as "spare", to be freed if we run
235 out of memory. We keep one large block, four cons-blocks, and
236 two string blocks. */
237
238char *spare_memory[7];
239
240/* Amount of spare memory to keep in large reserve block. */
241
242#define SPARE_MEMORY (1 << 14)
243
244/* Number of extra blocks malloc should get when it needs more core. */
245
246static int malloc_hysteresis;
247
248/* Non-nil means defun should do purecopy on the function definition. */
249
250Lisp_Object Vpurify_flag;
251
252/* Non-nil means we are handling a memory-full error. */
253
254Lisp_Object Vmemory_full;
255
256#ifndef HAVE_SHM
257
258/* Initialize it to a nonzero value to force it into data space
259 (rather than bss space). That way unexec will remap it into text
260 space (pure), on some systems. We have not implemented the
261 remapping on more recent systems because this is less important
262 nowadays than in the days of small memories and timesharing. */
263
264EMACS_INT pure[PURESIZE / sizeof (EMACS_INT)] = {1,};
265#define PUREBEG (char *) pure
266
267#else /* HAVE_SHM */
268
269#define pure PURE_SEG_BITS /* Use shared memory segment */
270#define PUREBEG (char *)PURE_SEG_BITS
271
272#endif /* HAVE_SHM */
273
274/* Pointer to the pure area, and its size. */
275
276static char *purebeg;
277static size_t pure_size;
278
279/* Number of bytes of pure storage used before pure storage overflowed.
280 If this is non-zero, this implies that an overflow occurred. */
281
282static size_t pure_bytes_used_before_overflow;
283
284/* Value is non-zero if P points into pure space. */
285
286#define PURE_POINTER_P(P) \
287 (((PNTR_COMPARISON_TYPE) (P) \
288 < (PNTR_COMPARISON_TYPE) ((char *) purebeg + pure_size)) \
289 && ((PNTR_COMPARISON_TYPE) (P) \
290 >= (PNTR_COMPARISON_TYPE) purebeg))
291
292/* Total number of bytes allocated in pure storage. */
293
294EMACS_INT pure_bytes_used;
295
296/* Index in pure at which next pure Lisp object will be allocated.. */
297
298static EMACS_INT pure_bytes_used_lisp;
299
300/* Number of bytes allocated for non-Lisp objects in pure storage. */
301
302static EMACS_INT pure_bytes_used_non_lisp;
303
304/* If nonzero, this is a warning delivered by malloc and not yet
305 displayed. */
306
307char *pending_malloc_warning;
308
309/* Pre-computed signal argument for use when memory is exhausted. */
310
311Lisp_Object Vmemory_signal_data;
312
313/* Maximum amount of C stack to save when a GC happens. */
314
315#ifndef MAX_SAVE_STACK
316#define MAX_SAVE_STACK 16000
317#endif
318
319/* Buffer in which we save a copy of the C stack at each GC. */
320
321char *stack_copy;
322int stack_copy_size;
323
324/* Non-zero means ignore malloc warnings. Set during initialization.
325 Currently not used. */
326
327int ignore_warnings;
328
329Lisp_Object Qgc_cons_threshold, Qchar_table_extra_slots;
330
331/* Hook run after GC has finished. */
332
333Lisp_Object Vpost_gc_hook, Qpost_gc_hook;
334
335Lisp_Object Vgc_elapsed; /* accumulated elapsed time in GC */
336EMACS_INT gcs_done; /* accumulated GCs */
337
338static void mark_buffer P_ ((Lisp_Object));
339extern void mark_kboards P_ ((void));
340extern void mark_backtrace P_ ((void));
341static void gc_sweep P_ ((void));
342static void mark_glyph_matrix P_ ((struct glyph_matrix *));
343static void mark_face_cache P_ ((struct face_cache *));
344
345#ifdef HAVE_WINDOW_SYSTEM
346extern void mark_fringe_data P_ ((void));
347static void mark_image P_ ((struct image *));
348static void mark_image_cache P_ ((struct frame *));
349#endif /* HAVE_WINDOW_SYSTEM */
350
351static struct Lisp_String *allocate_string P_ ((void));
352static void compact_small_strings P_ ((void));
353static void free_large_strings P_ ((void));
354static void sweep_strings P_ ((void));
355
356extern int message_enable_multibyte;
357
358/* When scanning the C stack for live Lisp objects, Emacs keeps track
359 of what memory allocated via lisp_malloc is intended for what
360 purpose. This enumeration specifies the type of memory. */
361
362enum mem_type
363{
364 MEM_TYPE_NON_LISP,
365 MEM_TYPE_BUFFER,
366 MEM_TYPE_CONS,
367 MEM_TYPE_STRING,
368 MEM_TYPE_MISC,
369 MEM_TYPE_SYMBOL,
370 MEM_TYPE_FLOAT,
371 /* Keep the following vector-like types together, with
372 MEM_TYPE_WINDOW being the last, and MEM_TYPE_VECTOR the
373 first. Or change the code of live_vector_p, for instance. */
374 MEM_TYPE_VECTOR,
375 MEM_TYPE_PROCESS,
376 MEM_TYPE_HASH_TABLE,
377 MEM_TYPE_FRAME,
378 MEM_TYPE_WINDOW
379};
380
381static POINTER_TYPE *lisp_align_malloc P_ ((size_t, enum mem_type));
382static POINTER_TYPE *lisp_malloc P_ ((size_t, enum mem_type));
383void refill_memory_reserve ();
384
385
386#if GC_MARK_STACK || defined GC_MALLOC_CHECK
387
388#if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
389#include <stdio.h> /* For fprintf. */
390#endif
391
392/* A unique object in pure space used to make some Lisp objects
393 on free lists recognizable in O(1). */
394
395Lisp_Object Vdead;
396
397#ifdef GC_MALLOC_CHECK
398
399enum mem_type allocated_mem_type;
400int dont_register_blocks;
401
402#endif /* GC_MALLOC_CHECK */
403
404/* A node in the red-black tree describing allocated memory containing
405 Lisp data. Each such block is recorded with its start and end
406 address when it is allocated, and removed from the tree when it
407 is freed.
408
409 A red-black tree is a balanced binary tree with the following
410 properties:
411
412 1. Every node is either red or black.
413 2. Every leaf is black.
414 3. If a node is red, then both of its children are black.
415 4. Every simple path from a node to a descendant leaf contains
416 the same number of black nodes.
417 5. The root is always black.
418
419 When nodes are inserted into the tree, or deleted from the tree,
420 the tree is "fixed" so that these properties are always true.
421
422 A red-black tree with N internal nodes has height at most 2
423 log(N+1). Searches, insertions and deletions are done in O(log N).
424 Please see a text book about data structures for a detailed
425 description of red-black trees. Any book worth its salt should
426 describe them. */
427
428struct mem_node
429{
430 /* Children of this node. These pointers are never NULL. When there
431 is no child, the value is MEM_NIL, which points to a dummy node. */
432 struct mem_node *left, *right;
433
434 /* The parent of this node. In the root node, this is NULL. */
435 struct mem_node *parent;
436
437 /* Start and end of allocated region. */
438 void *start, *end;
439
440 /* Node color. */
441 enum {MEM_BLACK, MEM_RED} color;
442
443 /* Memory type. */
444 enum mem_type type;
445};
446
447/* Base address of stack. Set in main. */
448
449Lisp_Object *stack_base;
450
451/* Root of the tree describing allocated Lisp memory. */
452
453static struct mem_node *mem_root;
454
455/* Lowest and highest known address in the heap. */
456
457static void *min_heap_address, *max_heap_address;
458
459/* Sentinel node of the tree. */
460
461static struct mem_node mem_z;
462#define MEM_NIL &mem_z
463
464static POINTER_TYPE *lisp_malloc P_ ((size_t, enum mem_type));
465static struct Lisp_Vector *allocate_vectorlike P_ ((EMACS_INT, enum mem_type));
466static void lisp_free P_ ((POINTER_TYPE *));
467static void mark_stack P_ ((void));
468static int live_vector_p P_ ((struct mem_node *, void *));
469static int live_buffer_p P_ ((struct mem_node *, void *));
470static int live_string_p P_ ((struct mem_node *, void *));
471static int live_cons_p P_ ((struct mem_node *, void *));
472static int live_symbol_p P_ ((struct mem_node *, void *));
473static int live_float_p P_ ((struct mem_node *, void *));
474static int live_misc_p P_ ((struct mem_node *, void *));
475static void mark_maybe_object P_ ((Lisp_Object));
476static void mark_memory P_ ((void *, void *));
477static void mem_init P_ ((void));
478static struct mem_node *mem_insert P_ ((void *, void *, enum mem_type));
479static void mem_insert_fixup P_ ((struct mem_node *));
480static void mem_rotate_left P_ ((struct mem_node *));
481static void mem_rotate_right P_ ((struct mem_node *));
482static void mem_delete P_ ((struct mem_node *));
483static void mem_delete_fixup P_ ((struct mem_node *));
484static INLINE struct mem_node *mem_find P_ ((void *));
485
486
487#if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
488static void check_gcpros P_ ((void));
489#endif
490
491#endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
492
493/* Recording what needs to be marked for gc. */
494
495struct gcpro *gcprolist;
496
497/* Addresses of staticpro'd variables. Initialize it to a nonzero
498 value; otherwise some compilers put it into BSS. */
499
500#define NSTATICS 1280
501Lisp_Object *staticvec[NSTATICS] = {&Vpurify_flag};
502
503/* Index of next unused slot in staticvec. */
504
505int staticidx = 0;
506
507static POINTER_TYPE *pure_alloc P_ ((size_t, int));
508
509
510/* Value is SZ rounded up to the next multiple of ALIGNMENT.
511 ALIGNMENT must be a power of 2. */
512
513#define ALIGN(ptr, ALIGNMENT) \
514 ((POINTER_TYPE *) ((((EMACS_UINT)(ptr)) + (ALIGNMENT) - 1) \
515 & ~((ALIGNMENT) - 1)))
516
517
518\f
519/************************************************************************
520 Malloc
521 ************************************************************************/
522
523/* Function malloc calls this if it finds we are near exhausting storage. */
524
525void
526malloc_warning (str)
527 char *str;
528{
529 pending_malloc_warning = str;
530}
531
532
533/* Display an already-pending malloc warning. */
534
535void
536display_malloc_warning ()
537{
538 call3 (intern ("display-warning"),
539 intern ("alloc"),
540 build_string (pending_malloc_warning),
541 intern ("emergency"));
542 pending_malloc_warning = 0;
543}
544
545
546#ifdef DOUG_LEA_MALLOC
547# define BYTES_USED (mallinfo ().uordblks)
548#else
549# define BYTES_USED _bytes_used
550#endif
551\f
552/* Called if we can't allocate relocatable space for a buffer. */
553
554void
555buffer_memory_full ()
556{
557 /* If buffers use the relocating allocator, no need to free
558 spare_memory, because we may have plenty of malloc space left
559 that we could get, and if we don't, the malloc that fails will
560 itself cause spare_memory to be freed. If buffers don't use the
561 relocating allocator, treat this like any other failing
562 malloc. */
563
564#ifndef REL_ALLOC
565 memory_full ();
566#endif
567
568 /* This used to call error, but if we've run out of memory, we could
569 get infinite recursion trying to build the string. */
570 xsignal (Qnil, Vmemory_signal_data);
571}
572
573
574#ifdef XMALLOC_OVERRUN_CHECK
575
576/* Check for overrun in malloc'ed buffers by wrapping a 16 byte header
577 and a 16 byte trailer around each block.
578
579 The header consists of 12 fixed bytes + a 4 byte integer contaning the
580 original block size, while the trailer consists of 16 fixed bytes.
581
582 The header is used to detect whether this block has been allocated
583 through these functions -- as it seems that some low-level libc
584 functions may bypass the malloc hooks.
585*/
586
587
588#define XMALLOC_OVERRUN_CHECK_SIZE 16
589
590static char xmalloc_overrun_check_header[XMALLOC_OVERRUN_CHECK_SIZE-4] =
591 { 0x9a, 0x9b, 0xae, 0xaf,
592 0xbf, 0xbe, 0xce, 0xcf,
593 0xea, 0xeb, 0xec, 0xed };
594
595static char xmalloc_overrun_check_trailer[XMALLOC_OVERRUN_CHECK_SIZE] =
596 { 0xaa, 0xab, 0xac, 0xad,
597 0xba, 0xbb, 0xbc, 0xbd,
598 0xca, 0xcb, 0xcc, 0xcd,
599 0xda, 0xdb, 0xdc, 0xdd };
600
601/* Macros to insert and extract the block size in the header. */
602
603#define XMALLOC_PUT_SIZE(ptr, size) \
604 (ptr[-1] = (size & 0xff), \
605 ptr[-2] = ((size >> 8) & 0xff), \
606 ptr[-3] = ((size >> 16) & 0xff), \
607 ptr[-4] = ((size >> 24) & 0xff))
608
609#define XMALLOC_GET_SIZE(ptr) \
610 (size_t)((unsigned)(ptr[-1]) | \
611 ((unsigned)(ptr[-2]) << 8) | \
612 ((unsigned)(ptr[-3]) << 16) | \
613 ((unsigned)(ptr[-4]) << 24))
614
615
616/* The call depth in overrun_check functions. For example, this might happen:
617 xmalloc()
618 overrun_check_malloc()
619 -> malloc -> (via hook)_-> emacs_blocked_malloc
620 -> overrun_check_malloc
621 call malloc (hooks are NULL, so real malloc is called).
622 malloc returns 10000.
623 add overhead, return 10016.
624 <- (back in overrun_check_malloc)
625 add overhead again, return 10032
626 xmalloc returns 10032.
627
628 (time passes).
629
630 xfree(10032)
631 overrun_check_free(10032)
632 decrease overhed
633 free(10016) <- crash, because 10000 is the original pointer. */
634
635static int check_depth;
636
637/* Like malloc, but wraps allocated block with header and trailer. */
638
639POINTER_TYPE *
640overrun_check_malloc (size)
641 size_t size;
642{
643 register unsigned char *val;
644 size_t overhead = ++check_depth == 1 ? XMALLOC_OVERRUN_CHECK_SIZE*2 : 0;
645
646 val = (unsigned char *) malloc (size + overhead);
647 if (val && check_depth == 1)
648 {
649 bcopy (xmalloc_overrun_check_header, val, XMALLOC_OVERRUN_CHECK_SIZE - 4);
650 val += XMALLOC_OVERRUN_CHECK_SIZE;
651 XMALLOC_PUT_SIZE(val, size);
652 bcopy (xmalloc_overrun_check_trailer, val + size, XMALLOC_OVERRUN_CHECK_SIZE);
653 }
654 --check_depth;
655 return (POINTER_TYPE *)val;
656}
657
658
659/* Like realloc, but checks old block for overrun, and wraps new block
660 with header and trailer. */
661
662POINTER_TYPE *
663overrun_check_realloc (block, size)
664 POINTER_TYPE *block;
665 size_t size;
666{
667 register unsigned char *val = (unsigned char *)block;
668 size_t overhead = ++check_depth == 1 ? XMALLOC_OVERRUN_CHECK_SIZE*2 : 0;
669
670 if (val
671 && check_depth == 1
672 && bcmp (xmalloc_overrun_check_header,
673 val - XMALLOC_OVERRUN_CHECK_SIZE,
674 XMALLOC_OVERRUN_CHECK_SIZE - 4) == 0)
675 {
676 size_t osize = XMALLOC_GET_SIZE (val);
677 if (bcmp (xmalloc_overrun_check_trailer,
678 val + osize,
679 XMALLOC_OVERRUN_CHECK_SIZE))
680 abort ();
681 bzero (val + osize, XMALLOC_OVERRUN_CHECK_SIZE);
682 val -= XMALLOC_OVERRUN_CHECK_SIZE;
683 bzero (val, XMALLOC_OVERRUN_CHECK_SIZE);
684 }
685
686 val = (unsigned char *) realloc ((POINTER_TYPE *)val, size + overhead);
687
688 if (val && check_depth == 1)
689 {
690 bcopy (xmalloc_overrun_check_header, val, XMALLOC_OVERRUN_CHECK_SIZE - 4);
691 val += XMALLOC_OVERRUN_CHECK_SIZE;
692 XMALLOC_PUT_SIZE(val, size);
693 bcopy (xmalloc_overrun_check_trailer, val + size, XMALLOC_OVERRUN_CHECK_SIZE);
694 }
695 --check_depth;
696 return (POINTER_TYPE *)val;
697}
698
699/* Like free, but checks block for overrun. */
700
701void
702overrun_check_free (block)
703 POINTER_TYPE *block;
704{
705 unsigned char *val = (unsigned char *)block;
706
707 ++check_depth;
708 if (val
709 && check_depth == 1
710 && bcmp (xmalloc_overrun_check_header,
711 val - XMALLOC_OVERRUN_CHECK_SIZE,
712 XMALLOC_OVERRUN_CHECK_SIZE - 4) == 0)
713 {
714 size_t osize = XMALLOC_GET_SIZE (val);
715 if (bcmp (xmalloc_overrun_check_trailer,
716 val + osize,
717 XMALLOC_OVERRUN_CHECK_SIZE))
718 abort ();
719#ifdef XMALLOC_CLEAR_FREE_MEMORY
720 val -= XMALLOC_OVERRUN_CHECK_SIZE;
721 memset (val, 0xff, osize + XMALLOC_OVERRUN_CHECK_SIZE*2);
722#else
723 bzero (val + osize, XMALLOC_OVERRUN_CHECK_SIZE);
724 val -= XMALLOC_OVERRUN_CHECK_SIZE;
725 bzero (val, XMALLOC_OVERRUN_CHECK_SIZE);
726#endif
727 }
728
729 free (val);
730 --check_depth;
731}
732
733#undef malloc
734#undef realloc
735#undef free
736#define malloc overrun_check_malloc
737#define realloc overrun_check_realloc
738#define free overrun_check_free
739#endif
740
741
742/* Like malloc but check for no memory and block interrupt input.. */
743
744POINTER_TYPE *
745xmalloc (size)
746 size_t size;
747{
748 register POINTER_TYPE *val;
749
750 BLOCK_INPUT;
751 val = (POINTER_TYPE *) malloc (size);
752 UNBLOCK_INPUT;
753
754 if (!val && size)
755 memory_full ();
756 return val;
757}
758
759
760/* Like realloc but check for no memory and block interrupt input.. */
761
762POINTER_TYPE *
763xrealloc (block, size)
764 POINTER_TYPE *block;
765 size_t size;
766{
767 register POINTER_TYPE *val;
768
769 BLOCK_INPUT;
770 /* We must call malloc explicitly when BLOCK is 0, since some
771 reallocs don't do this. */
772 if (! block)
773 val = (POINTER_TYPE *) malloc (size);
774 else
775 val = (POINTER_TYPE *) realloc (block, size);
776 UNBLOCK_INPUT;
777
778 if (!val && size) memory_full ();
779 return val;
780}
781
782
783/* Like free but block interrupt input. */
784
785void
786xfree (block)
787 POINTER_TYPE *block;
788{
789 BLOCK_INPUT;
790 free (block);
791 UNBLOCK_INPUT;
792 /* We don't call refill_memory_reserve here
793 because that duplicates doing so in emacs_blocked_free
794 and the criterion should go there. */
795}
796
797
798/* Like strdup, but uses xmalloc. */
799
800char *
801xstrdup (s)
802 const char *s;
803{
804 size_t len = strlen (s) + 1;
805 char *p = (char *) xmalloc (len);
806 bcopy (s, p, len);
807 return p;
808}
809
810
811/* Unwind for SAFE_ALLOCA */
812
813Lisp_Object
814safe_alloca_unwind (arg)
815 Lisp_Object arg;
816{
817 register struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
818
819 p->dogc = 0;
820 xfree (p->pointer);
821 p->pointer = 0;
822 free_misc (arg);
823 return Qnil;
824}
825
826
827/* Like malloc but used for allocating Lisp data. NBYTES is the
828 number of bytes to allocate, TYPE describes the intended use of the
829 allcated memory block (for strings, for conses, ...). */
830
831#ifndef USE_LSB_TAG
832static void *lisp_malloc_loser;
833#endif
834
835static POINTER_TYPE *
836lisp_malloc (nbytes, type)
837 size_t nbytes;
838 enum mem_type type;
839{
840 register void *val;
841
842 BLOCK_INPUT;
843
844#ifdef GC_MALLOC_CHECK
845 allocated_mem_type = type;
846#endif
847
848 val = (void *) malloc (nbytes);
849
850#ifndef USE_LSB_TAG
851 /* If the memory just allocated cannot be addressed thru a Lisp
852 object's pointer, and it needs to be,
853 that's equivalent to running out of memory. */
854 if (val && type != MEM_TYPE_NON_LISP)
855 {
856 Lisp_Object tem;
857 XSETCONS (tem, (char *) val + nbytes - 1);
858 if ((char *) XCONS (tem) != (char *) val + nbytes - 1)
859 {
860 lisp_malloc_loser = val;
861 free (val);
862 val = 0;
863 }
864 }
865#endif
866
867#if GC_MARK_STACK && !defined GC_MALLOC_CHECK
868 if (val && type != MEM_TYPE_NON_LISP)
869 mem_insert (val, (char *) val + nbytes, type);
870#endif
871
872 UNBLOCK_INPUT;
873 if (!val && nbytes)
874 memory_full ();
875 return val;
876}
877
878/* Free BLOCK. This must be called to free memory allocated with a
879 call to lisp_malloc. */
880
881static void
882lisp_free (block)
883 POINTER_TYPE *block;
884{
885 BLOCK_INPUT;
886 free (block);
887#if GC_MARK_STACK && !defined GC_MALLOC_CHECK
888 mem_delete (mem_find (block));
889#endif
890 UNBLOCK_INPUT;
891}
892
893/* Allocation of aligned blocks of memory to store Lisp data. */
894/* The entry point is lisp_align_malloc which returns blocks of at most */
895/* BLOCK_BYTES and guarantees they are aligned on a BLOCK_ALIGN boundary. */
896
897/* Use posix_memalloc if the system has it and we're using the system's
898 malloc (because our gmalloc.c routines don't have posix_memalign although
899 its memalloc could be used). */
900#if defined (HAVE_POSIX_MEMALIGN) && defined (SYSTEM_MALLOC)
901#define USE_POSIX_MEMALIGN 1
902#endif
903
904/* BLOCK_ALIGN has to be a power of 2. */
905#define BLOCK_ALIGN (1 << 10)
906
907/* Padding to leave at the end of a malloc'd block. This is to give
908 malloc a chance to minimize the amount of memory wasted to alignment.
909 It should be tuned to the particular malloc library used.
910 On glibc-2.3.2, malloc never tries to align, so a padding of 0 is best.
911 posix_memalign on the other hand would ideally prefer a value of 4
912 because otherwise, there's 1020 bytes wasted between each ablocks.
913 In Emacs, testing shows that those 1020 can most of the time be
914 efficiently used by malloc to place other objects, so a value of 0 can
915 still preferable unless you have a lot of aligned blocks and virtually
916 nothing else. */
917#define BLOCK_PADDING 0
918#define BLOCK_BYTES \
919 (BLOCK_ALIGN - sizeof (struct ablock *) - BLOCK_PADDING)
920
921/* Internal data structures and constants. */
922
923#define ABLOCKS_SIZE 16
924
925/* An aligned block of memory. */
926struct ablock
927{
928 union
929 {
930 char payload[BLOCK_BYTES];
931 struct ablock *next_free;
932 } x;
933 /* `abase' is the aligned base of the ablocks. */
934 /* It is overloaded to hold the virtual `busy' field that counts
935 the number of used ablock in the parent ablocks.
936 The first ablock has the `busy' field, the others have the `abase'
937 field. To tell the difference, we assume that pointers will have
938 integer values larger than 2 * ABLOCKS_SIZE. The lowest bit of `busy'
939 is used to tell whether the real base of the parent ablocks is `abase'
940 (if not, the word before the first ablock holds a pointer to the
941 real base). */
942 struct ablocks *abase;
943 /* The padding of all but the last ablock is unused. The padding of
944 the last ablock in an ablocks is not allocated. */
945#if BLOCK_PADDING
946 char padding[BLOCK_PADDING];
947#endif
948};
949
950/* A bunch of consecutive aligned blocks. */
951struct ablocks
952{
953 struct ablock blocks[ABLOCKS_SIZE];
954};
955
956/* Size of the block requested from malloc or memalign. */
957#define ABLOCKS_BYTES (sizeof (struct ablocks) - BLOCK_PADDING)
958
959#define ABLOCK_ABASE(block) \
960 (((unsigned long) (block)->abase) <= (1 + 2 * ABLOCKS_SIZE) \
961 ? (struct ablocks *)(block) \
962 : (block)->abase)
963
964/* Virtual `busy' field. */
965#define ABLOCKS_BUSY(abase) ((abase)->blocks[0].abase)
966
967/* Pointer to the (not necessarily aligned) malloc block. */
968#ifdef USE_POSIX_MEMALIGN
969#define ABLOCKS_BASE(abase) (abase)
970#else
971#define ABLOCKS_BASE(abase) \
972 (1 & (long) ABLOCKS_BUSY (abase) ? abase : ((void**)abase)[-1])
973#endif
974
975/* The list of free ablock. */
976static struct ablock *free_ablock;
977
978/* Allocate an aligned block of nbytes.
979 Alignment is on a multiple of BLOCK_ALIGN and `nbytes' has to be
980 smaller or equal to BLOCK_BYTES. */
981static POINTER_TYPE *
982lisp_align_malloc (nbytes, type)
983 size_t nbytes;
984 enum mem_type type;
985{
986 void *base, *val;
987 struct ablocks *abase;
988
989 eassert (nbytes <= BLOCK_BYTES);
990
991 BLOCK_INPUT;
992
993#ifdef GC_MALLOC_CHECK
994 allocated_mem_type = type;
995#endif
996
997 if (!free_ablock)
998 {
999 int i;
1000 EMACS_INT aligned; /* int gets warning casting to 64-bit pointer. */
1001
1002#ifdef DOUG_LEA_MALLOC
1003 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1004 because mapped region contents are not preserved in
1005 a dumped Emacs. */
1006 mallopt (M_MMAP_MAX, 0);
1007#endif
1008
1009#ifdef USE_POSIX_MEMALIGN
1010 {
1011 int err = posix_memalign (&base, BLOCK_ALIGN, ABLOCKS_BYTES);
1012 if (err)
1013 base = NULL;
1014 abase = base;
1015 }
1016#else
1017 base = malloc (ABLOCKS_BYTES);
1018 abase = ALIGN (base, BLOCK_ALIGN);
1019#endif
1020
1021 if (base == 0)
1022 {
1023 UNBLOCK_INPUT;
1024 memory_full ();
1025 }
1026
1027 aligned = (base == abase);
1028 if (!aligned)
1029 ((void**)abase)[-1] = base;
1030
1031#ifdef DOUG_LEA_MALLOC
1032 /* Back to a reasonable maximum of mmap'ed areas. */
1033 mallopt (M_MMAP_MAX, MMAP_MAX_AREAS);
1034#endif
1035
1036#ifndef USE_LSB_TAG
1037 /* If the memory just allocated cannot be addressed thru a Lisp
1038 object's pointer, and it needs to be, that's equivalent to
1039 running out of memory. */
1040 if (type != MEM_TYPE_NON_LISP)
1041 {
1042 Lisp_Object tem;
1043 char *end = (char *) base + ABLOCKS_BYTES - 1;
1044 XSETCONS (tem, end);
1045 if ((char *) XCONS (tem) != end)
1046 {
1047 lisp_malloc_loser = base;
1048 free (base);
1049 UNBLOCK_INPUT;
1050 memory_full ();
1051 }
1052 }
1053#endif
1054
1055 /* Initialize the blocks and put them on the free list.
1056 Is `base' was not properly aligned, we can't use the last block. */
1057 for (i = 0; i < (aligned ? ABLOCKS_SIZE : ABLOCKS_SIZE - 1); i++)
1058 {
1059 abase->blocks[i].abase = abase;
1060 abase->blocks[i].x.next_free = free_ablock;
1061 free_ablock = &abase->blocks[i];
1062 }
1063 ABLOCKS_BUSY (abase) = (struct ablocks *) (long) aligned;
1064
1065 eassert (0 == ((EMACS_UINT)abase) % BLOCK_ALIGN);
1066 eassert (ABLOCK_ABASE (&abase->blocks[3]) == abase); /* 3 is arbitrary */
1067 eassert (ABLOCK_ABASE (&abase->blocks[0]) == abase);
1068 eassert (ABLOCKS_BASE (abase) == base);
1069 eassert (aligned == (long) ABLOCKS_BUSY (abase));
1070 }
1071
1072 abase = ABLOCK_ABASE (free_ablock);
1073 ABLOCKS_BUSY (abase) = (struct ablocks *) (2 + (long) ABLOCKS_BUSY (abase));
1074 val = free_ablock;
1075 free_ablock = free_ablock->x.next_free;
1076
1077#if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1078 if (val && type != MEM_TYPE_NON_LISP)
1079 mem_insert (val, (char *) val + nbytes, type);
1080#endif
1081
1082 UNBLOCK_INPUT;
1083 if (!val && nbytes)
1084 memory_full ();
1085
1086 eassert (0 == ((EMACS_UINT)val) % BLOCK_ALIGN);
1087 return val;
1088}
1089
1090static void
1091lisp_align_free (block)
1092 POINTER_TYPE *block;
1093{
1094 struct ablock *ablock = block;
1095 struct ablocks *abase = ABLOCK_ABASE (ablock);
1096
1097 BLOCK_INPUT;
1098#if GC_MARK_STACK && !defined GC_MALLOC_CHECK
1099 mem_delete (mem_find (block));
1100#endif
1101 /* Put on free list. */
1102 ablock->x.next_free = free_ablock;
1103 free_ablock = ablock;
1104 /* Update busy count. */
1105 ABLOCKS_BUSY (abase) = (struct ablocks *) (-2 + (long) ABLOCKS_BUSY (abase));
1106
1107 if (2 > (long) ABLOCKS_BUSY (abase))
1108 { /* All the blocks are free. */
1109 int i = 0, aligned = (long) ABLOCKS_BUSY (abase);
1110 struct ablock **tem = &free_ablock;
1111 struct ablock *atop = &abase->blocks[aligned ? ABLOCKS_SIZE : ABLOCKS_SIZE - 1];
1112
1113 while (*tem)
1114 {
1115 if (*tem >= (struct ablock *) abase && *tem < atop)
1116 {
1117 i++;
1118 *tem = (*tem)->x.next_free;
1119 }
1120 else
1121 tem = &(*tem)->x.next_free;
1122 }
1123 eassert ((aligned & 1) == aligned);
1124 eassert (i == (aligned ? ABLOCKS_SIZE : ABLOCKS_SIZE - 1));
1125#ifdef USE_POSIX_MEMALIGN
1126 eassert ((unsigned long)ABLOCKS_BASE (abase) % BLOCK_ALIGN == 0);
1127#endif
1128 free (ABLOCKS_BASE (abase));
1129 }
1130 UNBLOCK_INPUT;
1131}
1132
1133/* Return a new buffer structure allocated from the heap with
1134 a call to lisp_malloc. */
1135
1136struct buffer *
1137allocate_buffer ()
1138{
1139 struct buffer *b
1140 = (struct buffer *) lisp_malloc (sizeof (struct buffer),
1141 MEM_TYPE_BUFFER);
1142 return b;
1143}
1144
1145\f
1146#ifndef SYSTEM_MALLOC
1147
1148/* Arranging to disable input signals while we're in malloc.
1149
1150 This only works with GNU malloc. To help out systems which can't
1151 use GNU malloc, all the calls to malloc, realloc, and free
1152 elsewhere in the code should be inside a BLOCK_INPUT/UNBLOCK_INPUT
1153 pair; unfortunately, we have no idea what C library functions
1154 might call malloc, so we can't really protect them unless you're
1155 using GNU malloc. Fortunately, most of the major operating systems
1156 can use GNU malloc. */
1157
1158#ifndef SYNC_INPUT
1159
1160#ifndef DOUG_LEA_MALLOC
1161extern void * (*__malloc_hook) P_ ((size_t, const void *));
1162extern void * (*__realloc_hook) P_ ((void *, size_t, const void *));
1163extern void (*__free_hook) P_ ((void *, const void *));
1164/* Else declared in malloc.h, perhaps with an extra arg. */
1165#endif /* DOUG_LEA_MALLOC */
1166static void * (*old_malloc_hook) P_ ((size_t, const void *));
1167static void * (*old_realloc_hook) P_ ((void *, size_t, const void*));
1168static void (*old_free_hook) P_ ((void*, const void*));
1169
1170/* This function is used as the hook for free to call. */
1171
1172static void
1173emacs_blocked_free (ptr, ptr2)
1174 void *ptr;
1175 const void *ptr2;
1176{
1177 EMACS_INT bytes_used_now;
1178
1179 BLOCK_INPUT_ALLOC;
1180
1181#ifdef GC_MALLOC_CHECK
1182 if (ptr)
1183 {
1184 struct mem_node *m;
1185
1186 m = mem_find (ptr);
1187 if (m == MEM_NIL || m->start != ptr)
1188 {
1189 fprintf (stderr,
1190 "Freeing `%p' which wasn't allocated with malloc\n", ptr);
1191 abort ();
1192 }
1193 else
1194 {
1195 /* fprintf (stderr, "free %p...%p (%p)\n", m->start, m->end, ptr); */
1196 mem_delete (m);
1197 }
1198 }
1199#endif /* GC_MALLOC_CHECK */
1200
1201 __free_hook = old_free_hook;
1202 free (ptr);
1203
1204 /* If we released our reserve (due to running out of memory),
1205 and we have a fair amount free once again,
1206 try to set aside another reserve in case we run out once more. */
1207 if (! NILP (Vmemory_full)
1208 /* Verify there is enough space that even with the malloc
1209 hysteresis this call won't run out again.
1210 The code here is correct as long as SPARE_MEMORY
1211 is substantially larger than the block size malloc uses. */
1212 && (bytes_used_when_full
1213 > ((bytes_used_when_reconsidered = BYTES_USED)
1214 + max (malloc_hysteresis, 4) * SPARE_MEMORY)))
1215 refill_memory_reserve ();
1216
1217 __free_hook = emacs_blocked_free;
1218 UNBLOCK_INPUT_ALLOC;
1219}
1220
1221
1222/* This function is the malloc hook that Emacs uses. */
1223
1224static void *
1225emacs_blocked_malloc (size, ptr)
1226 size_t size;
1227 const void *ptr;
1228{
1229 void *value;
1230
1231 BLOCK_INPUT_ALLOC;
1232 __malloc_hook = old_malloc_hook;
1233#ifdef DOUG_LEA_MALLOC
1234 mallopt (M_TOP_PAD, malloc_hysteresis * 4096);
1235#else
1236 __malloc_extra_blocks = malloc_hysteresis;
1237#endif
1238
1239 value = (void *) malloc (size);
1240
1241#ifdef GC_MALLOC_CHECK
1242 {
1243 struct mem_node *m = mem_find (value);
1244 if (m != MEM_NIL)
1245 {
1246 fprintf (stderr, "Malloc returned %p which is already in use\n",
1247 value);
1248 fprintf (stderr, "Region in use is %p...%p, %u bytes, type %d\n",
1249 m->start, m->end, (char *) m->end - (char *) m->start,
1250 m->type);
1251 abort ();
1252 }
1253
1254 if (!dont_register_blocks)
1255 {
1256 mem_insert (value, (char *) value + max (1, size), allocated_mem_type);
1257 allocated_mem_type = MEM_TYPE_NON_LISP;
1258 }
1259 }
1260#endif /* GC_MALLOC_CHECK */
1261
1262 __malloc_hook = emacs_blocked_malloc;
1263 UNBLOCK_INPUT_ALLOC;
1264
1265 /* fprintf (stderr, "%p malloc\n", value); */
1266 return value;
1267}
1268
1269
1270/* This function is the realloc hook that Emacs uses. */
1271
1272static void *
1273emacs_blocked_realloc (ptr, size, ptr2)
1274 void *ptr;
1275 size_t size;
1276 const void *ptr2;
1277{
1278 void *value;
1279
1280 BLOCK_INPUT_ALLOC;
1281 __realloc_hook = old_realloc_hook;
1282
1283#ifdef GC_MALLOC_CHECK
1284 if (ptr)
1285 {
1286 struct mem_node *m = mem_find (ptr);
1287 if (m == MEM_NIL || m->start != ptr)
1288 {
1289 fprintf (stderr,
1290 "Realloc of %p which wasn't allocated with malloc\n",
1291 ptr);
1292 abort ();
1293 }
1294
1295 mem_delete (m);
1296 }
1297
1298 /* fprintf (stderr, "%p -> realloc\n", ptr); */
1299
1300 /* Prevent malloc from registering blocks. */
1301 dont_register_blocks = 1;
1302#endif /* GC_MALLOC_CHECK */
1303
1304 value = (void *) realloc (ptr, size);
1305
1306#ifdef GC_MALLOC_CHECK
1307 dont_register_blocks = 0;
1308
1309 {
1310 struct mem_node *m = mem_find (value);
1311 if (m != MEM_NIL)
1312 {
1313 fprintf (stderr, "Realloc returns memory that is already in use\n");
1314 abort ();
1315 }
1316
1317 /* Can't handle zero size regions in the red-black tree. */
1318 mem_insert (value, (char *) value + max (size, 1), MEM_TYPE_NON_LISP);
1319 }
1320
1321 /* fprintf (stderr, "%p <- realloc\n", value); */
1322#endif /* GC_MALLOC_CHECK */
1323
1324 __realloc_hook = emacs_blocked_realloc;
1325 UNBLOCK_INPUT_ALLOC;
1326
1327 return value;
1328}
1329
1330
1331#ifdef HAVE_GTK_AND_PTHREAD
1332/* Called from Fdump_emacs so that when the dumped Emacs starts, it has a
1333 normal malloc. Some thread implementations need this as they call
1334 malloc before main. The pthread_self call in BLOCK_INPUT_ALLOC then
1335 calls malloc because it is the first call, and we have an endless loop. */
1336
1337void
1338reset_malloc_hooks ()
1339{
1340 __free_hook = 0;
1341 __malloc_hook = 0;
1342 __realloc_hook = 0;
1343}
1344#endif /* HAVE_GTK_AND_PTHREAD */
1345
1346
1347/* Called from main to set up malloc to use our hooks. */
1348
1349void
1350uninterrupt_malloc ()
1351{
1352#ifdef HAVE_GTK_AND_PTHREAD
1353 pthread_mutexattr_t attr;
1354
1355 /* GLIBC has a faster way to do this, but lets keep it portable.
1356 This is according to the Single UNIX Specification. */
1357 pthread_mutexattr_init (&attr);
1358 pthread_mutexattr_settype (&attr, PTHREAD_MUTEX_RECURSIVE);
1359 pthread_mutex_init (&alloc_mutex, &attr);
1360#endif /* HAVE_GTK_AND_PTHREAD */
1361
1362 if (__free_hook != emacs_blocked_free)
1363 old_free_hook = __free_hook;
1364 __free_hook = emacs_blocked_free;
1365
1366 if (__malloc_hook != emacs_blocked_malloc)
1367 old_malloc_hook = __malloc_hook;
1368 __malloc_hook = emacs_blocked_malloc;
1369
1370 if (__realloc_hook != emacs_blocked_realloc)
1371 old_realloc_hook = __realloc_hook;
1372 __realloc_hook = emacs_blocked_realloc;
1373}
1374
1375#endif /* not SYNC_INPUT */
1376#endif /* not SYSTEM_MALLOC */
1377
1378
1379\f
1380/***********************************************************************
1381 Interval Allocation
1382 ***********************************************************************/
1383
1384/* Number of intervals allocated in an interval_block structure.
1385 The 1020 is 1024 minus malloc overhead. */
1386
1387#define INTERVAL_BLOCK_SIZE \
1388 ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))
1389
1390/* Intervals are allocated in chunks in form of an interval_block
1391 structure. */
1392
1393struct interval_block
1394{
1395 /* Place `intervals' first, to preserve alignment. */
1396 struct interval intervals[INTERVAL_BLOCK_SIZE];
1397 struct interval_block *next;
1398};
1399
1400/* Current interval block. Its `next' pointer points to older
1401 blocks. */
1402
1403struct interval_block *interval_block;
1404
1405/* Index in interval_block above of the next unused interval
1406 structure. */
1407
1408static int interval_block_index;
1409
1410/* Number of free and live intervals. */
1411
1412static int total_free_intervals, total_intervals;
1413
1414/* List of free intervals. */
1415
1416INTERVAL interval_free_list;
1417
1418/* Total number of interval blocks now in use. */
1419
1420int n_interval_blocks;
1421
1422
1423/* Initialize interval allocation. */
1424
1425static void
1426init_intervals ()
1427{
1428 interval_block = NULL;
1429 interval_block_index = INTERVAL_BLOCK_SIZE;
1430 interval_free_list = 0;
1431 n_interval_blocks = 0;
1432}
1433
1434
1435/* Return a new interval. */
1436
1437INTERVAL
1438make_interval ()
1439{
1440 INTERVAL val;
1441
1442 /* eassert (!handling_signal); */
1443
1444#ifndef SYNC_INPUT
1445 BLOCK_INPUT;
1446#endif
1447
1448 if (interval_free_list)
1449 {
1450 val = interval_free_list;
1451 interval_free_list = INTERVAL_PARENT (interval_free_list);
1452 }
1453 else
1454 {
1455 if (interval_block_index == INTERVAL_BLOCK_SIZE)
1456 {
1457 register struct interval_block *newi;
1458
1459 newi = (struct interval_block *) lisp_malloc (sizeof *newi,
1460 MEM_TYPE_NON_LISP);
1461
1462 newi->next = interval_block;
1463 interval_block = newi;
1464 interval_block_index = 0;
1465 n_interval_blocks++;
1466 }
1467 val = &interval_block->intervals[interval_block_index++];
1468 }
1469
1470#ifndef SYNC_INPUT
1471 UNBLOCK_INPUT;
1472#endif
1473
1474 consing_since_gc += sizeof (struct interval);
1475 intervals_consed++;
1476 RESET_INTERVAL (val);
1477 val->gcmarkbit = 0;
1478 return val;
1479}
1480
1481
1482/* Mark Lisp objects in interval I. */
1483
1484static void
1485mark_interval (i, dummy)
1486 register INTERVAL i;
1487 Lisp_Object dummy;
1488{
1489 eassert (!i->gcmarkbit); /* Intervals are never shared. */
1490 i->gcmarkbit = 1;
1491 mark_object (i->plist);
1492}
1493
1494
1495/* Mark the interval tree rooted in TREE. Don't call this directly;
1496 use the macro MARK_INTERVAL_TREE instead. */
1497
1498static void
1499mark_interval_tree (tree)
1500 register INTERVAL tree;
1501{
1502 /* No need to test if this tree has been marked already; this
1503 function is always called through the MARK_INTERVAL_TREE macro,
1504 which takes care of that. */
1505
1506 traverse_intervals_noorder (tree, mark_interval, Qnil);
1507}
1508
1509
1510/* Mark the interval tree rooted in I. */
1511
1512#define MARK_INTERVAL_TREE(i) \
1513 do { \
1514 if (!NULL_INTERVAL_P (i) && !i->gcmarkbit) \
1515 mark_interval_tree (i); \
1516 } while (0)
1517
1518
1519#define UNMARK_BALANCE_INTERVALS(i) \
1520 do { \
1521 if (! NULL_INTERVAL_P (i)) \
1522 (i) = balance_intervals (i); \
1523 } while (0)
1524
1525\f
1526/* Number support. If NO_UNION_TYPE isn't in effect, we
1527 can't create number objects in macros. */
1528#ifndef make_number
1529Lisp_Object
1530make_number (n)
1531 EMACS_INT n;
1532{
1533 Lisp_Object obj;
1534 obj.s.val = n;
1535 obj.s.type = Lisp_Int;
1536 return obj;
1537}
1538#endif
1539\f
1540/***********************************************************************
1541 String Allocation
1542 ***********************************************************************/
1543
1544/* Lisp_Strings are allocated in string_block structures. When a new
1545 string_block is allocated, all the Lisp_Strings it contains are
1546 added to a free-list string_free_list. When a new Lisp_String is
1547 needed, it is taken from that list. During the sweep phase of GC,
1548 string_blocks that are entirely free are freed, except two which
1549 we keep.
1550
1551 String data is allocated from sblock structures. Strings larger
1552 than LARGE_STRING_BYTES, get their own sblock, data for smaller
1553 strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
1554
1555 Sblocks consist internally of sdata structures, one for each
1556 Lisp_String. The sdata structure points to the Lisp_String it
1557 belongs to. The Lisp_String points back to the `u.data' member of
1558 its sdata structure.
1559
1560 When a Lisp_String is freed during GC, it is put back on
1561 string_free_list, and its `data' member and its sdata's `string'
1562 pointer is set to null. The size of the string is recorded in the
1563 `u.nbytes' member of the sdata. So, sdata structures that are no
1564 longer used, can be easily recognized, and it's easy to compact the
1565 sblocks of small strings which we do in compact_small_strings. */
1566
1567/* Size in bytes of an sblock structure used for small strings. This
1568 is 8192 minus malloc overhead. */
1569
1570#define SBLOCK_SIZE 8188
1571
1572/* Strings larger than this are considered large strings. String data
1573 for large strings is allocated from individual sblocks. */
1574
1575#define LARGE_STRING_BYTES 1024
1576
1577/* Structure describing string memory sub-allocated from an sblock.
1578 This is where the contents of Lisp strings are stored. */
1579
1580struct sdata
1581{
1582 /* Back-pointer to the string this sdata belongs to. If null, this
1583 structure is free, and the NBYTES member of the union below
1584 contains the string's byte size (the same value that STRING_BYTES
1585 would return if STRING were non-null). If non-null, STRING_BYTES
1586 (STRING) is the size of the data, and DATA contains the string's
1587 contents. */
1588 struct Lisp_String *string;
1589
1590#ifdef GC_CHECK_STRING_BYTES
1591
1592 EMACS_INT nbytes;
1593 unsigned char data[1];
1594
1595#define SDATA_NBYTES(S) (S)->nbytes
1596#define SDATA_DATA(S) (S)->data
1597
1598#else /* not GC_CHECK_STRING_BYTES */
1599
1600 union
1601 {
1602 /* When STRING in non-null. */
1603 unsigned char data[1];
1604
1605 /* When STRING is null. */
1606 EMACS_INT nbytes;
1607 } u;
1608
1609
1610#define SDATA_NBYTES(S) (S)->u.nbytes
1611#define SDATA_DATA(S) (S)->u.data
1612
1613#endif /* not GC_CHECK_STRING_BYTES */
1614};
1615
1616
1617/* Structure describing a block of memory which is sub-allocated to
1618 obtain string data memory for strings. Blocks for small strings
1619 are of fixed size SBLOCK_SIZE. Blocks for large strings are made
1620 as large as needed. */
1621
1622struct sblock
1623{
1624 /* Next in list. */
1625 struct sblock *next;
1626
1627 /* Pointer to the next free sdata block. This points past the end
1628 of the sblock if there isn't any space left in this block. */
1629 struct sdata *next_free;
1630
1631 /* Start of data. */
1632 struct sdata first_data;
1633};
1634
1635/* Number of Lisp strings in a string_block structure. The 1020 is
1636 1024 minus malloc overhead. */
1637
1638#define STRING_BLOCK_SIZE \
1639 ((1020 - sizeof (struct string_block *)) / sizeof (struct Lisp_String))
1640
1641/* Structure describing a block from which Lisp_String structures
1642 are allocated. */
1643
1644struct string_block
1645{
1646 /* Place `strings' first, to preserve alignment. */
1647 struct Lisp_String strings[STRING_BLOCK_SIZE];
1648 struct string_block *next;
1649};
1650
1651/* Head and tail of the list of sblock structures holding Lisp string
1652 data. We always allocate from current_sblock. The NEXT pointers
1653 in the sblock structures go from oldest_sblock to current_sblock. */
1654
1655static struct sblock *oldest_sblock, *current_sblock;
1656
1657/* List of sblocks for large strings. */
1658
1659static struct sblock *large_sblocks;
1660
1661/* List of string_block structures, and how many there are. */
1662
1663static struct string_block *string_blocks;
1664static int n_string_blocks;
1665
1666/* Free-list of Lisp_Strings. */
1667
1668static struct Lisp_String *string_free_list;
1669
1670/* Number of live and free Lisp_Strings. */
1671
1672static int total_strings, total_free_strings;
1673
1674/* Number of bytes used by live strings. */
1675
1676static int total_string_size;
1677
1678/* Given a pointer to a Lisp_String S which is on the free-list
1679 string_free_list, return a pointer to its successor in the
1680 free-list. */
1681
1682#define NEXT_FREE_LISP_STRING(S) (*(struct Lisp_String **) (S))
1683
1684/* Return a pointer to the sdata structure belonging to Lisp string S.
1685 S must be live, i.e. S->data must not be null. S->data is actually
1686 a pointer to the `u.data' member of its sdata structure; the
1687 structure starts at a constant offset in front of that. */
1688
1689#ifdef GC_CHECK_STRING_BYTES
1690
1691#define SDATA_OF_STRING(S) \
1692 ((struct sdata *) ((S)->data - sizeof (struct Lisp_String *) \
1693 - sizeof (EMACS_INT)))
1694
1695#else /* not GC_CHECK_STRING_BYTES */
1696
1697#define SDATA_OF_STRING(S) \
1698 ((struct sdata *) ((S)->data - sizeof (struct Lisp_String *)))
1699
1700#endif /* not GC_CHECK_STRING_BYTES */
1701
1702
1703#ifdef GC_CHECK_STRING_OVERRUN
1704
1705/* We check for overrun in string data blocks by appending a small
1706 "cookie" after each allocated string data block, and check for the
1707 presence of this cookie during GC. */
1708
1709#define GC_STRING_OVERRUN_COOKIE_SIZE 4
1710static char string_overrun_cookie[GC_STRING_OVERRUN_COOKIE_SIZE] =
1711 { 0xde, 0xad, 0xbe, 0xef };
1712
1713#else
1714#define GC_STRING_OVERRUN_COOKIE_SIZE 0
1715#endif
1716
1717/* Value is the size of an sdata structure large enough to hold NBYTES
1718 bytes of string data. The value returned includes a terminating
1719 NUL byte, the size of the sdata structure, and padding. */
1720
1721#ifdef GC_CHECK_STRING_BYTES
1722
1723#define SDATA_SIZE(NBYTES) \
1724 ((sizeof (struct Lisp_String *) \
1725 + (NBYTES) + 1 \
1726 + sizeof (EMACS_INT) \
1727 + sizeof (EMACS_INT) - 1) \
1728 & ~(sizeof (EMACS_INT) - 1))
1729
1730#else /* not GC_CHECK_STRING_BYTES */
1731
1732#define SDATA_SIZE(NBYTES) \
1733 ((sizeof (struct Lisp_String *) \
1734 + (NBYTES) + 1 \
1735 + sizeof (EMACS_INT) - 1) \
1736 & ~(sizeof (EMACS_INT) - 1))
1737
1738#endif /* not GC_CHECK_STRING_BYTES */
1739
1740/* Extra bytes to allocate for each string. */
1741
1742#define GC_STRING_EXTRA (GC_STRING_OVERRUN_COOKIE_SIZE)
1743
1744/* Initialize string allocation. Called from init_alloc_once. */
1745
1746void
1747init_strings ()
1748{
1749 total_strings = total_free_strings = total_string_size = 0;
1750 oldest_sblock = current_sblock = large_sblocks = NULL;
1751 string_blocks = NULL;
1752 n_string_blocks = 0;
1753 string_free_list = NULL;
1754}
1755
1756
1757#ifdef GC_CHECK_STRING_BYTES
1758
1759static int check_string_bytes_count;
1760
1761void check_string_bytes P_ ((int));
1762void check_sblock P_ ((struct sblock *));
1763
1764#define CHECK_STRING_BYTES(S) STRING_BYTES (S)
1765
1766
1767/* Like GC_STRING_BYTES, but with debugging check. */
1768
1769int
1770string_bytes (s)
1771 struct Lisp_String *s;
1772{
1773 int nbytes = (s->size_byte < 0 ? s->size & ~ARRAY_MARK_FLAG : s->size_byte);
1774 if (!PURE_POINTER_P (s)
1775 && s->data
1776 && nbytes != SDATA_NBYTES (SDATA_OF_STRING (s)))
1777 abort ();
1778 return nbytes;
1779}
1780
1781/* Check validity of Lisp strings' string_bytes member in B. */
1782
1783void
1784check_sblock (b)
1785 struct sblock *b;
1786{
1787 struct sdata *from, *end, *from_end;
1788
1789 end = b->next_free;
1790
1791 for (from = &b->first_data; from < end; from = from_end)
1792 {
1793 /* Compute the next FROM here because copying below may
1794 overwrite data we need to compute it. */
1795 int nbytes;
1796
1797 /* Check that the string size recorded in the string is the
1798 same as the one recorded in the sdata structure. */
1799 if (from->string)
1800 CHECK_STRING_BYTES (from->string);
1801
1802 if (from->string)
1803 nbytes = GC_STRING_BYTES (from->string);
1804 else
1805 nbytes = SDATA_NBYTES (from);
1806
1807 nbytes = SDATA_SIZE (nbytes);
1808 from_end = (struct sdata *) ((char *) from + nbytes + GC_STRING_EXTRA);
1809 }
1810}
1811
1812
1813/* Check validity of Lisp strings' string_bytes member. ALL_P
1814 non-zero means check all strings, otherwise check only most
1815 recently allocated strings. Used for hunting a bug. */
1816
1817void
1818check_string_bytes (all_p)
1819 int all_p;
1820{
1821 if (all_p)
1822 {
1823 struct sblock *b;
1824
1825 for (b = large_sblocks; b; b = b->next)
1826 {
1827 struct Lisp_String *s = b->first_data.string;
1828 if (s)
1829 CHECK_STRING_BYTES (s);
1830 }
1831
1832 for (b = oldest_sblock; b; b = b->next)
1833 check_sblock (b);
1834 }
1835 else
1836 check_sblock (current_sblock);
1837}
1838
1839#endif /* GC_CHECK_STRING_BYTES */
1840
1841#ifdef GC_CHECK_STRING_FREE_LIST
1842
1843/* Walk through the string free list looking for bogus next pointers.
1844 This may catch buffer overrun from a previous string. */
1845
1846static void
1847check_string_free_list ()
1848{
1849 struct Lisp_String *s;
1850
1851 /* Pop a Lisp_String off the free-list. */
1852 s = string_free_list;
1853 while (s != NULL)
1854 {
1855 if ((unsigned)s < 1024)
1856 abort();
1857 s = NEXT_FREE_LISP_STRING (s);
1858 }
1859}
1860#else
1861#define check_string_free_list()
1862#endif
1863
1864/* Return a new Lisp_String. */
1865
1866static struct Lisp_String *
1867allocate_string ()
1868{
1869 struct Lisp_String *s;
1870
1871 /* eassert (!handling_signal); */
1872
1873#ifndef SYNC_INPUT
1874 BLOCK_INPUT;
1875#endif
1876
1877 /* If the free-list is empty, allocate a new string_block, and
1878 add all the Lisp_Strings in it to the free-list. */
1879 if (string_free_list == NULL)
1880 {
1881 struct string_block *b;
1882 int i;
1883
1884 b = (struct string_block *) lisp_malloc (sizeof *b, MEM_TYPE_STRING);
1885 bzero (b, sizeof *b);
1886 b->next = string_blocks;
1887 string_blocks = b;
1888 ++n_string_blocks;
1889
1890 for (i = STRING_BLOCK_SIZE - 1; i >= 0; --i)
1891 {
1892 s = b->strings + i;
1893 NEXT_FREE_LISP_STRING (s) = string_free_list;
1894 string_free_list = s;
1895 }
1896
1897 total_free_strings += STRING_BLOCK_SIZE;
1898 }
1899
1900 check_string_free_list ();
1901
1902 /* Pop a Lisp_String off the free-list. */
1903 s = string_free_list;
1904 string_free_list = NEXT_FREE_LISP_STRING (s);
1905
1906#ifndef SYNC_INPUT
1907 UNBLOCK_INPUT;
1908#endif
1909
1910 /* Probably not strictly necessary, but play it safe. */
1911 bzero (s, sizeof *s);
1912
1913 --total_free_strings;
1914 ++total_strings;
1915 ++strings_consed;
1916 consing_since_gc += sizeof *s;
1917
1918#ifdef GC_CHECK_STRING_BYTES
1919 if (!noninteractive
1920#ifdef MAC_OS8
1921 && current_sblock
1922#endif
1923 )
1924 {
1925 if (++check_string_bytes_count == 200)
1926 {
1927 check_string_bytes_count = 0;
1928 check_string_bytes (1);
1929 }
1930 else
1931 check_string_bytes (0);
1932 }
1933#endif /* GC_CHECK_STRING_BYTES */
1934
1935 return s;
1936}
1937
1938
1939/* Set up Lisp_String S for holding NCHARS characters, NBYTES bytes,
1940 plus a NUL byte at the end. Allocate an sdata structure for S, and
1941 set S->data to its `u.data' member. Store a NUL byte at the end of
1942 S->data. Set S->size to NCHARS and S->size_byte to NBYTES. Free
1943 S->data if it was initially non-null. */
1944
1945void
1946allocate_string_data (s, nchars, nbytes)
1947 struct Lisp_String *s;
1948 int nchars, nbytes;
1949{
1950 struct sdata *data, *old_data;
1951 struct sblock *b;
1952 int needed, old_nbytes;
1953
1954 /* Determine the number of bytes needed to store NBYTES bytes
1955 of string data. */
1956 needed = SDATA_SIZE (nbytes);
1957 old_data = s->data ? SDATA_OF_STRING (s) : NULL;
1958 old_nbytes = GC_STRING_BYTES (s);
1959
1960#ifndef SYNC_INPUT
1961 BLOCK_INPUT;
1962#endif
1963
1964 if (nbytes > LARGE_STRING_BYTES)
1965 {
1966 size_t size = sizeof *b - sizeof (struct sdata) + needed;
1967
1968#ifdef DOUG_LEA_MALLOC
1969 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
1970 because mapped region contents are not preserved in
1971 a dumped Emacs.
1972
1973 In case you think of allowing it in a dumped Emacs at the
1974 cost of not being able to re-dump, there's another reason:
1975 mmap'ed data typically have an address towards the top of the
1976 address space, which won't fit into an EMACS_INT (at least on
1977 32-bit systems with the current tagging scheme). --fx */
1978 BLOCK_INPUT;
1979 mallopt (M_MMAP_MAX, 0);
1980 UNBLOCK_INPUT;
1981#endif
1982
1983 b = (struct sblock *) lisp_malloc (size + GC_STRING_EXTRA, MEM_TYPE_NON_LISP);
1984
1985#ifdef DOUG_LEA_MALLOC
1986 /* Back to a reasonable maximum of mmap'ed areas. */
1987 BLOCK_INPUT;
1988 mallopt (M_MMAP_MAX, MMAP_MAX_AREAS);
1989 UNBLOCK_INPUT;
1990#endif
1991
1992 b->next_free = &b->first_data;
1993 b->first_data.string = NULL;
1994 b->next = large_sblocks;
1995 large_sblocks = b;
1996 }
1997 else if (current_sblock == NULL
1998 || (((char *) current_sblock + SBLOCK_SIZE
1999 - (char *) current_sblock->next_free)
2000 < (needed + GC_STRING_EXTRA)))
2001 {
2002 /* Not enough room in the current sblock. */
2003 b = (struct sblock *) lisp_malloc (SBLOCK_SIZE, MEM_TYPE_NON_LISP);
2004 b->next_free = &b->first_data;
2005 b->first_data.string = NULL;
2006 b->next = NULL;
2007
2008 if (current_sblock)
2009 current_sblock->next = b;
2010 else
2011 oldest_sblock = b;
2012 current_sblock = b;
2013 }
2014 else
2015 b = current_sblock;
2016
2017 data = b->next_free;
2018 b->next_free = (struct sdata *) ((char *) data + needed + GC_STRING_EXTRA);
2019
2020#ifndef SYNC_INPUT
2021 UNBLOCK_INPUT;
2022#endif
2023
2024 data->string = s;
2025 s->data = SDATA_DATA (data);
2026#ifdef GC_CHECK_STRING_BYTES
2027 SDATA_NBYTES (data) = nbytes;
2028#endif
2029 s->size = nchars;
2030 s->size_byte = nbytes;
2031 s->data[nbytes] = '\0';
2032#ifdef GC_CHECK_STRING_OVERRUN
2033 bcopy (string_overrun_cookie, (char *) data + needed,
2034 GC_STRING_OVERRUN_COOKIE_SIZE);
2035#endif
2036
2037 /* If S had already data assigned, mark that as free by setting its
2038 string back-pointer to null, and recording the size of the data
2039 in it. */
2040 if (old_data)
2041 {
2042 SDATA_NBYTES (old_data) = old_nbytes;
2043 old_data->string = NULL;
2044 }
2045
2046 consing_since_gc += needed;
2047}
2048
2049
2050/* Sweep and compact strings. */
2051
2052static void
2053sweep_strings ()
2054{
2055 struct string_block *b, *next;
2056 struct string_block *live_blocks = NULL;
2057
2058 string_free_list = NULL;
2059 total_strings = total_free_strings = 0;
2060 total_string_size = 0;
2061
2062 /* Scan strings_blocks, free Lisp_Strings that aren't marked. */
2063 for (b = string_blocks; b; b = next)
2064 {
2065 int i, nfree = 0;
2066 struct Lisp_String *free_list_before = string_free_list;
2067
2068 next = b->next;
2069
2070 for (i = 0; i < STRING_BLOCK_SIZE; ++i)
2071 {
2072 struct Lisp_String *s = b->strings + i;
2073
2074 if (s->data)
2075 {
2076 /* String was not on free-list before. */
2077 if (STRING_MARKED_P (s))
2078 {
2079 /* String is live; unmark it and its intervals. */
2080 UNMARK_STRING (s);
2081
2082 if (!NULL_INTERVAL_P (s->intervals))
2083 UNMARK_BALANCE_INTERVALS (s->intervals);
2084
2085 ++total_strings;
2086 total_string_size += STRING_BYTES (s);
2087 }
2088 else
2089 {
2090 /* String is dead. Put it on the free-list. */
2091 struct sdata *data = SDATA_OF_STRING (s);
2092
2093 /* Save the size of S in its sdata so that we know
2094 how large that is. Reset the sdata's string
2095 back-pointer so that we know it's free. */
2096#ifdef GC_CHECK_STRING_BYTES
2097 if (GC_STRING_BYTES (s) != SDATA_NBYTES (data))
2098 abort ();
2099#else
2100 data->u.nbytes = GC_STRING_BYTES (s);
2101#endif
2102 data->string = NULL;
2103
2104 /* Reset the strings's `data' member so that we
2105 know it's free. */
2106 s->data = NULL;
2107
2108 /* Put the string on the free-list. */
2109 NEXT_FREE_LISP_STRING (s) = string_free_list;
2110 string_free_list = s;
2111 ++nfree;
2112 }
2113 }
2114 else
2115 {
2116 /* S was on the free-list before. Put it there again. */
2117 NEXT_FREE_LISP_STRING (s) = string_free_list;
2118 string_free_list = s;
2119 ++nfree;
2120 }
2121 }
2122
2123 /* Free blocks that contain free Lisp_Strings only, except
2124 the first two of them. */
2125 if (nfree == STRING_BLOCK_SIZE
2126 && total_free_strings > STRING_BLOCK_SIZE)
2127 {
2128 lisp_free (b);
2129 --n_string_blocks;
2130 string_free_list = free_list_before;
2131 }
2132 else
2133 {
2134 total_free_strings += nfree;
2135 b->next = live_blocks;
2136 live_blocks = b;
2137 }
2138 }
2139
2140 check_string_free_list ();
2141
2142 string_blocks = live_blocks;
2143 free_large_strings ();
2144 compact_small_strings ();
2145
2146 check_string_free_list ();
2147}
2148
2149
2150/* Free dead large strings. */
2151
2152static void
2153free_large_strings ()
2154{
2155 struct sblock *b, *next;
2156 struct sblock *live_blocks = NULL;
2157
2158 for (b = large_sblocks; b; b = next)
2159 {
2160 next = b->next;
2161
2162 if (b->first_data.string == NULL)
2163 lisp_free (b);
2164 else
2165 {
2166 b->next = live_blocks;
2167 live_blocks = b;
2168 }
2169 }
2170
2171 large_sblocks = live_blocks;
2172}
2173
2174
2175/* Compact data of small strings. Free sblocks that don't contain
2176 data of live strings after compaction. */
2177
2178static void
2179compact_small_strings ()
2180{
2181 struct sblock *b, *tb, *next;
2182 struct sdata *from, *to, *end, *tb_end;
2183 struct sdata *to_end, *from_end;
2184
2185 /* TB is the sblock we copy to, TO is the sdata within TB we copy
2186 to, and TB_END is the end of TB. */
2187 tb = oldest_sblock;
2188 tb_end = (struct sdata *) ((char *) tb + SBLOCK_SIZE);
2189 to = &tb->first_data;
2190
2191 /* Step through the blocks from the oldest to the youngest. We
2192 expect that old blocks will stabilize over time, so that less
2193 copying will happen this way. */
2194 for (b = oldest_sblock; b; b = b->next)
2195 {
2196 end = b->next_free;
2197 xassert ((char *) end <= (char *) b + SBLOCK_SIZE);
2198
2199 for (from = &b->first_data; from < end; from = from_end)
2200 {
2201 /* Compute the next FROM here because copying below may
2202 overwrite data we need to compute it. */
2203 int nbytes;
2204
2205#ifdef GC_CHECK_STRING_BYTES
2206 /* Check that the string size recorded in the string is the
2207 same as the one recorded in the sdata structure. */
2208 if (from->string
2209 && GC_STRING_BYTES (from->string) != SDATA_NBYTES (from))
2210 abort ();
2211#endif /* GC_CHECK_STRING_BYTES */
2212
2213 if (from->string)
2214 nbytes = GC_STRING_BYTES (from->string);
2215 else
2216 nbytes = SDATA_NBYTES (from);
2217
2218 if (nbytes > LARGE_STRING_BYTES)
2219 abort ();
2220
2221 nbytes = SDATA_SIZE (nbytes);
2222 from_end = (struct sdata *) ((char *) from + nbytes + GC_STRING_EXTRA);
2223
2224#ifdef GC_CHECK_STRING_OVERRUN
2225 if (bcmp (string_overrun_cookie,
2226 ((char *) from_end) - GC_STRING_OVERRUN_COOKIE_SIZE,
2227 GC_STRING_OVERRUN_COOKIE_SIZE))
2228 abort ();
2229#endif
2230
2231 /* FROM->string non-null means it's alive. Copy its data. */
2232 if (from->string)
2233 {
2234 /* If TB is full, proceed with the next sblock. */
2235 to_end = (struct sdata *) ((char *) to + nbytes + GC_STRING_EXTRA);
2236 if (to_end > tb_end)
2237 {
2238 tb->next_free = to;
2239 tb = tb->next;
2240 tb_end = (struct sdata *) ((char *) tb + SBLOCK_SIZE);
2241 to = &tb->first_data;
2242 to_end = (struct sdata *) ((char *) to + nbytes + GC_STRING_EXTRA);
2243 }
2244
2245 /* Copy, and update the string's `data' pointer. */
2246 if (from != to)
2247 {
2248 xassert (tb != b || to <= from);
2249 safe_bcopy ((char *) from, (char *) to, nbytes + GC_STRING_EXTRA);
2250 to->string->data = SDATA_DATA (to);
2251 }
2252
2253 /* Advance past the sdata we copied to. */
2254 to = to_end;
2255 }
2256 }
2257 }
2258
2259 /* The rest of the sblocks following TB don't contain live data, so
2260 we can free them. */
2261 for (b = tb->next; b; b = next)
2262 {
2263 next = b->next;
2264 lisp_free (b);
2265 }
2266
2267 tb->next_free = to;
2268 tb->next = NULL;
2269 current_sblock = tb;
2270}
2271
2272
2273DEFUN ("make-string", Fmake_string, Smake_string, 2, 2, 0,
2274 doc: /* Return a newly created string of length LENGTH, with INIT in each element.
2275LENGTH must be an integer.
2276INIT must be an integer that represents a character. */)
2277 (length, init)
2278 Lisp_Object length, init;
2279{
2280 register Lisp_Object val;
2281 register unsigned char *p, *end;
2282 int c, nbytes;
2283
2284 CHECK_NATNUM (length);
2285 CHECK_NUMBER (init);
2286
2287 c = XINT (init);
2288 if (SINGLE_BYTE_CHAR_P (c))
2289 {
2290 nbytes = XINT (length);
2291 val = make_uninit_string (nbytes);
2292 p = SDATA (val);
2293 end = p + SCHARS (val);
2294 while (p != end)
2295 *p++ = c;
2296 }
2297 else
2298 {
2299 unsigned char str[MAX_MULTIBYTE_LENGTH];
2300 int len = CHAR_STRING (c, str);
2301
2302 nbytes = len * XINT (length);
2303 val = make_uninit_multibyte_string (XINT (length), nbytes);
2304 p = SDATA (val);
2305 end = p + nbytes;
2306 while (p != end)
2307 {
2308 bcopy (str, p, len);
2309 p += len;
2310 }
2311 }
2312
2313 *p = 0;
2314 return val;
2315}
2316
2317
2318DEFUN ("make-bool-vector", Fmake_bool_vector, Smake_bool_vector, 2, 2, 0,
2319 doc: /* Return a new bool-vector of length LENGTH, using INIT for each element.
2320LENGTH must be a number. INIT matters only in whether it is t or nil. */)
2321 (length, init)
2322 Lisp_Object length, init;
2323{
2324 register Lisp_Object val;
2325 struct Lisp_Bool_Vector *p;
2326 int real_init, i;
2327 int length_in_chars, length_in_elts, bits_per_value;
2328
2329 CHECK_NATNUM (length);
2330
2331 bits_per_value = sizeof (EMACS_INT) * BOOL_VECTOR_BITS_PER_CHAR;
2332
2333 length_in_elts = (XFASTINT (length) + bits_per_value - 1) / bits_per_value;
2334 length_in_chars = ((XFASTINT (length) + BOOL_VECTOR_BITS_PER_CHAR - 1)
2335 / BOOL_VECTOR_BITS_PER_CHAR);
2336
2337 /* We must allocate one more elements than LENGTH_IN_ELTS for the
2338 slot `size' of the struct Lisp_Bool_Vector. */
2339 val = Fmake_vector (make_number (length_in_elts + 1), Qnil);
2340 p = XBOOL_VECTOR (val);
2341
2342 /* Get rid of any bits that would cause confusion. */
2343 p->vector_size = 0;
2344 XSETBOOL_VECTOR (val, p);
2345 p->size = XFASTINT (length);
2346
2347 real_init = (NILP (init) ? 0 : -1);
2348 for (i = 0; i < length_in_chars ; i++)
2349 p->data[i] = real_init;
2350
2351 /* Clear the extraneous bits in the last byte. */
2352 if (XINT (length) != length_in_chars * BOOL_VECTOR_BITS_PER_CHAR)
2353 XBOOL_VECTOR (val)->data[length_in_chars - 1]
2354 &= (1 << (XINT (length) % BOOL_VECTOR_BITS_PER_CHAR)) - 1;
2355
2356 return val;
2357}
2358
2359
2360/* Make a string from NBYTES bytes at CONTENTS, and compute the number
2361 of characters from the contents. This string may be unibyte or
2362 multibyte, depending on the contents. */
2363
2364Lisp_Object
2365make_string (contents, nbytes)
2366 const char *contents;
2367 int nbytes;
2368{
2369 register Lisp_Object val;
2370 int nchars, multibyte_nbytes;
2371
2372 parse_str_as_multibyte (contents, nbytes, &nchars, &multibyte_nbytes);
2373 if (nbytes == nchars || nbytes != multibyte_nbytes)
2374 /* CONTENTS contains no multibyte sequences or contains an invalid
2375 multibyte sequence. We must make unibyte string. */
2376 val = make_unibyte_string (contents, nbytes);
2377 else
2378 val = make_multibyte_string (contents, nchars, nbytes);
2379 return val;
2380}
2381
2382
2383/* Make an unibyte string from LENGTH bytes at CONTENTS. */
2384
2385Lisp_Object
2386make_unibyte_string (contents, length)
2387 const char *contents;
2388 int length;
2389{
2390 register Lisp_Object val;
2391 val = make_uninit_string (length);
2392 bcopy (contents, SDATA (val), length);
2393 STRING_SET_UNIBYTE (val);
2394 return val;
2395}
2396
2397
2398/* Make a multibyte string from NCHARS characters occupying NBYTES
2399 bytes at CONTENTS. */
2400
2401Lisp_Object
2402make_multibyte_string (contents, nchars, nbytes)
2403 const char *contents;
2404 int nchars, nbytes;
2405{
2406 register Lisp_Object val;
2407 val = make_uninit_multibyte_string (nchars, nbytes);
2408 bcopy (contents, SDATA (val), nbytes);
2409 return val;
2410}
2411
2412
2413/* Make a string from NCHARS characters occupying NBYTES bytes at
2414 CONTENTS. It is a multibyte string if NBYTES != NCHARS. */
2415
2416Lisp_Object
2417make_string_from_bytes (contents, nchars, nbytes)
2418 const char *contents;
2419 int nchars, nbytes;
2420{
2421 register Lisp_Object val;
2422 val = make_uninit_multibyte_string (nchars, nbytes);
2423 bcopy (contents, SDATA (val), nbytes);
2424 if (SBYTES (val) == SCHARS (val))
2425 STRING_SET_UNIBYTE (val);
2426 return val;
2427}
2428
2429
2430/* Make a string from NCHARS characters occupying NBYTES bytes at
2431 CONTENTS. The argument MULTIBYTE controls whether to label the
2432 string as multibyte. If NCHARS is negative, it counts the number of
2433 characters by itself. */
2434
2435Lisp_Object
2436make_specified_string (contents, nchars, nbytes, multibyte)
2437 const char *contents;
2438 int nchars, nbytes;
2439 int multibyte;
2440{
2441 register Lisp_Object val;
2442
2443 if (nchars < 0)
2444 {
2445 if (multibyte)
2446 nchars = multibyte_chars_in_text (contents, nbytes);
2447 else
2448 nchars = nbytes;
2449 }
2450 val = make_uninit_multibyte_string (nchars, nbytes);
2451 bcopy (contents, SDATA (val), nbytes);
2452 if (!multibyte)
2453 STRING_SET_UNIBYTE (val);
2454 return val;
2455}
2456
2457
2458/* Make a string from the data at STR, treating it as multibyte if the
2459 data warrants. */
2460
2461Lisp_Object
2462build_string (str)
2463 const char *str;
2464{
2465 return make_string (str, strlen (str));
2466}
2467
2468
2469/* Return an unibyte Lisp_String set up to hold LENGTH characters
2470 occupying LENGTH bytes. */
2471
2472Lisp_Object
2473make_uninit_string (length)
2474 int length;
2475{
2476 Lisp_Object val;
2477 val = make_uninit_multibyte_string (length, length);
2478 STRING_SET_UNIBYTE (val);
2479 return val;
2480}
2481
2482
2483/* Return a multibyte Lisp_String set up to hold NCHARS characters
2484 which occupy NBYTES bytes. */
2485
2486Lisp_Object
2487make_uninit_multibyte_string (nchars, nbytes)
2488 int nchars, nbytes;
2489{
2490 Lisp_Object string;
2491 struct Lisp_String *s;
2492
2493 if (nchars < 0)
2494 abort ();
2495
2496 s = allocate_string ();
2497 allocate_string_data (s, nchars, nbytes);
2498 XSETSTRING (string, s);
2499 string_chars_consed += nbytes;
2500 return string;
2501}
2502
2503
2504\f
2505/***********************************************************************
2506 Float Allocation
2507 ***********************************************************************/
2508
2509/* We store float cells inside of float_blocks, allocating a new
2510 float_block with malloc whenever necessary. Float cells reclaimed
2511 by GC are put on a free list to be reallocated before allocating
2512 any new float cells from the latest float_block. */
2513
2514#define FLOAT_BLOCK_SIZE \
2515 (((BLOCK_BYTES - sizeof (struct float_block *) \
2516 /* The compiler might add padding at the end. */ \
2517 - (sizeof (struct Lisp_Float) - sizeof (int))) * CHAR_BIT) \
2518 / (sizeof (struct Lisp_Float) * CHAR_BIT + 1))
2519
2520#define GETMARKBIT(block,n) \
2521 (((block)->gcmarkbits[(n) / (sizeof(int) * CHAR_BIT)] \
2522 >> ((n) % (sizeof(int) * CHAR_BIT))) \
2523 & 1)
2524
2525#define SETMARKBIT(block,n) \
2526 (block)->gcmarkbits[(n) / (sizeof(int) * CHAR_BIT)] \
2527 |= 1 << ((n) % (sizeof(int) * CHAR_BIT))
2528
2529#define UNSETMARKBIT(block,n) \
2530 (block)->gcmarkbits[(n) / (sizeof(int) * CHAR_BIT)] \
2531 &= ~(1 << ((n) % (sizeof(int) * CHAR_BIT)))
2532
2533#define FLOAT_BLOCK(fptr) \
2534 ((struct float_block *)(((EMACS_UINT)(fptr)) & ~(BLOCK_ALIGN - 1)))
2535
2536#define FLOAT_INDEX(fptr) \
2537 ((((EMACS_UINT)(fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Float))
2538
2539struct float_block
2540{
2541 /* Place `floats' at the beginning, to ease up FLOAT_INDEX's job. */
2542 struct Lisp_Float floats[FLOAT_BLOCK_SIZE];
2543 int gcmarkbits[1 + FLOAT_BLOCK_SIZE / (sizeof(int) * CHAR_BIT)];
2544 struct float_block *next;
2545};
2546
2547#define FLOAT_MARKED_P(fptr) \
2548 GETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2549
2550#define FLOAT_MARK(fptr) \
2551 SETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2552
2553#define FLOAT_UNMARK(fptr) \
2554 UNSETMARKBIT (FLOAT_BLOCK (fptr), FLOAT_INDEX ((fptr)))
2555
2556/* Current float_block. */
2557
2558struct float_block *float_block;
2559
2560/* Index of first unused Lisp_Float in the current float_block. */
2561
2562int float_block_index;
2563
2564/* Total number of float blocks now in use. */
2565
2566int n_float_blocks;
2567
2568/* Free-list of Lisp_Floats. */
2569
2570struct Lisp_Float *float_free_list;
2571
2572
2573/* Initialize float allocation. */
2574
2575void
2576init_float ()
2577{
2578 float_block = NULL;
2579 float_block_index = FLOAT_BLOCK_SIZE; /* Force alloc of new float_block. */
2580 float_free_list = 0;
2581 n_float_blocks = 0;
2582}
2583
2584
2585/* Explicitly free a float cell by putting it on the free-list. */
2586
2587void
2588free_float (ptr)
2589 struct Lisp_Float *ptr;
2590{
2591 ptr->u.chain = float_free_list;
2592 float_free_list = ptr;
2593}
2594
2595
2596/* Return a new float object with value FLOAT_VALUE. */
2597
2598Lisp_Object
2599make_float (float_value)
2600 double float_value;
2601{
2602 register Lisp_Object val;
2603
2604 /* eassert (!handling_signal); */
2605
2606#ifndef SYNC_INPUT
2607 BLOCK_INPUT;
2608#endif
2609
2610 if (float_free_list)
2611 {
2612 /* We use the data field for chaining the free list
2613 so that we won't use the same field that has the mark bit. */
2614 XSETFLOAT (val, float_free_list);
2615 float_free_list = float_free_list->u.chain;
2616 }
2617 else
2618 {
2619 if (float_block_index == FLOAT_BLOCK_SIZE)
2620 {
2621 register struct float_block *new;
2622
2623 new = (struct float_block *) lisp_align_malloc (sizeof *new,
2624 MEM_TYPE_FLOAT);
2625 new->next = float_block;
2626 bzero ((char *) new->gcmarkbits, sizeof new->gcmarkbits);
2627 float_block = new;
2628 float_block_index = 0;
2629 n_float_blocks++;
2630 }
2631 XSETFLOAT (val, &float_block->floats[float_block_index]);
2632 float_block_index++;
2633 }
2634
2635#ifndef SYNC_INPUT
2636 UNBLOCK_INPUT;
2637#endif
2638
2639 XFLOAT_DATA (val) = float_value;
2640 eassert (!FLOAT_MARKED_P (XFLOAT (val)));
2641 consing_since_gc += sizeof (struct Lisp_Float);
2642 floats_consed++;
2643 return val;
2644}
2645
2646
2647\f
2648/***********************************************************************
2649 Cons Allocation
2650 ***********************************************************************/
2651
2652/* We store cons cells inside of cons_blocks, allocating a new
2653 cons_block with malloc whenever necessary. Cons cells reclaimed by
2654 GC are put on a free list to be reallocated before allocating
2655 any new cons cells from the latest cons_block. */
2656
2657#define CONS_BLOCK_SIZE \
2658 (((BLOCK_BYTES - sizeof (struct cons_block *)) * CHAR_BIT) \
2659 / (sizeof (struct Lisp_Cons) * CHAR_BIT + 1))
2660
2661#define CONS_BLOCK(fptr) \
2662 ((struct cons_block *)(((EMACS_UINT)(fptr)) & ~(BLOCK_ALIGN - 1)))
2663
2664#define CONS_INDEX(fptr) \
2665 ((((EMACS_UINT)(fptr)) & (BLOCK_ALIGN - 1)) / sizeof (struct Lisp_Cons))
2666
2667struct cons_block
2668{
2669 /* Place `conses' at the beginning, to ease up CONS_INDEX's job. */
2670 struct Lisp_Cons conses[CONS_BLOCK_SIZE];
2671 int gcmarkbits[1 + CONS_BLOCK_SIZE / (sizeof(int) * CHAR_BIT)];
2672 struct cons_block *next;
2673};
2674
2675#define CONS_MARKED_P(fptr) \
2676 GETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2677
2678#define CONS_MARK(fptr) \
2679 SETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2680
2681#define CONS_UNMARK(fptr) \
2682 UNSETMARKBIT (CONS_BLOCK (fptr), CONS_INDEX ((fptr)))
2683
2684/* Current cons_block. */
2685
2686struct cons_block *cons_block;
2687
2688/* Index of first unused Lisp_Cons in the current block. */
2689
2690int cons_block_index;
2691
2692/* Free-list of Lisp_Cons structures. */
2693
2694struct Lisp_Cons *cons_free_list;
2695
2696/* Total number of cons blocks now in use. */
2697
2698int n_cons_blocks;
2699
2700
2701/* Initialize cons allocation. */
2702
2703void
2704init_cons ()
2705{
2706 cons_block = NULL;
2707 cons_block_index = CONS_BLOCK_SIZE; /* Force alloc of new cons_block. */
2708 cons_free_list = 0;
2709 n_cons_blocks = 0;
2710}
2711
2712
2713/* Explicitly free a cons cell by putting it on the free-list. */
2714
2715void
2716free_cons (ptr)
2717 struct Lisp_Cons *ptr;
2718{
2719 ptr->u.chain = cons_free_list;
2720#if GC_MARK_STACK
2721 ptr->car = Vdead;
2722#endif
2723 cons_free_list = ptr;
2724}
2725
2726DEFUN ("cons", Fcons, Scons, 2, 2, 0,
2727 doc: /* Create a new cons, give it CAR and CDR as components, and return it. */)
2728 (car, cdr)
2729 Lisp_Object car, cdr;
2730{
2731 register Lisp_Object val;
2732
2733 /* eassert (!handling_signal); */
2734
2735#ifndef SYNC_INPUT
2736 BLOCK_INPUT;
2737#endif
2738
2739 if (cons_free_list)
2740 {
2741 /* We use the cdr for chaining the free list
2742 so that we won't use the same field that has the mark bit. */
2743 XSETCONS (val, cons_free_list);
2744 cons_free_list = cons_free_list->u.chain;
2745 }
2746 else
2747 {
2748 if (cons_block_index == CONS_BLOCK_SIZE)
2749 {
2750 register struct cons_block *new;
2751 new = (struct cons_block *) lisp_align_malloc (sizeof *new,
2752 MEM_TYPE_CONS);
2753 bzero ((char *) new->gcmarkbits, sizeof new->gcmarkbits);
2754 new->next = cons_block;
2755 cons_block = new;
2756 cons_block_index = 0;
2757 n_cons_blocks++;
2758 }
2759 XSETCONS (val, &cons_block->conses[cons_block_index]);
2760 cons_block_index++;
2761 }
2762
2763#ifndef SYNC_INPUT
2764 UNBLOCK_INPUT;
2765#endif
2766
2767 XSETCAR (val, car);
2768 XSETCDR (val, cdr);
2769 eassert (!CONS_MARKED_P (XCONS (val)));
2770 consing_since_gc += sizeof (struct Lisp_Cons);
2771 cons_cells_consed++;
2772 return val;
2773}
2774
2775/* Get an error now if there's any junk in the cons free list. */
2776void
2777check_cons_list ()
2778{
2779#ifdef GC_CHECK_CONS_LIST
2780 struct Lisp_Cons *tail = cons_free_list;
2781
2782 while (tail)
2783 tail = tail->u.chain;
2784#endif
2785}
2786
2787/* Make a list of 1, 2, 3, 4 or 5 specified objects. */
2788
2789Lisp_Object
2790list1 (arg1)
2791 Lisp_Object arg1;
2792{
2793 return Fcons (arg1, Qnil);
2794}
2795
2796Lisp_Object
2797list2 (arg1, arg2)
2798 Lisp_Object arg1, arg2;
2799{
2800 return Fcons (arg1, Fcons (arg2, Qnil));
2801}
2802
2803
2804Lisp_Object
2805list3 (arg1, arg2, arg3)
2806 Lisp_Object arg1, arg2, arg3;
2807{
2808 return Fcons (arg1, Fcons (arg2, Fcons (arg3, Qnil)));
2809}
2810
2811
2812Lisp_Object
2813list4 (arg1, arg2, arg3, arg4)
2814 Lisp_Object arg1, arg2, arg3, arg4;
2815{
2816 return Fcons (arg1, Fcons (arg2, Fcons (arg3, Fcons (arg4, Qnil))));
2817}
2818
2819
2820Lisp_Object
2821list5 (arg1, arg2, arg3, arg4, arg5)
2822 Lisp_Object arg1, arg2, arg3, arg4, arg5;
2823{
2824 return Fcons (arg1, Fcons (arg2, Fcons (arg3, Fcons (arg4,
2825 Fcons (arg5, Qnil)))));
2826}
2827
2828
2829DEFUN ("list", Flist, Slist, 0, MANY, 0,
2830 doc: /* Return a newly created list with specified arguments as elements.
2831Any number of arguments, even zero arguments, are allowed.
2832usage: (list &rest OBJECTS) */)
2833 (nargs, args)
2834 int nargs;
2835 register Lisp_Object *args;
2836{
2837 register Lisp_Object val;
2838 val = Qnil;
2839
2840 while (nargs > 0)
2841 {
2842 nargs--;
2843 val = Fcons (args[nargs], val);
2844 }
2845 return val;
2846}
2847
2848
2849DEFUN ("make-list", Fmake_list, Smake_list, 2, 2, 0,
2850 doc: /* Return a newly created list of length LENGTH, with each element being INIT. */)
2851 (length, init)
2852 register Lisp_Object length, init;
2853{
2854 register Lisp_Object val;
2855 register int size;
2856
2857 CHECK_NATNUM (length);
2858 size = XFASTINT (length);
2859
2860 val = Qnil;
2861 while (size > 0)
2862 {
2863 val = Fcons (init, val);
2864 --size;
2865
2866 if (size > 0)
2867 {
2868 val = Fcons (init, val);
2869 --size;
2870
2871 if (size > 0)
2872 {
2873 val = Fcons (init, val);
2874 --size;
2875
2876 if (size > 0)
2877 {
2878 val = Fcons (init, val);
2879 --size;
2880
2881 if (size > 0)
2882 {
2883 val = Fcons (init, val);
2884 --size;
2885 }
2886 }
2887 }
2888 }
2889
2890 QUIT;
2891 }
2892
2893 return val;
2894}
2895
2896
2897\f
2898/***********************************************************************
2899 Vector Allocation
2900 ***********************************************************************/
2901
2902/* Singly-linked list of all vectors. */
2903
2904struct Lisp_Vector *all_vectors;
2905
2906/* Total number of vector-like objects now in use. */
2907
2908int n_vectors;
2909
2910
2911/* Value is a pointer to a newly allocated Lisp_Vector structure
2912 with room for LEN Lisp_Objects. */
2913
2914static struct Lisp_Vector *
2915allocate_vectorlike (len, type)
2916 EMACS_INT len;
2917 enum mem_type type;
2918{
2919 struct Lisp_Vector *p;
2920 size_t nbytes;
2921
2922#ifdef DOUG_LEA_MALLOC
2923 /* Prevent mmap'ing the chunk. Lisp data may not be mmap'ed
2924 because mapped region contents are not preserved in
2925 a dumped Emacs. */
2926 BLOCK_INPUT;
2927 mallopt (M_MMAP_MAX, 0);
2928 UNBLOCK_INPUT;
2929#endif
2930
2931 /* This gets triggered by code which I haven't bothered to fix. --Stef */
2932 /* eassert (!handling_signal); */
2933
2934 nbytes = sizeof *p + (len - 1) * sizeof p->contents[0];
2935 p = (struct Lisp_Vector *) lisp_malloc (nbytes, type);
2936
2937#ifdef DOUG_LEA_MALLOC
2938 /* Back to a reasonable maximum of mmap'ed areas. */
2939 BLOCK_INPUT;
2940 mallopt (M_MMAP_MAX, MMAP_MAX_AREAS);
2941 UNBLOCK_INPUT;
2942#endif
2943
2944 consing_since_gc += nbytes;
2945 vector_cells_consed += len;
2946
2947#ifndef SYNC_INPUT
2948 BLOCK_INPUT;
2949#endif
2950
2951 p->next = all_vectors;
2952 all_vectors = p;
2953
2954#ifndef SYNC_INPUT
2955 UNBLOCK_INPUT;
2956#endif
2957
2958 ++n_vectors;
2959 return p;
2960}
2961
2962
2963/* Allocate a vector with NSLOTS slots. */
2964
2965struct Lisp_Vector *
2966allocate_vector (nslots)
2967 EMACS_INT nslots;
2968{
2969 struct Lisp_Vector *v = allocate_vectorlike (nslots, MEM_TYPE_VECTOR);
2970 v->size = nslots;
2971 return v;
2972}
2973
2974
2975/* Allocate other vector-like structures. */
2976
2977struct Lisp_Hash_Table *
2978allocate_hash_table ()
2979{
2980 EMACS_INT len = VECSIZE (struct Lisp_Hash_Table);
2981 struct Lisp_Vector *v = allocate_vectorlike (len, MEM_TYPE_HASH_TABLE);
2982 EMACS_INT i;
2983
2984 v->size = len;
2985 for (i = 0; i < len; ++i)
2986 v->contents[i] = Qnil;
2987
2988 return (struct Lisp_Hash_Table *) v;
2989}
2990
2991
2992struct window *
2993allocate_window ()
2994{
2995 EMACS_INT len = VECSIZE (struct window);
2996 struct Lisp_Vector *v = allocate_vectorlike (len, MEM_TYPE_WINDOW);
2997 EMACS_INT i;
2998
2999 for (i = 0; i < len; ++i)
3000 v->contents[i] = Qnil;
3001 v->size = len;
3002
3003 return (struct window *) v;
3004}
3005
3006
3007struct frame *
3008allocate_frame ()
3009{
3010 EMACS_INT len = VECSIZE (struct frame);
3011 struct Lisp_Vector *v = allocate_vectorlike (len, MEM_TYPE_FRAME);
3012 EMACS_INT i;
3013
3014 for (i = 0; i < len; ++i)
3015 v->contents[i] = make_number (0);
3016 v->size = len;
3017 return (struct frame *) v;
3018}
3019
3020
3021struct Lisp_Process *
3022allocate_process ()
3023{
3024 /* Memory-footprint of the object in nb of Lisp_Object fields. */
3025 EMACS_INT memlen = VECSIZE (struct Lisp_Process);
3026 /* Size if we only count the actual Lisp_Object fields (which need to be
3027 traced by the GC). */
3028 EMACS_INT lisplen = PSEUDOVECSIZE (struct Lisp_Process, pid);
3029 struct Lisp_Vector *v = allocate_vectorlike (memlen, MEM_TYPE_PROCESS);
3030 EMACS_INT i;
3031
3032 for (i = 0; i < lisplen; ++i)
3033 v->contents[i] = Qnil;
3034 v->size = lisplen;
3035
3036 return (struct Lisp_Process *) v;
3037}
3038
3039
3040struct Lisp_Vector *
3041allocate_other_vector (len)
3042 EMACS_INT len;
3043{
3044 struct Lisp_Vector *v = allocate_vectorlike (len, MEM_TYPE_VECTOR);
3045 EMACS_INT i;
3046
3047 for (i = 0; i < len; ++i)
3048 v->contents[i] = Qnil;
3049 v->size = len;
3050
3051 return v;
3052}
3053
3054
3055DEFUN ("make-vector", Fmake_vector, Smake_vector, 2, 2, 0,
3056 doc: /* Return a newly created vector of length LENGTH, with each element being INIT.
3057See also the function `vector'. */)
3058 (length, init)
3059 register Lisp_Object length, init;
3060{
3061 Lisp_Object vector;
3062 register EMACS_INT sizei;
3063 register int index;
3064 register struct Lisp_Vector *p;
3065
3066 CHECK_NATNUM (length);
3067 sizei = XFASTINT (length);
3068
3069 p = allocate_vector (sizei);
3070 for (index = 0; index < sizei; index++)
3071 p->contents[index] = init;
3072
3073 XSETVECTOR (vector, p);
3074 return vector;
3075}
3076
3077
3078DEFUN ("make-char-table", Fmake_char_table, Smake_char_table, 1, 2, 0,
3079 doc: /* Return a newly created char-table, with purpose PURPOSE.
3080Each element is initialized to INIT, which defaults to nil.
3081PURPOSE should be a symbol which has a `char-table-extra-slots' property.
3082The property's value should be an integer between 0 and 10. */)
3083 (purpose, init)
3084 register Lisp_Object purpose, init;
3085{
3086 Lisp_Object vector;
3087 Lisp_Object n;
3088 CHECK_SYMBOL (purpose);
3089 n = Fget (purpose, Qchar_table_extra_slots);
3090 CHECK_NUMBER (n);
3091 if (XINT (n) < 0 || XINT (n) > 10)
3092 args_out_of_range (n, Qnil);
3093 /* Add 2 to the size for the defalt and parent slots. */
3094 vector = Fmake_vector (make_number (CHAR_TABLE_STANDARD_SLOTS + XINT (n)),
3095 init);
3096 XCHAR_TABLE (vector)->top = Qt;
3097 XCHAR_TABLE (vector)->parent = Qnil;
3098 XCHAR_TABLE (vector)->purpose = purpose;
3099 XSETCHAR_TABLE (vector, XCHAR_TABLE (vector));
3100 return vector;
3101}
3102
3103
3104/* Return a newly created sub char table with slots initialized by INIT.
3105 Since a sub char table does not appear as a top level Emacs Lisp
3106 object, we don't need a Lisp interface to make it. */
3107
3108Lisp_Object
3109make_sub_char_table (init)
3110 Lisp_Object init;
3111{
3112 Lisp_Object vector
3113 = Fmake_vector (make_number (SUB_CHAR_TABLE_STANDARD_SLOTS), init);
3114 XCHAR_TABLE (vector)->top = Qnil;
3115 XCHAR_TABLE (vector)->defalt = Qnil;
3116 XSETCHAR_TABLE (vector, XCHAR_TABLE (vector));
3117 return vector;
3118}
3119
3120
3121DEFUN ("vector", Fvector, Svector, 0, MANY, 0,
3122 doc: /* Return a newly created vector with specified arguments as elements.
3123Any number of arguments, even zero arguments, are allowed.
3124usage: (vector &rest OBJECTS) */)
3125 (nargs, args)
3126 register int nargs;
3127 Lisp_Object *args;
3128{
3129 register Lisp_Object len, val;
3130 register int index;
3131 register struct Lisp_Vector *p;
3132
3133 XSETFASTINT (len, nargs);
3134 val = Fmake_vector (len, Qnil);
3135 p = XVECTOR (val);
3136 for (index = 0; index < nargs; index++)
3137 p->contents[index] = args[index];
3138 return val;
3139}
3140
3141
3142DEFUN ("make-byte-code", Fmake_byte_code, Smake_byte_code, 4, MANY, 0,
3143 doc: /* Create a byte-code object with specified arguments as elements.
3144The arguments should be the arglist, bytecode-string, constant vector,
3145stack size, (optional) doc string, and (optional) interactive spec.
3146The first four arguments are required; at most six have any
3147significance.
3148usage: (make-byte-code ARGLIST BYTE-CODE CONSTANTS DEPTH &optional DOCSTRING INTERACTIVE-SPEC &rest ELEMENTS) */)
3149 (nargs, args)
3150 register int nargs;
3151 Lisp_Object *args;
3152{
3153 register Lisp_Object len, val;
3154 register int index;
3155 register struct Lisp_Vector *p;
3156
3157 XSETFASTINT (len, nargs);
3158 if (!NILP (Vpurify_flag))
3159 val = make_pure_vector ((EMACS_INT) nargs);
3160 else
3161 val = Fmake_vector (len, Qnil);
3162
3163 if (STRINGP (args[1]) && STRING_MULTIBYTE (args[1]))
3164 /* BYTECODE-STRING must have been produced by Emacs 20.2 or the
3165 earlier because they produced a raw 8-bit string for byte-code
3166 and now such a byte-code string is loaded as multibyte while
3167 raw 8-bit characters converted to multibyte form. Thus, now we
3168 must convert them back to the original unibyte form. */
3169 args[1] = Fstring_as_unibyte (args[1]);
3170
3171 p = XVECTOR (val);
3172 for (index = 0; index < nargs; index++)
3173 {
3174 if (!NILP (Vpurify_flag))
3175 args[index] = Fpurecopy (args[index]);
3176 p->contents[index] = args[index];
3177 }
3178 XSETCOMPILED (val, p);
3179 return val;
3180}
3181
3182
3183\f
3184/***********************************************************************
3185 Symbol Allocation
3186 ***********************************************************************/
3187
3188/* Each symbol_block is just under 1020 bytes long, since malloc
3189 really allocates in units of powers of two and uses 4 bytes for its
3190 own overhead. */
3191
3192#define SYMBOL_BLOCK_SIZE \
3193 ((1020 - sizeof (struct symbol_block *)) / sizeof (struct Lisp_Symbol))
3194
3195struct symbol_block
3196{
3197 /* Place `symbols' first, to preserve alignment. */
3198 struct Lisp_Symbol symbols[SYMBOL_BLOCK_SIZE];
3199 struct symbol_block *next;
3200};
3201
3202/* Current symbol block and index of first unused Lisp_Symbol
3203 structure in it. */
3204
3205struct symbol_block *symbol_block;
3206int symbol_block_index;
3207
3208/* List of free symbols. */
3209
3210struct Lisp_Symbol *symbol_free_list;
3211
3212/* Total number of symbol blocks now in use. */
3213
3214int n_symbol_blocks;
3215
3216
3217/* Initialize symbol allocation. */
3218
3219void
3220init_symbol ()
3221{
3222 symbol_block = NULL;
3223 symbol_block_index = SYMBOL_BLOCK_SIZE;
3224 symbol_free_list = 0;
3225 n_symbol_blocks = 0;
3226}
3227
3228
3229DEFUN ("make-symbol", Fmake_symbol, Smake_symbol, 1, 1, 0,
3230 doc: /* Return a newly allocated uninterned symbol whose name is NAME.
3231Its value and function definition are void, and its property list is nil. */)
3232 (name)
3233 Lisp_Object name;
3234{
3235 register Lisp_Object val;
3236 register struct Lisp_Symbol *p;
3237
3238 CHECK_STRING (name);
3239
3240 /* eassert (!handling_signal); */
3241
3242#ifndef SYNC_INPUT
3243 BLOCK_INPUT;
3244#endif
3245
3246 if (symbol_free_list)
3247 {
3248 XSETSYMBOL (val, symbol_free_list);
3249 symbol_free_list = symbol_free_list->next;
3250 }
3251 else
3252 {
3253 if (symbol_block_index == SYMBOL_BLOCK_SIZE)
3254 {
3255 struct symbol_block *new;
3256 new = (struct symbol_block *) lisp_malloc (sizeof *new,
3257 MEM_TYPE_SYMBOL);
3258 new->next = symbol_block;
3259 symbol_block = new;
3260 symbol_block_index = 0;
3261 n_symbol_blocks++;
3262 }
3263 XSETSYMBOL (val, &symbol_block->symbols[symbol_block_index]);
3264 symbol_block_index++;
3265 }
3266
3267#ifndef SYNC_INPUT
3268 UNBLOCK_INPUT;
3269#endif
3270
3271 p = XSYMBOL (val);
3272 p->xname = name;
3273 p->plist = Qnil;
3274 p->value = Qunbound;
3275 p->function = Qunbound;
3276 p->next = NULL;
3277 p->gcmarkbit = 0;
3278 p->interned = SYMBOL_UNINTERNED;
3279 p->constant = 0;
3280 p->indirect_variable = 0;
3281 consing_since_gc += sizeof (struct Lisp_Symbol);
3282 symbols_consed++;
3283 return val;
3284}
3285
3286
3287\f
3288/***********************************************************************
3289 Marker (Misc) Allocation
3290 ***********************************************************************/
3291
3292/* Allocation of markers and other objects that share that structure.
3293 Works like allocation of conses. */
3294
3295#define MARKER_BLOCK_SIZE \
3296 ((1020 - sizeof (struct marker_block *)) / sizeof (union Lisp_Misc))
3297
3298struct marker_block
3299{
3300 /* Place `markers' first, to preserve alignment. */
3301 union Lisp_Misc markers[MARKER_BLOCK_SIZE];
3302 struct marker_block *next;
3303};
3304
3305struct marker_block *marker_block;
3306int marker_block_index;
3307
3308union Lisp_Misc *marker_free_list;
3309
3310/* Total number of marker blocks now in use. */
3311
3312int n_marker_blocks;
3313
3314void
3315init_marker ()
3316{
3317 marker_block = NULL;
3318 marker_block_index = MARKER_BLOCK_SIZE;
3319 marker_free_list = 0;
3320 n_marker_blocks = 0;
3321}
3322
3323/* Return a newly allocated Lisp_Misc object, with no substructure. */
3324
3325Lisp_Object
3326allocate_misc ()
3327{
3328 Lisp_Object val;
3329
3330 /* eassert (!handling_signal); */
3331
3332#ifndef SYNC_INPUT
3333 BLOCK_INPUT;
3334#endif
3335
3336 if (marker_free_list)
3337 {
3338 XSETMISC (val, marker_free_list);
3339 marker_free_list = marker_free_list->u_free.chain;
3340 }
3341 else
3342 {
3343 if (marker_block_index == MARKER_BLOCK_SIZE)
3344 {
3345 struct marker_block *new;
3346 new = (struct marker_block *) lisp_malloc (sizeof *new,
3347 MEM_TYPE_MISC);
3348 new->next = marker_block;
3349 marker_block = new;
3350 marker_block_index = 0;
3351 n_marker_blocks++;
3352 total_free_markers += MARKER_BLOCK_SIZE;
3353 }
3354 XSETMISC (val, &marker_block->markers[marker_block_index]);
3355 marker_block_index++;
3356 }
3357
3358#ifndef SYNC_INPUT
3359 UNBLOCK_INPUT;
3360#endif
3361
3362 --total_free_markers;
3363 consing_since_gc += sizeof (union Lisp_Misc);
3364 misc_objects_consed++;
3365 XMARKER (val)->gcmarkbit = 0;
3366 return val;
3367}
3368
3369/* Free a Lisp_Misc object */
3370
3371void
3372free_misc (misc)
3373 Lisp_Object misc;
3374{
3375 XMISC (misc)->u_marker.type = Lisp_Misc_Free;
3376 XMISC (misc)->u_free.chain = marker_free_list;
3377 marker_free_list = XMISC (misc);
3378
3379 total_free_markers++;
3380}
3381
3382/* Return a Lisp_Misc_Save_Value object containing POINTER and
3383 INTEGER. This is used to package C values to call record_unwind_protect.
3384 The unwind function can get the C values back using XSAVE_VALUE. */
3385
3386Lisp_Object
3387make_save_value (pointer, integer)
3388 void *pointer;
3389 int integer;
3390{
3391 register Lisp_Object val;
3392 register struct Lisp_Save_Value *p;
3393
3394 val = allocate_misc ();
3395 XMISCTYPE (val) = Lisp_Misc_Save_Value;
3396 p = XSAVE_VALUE (val);
3397 p->pointer = pointer;
3398 p->integer = integer;
3399 p->dogc = 0;
3400 return val;
3401}
3402
3403DEFUN ("make-marker", Fmake_marker, Smake_marker, 0, 0, 0,
3404 doc: /* Return a newly allocated marker which does not point at any place. */)
3405 ()
3406{
3407 register Lisp_Object val;
3408 register struct Lisp_Marker *p;
3409
3410 val = allocate_misc ();
3411 XMISCTYPE (val) = Lisp_Misc_Marker;
3412 p = XMARKER (val);
3413 p->buffer = 0;
3414 p->bytepos = 0;
3415 p->charpos = 0;
3416 p->next = NULL;
3417 p->insertion_type = 0;
3418 return val;
3419}
3420
3421/* Put MARKER back on the free list after using it temporarily. */
3422
3423void
3424free_marker (marker)
3425 Lisp_Object marker;
3426{
3427 unchain_marker (XMARKER (marker));
3428 free_misc (marker);
3429}
3430
3431\f
3432/* Return a newly created vector or string with specified arguments as
3433 elements. If all the arguments are characters that can fit
3434 in a string of events, make a string; otherwise, make a vector.
3435
3436 Any number of arguments, even zero arguments, are allowed. */
3437
3438Lisp_Object
3439make_event_array (nargs, args)
3440 register int nargs;
3441 Lisp_Object *args;
3442{
3443 int i;
3444
3445 for (i = 0; i < nargs; i++)
3446 /* The things that fit in a string
3447 are characters that are in 0...127,
3448 after discarding the meta bit and all the bits above it. */
3449 if (!INTEGERP (args[i])
3450 || (XUINT (args[i]) & ~(-CHAR_META)) >= 0200)
3451 return Fvector (nargs, args);
3452
3453 /* Since the loop exited, we know that all the things in it are
3454 characters, so we can make a string. */
3455 {
3456 Lisp_Object result;
3457
3458 result = Fmake_string (make_number (nargs), make_number (0));
3459 for (i = 0; i < nargs; i++)
3460 {
3461 SSET (result, i, XINT (args[i]));
3462 /* Move the meta bit to the right place for a string char. */
3463 if (XINT (args[i]) & CHAR_META)
3464 SSET (result, i, SREF (result, i) | 0x80);
3465 }
3466
3467 return result;
3468 }
3469}
3470
3471
3472\f
3473/************************************************************************
3474 Memory Full Handling
3475 ************************************************************************/
3476
3477
3478/* Called if malloc returns zero. */
3479
3480void
3481memory_full ()
3482{
3483 int i;
3484
3485 Vmemory_full = Qt;
3486
3487 memory_full_cons_threshold = sizeof (struct cons_block);
3488
3489 /* The first time we get here, free the spare memory. */
3490 for (i = 0; i < sizeof (spare_memory) / sizeof (char *); i++)
3491 if (spare_memory[i])
3492 {
3493 if (i == 0)
3494 free (spare_memory[i]);
3495 else if (i >= 1 && i <= 4)
3496 lisp_align_free (spare_memory[i]);
3497 else
3498 lisp_free (spare_memory[i]);
3499 spare_memory[i] = 0;
3500 }
3501
3502 /* Record the space now used. When it decreases substantially,
3503 we can refill the memory reserve. */
3504#ifndef SYSTEM_MALLOC
3505 bytes_used_when_full = BYTES_USED;
3506#endif
3507
3508 /* This used to call error, but if we've run out of memory, we could
3509 get infinite recursion trying to build the string. */
3510 xsignal (Qnil, Vmemory_signal_data);
3511}
3512
3513/* If we released our reserve (due to running out of memory),
3514 and we have a fair amount free once again,
3515 try to set aside another reserve in case we run out once more.
3516
3517 This is called when a relocatable block is freed in ralloc.c,
3518 and also directly from this file, in case we're not using ralloc.c. */
3519
3520void
3521refill_memory_reserve ()
3522{
3523#ifndef SYSTEM_MALLOC
3524 if (spare_memory[0] == 0)
3525 spare_memory[0] = (char *) malloc ((size_t) SPARE_MEMORY);
3526 if (spare_memory[1] == 0)
3527 spare_memory[1] = (char *) lisp_align_malloc (sizeof (struct cons_block),
3528 MEM_TYPE_CONS);
3529 if (spare_memory[2] == 0)
3530 spare_memory[2] = (char *) lisp_align_malloc (sizeof (struct cons_block),
3531 MEM_TYPE_CONS);
3532 if (spare_memory[3] == 0)
3533 spare_memory[3] = (char *) lisp_align_malloc (sizeof (struct cons_block),
3534 MEM_TYPE_CONS);
3535 if (spare_memory[4] == 0)
3536 spare_memory[4] = (char *) lisp_align_malloc (sizeof (struct cons_block),
3537 MEM_TYPE_CONS);
3538 if (spare_memory[5] == 0)
3539 spare_memory[5] = (char *) lisp_malloc (sizeof (struct string_block),
3540 MEM_TYPE_STRING);
3541 if (spare_memory[6] == 0)
3542 spare_memory[6] = (char *) lisp_malloc (sizeof (struct string_block),
3543 MEM_TYPE_STRING);
3544 if (spare_memory[0] && spare_memory[1] && spare_memory[5])
3545 Vmemory_full = Qnil;
3546#endif
3547}
3548\f
3549/************************************************************************
3550 C Stack Marking
3551 ************************************************************************/
3552
3553#if GC_MARK_STACK || defined GC_MALLOC_CHECK
3554
3555/* Conservative C stack marking requires a method to identify possibly
3556 live Lisp objects given a pointer value. We do this by keeping
3557 track of blocks of Lisp data that are allocated in a red-black tree
3558 (see also the comment of mem_node which is the type of nodes in
3559 that tree). Function lisp_malloc adds information for an allocated
3560 block to the red-black tree with calls to mem_insert, and function
3561 lisp_free removes it with mem_delete. Functions live_string_p etc
3562 call mem_find to lookup information about a given pointer in the
3563 tree, and use that to determine if the pointer points to a Lisp
3564 object or not. */
3565
3566/* Initialize this part of alloc.c. */
3567
3568static void
3569mem_init ()
3570{
3571 mem_z.left = mem_z.right = MEM_NIL;
3572 mem_z.parent = NULL;
3573 mem_z.color = MEM_BLACK;
3574 mem_z.start = mem_z.end = NULL;
3575 mem_root = MEM_NIL;
3576}
3577
3578
3579/* Value is a pointer to the mem_node containing START. Value is
3580 MEM_NIL if there is no node in the tree containing START. */
3581
3582static INLINE struct mem_node *
3583mem_find (start)
3584 void *start;
3585{
3586 struct mem_node *p;
3587
3588 if (start < min_heap_address || start > max_heap_address)
3589 return MEM_NIL;
3590
3591 /* Make the search always successful to speed up the loop below. */
3592 mem_z.start = start;
3593 mem_z.end = (char *) start + 1;
3594
3595 p = mem_root;
3596 while (start < p->start || start >= p->end)
3597 p = start < p->start ? p->left : p->right;
3598 return p;
3599}
3600
3601
3602/* Insert a new node into the tree for a block of memory with start
3603 address START, end address END, and type TYPE. Value is a
3604 pointer to the node that was inserted. */
3605
3606static struct mem_node *
3607mem_insert (start, end, type)
3608 void *start, *end;
3609 enum mem_type type;
3610{
3611 struct mem_node *c, *parent, *x;
3612
3613 if (start < min_heap_address)
3614 min_heap_address = start;
3615 if (end > max_heap_address)
3616 max_heap_address = end;
3617
3618 /* See where in the tree a node for START belongs. In this
3619 particular application, it shouldn't happen that a node is already
3620 present. For debugging purposes, let's check that. */
3621 c = mem_root;
3622 parent = NULL;
3623
3624#if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
3625
3626 while (c != MEM_NIL)
3627 {
3628 if (start >= c->start && start < c->end)
3629 abort ();
3630 parent = c;
3631 c = start < c->start ? c->left : c->right;
3632 }
3633
3634#else /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3635
3636 while (c != MEM_NIL)
3637 {
3638 parent = c;
3639 c = start < c->start ? c->left : c->right;
3640 }
3641
3642#endif /* GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS */
3643
3644 /* Create a new node. */
3645#ifdef GC_MALLOC_CHECK
3646 x = (struct mem_node *) _malloc_internal (sizeof *x);
3647 if (x == NULL)
3648 abort ();
3649#else
3650 x = (struct mem_node *) xmalloc (sizeof *x);
3651#endif
3652 x->start = start;
3653 x->end = end;
3654 x->type = type;
3655 x->parent = parent;
3656 x->left = x->right = MEM_NIL;
3657 x->color = MEM_RED;
3658
3659 /* Insert it as child of PARENT or install it as root. */
3660 if (parent)
3661 {
3662 if (start < parent->start)
3663 parent->left = x;
3664 else
3665 parent->right = x;
3666 }
3667 else
3668 mem_root = x;
3669
3670 /* Re-establish red-black tree properties. */
3671 mem_insert_fixup (x);
3672
3673 return x;
3674}
3675
3676
3677/* Re-establish the red-black properties of the tree, and thereby
3678 balance the tree, after node X has been inserted; X is always red. */
3679
3680static void
3681mem_insert_fixup (x)
3682 struct mem_node *x;
3683{
3684 while (x != mem_root && x->parent->color == MEM_RED)
3685 {
3686 /* X is red and its parent is red. This is a violation of
3687 red-black tree property #3. */
3688
3689 if (x->parent == x->parent->parent->left)
3690 {
3691 /* We're on the left side of our grandparent, and Y is our
3692 "uncle". */
3693 struct mem_node *y = x->parent->parent->right;
3694
3695 if (y->color == MEM_RED)
3696 {
3697 /* Uncle and parent are red but should be black because
3698 X is red. Change the colors accordingly and proceed
3699 with the grandparent. */
3700 x->parent->color = MEM_BLACK;
3701 y->color = MEM_BLACK;
3702 x->parent->parent->color = MEM_RED;
3703 x = x->parent->parent;
3704 }
3705 else
3706 {
3707 /* Parent and uncle have different colors; parent is
3708 red, uncle is black. */
3709 if (x == x->parent->right)
3710 {
3711 x = x->parent;
3712 mem_rotate_left (x);
3713 }
3714
3715 x->parent->color = MEM_BLACK;
3716 x->parent->parent->color = MEM_RED;
3717 mem_rotate_right (x->parent->parent);
3718 }
3719 }
3720 else
3721 {
3722 /* This is the symmetrical case of above. */
3723 struct mem_node *y = x->parent->parent->left;
3724
3725 if (y->color == MEM_RED)
3726 {
3727 x->parent->color = MEM_BLACK;
3728 y->color = MEM_BLACK;
3729 x->parent->parent->color = MEM_RED;
3730 x = x->parent->parent;
3731 }
3732 else
3733 {
3734 if (x == x->parent->left)
3735 {
3736 x = x->parent;
3737 mem_rotate_right (x);
3738 }
3739
3740 x->parent->color = MEM_BLACK;
3741 x->parent->parent->color = MEM_RED;
3742 mem_rotate_left (x->parent->parent);
3743 }
3744 }
3745 }
3746
3747 /* The root may have been changed to red due to the algorithm. Set
3748 it to black so that property #5 is satisfied. */
3749 mem_root->color = MEM_BLACK;
3750}
3751
3752
3753/* (x) (y)
3754 / \ / \
3755 a (y) ===> (x) c
3756 / \ / \
3757 b c a b */
3758
3759static void
3760mem_rotate_left (x)
3761 struct mem_node *x;
3762{
3763 struct mem_node *y;
3764
3765 /* Turn y's left sub-tree into x's right sub-tree. */
3766 y = x->right;
3767 x->right = y->left;
3768 if (y->left != MEM_NIL)
3769 y->left->parent = x;
3770
3771 /* Y's parent was x's parent. */
3772 if (y != MEM_NIL)
3773 y->parent = x->parent;
3774
3775 /* Get the parent to point to y instead of x. */
3776 if (x->parent)
3777 {
3778 if (x == x->parent->left)
3779 x->parent->left = y;
3780 else
3781 x->parent->right = y;
3782 }
3783 else
3784 mem_root = y;
3785
3786 /* Put x on y's left. */
3787 y->left = x;
3788 if (x != MEM_NIL)
3789 x->parent = y;
3790}
3791
3792
3793/* (x) (Y)
3794 / \ / \
3795 (y) c ===> a (x)
3796 / \ / \
3797 a b b c */
3798
3799static void
3800mem_rotate_right (x)
3801 struct mem_node *x;
3802{
3803 struct mem_node *y = x->left;
3804
3805 x->left = y->right;
3806 if (y->right != MEM_NIL)
3807 y->right->parent = x;
3808
3809 if (y != MEM_NIL)
3810 y->parent = x->parent;
3811 if (x->parent)
3812 {
3813 if (x == x->parent->right)
3814 x->parent->right = y;
3815 else
3816 x->parent->left = y;
3817 }
3818 else
3819 mem_root = y;
3820
3821 y->right = x;
3822 if (x != MEM_NIL)
3823 x->parent = y;
3824}
3825
3826
3827/* Delete node Z from the tree. If Z is null or MEM_NIL, do nothing. */
3828
3829static void
3830mem_delete (z)
3831 struct mem_node *z;
3832{
3833 struct mem_node *x, *y;
3834
3835 if (!z || z == MEM_NIL)
3836 return;
3837
3838 if (z->left == MEM_NIL || z->right == MEM_NIL)
3839 y = z;
3840 else
3841 {
3842 y = z->right;
3843 while (y->left != MEM_NIL)
3844 y = y->left;
3845 }
3846
3847 if (y->left != MEM_NIL)
3848 x = y->left;
3849 else
3850 x = y->right;
3851
3852 x->parent = y->parent;
3853 if (y->parent)
3854 {
3855 if (y == y->parent->left)
3856 y->parent->left = x;
3857 else
3858 y->parent->right = x;
3859 }
3860 else
3861 mem_root = x;
3862
3863 if (y != z)
3864 {
3865 z->start = y->start;
3866 z->end = y->end;
3867 z->type = y->type;
3868 }
3869
3870 if (y->color == MEM_BLACK)
3871 mem_delete_fixup (x);
3872
3873#ifdef GC_MALLOC_CHECK
3874 _free_internal (y);
3875#else
3876 xfree (y);
3877#endif
3878}
3879
3880
3881/* Re-establish the red-black properties of the tree, after a
3882 deletion. */
3883
3884static void
3885mem_delete_fixup (x)
3886 struct mem_node *x;
3887{
3888 while (x != mem_root && x->color == MEM_BLACK)
3889 {
3890 if (x == x->parent->left)
3891 {
3892 struct mem_node *w = x->parent->right;
3893
3894 if (w->color == MEM_RED)
3895 {
3896 w->color = MEM_BLACK;
3897 x->parent->color = MEM_RED;
3898 mem_rotate_left (x->parent);
3899 w = x->parent->right;
3900 }
3901
3902 if (w->left->color == MEM_BLACK && w->right->color == MEM_BLACK)
3903 {
3904 w->color = MEM_RED;
3905 x = x->parent;
3906 }
3907 else
3908 {
3909 if (w->right->color == MEM_BLACK)
3910 {
3911 w->left->color = MEM_BLACK;
3912 w->color = MEM_RED;
3913 mem_rotate_right (w);
3914 w = x->parent->right;
3915 }
3916 w->color = x->parent->color;
3917 x->parent->color = MEM_BLACK;
3918 w->right->color = MEM_BLACK;
3919 mem_rotate_left (x->parent);
3920 x = mem_root;
3921 }
3922 }
3923 else
3924 {
3925 struct mem_node *w = x->parent->left;
3926
3927 if (w->color == MEM_RED)
3928 {
3929 w->color = MEM_BLACK;
3930 x->parent->color = MEM_RED;
3931 mem_rotate_right (x->parent);
3932 w = x->parent->left;
3933 }
3934
3935 if (w->right->color == MEM_BLACK && w->left->color == MEM_BLACK)
3936 {
3937 w->color = MEM_RED;
3938 x = x->parent;
3939 }
3940 else
3941 {
3942 if (w->left->color == MEM_BLACK)
3943 {
3944 w->right->color = MEM_BLACK;
3945 w->color = MEM_RED;
3946 mem_rotate_left (w);
3947 w = x->parent->left;
3948 }
3949
3950 w->color = x->parent->color;
3951 x->parent->color = MEM_BLACK;
3952 w->left->color = MEM_BLACK;
3953 mem_rotate_right (x->parent);
3954 x = mem_root;
3955 }
3956 }
3957 }
3958
3959 x->color = MEM_BLACK;
3960}
3961
3962
3963/* Value is non-zero if P is a pointer to a live Lisp string on
3964 the heap. M is a pointer to the mem_block for P. */
3965
3966static INLINE int
3967live_string_p (m, p)
3968 struct mem_node *m;
3969 void *p;
3970{
3971 if (m->type == MEM_TYPE_STRING)
3972 {
3973 struct string_block *b = (struct string_block *) m->start;
3974 int offset = (char *) p - (char *) &b->strings[0];
3975
3976 /* P must point to the start of a Lisp_String structure, and it
3977 must not be on the free-list. */
3978 return (offset >= 0
3979 && offset % sizeof b->strings[0] == 0
3980 && offset < (STRING_BLOCK_SIZE * sizeof b->strings[0])
3981 && ((struct Lisp_String *) p)->data != NULL);
3982 }
3983 else
3984 return 0;
3985}
3986
3987
3988/* Value is non-zero if P is a pointer to a live Lisp cons on
3989 the heap. M is a pointer to the mem_block for P. */
3990
3991static INLINE int
3992live_cons_p (m, p)
3993 struct mem_node *m;
3994 void *p;
3995{
3996 if (m->type == MEM_TYPE_CONS)
3997 {
3998 struct cons_block *b = (struct cons_block *) m->start;
3999 int offset = (char *) p - (char *) &b->conses[0];
4000
4001 /* P must point to the start of a Lisp_Cons, not be
4002 one of the unused cells in the current cons block,
4003 and not be on the free-list. */
4004 return (offset >= 0
4005 && offset % sizeof b->conses[0] == 0
4006 && offset < (CONS_BLOCK_SIZE * sizeof b->conses[0])
4007 && (b != cons_block
4008 || offset / sizeof b->conses[0] < cons_block_index)
4009 && !EQ (((struct Lisp_Cons *) p)->car, Vdead));
4010 }
4011 else
4012 return 0;
4013}
4014
4015
4016/* Value is non-zero if P is a pointer to a live Lisp symbol on
4017 the heap. M is a pointer to the mem_block for P. */
4018
4019static INLINE int
4020live_symbol_p (m, p)
4021 struct mem_node *m;
4022 void *p;
4023{
4024 if (m->type == MEM_TYPE_SYMBOL)
4025 {
4026 struct symbol_block *b = (struct symbol_block *) m->start;
4027 int offset = (char *) p - (char *) &b->symbols[0];
4028
4029 /* P must point to the start of a Lisp_Symbol, not be
4030 one of the unused cells in the current symbol block,
4031 and not be on the free-list. */
4032 return (offset >= 0
4033 && offset % sizeof b->symbols[0] == 0
4034 && offset < (SYMBOL_BLOCK_SIZE * sizeof b->symbols[0])
4035 && (b != symbol_block
4036 || offset / sizeof b->symbols[0] < symbol_block_index)
4037 && !EQ (((struct Lisp_Symbol *) p)->function, Vdead));
4038 }
4039 else
4040 return 0;
4041}
4042
4043
4044/* Value is non-zero if P is a pointer to a live Lisp float on
4045 the heap. M is a pointer to the mem_block for P. */
4046
4047static INLINE int
4048live_float_p (m, p)
4049 struct mem_node *m;
4050 void *p;
4051{
4052 if (m->type == MEM_TYPE_FLOAT)
4053 {
4054 struct float_block *b = (struct float_block *) m->start;
4055 int offset = (char *) p - (char *) &b->floats[0];
4056
4057 /* P must point to the start of a Lisp_Float and not be
4058 one of the unused cells in the current float block. */
4059 return (offset >= 0
4060 && offset % sizeof b->floats[0] == 0
4061 && offset < (FLOAT_BLOCK_SIZE * sizeof b->floats[0])
4062 && (b != float_block
4063 || offset / sizeof b->floats[0] < float_block_index));
4064 }
4065 else
4066 return 0;
4067}
4068
4069
4070/* Value is non-zero if P is a pointer to a live Lisp Misc on
4071 the heap. M is a pointer to the mem_block for P. */
4072
4073static INLINE int
4074live_misc_p (m, p)
4075 struct mem_node *m;
4076 void *p;
4077{
4078 if (m->type == MEM_TYPE_MISC)
4079 {
4080 struct marker_block *b = (struct marker_block *) m->start;
4081 int offset = (char *) p - (char *) &b->markers[0];
4082
4083 /* P must point to the start of a Lisp_Misc, not be
4084 one of the unused cells in the current misc block,
4085 and not be on the free-list. */
4086 return (offset >= 0
4087 && offset % sizeof b->markers[0] == 0
4088 && offset < (MARKER_BLOCK_SIZE * sizeof b->markers[0])
4089 && (b != marker_block
4090 || offset / sizeof b->markers[0] < marker_block_index)
4091 && ((union Lisp_Misc *) p)->u_marker.type != Lisp_Misc_Free);
4092 }
4093 else
4094 return 0;
4095}
4096
4097
4098/* Value is non-zero if P is a pointer to a live vector-like object.
4099 M is a pointer to the mem_block for P. */
4100
4101static INLINE int
4102live_vector_p (m, p)
4103 struct mem_node *m;
4104 void *p;
4105{
4106 return (p == m->start
4107 && m->type >= MEM_TYPE_VECTOR
4108 && m->type <= MEM_TYPE_WINDOW);
4109}
4110
4111
4112/* Value is non-zero if P is a pointer to a live buffer. M is a
4113 pointer to the mem_block for P. */
4114
4115static INLINE int
4116live_buffer_p (m, p)
4117 struct mem_node *m;
4118 void *p;
4119{
4120 /* P must point to the start of the block, and the buffer
4121 must not have been killed. */
4122 return (m->type == MEM_TYPE_BUFFER
4123 && p == m->start
4124 && !NILP (((struct buffer *) p)->name));
4125}
4126
4127#endif /* GC_MARK_STACK || defined GC_MALLOC_CHECK */
4128
4129#if GC_MARK_STACK
4130
4131#if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4132
4133/* Array of objects that are kept alive because the C stack contains
4134 a pattern that looks like a reference to them . */
4135
4136#define MAX_ZOMBIES 10
4137static Lisp_Object zombies[MAX_ZOMBIES];
4138
4139/* Number of zombie objects. */
4140
4141static int nzombies;
4142
4143/* Number of garbage collections. */
4144
4145static int ngcs;
4146
4147/* Average percentage of zombies per collection. */
4148
4149static double avg_zombies;
4150
4151/* Max. number of live and zombie objects. */
4152
4153static int max_live, max_zombies;
4154
4155/* Average number of live objects per GC. */
4156
4157static double avg_live;
4158
4159DEFUN ("gc-status", Fgc_status, Sgc_status, 0, 0, "",
4160 doc: /* Show information about live and zombie objects. */)
4161 ()
4162{
4163 Lisp_Object args[8], zombie_list = Qnil;
4164 int i;
4165 for (i = 0; i < nzombies; i++)
4166 zombie_list = Fcons (zombies[i], zombie_list);
4167 args[0] = build_string ("%d GCs, avg live/zombies = %.2f/%.2f (%f%%), max %d/%d\nzombies: %S");
4168 args[1] = make_number (ngcs);
4169 args[2] = make_float (avg_live);
4170 args[3] = make_float (avg_zombies);
4171 args[4] = make_float (avg_zombies / avg_live / 100);
4172 args[5] = make_number (max_live);
4173 args[6] = make_number (max_zombies);
4174 args[7] = zombie_list;
4175 return Fmessage (8, args);
4176}
4177
4178#endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4179
4180
4181/* Mark OBJ if we can prove it's a Lisp_Object. */
4182
4183static INLINE void
4184mark_maybe_object (obj)
4185 Lisp_Object obj;
4186{
4187 void *po = (void *) XPNTR (obj);
4188 struct mem_node *m = mem_find (po);
4189
4190 if (m != MEM_NIL)
4191 {
4192 int mark_p = 0;
4193
4194 switch (XGCTYPE (obj))
4195 {
4196 case Lisp_String:
4197 mark_p = (live_string_p (m, po)
4198 && !STRING_MARKED_P ((struct Lisp_String *) po));
4199 break;
4200
4201 case Lisp_Cons:
4202 mark_p = (live_cons_p (m, po) && !CONS_MARKED_P (XCONS (obj)));
4203 break;
4204
4205 case Lisp_Symbol:
4206 mark_p = (live_symbol_p (m, po) && !XSYMBOL (obj)->gcmarkbit);
4207 break;
4208
4209 case Lisp_Float:
4210 mark_p = (live_float_p (m, po) && !FLOAT_MARKED_P (XFLOAT (obj)));
4211 break;
4212
4213 case Lisp_Vectorlike:
4214 /* Note: can't check GC_BUFFERP before we know it's a
4215 buffer because checking that dereferences the pointer
4216 PO which might point anywhere. */
4217 if (live_vector_p (m, po))
4218 mark_p = !GC_SUBRP (obj) && !VECTOR_MARKED_P (XVECTOR (obj));
4219 else if (live_buffer_p (m, po))
4220 mark_p = GC_BUFFERP (obj) && !VECTOR_MARKED_P (XBUFFER (obj));
4221 break;
4222
4223 case Lisp_Misc:
4224 mark_p = (live_misc_p (m, po) && !XMARKER (obj)->gcmarkbit);
4225 break;
4226
4227 case Lisp_Int:
4228 case Lisp_Type_Limit:
4229 break;
4230 }
4231
4232 if (mark_p)
4233 {
4234#if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4235 if (nzombies < MAX_ZOMBIES)
4236 zombies[nzombies] = obj;
4237 ++nzombies;
4238#endif
4239 mark_object (obj);
4240 }
4241 }
4242}
4243
4244
4245/* If P points to Lisp data, mark that as live if it isn't already
4246 marked. */
4247
4248static INLINE void
4249mark_maybe_pointer (p)
4250 void *p;
4251{
4252 struct mem_node *m;
4253
4254 /* Quickly rule out some values which can't point to Lisp data. We
4255 assume that Lisp data is aligned on even addresses. */
4256 if ((EMACS_INT) p & 1)
4257 return;
4258
4259 m = mem_find (p);
4260 if (m != MEM_NIL)
4261 {
4262 Lisp_Object obj = Qnil;
4263
4264 switch (m->type)
4265 {
4266 case MEM_TYPE_NON_LISP:
4267 /* Nothing to do; not a pointer to Lisp memory. */
4268 break;
4269
4270 case MEM_TYPE_BUFFER:
4271 if (live_buffer_p (m, p) && !VECTOR_MARKED_P((struct buffer *)p))
4272 XSETVECTOR (obj, p);
4273 break;
4274
4275 case MEM_TYPE_CONS:
4276 if (live_cons_p (m, p) && !CONS_MARKED_P ((struct Lisp_Cons *) p))
4277 XSETCONS (obj, p);
4278 break;
4279
4280 case MEM_TYPE_STRING:
4281 if (live_string_p (m, p)
4282 && !STRING_MARKED_P ((struct Lisp_String *) p))
4283 XSETSTRING (obj, p);
4284 break;
4285
4286 case MEM_TYPE_MISC:
4287 if (live_misc_p (m, p) && !((struct Lisp_Free *) p)->gcmarkbit)
4288 XSETMISC (obj, p);
4289 break;
4290
4291 case MEM_TYPE_SYMBOL:
4292 if (live_symbol_p (m, p) && !((struct Lisp_Symbol *) p)->gcmarkbit)
4293 XSETSYMBOL (obj, p);
4294 break;
4295
4296 case MEM_TYPE_FLOAT:
4297 if (live_float_p (m, p) && !FLOAT_MARKED_P (p))
4298 XSETFLOAT (obj, p);
4299 break;
4300
4301 case MEM_TYPE_VECTOR:
4302 case MEM_TYPE_PROCESS:
4303 case MEM_TYPE_HASH_TABLE:
4304 case MEM_TYPE_FRAME:
4305 case MEM_TYPE_WINDOW:
4306 if (live_vector_p (m, p))
4307 {
4308 Lisp_Object tem;
4309 XSETVECTOR (tem, p);
4310 if (!GC_SUBRP (tem) && !VECTOR_MARKED_P (XVECTOR (tem)))
4311 obj = tem;
4312 }
4313 break;
4314
4315 default:
4316 abort ();
4317 }
4318
4319 if (!GC_NILP (obj))
4320 mark_object (obj);
4321 }
4322}
4323
4324
4325/* Mark Lisp objects referenced from the address range START..END. */
4326
4327static void
4328mark_memory (start, end)
4329 void *start, *end;
4330{
4331 Lisp_Object *p;
4332 void **pp;
4333
4334#if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4335 nzombies = 0;
4336#endif
4337
4338 /* Make START the pointer to the start of the memory region,
4339 if it isn't already. */
4340 if (end < start)
4341 {
4342 void *tem = start;
4343 start = end;
4344 end = tem;
4345 }
4346
4347 /* Mark Lisp_Objects. */
4348 for (p = (Lisp_Object *) start; (void *) p < end; ++p)
4349 mark_maybe_object (*p);
4350
4351 /* Mark Lisp data pointed to. This is necessary because, in some
4352 situations, the C compiler optimizes Lisp objects away, so that
4353 only a pointer to them remains. Example:
4354
4355 DEFUN ("testme", Ftestme, Stestme, 0, 0, 0, "")
4356 ()
4357 {
4358 Lisp_Object obj = build_string ("test");
4359 struct Lisp_String *s = XSTRING (obj);
4360 Fgarbage_collect ();
4361 fprintf (stderr, "test `%s'\n", s->data);
4362 return Qnil;
4363 }
4364
4365 Here, `obj' isn't really used, and the compiler optimizes it
4366 away. The only reference to the life string is through the
4367 pointer `s'. */
4368
4369 for (pp = (void **) start; (void *) pp < end; ++pp)
4370 mark_maybe_pointer (*pp);
4371}
4372
4373/* setjmp will work with GCC unless NON_SAVING_SETJMP is defined in
4374 the GCC system configuration. In gcc 3.2, the only systems for
4375 which this is so are i386-sco5 non-ELF, i386-sysv3 (maybe included
4376 by others?) and ns32k-pc532-min. */
4377
4378#if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
4379
4380static int setjmp_tested_p, longjmps_done;
4381
4382#define SETJMP_WILL_LIKELY_WORK "\
4383\n\
4384Emacs garbage collector has been changed to use conservative stack\n\
4385marking. Emacs has determined that the method it uses to do the\n\
4386marking will likely work on your system, but this isn't sure.\n\
4387\n\
4388If you are a system-programmer, or can get the help of a local wizard\n\
4389who is, please take a look at the function mark_stack in alloc.c, and\n\
4390verify that the methods used are appropriate for your system.\n\
4391\n\
4392Please mail the result to <emacs-devel@gnu.org>.\n\
4393"
4394
4395#define SETJMP_WILL_NOT_WORK "\
4396\n\
4397Emacs garbage collector has been changed to use conservative stack\n\
4398marking. Emacs has determined that the default method it uses to do the\n\
4399marking will not work on your system. We will need a system-dependent\n\
4400solution for your system.\n\
4401\n\
4402Please take a look at the function mark_stack in alloc.c, and\n\
4403try to find a way to make it work on your system.\n\
4404\n\
4405Note that you may get false negatives, depending on the compiler.\n\
4406In particular, you need to use -O with GCC for this test.\n\
4407\n\
4408Please mail the result to <emacs-devel@gnu.org>.\n\
4409"
4410
4411
4412/* Perform a quick check if it looks like setjmp saves registers in a
4413 jmp_buf. Print a message to stderr saying so. When this test
4414 succeeds, this is _not_ a proof that setjmp is sufficient for
4415 conservative stack marking. Only the sources or a disassembly
4416 can prove that. */
4417
4418static void
4419test_setjmp ()
4420{
4421 char buf[10];
4422 register int x;
4423 jmp_buf jbuf;
4424 int result = 0;
4425
4426 /* Arrange for X to be put in a register. */
4427 sprintf (buf, "1");
4428 x = strlen (buf);
4429 x = 2 * x - 1;
4430
4431 setjmp (jbuf);
4432 if (longjmps_done == 1)
4433 {
4434 /* Came here after the longjmp at the end of the function.
4435
4436 If x == 1, the longjmp has restored the register to its
4437 value before the setjmp, and we can hope that setjmp
4438 saves all such registers in the jmp_buf, although that
4439 isn't sure.
4440
4441 For other values of X, either something really strange is
4442 taking place, or the setjmp just didn't save the register. */
4443
4444 if (x == 1)
4445 fprintf (stderr, SETJMP_WILL_LIKELY_WORK);
4446 else
4447 {
4448 fprintf (stderr, SETJMP_WILL_NOT_WORK);
4449 exit (1);
4450 }
4451 }
4452
4453 ++longjmps_done;
4454 x = 2;
4455 if (longjmps_done == 1)
4456 longjmp (jbuf, 1);
4457}
4458
4459#endif /* not GC_SAVE_REGISTERS_ON_STACK && not GC_SETJMP_WORKS */
4460
4461
4462#if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4463
4464/* Abort if anything GCPRO'd doesn't survive the GC. */
4465
4466static void
4467check_gcpros ()
4468{
4469 struct gcpro *p;
4470 int i;
4471
4472 for (p = gcprolist; p; p = p->next)
4473 for (i = 0; i < p->nvars; ++i)
4474 if (!survives_gc_p (p->var[i]))
4475 /* FIXME: It's not necessarily a bug. It might just be that the
4476 GCPRO is unnecessary or should release the object sooner. */
4477 abort ();
4478}
4479
4480#elif GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
4481
4482static void
4483dump_zombies ()
4484{
4485 int i;
4486
4487 fprintf (stderr, "\nZombies kept alive = %d:\n", nzombies);
4488 for (i = 0; i < min (MAX_ZOMBIES, nzombies); ++i)
4489 {
4490 fprintf (stderr, " %d = ", i);
4491 debug_print (zombies[i]);
4492 }
4493}
4494
4495#endif /* GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES */
4496
4497
4498/* Mark live Lisp objects on the C stack.
4499
4500 There are several system-dependent problems to consider when
4501 porting this to new architectures:
4502
4503 Processor Registers
4504
4505 We have to mark Lisp objects in CPU registers that can hold local
4506 variables or are used to pass parameters.
4507
4508 If GC_SAVE_REGISTERS_ON_STACK is defined, it should expand to
4509 something that either saves relevant registers on the stack, or
4510 calls mark_maybe_object passing it each register's contents.
4511
4512 If GC_SAVE_REGISTERS_ON_STACK is not defined, the current
4513 implementation assumes that calling setjmp saves registers we need
4514 to see in a jmp_buf which itself lies on the stack. This doesn't
4515 have to be true! It must be verified for each system, possibly
4516 by taking a look at the source code of setjmp.
4517
4518 Stack Layout
4519
4520 Architectures differ in the way their processor stack is organized.
4521 For example, the stack might look like this
4522
4523 +----------------+
4524 | Lisp_Object | size = 4
4525 +----------------+
4526 | something else | size = 2
4527 +----------------+
4528 | Lisp_Object | size = 4
4529 +----------------+
4530 | ... |
4531
4532 In such a case, not every Lisp_Object will be aligned equally. To
4533 find all Lisp_Object on the stack it won't be sufficient to walk
4534 the stack in steps of 4 bytes. Instead, two passes will be
4535 necessary, one starting at the start of the stack, and a second
4536 pass starting at the start of the stack + 2. Likewise, if the
4537 minimal alignment of Lisp_Objects on the stack is 1, four passes
4538 would be necessary, each one starting with one byte more offset
4539 from the stack start.
4540
4541 The current code assumes by default that Lisp_Objects are aligned
4542 equally on the stack. */
4543
4544static void
4545mark_stack ()
4546{
4547 int i;
4548 jmp_buf j;
4549 volatile int stack_grows_down_p = (char *) &j > (char *) stack_base;
4550 void *end;
4551
4552 /* This trick flushes the register windows so that all the state of
4553 the process is contained in the stack. */
4554 /* Fixme: Code in the Boehm GC suggests flushing (with `flushrs') is
4555 needed on ia64 too. See mach_dep.c, where it also says inline
4556 assembler doesn't work with relevant proprietary compilers. */
4557#ifdef sparc
4558 asm ("ta 3");
4559#endif
4560
4561 /* Save registers that we need to see on the stack. We need to see
4562 registers used to hold register variables and registers used to
4563 pass parameters. */
4564#ifdef GC_SAVE_REGISTERS_ON_STACK
4565 GC_SAVE_REGISTERS_ON_STACK (end);
4566#else /* not GC_SAVE_REGISTERS_ON_STACK */
4567
4568#ifndef GC_SETJMP_WORKS /* If it hasn't been checked yet that
4569 setjmp will definitely work, test it
4570 and print a message with the result
4571 of the test. */
4572 if (!setjmp_tested_p)
4573 {
4574 setjmp_tested_p = 1;
4575 test_setjmp ();
4576 }
4577#endif /* GC_SETJMP_WORKS */
4578
4579 setjmp (j);
4580 end = stack_grows_down_p ? (char *) &j + sizeof j : (char *) &j;
4581#endif /* not GC_SAVE_REGISTERS_ON_STACK */
4582
4583 /* This assumes that the stack is a contiguous region in memory. If
4584 that's not the case, something has to be done here to iterate
4585 over the stack segments. */
4586#ifndef GC_LISP_OBJECT_ALIGNMENT
4587#ifdef __GNUC__
4588#define GC_LISP_OBJECT_ALIGNMENT __alignof__ (Lisp_Object)
4589#else
4590#define GC_LISP_OBJECT_ALIGNMENT sizeof (Lisp_Object)
4591#endif
4592#endif
4593 for (i = 0; i < sizeof (Lisp_Object); i += GC_LISP_OBJECT_ALIGNMENT)
4594 mark_memory ((char *) stack_base + i, end);
4595 /* Allow for marking a secondary stack, like the register stack on the
4596 ia64. */
4597#ifdef GC_MARK_SECONDARY_STACK
4598 GC_MARK_SECONDARY_STACK ();
4599#endif
4600
4601#if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
4602 check_gcpros ();
4603#endif
4604}
4605
4606#endif /* GC_MARK_STACK != 0 */
4607
4608
4609/* Determine whether it is safe to access memory at address P. */
4610int
4611valid_pointer_p (p)
4612 void *p;
4613{
4614 int fd;
4615
4616 /* Obviously, we cannot just access it (we would SEGV trying), so we
4617 trick the o/s to tell us whether p is a valid pointer.
4618 Unfortunately, we cannot use NULL_DEVICE here, as emacs_write may
4619 not validate p in that case. */
4620
4621 if ((fd = emacs_open ("__Valid__Lisp__Object__", O_CREAT | O_WRONLY | O_TRUNC, 0666)) >= 0)
4622 {
4623 int valid = (emacs_write (fd, (char *)p, 16) == 16);
4624 emacs_close (fd);
4625 unlink ("__Valid__Lisp__Object__");
4626 return valid;
4627 }
4628
4629 return -1;
4630}
4631
4632/* Return 1 if OBJ is a valid lisp object.
4633 Return 0 if OBJ is NOT a valid lisp object.
4634 Return -1 if we cannot validate OBJ.
4635 This function can be quite slow,
4636 so it should only be used in code for manual debugging. */
4637
4638int
4639valid_lisp_object_p (obj)
4640 Lisp_Object obj;
4641{
4642 void *p;
4643#if GC_MARK_STACK
4644 struct mem_node *m;
4645#endif
4646
4647 if (INTEGERP (obj))
4648 return 1;
4649
4650 p = (void *) XPNTR (obj);
4651 if (PURE_POINTER_P (p))
4652 return 1;
4653
4654#if !GC_MARK_STACK
4655 return valid_pointer_p (p);
4656#else
4657
4658 m = mem_find (p);
4659
4660 if (m == MEM_NIL)
4661 {
4662 int valid = valid_pointer_p (p);
4663 if (valid <= 0)
4664 return valid;
4665
4666 if (SUBRP (obj))
4667 return 1;
4668
4669 return 0;
4670 }
4671
4672 switch (m->type)
4673 {
4674 case MEM_TYPE_NON_LISP:
4675 return 0;
4676
4677 case MEM_TYPE_BUFFER:
4678 return live_buffer_p (m, p);
4679
4680 case MEM_TYPE_CONS:
4681 return live_cons_p (m, p);
4682
4683 case MEM_TYPE_STRING:
4684 return live_string_p (m, p);
4685
4686 case MEM_TYPE_MISC:
4687 return live_misc_p (m, p);
4688
4689 case MEM_TYPE_SYMBOL:
4690 return live_symbol_p (m, p);
4691
4692 case MEM_TYPE_FLOAT:
4693 return live_float_p (m, p);
4694
4695 case MEM_TYPE_VECTOR:
4696 case MEM_TYPE_PROCESS:
4697 case MEM_TYPE_HASH_TABLE:
4698 case MEM_TYPE_FRAME:
4699 case MEM_TYPE_WINDOW:
4700 return live_vector_p (m, p);
4701
4702 default:
4703 break;
4704 }
4705
4706 return 0;
4707#endif
4708}
4709
4710
4711
4712\f
4713/***********************************************************************
4714 Pure Storage Management
4715 ***********************************************************************/
4716
4717/* Allocate room for SIZE bytes from pure Lisp storage and return a
4718 pointer to it. TYPE is the Lisp type for which the memory is
4719 allocated. TYPE < 0 means it's not used for a Lisp object. */
4720
4721static POINTER_TYPE *
4722pure_alloc (size, type)
4723 size_t size;
4724 int type;
4725{
4726 POINTER_TYPE *result;
4727#ifdef USE_LSB_TAG
4728 size_t alignment = (1 << GCTYPEBITS);
4729#else
4730 size_t alignment = sizeof (EMACS_INT);
4731
4732 /* Give Lisp_Floats an extra alignment. */
4733 if (type == Lisp_Float)
4734 {
4735#if defined __GNUC__ && __GNUC__ >= 2
4736 alignment = __alignof (struct Lisp_Float);
4737#else
4738 alignment = sizeof (struct Lisp_Float);
4739#endif
4740 }
4741#endif
4742
4743 again:
4744 if (type >= 0)
4745 {
4746 /* Allocate space for a Lisp object from the beginning of the free
4747 space with taking account of alignment. */
4748 result = ALIGN (purebeg + pure_bytes_used_lisp, alignment);
4749 pure_bytes_used_lisp = ((char *)result - (char *)purebeg) + size;
4750 }
4751 else
4752 {
4753 /* Allocate space for a non-Lisp object from the end of the free
4754 space. */
4755 pure_bytes_used_non_lisp += size;
4756 result = purebeg + pure_size - pure_bytes_used_non_lisp;
4757 }
4758 pure_bytes_used = pure_bytes_used_lisp + pure_bytes_used_non_lisp;
4759
4760 if (pure_bytes_used <= pure_size)
4761 return result;
4762
4763 /* Don't allocate a large amount here,
4764 because it might get mmap'd and then its address
4765 might not be usable. */
4766 purebeg = (char *) xmalloc (10000);
4767 pure_size = 10000;
4768 pure_bytes_used_before_overflow += pure_bytes_used - size;
4769 pure_bytes_used = 0;
4770 pure_bytes_used_lisp = pure_bytes_used_non_lisp = 0;
4771 goto again;
4772}
4773
4774
4775/* Print a warning if PURESIZE is too small. */
4776
4777void
4778check_pure_size ()
4779{
4780 if (pure_bytes_used_before_overflow)
4781 message ("emacs:0:Pure Lisp storage overflow (approx. %d bytes needed)",
4782 (int) (pure_bytes_used + pure_bytes_used_before_overflow));
4783}
4784
4785
4786/* Find the byte sequence {DATA[0], ..., DATA[NBYTES-1], '\0'} from
4787 the non-Lisp data pool of the pure storage, and return its start
4788 address. Return NULL if not found. */
4789
4790static char *
4791find_string_data_in_pure (data, nbytes)
4792 char *data;
4793 int nbytes;
4794{
4795 int i, skip, bm_skip[256], last_char_skip, infinity, start, start_max;
4796 unsigned char *p;
4797 char *non_lisp_beg;
4798
4799 if (pure_bytes_used_non_lisp < nbytes + 1)
4800 return NULL;
4801
4802 /* Set up the Boyer-Moore table. */
4803 skip = nbytes + 1;
4804 for (i = 0; i < 256; i++)
4805 bm_skip[i] = skip;
4806
4807 p = (unsigned char *) data;
4808 while (--skip > 0)
4809 bm_skip[*p++] = skip;
4810
4811 last_char_skip = bm_skip['\0'];
4812
4813 non_lisp_beg = purebeg + pure_size - pure_bytes_used_non_lisp;
4814 start_max = pure_bytes_used_non_lisp - (nbytes + 1);
4815
4816 /* See the comments in the function `boyer_moore' (search.c) for the
4817 use of `infinity'. */
4818 infinity = pure_bytes_used_non_lisp + 1;
4819 bm_skip['\0'] = infinity;
4820
4821 p = (unsigned char *) non_lisp_beg + nbytes;
4822 start = 0;
4823 do
4824 {
4825 /* Check the last character (== '\0'). */
4826 do
4827 {
4828 start += bm_skip[*(p + start)];
4829 }
4830 while (start <= start_max);
4831
4832 if (start < infinity)
4833 /* Couldn't find the last character. */
4834 return NULL;
4835
4836 /* No less than `infinity' means we could find the last
4837 character at `p[start - infinity]'. */
4838 start -= infinity;
4839
4840 /* Check the remaining characters. */
4841 if (memcmp (data, non_lisp_beg + start, nbytes) == 0)
4842 /* Found. */
4843 return non_lisp_beg + start;
4844
4845 start += last_char_skip;
4846 }
4847 while (start <= start_max);
4848
4849 return NULL;
4850}
4851
4852
4853/* Return a string allocated in pure space. DATA is a buffer holding
4854 NCHARS characters, and NBYTES bytes of string data. MULTIBYTE
4855 non-zero means make the result string multibyte.
4856
4857 Must get an error if pure storage is full, since if it cannot hold
4858 a large string it may be able to hold conses that point to that
4859 string; then the string is not protected from gc. */
4860
4861Lisp_Object
4862make_pure_string (data, nchars, nbytes, multibyte)
4863 char *data;
4864 int nchars, nbytes;
4865 int multibyte;
4866{
4867 Lisp_Object string;
4868 struct Lisp_String *s;
4869
4870 s = (struct Lisp_String *) pure_alloc (sizeof *s, Lisp_String);
4871 s->data = find_string_data_in_pure (data, nbytes);
4872 if (s->data == NULL)
4873 {
4874 s->data = (unsigned char *) pure_alloc (nbytes + 1, -1);
4875 bcopy (data, s->data, nbytes);
4876 s->data[nbytes] = '\0';
4877 }
4878 s->size = nchars;
4879 s->size_byte = multibyte ? nbytes : -1;
4880 s->intervals = NULL_INTERVAL;
4881 XSETSTRING (string, s);
4882 return string;
4883}
4884
4885
4886/* Return a cons allocated from pure space. Give it pure copies
4887 of CAR as car and CDR as cdr. */
4888
4889Lisp_Object
4890pure_cons (car, cdr)
4891 Lisp_Object car, cdr;
4892{
4893 register Lisp_Object new;
4894 struct Lisp_Cons *p;
4895
4896 p = (struct Lisp_Cons *) pure_alloc (sizeof *p, Lisp_Cons);
4897 XSETCONS (new, p);
4898 XSETCAR (new, Fpurecopy (car));
4899 XSETCDR (new, Fpurecopy (cdr));
4900 return new;
4901}
4902
4903
4904/* Value is a float object with value NUM allocated from pure space. */
4905
4906Lisp_Object
4907make_pure_float (num)
4908 double num;
4909{
4910 register Lisp_Object new;
4911 struct Lisp_Float *p;
4912
4913 p = (struct Lisp_Float *) pure_alloc (sizeof *p, Lisp_Float);
4914 XSETFLOAT (new, p);
4915 XFLOAT_DATA (new) = num;
4916 return new;
4917}
4918
4919
4920/* Return a vector with room for LEN Lisp_Objects allocated from
4921 pure space. */
4922
4923Lisp_Object
4924make_pure_vector (len)
4925 EMACS_INT len;
4926{
4927 Lisp_Object new;
4928 struct Lisp_Vector *p;
4929 size_t size = sizeof *p + (len - 1) * sizeof (Lisp_Object);
4930
4931 p = (struct Lisp_Vector *) pure_alloc (size, Lisp_Vectorlike);
4932 XSETVECTOR (new, p);
4933 XVECTOR (new)->size = len;
4934 return new;
4935}
4936
4937
4938DEFUN ("purecopy", Fpurecopy, Spurecopy, 1, 1, 0,
4939 doc: /* Make a copy of object OBJ in pure storage.
4940Recursively copies contents of vectors and cons cells.
4941Does not copy symbols. Copies strings without text properties. */)
4942 (obj)
4943 register Lisp_Object obj;
4944{
4945 if (NILP (Vpurify_flag))
4946 return obj;
4947
4948 if (PURE_POINTER_P (XPNTR (obj)))
4949 return obj;
4950
4951 if (CONSP (obj))
4952 return pure_cons (XCAR (obj), XCDR (obj));
4953 else if (FLOATP (obj))
4954 return make_pure_float (XFLOAT_DATA (obj));
4955 else if (STRINGP (obj))
4956 return make_pure_string (SDATA (obj), SCHARS (obj),
4957 SBYTES (obj),
4958 STRING_MULTIBYTE (obj));
4959 else if (COMPILEDP (obj) || VECTORP (obj))
4960 {
4961 register struct Lisp_Vector *vec;
4962 register int i;
4963 EMACS_INT size;
4964
4965 size = XVECTOR (obj)->size;
4966 if (size & PSEUDOVECTOR_FLAG)
4967 size &= PSEUDOVECTOR_SIZE_MASK;
4968 vec = XVECTOR (make_pure_vector (size));
4969 for (i = 0; i < size; i++)
4970 vec->contents[i] = Fpurecopy (XVECTOR (obj)->contents[i]);
4971 if (COMPILEDP (obj))
4972 XSETCOMPILED (obj, vec);
4973 else
4974 XSETVECTOR (obj, vec);
4975 return obj;
4976 }
4977 else if (MARKERP (obj))
4978 error ("Attempt to copy a marker to pure storage");
4979
4980 return obj;
4981}
4982
4983
4984\f
4985/***********************************************************************
4986 Protection from GC
4987 ***********************************************************************/
4988
4989/* Put an entry in staticvec, pointing at the variable with address
4990 VARADDRESS. */
4991
4992void
4993staticpro (varaddress)
4994 Lisp_Object *varaddress;
4995{
4996 staticvec[staticidx++] = varaddress;
4997 if (staticidx >= NSTATICS)
4998 abort ();
4999}
5000
5001struct catchtag
5002{
5003 Lisp_Object tag;
5004 Lisp_Object val;
5005 struct catchtag *next;
5006};
5007
5008\f
5009/***********************************************************************
5010 Protection from GC
5011 ***********************************************************************/
5012
5013/* Temporarily prevent garbage collection. */
5014
5015int
5016inhibit_garbage_collection ()
5017{
5018 int count = SPECPDL_INDEX ();
5019 int nbits = min (VALBITS, BITS_PER_INT);
5020
5021 specbind (Qgc_cons_threshold, make_number (((EMACS_INT) 1 << (nbits - 1)) - 1));
5022 return count;
5023}
5024
5025
5026DEFUN ("garbage-collect", Fgarbage_collect, Sgarbage_collect, 0, 0, "",
5027 doc: /* Reclaim storage for Lisp objects no longer needed.
5028Garbage collection happens automatically if you cons more than
5029`gc-cons-threshold' bytes of Lisp data since previous garbage collection.
5030`garbage-collect' normally returns a list with info on amount of space in use:
5031 ((USED-CONSES . FREE-CONSES) (USED-SYMS . FREE-SYMS)
5032 (USED-MARKERS . FREE-MARKERS) USED-STRING-CHARS USED-VECTOR-SLOTS
5033 (USED-FLOATS . FREE-FLOATS) (USED-INTERVALS . FREE-INTERVALS)
5034 (USED-STRINGS . FREE-STRINGS))
5035However, if there was overflow in pure space, `garbage-collect'
5036returns nil, because real GC can't be done. */)
5037 ()
5038{
5039 register struct specbinding *bind;
5040 struct catchtag *catch;
5041 struct handler *handler;
5042 char stack_top_variable;
5043 register int i;
5044 int message_p;
5045 Lisp_Object total[8];
5046 int count = SPECPDL_INDEX ();
5047 EMACS_TIME t1, t2, t3;
5048
5049 if (abort_on_gc)
5050 abort ();
5051
5052 /* Can't GC if pure storage overflowed because we can't determine
5053 if something is a pure object or not. */
5054 if (pure_bytes_used_before_overflow)
5055 return Qnil;
5056
5057 CHECK_CONS_LIST ();
5058
5059 /* Don't keep undo information around forever.
5060 Do this early on, so it is no problem if the user quits. */
5061 {
5062 register struct buffer *nextb = all_buffers;
5063
5064 while (nextb)
5065 {
5066 /* If a buffer's undo list is Qt, that means that undo is
5067 turned off in that buffer. Calling truncate_undo_list on
5068 Qt tends to return NULL, which effectively turns undo back on.
5069 So don't call truncate_undo_list if undo_list is Qt. */
5070 if (! NILP (nextb->name) && ! EQ (nextb->undo_list, Qt))
5071 truncate_undo_list (nextb);
5072
5073 /* Shrink buffer gaps, but skip indirect and dead buffers. */
5074 if (nextb->base_buffer == 0 && !NILP (nextb->name))
5075 {
5076 /* If a buffer's gap size is more than 10% of the buffer
5077 size, or larger than 2000 bytes, then shrink it
5078 accordingly. Keep a minimum size of 20 bytes. */
5079 int size = min (2000, max (20, (nextb->text->z_byte / 10)));
5080
5081 if (nextb->text->gap_size > size)
5082 {
5083 struct buffer *save_current = current_buffer;
5084 current_buffer = nextb;
5085 make_gap (-(nextb->text->gap_size - size));
5086 current_buffer = save_current;
5087 }
5088 }
5089
5090 nextb = nextb->next;
5091 }
5092 }
5093
5094 EMACS_GET_TIME (t1);
5095
5096 /* In case user calls debug_print during GC,
5097 don't let that cause a recursive GC. */
5098 consing_since_gc = 0;
5099
5100 /* Save what's currently displayed in the echo area. */
5101 message_p = push_message ();
5102 record_unwind_protect (pop_message_unwind, Qnil);
5103
5104 /* Save a copy of the contents of the stack, for debugging. */
5105#if MAX_SAVE_STACK > 0
5106 if (NILP (Vpurify_flag))
5107 {
5108 i = &stack_top_variable - stack_bottom;
5109 if (i < 0) i = -i;
5110 if (i < MAX_SAVE_STACK)
5111 {
5112 if (stack_copy == 0)
5113 stack_copy = (char *) xmalloc (stack_copy_size = i);
5114 else if (stack_copy_size < i)
5115 stack_copy = (char *) xrealloc (stack_copy, (stack_copy_size = i));
5116 if (stack_copy)
5117 {
5118 if ((EMACS_INT) (&stack_top_variable - stack_bottom) > 0)
5119 bcopy (stack_bottom, stack_copy, i);
5120 else
5121 bcopy (&stack_top_variable, stack_copy, i);
5122 }
5123 }
5124 }
5125#endif /* MAX_SAVE_STACK > 0 */
5126
5127 if (garbage_collection_messages)
5128 message1_nolog ("Garbage collecting...");
5129
5130 BLOCK_INPUT;
5131
5132 shrink_regexp_cache ();
5133
5134 gc_in_progress = 1;
5135
5136 /* clear_marks (); */
5137
5138 /* Mark all the special slots that serve as the roots of accessibility. */
5139
5140 for (i = 0; i < staticidx; i++)
5141 mark_object (*staticvec[i]);
5142
5143 for (bind = specpdl; bind != specpdl_ptr; bind++)
5144 {
5145 mark_object (bind->symbol);
5146 mark_object (bind->old_value);
5147 }
5148 mark_kboards ();
5149
5150#ifdef USE_GTK
5151 {
5152 extern void xg_mark_data ();
5153 xg_mark_data ();
5154 }
5155#endif
5156
5157#if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
5158 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
5159 mark_stack ();
5160#else
5161 {
5162 register struct gcpro *tail;
5163 for (tail = gcprolist; tail; tail = tail->next)
5164 for (i = 0; i < tail->nvars; i++)
5165 mark_object (tail->var[i]);
5166 }
5167#endif
5168
5169 mark_byte_stack ();
5170 for (catch = catchlist; catch; catch = catch->next)
5171 {
5172 mark_object (catch->tag);
5173 mark_object (catch->val);
5174 }
5175 for (handler = handlerlist; handler; handler = handler->next)
5176 {
5177 mark_object (handler->handler);
5178 mark_object (handler->var);
5179 }
5180 mark_backtrace ();
5181
5182#ifdef HAVE_WINDOW_SYSTEM
5183 mark_fringe_data ();
5184#endif
5185
5186#if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5187 mark_stack ();
5188#endif
5189
5190 /* Everything is now marked, except for the things that require special
5191 finalization, i.e. the undo_list.
5192 Look thru every buffer's undo list
5193 for elements that update markers that were not marked,
5194 and delete them. */
5195 {
5196 register struct buffer *nextb = all_buffers;
5197
5198 while (nextb)
5199 {
5200 /* If a buffer's undo list is Qt, that means that undo is
5201 turned off in that buffer. Calling truncate_undo_list on
5202 Qt tends to return NULL, which effectively turns undo back on.
5203 So don't call truncate_undo_list if undo_list is Qt. */
5204 if (! EQ (nextb->undo_list, Qt))
5205 {
5206 Lisp_Object tail, prev;
5207 tail = nextb->undo_list;
5208 prev = Qnil;
5209 while (CONSP (tail))
5210 {
5211 if (GC_CONSP (XCAR (tail))
5212 && GC_MARKERP (XCAR (XCAR (tail)))
5213 && !XMARKER (XCAR (XCAR (tail)))->gcmarkbit)
5214 {
5215 if (NILP (prev))
5216 nextb->undo_list = tail = XCDR (tail);
5217 else
5218 {
5219 tail = XCDR (tail);
5220 XSETCDR (prev, tail);
5221 }
5222 }
5223 else
5224 {
5225 prev = tail;
5226 tail = XCDR (tail);
5227 }
5228 }
5229 }
5230 /* Now that we have stripped the elements that need not be in the
5231 undo_list any more, we can finally mark the list. */
5232 mark_object (nextb->undo_list);
5233
5234 nextb = nextb->next;
5235 }
5236 }
5237
5238 gc_sweep ();
5239
5240 /* Clear the mark bits that we set in certain root slots. */
5241
5242 unmark_byte_stack ();
5243 VECTOR_UNMARK (&buffer_defaults);
5244 VECTOR_UNMARK (&buffer_local_symbols);
5245
5246#if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES && 0
5247 dump_zombies ();
5248#endif
5249
5250 UNBLOCK_INPUT;
5251
5252 CHECK_CONS_LIST ();
5253
5254 /* clear_marks (); */
5255 gc_in_progress = 0;
5256
5257 consing_since_gc = 0;
5258 if (gc_cons_threshold < 10000)
5259 gc_cons_threshold = 10000;
5260
5261 if (FLOATP (Vgc_cons_percentage))
5262 { /* Set gc_cons_combined_threshold. */
5263 EMACS_INT total = 0;
5264
5265 total += total_conses * sizeof (struct Lisp_Cons);
5266 total += total_symbols * sizeof (struct Lisp_Symbol);
5267 total += total_markers * sizeof (union Lisp_Misc);
5268 total += total_string_size;
5269 total += total_vector_size * sizeof (Lisp_Object);
5270 total += total_floats * sizeof (struct Lisp_Float);
5271 total += total_intervals * sizeof (struct interval);
5272 total += total_strings * sizeof (struct Lisp_String);
5273
5274 gc_relative_threshold = total * XFLOAT_DATA (Vgc_cons_percentage);
5275 }
5276 else
5277 gc_relative_threshold = 0;
5278
5279 if (garbage_collection_messages)
5280 {
5281 if (message_p || minibuf_level > 0)
5282 restore_message ();
5283 else
5284 message1_nolog ("Garbage collecting...done");
5285 }
5286
5287 unbind_to (count, Qnil);
5288
5289 total[0] = Fcons (make_number (total_conses),
5290 make_number (total_free_conses));
5291 total[1] = Fcons (make_number (total_symbols),
5292 make_number (total_free_symbols));
5293 total[2] = Fcons (make_number (total_markers),
5294 make_number (total_free_markers));
5295 total[3] = make_number (total_string_size);
5296 total[4] = make_number (total_vector_size);
5297 total[5] = Fcons (make_number (total_floats),
5298 make_number (total_free_floats));
5299 total[6] = Fcons (make_number (total_intervals),
5300 make_number (total_free_intervals));
5301 total[7] = Fcons (make_number (total_strings),
5302 make_number (total_free_strings));
5303
5304#if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
5305 {
5306 /* Compute average percentage of zombies. */
5307 double nlive = 0;
5308
5309 for (i = 0; i < 7; ++i)
5310 if (CONSP (total[i]))
5311 nlive += XFASTINT (XCAR (total[i]));
5312
5313 avg_live = (avg_live * ngcs + nlive) / (ngcs + 1);
5314 max_live = max (nlive, max_live);
5315 avg_zombies = (avg_zombies * ngcs + nzombies) / (ngcs + 1);
5316 max_zombies = max (nzombies, max_zombies);
5317 ++ngcs;
5318 }
5319#endif
5320
5321 if (!NILP (Vpost_gc_hook))
5322 {
5323 int count = inhibit_garbage_collection ();
5324 safe_run_hooks (Qpost_gc_hook);
5325 unbind_to (count, Qnil);
5326 }
5327
5328 /* Accumulate statistics. */
5329 EMACS_GET_TIME (t2);
5330 EMACS_SUB_TIME (t3, t2, t1);
5331 if (FLOATP (Vgc_elapsed))
5332 Vgc_elapsed = make_float (XFLOAT_DATA (Vgc_elapsed) +
5333 EMACS_SECS (t3) +
5334 EMACS_USECS (t3) * 1.0e-6);
5335 gcs_done++;
5336
5337 return Flist (sizeof total / sizeof *total, total);
5338}
5339
5340
5341/* Mark Lisp objects in glyph matrix MATRIX. Currently the
5342 only interesting objects referenced from glyphs are strings. */
5343
5344static void
5345mark_glyph_matrix (matrix)
5346 struct glyph_matrix *matrix;
5347{
5348 struct glyph_row *row = matrix->rows;
5349 struct glyph_row *end = row + matrix->nrows;
5350
5351 for (; row < end; ++row)
5352 if (row->enabled_p)
5353 {
5354 int area;
5355 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
5356 {
5357 struct glyph *glyph = row->glyphs[area];
5358 struct glyph *end_glyph = glyph + row->used[area];
5359
5360 for (; glyph < end_glyph; ++glyph)
5361 if (GC_STRINGP (glyph->object)
5362 && !STRING_MARKED_P (XSTRING (glyph->object)))
5363 mark_object (glyph->object);
5364 }
5365 }
5366}
5367
5368
5369/* Mark Lisp faces in the face cache C. */
5370
5371static void
5372mark_face_cache (c)
5373 struct face_cache *c;
5374{
5375 if (c)
5376 {
5377 int i, j;
5378 for (i = 0; i < c->used; ++i)
5379 {
5380 struct face *face = FACE_FROM_ID (c->f, i);
5381
5382 if (face)
5383 {
5384 for (j = 0; j < LFACE_VECTOR_SIZE; ++j)
5385 mark_object (face->lface[j]);
5386 }
5387 }
5388 }
5389}
5390
5391
5392#ifdef HAVE_WINDOW_SYSTEM
5393
5394/* Mark Lisp objects in image IMG. */
5395
5396static void
5397mark_image (img)
5398 struct image *img;
5399{
5400 mark_object (img->spec);
5401
5402 if (!NILP (img->data.lisp_val))
5403 mark_object (img->data.lisp_val);
5404}
5405
5406
5407/* Mark Lisp objects in image cache of frame F. It's done this way so
5408 that we don't have to include xterm.h here. */
5409
5410static void
5411mark_image_cache (f)
5412 struct frame *f;
5413{
5414 forall_images_in_image_cache (f, mark_image);
5415}
5416
5417#endif /* HAVE_X_WINDOWS */
5418
5419
5420\f
5421/* Mark reference to a Lisp_Object.
5422 If the object referred to has not been seen yet, recursively mark
5423 all the references contained in it. */
5424
5425#define LAST_MARKED_SIZE 500
5426Lisp_Object last_marked[LAST_MARKED_SIZE];
5427int last_marked_index;
5428
5429/* For debugging--call abort when we cdr down this many
5430 links of a list, in mark_object. In debugging,
5431 the call to abort will hit a breakpoint.
5432 Normally this is zero and the check never goes off. */
5433int mark_object_loop_halt;
5434
5435void
5436mark_object (arg)
5437 Lisp_Object arg;
5438{
5439 register Lisp_Object obj = arg;
5440#ifdef GC_CHECK_MARKED_OBJECTS
5441 void *po;
5442 struct mem_node *m;
5443#endif
5444 int cdr_count = 0;
5445
5446 loop:
5447
5448 if (PURE_POINTER_P (XPNTR (obj)))
5449 return;
5450
5451 last_marked[last_marked_index++] = obj;
5452 if (last_marked_index == LAST_MARKED_SIZE)
5453 last_marked_index = 0;
5454
5455 /* Perform some sanity checks on the objects marked here. Abort if
5456 we encounter an object we know is bogus. This increases GC time
5457 by ~80%, and requires compilation with GC_MARK_STACK != 0. */
5458#ifdef GC_CHECK_MARKED_OBJECTS
5459
5460 po = (void *) XPNTR (obj);
5461
5462 /* Check that the object pointed to by PO is known to be a Lisp
5463 structure allocated from the heap. */
5464#define CHECK_ALLOCATED() \
5465 do { \
5466 m = mem_find (po); \
5467 if (m == MEM_NIL) \
5468 abort (); \
5469 } while (0)
5470
5471 /* Check that the object pointed to by PO is live, using predicate
5472 function LIVEP. */
5473#define CHECK_LIVE(LIVEP) \
5474 do { \
5475 if (!LIVEP (m, po)) \
5476 abort (); \
5477 } while (0)
5478
5479 /* Check both of the above conditions. */
5480#define CHECK_ALLOCATED_AND_LIVE(LIVEP) \
5481 do { \
5482 CHECK_ALLOCATED (); \
5483 CHECK_LIVE (LIVEP); \
5484 } while (0) \
5485
5486#else /* not GC_CHECK_MARKED_OBJECTS */
5487
5488#define CHECK_ALLOCATED() (void) 0
5489#define CHECK_LIVE(LIVEP) (void) 0
5490#define CHECK_ALLOCATED_AND_LIVE(LIVEP) (void) 0
5491
5492#endif /* not GC_CHECK_MARKED_OBJECTS */
5493
5494 switch (SWITCH_ENUM_CAST (XGCTYPE (obj)))
5495 {
5496 case Lisp_String:
5497 {
5498 register struct Lisp_String *ptr = XSTRING (obj);
5499 CHECK_ALLOCATED_AND_LIVE (live_string_p);
5500 MARK_INTERVAL_TREE (ptr->intervals);
5501 MARK_STRING (ptr);
5502#ifdef GC_CHECK_STRING_BYTES
5503 /* Check that the string size recorded in the string is the
5504 same as the one recorded in the sdata structure. */
5505 CHECK_STRING_BYTES (ptr);
5506#endif /* GC_CHECK_STRING_BYTES */
5507 }
5508 break;
5509
5510 case Lisp_Vectorlike:
5511#ifdef GC_CHECK_MARKED_OBJECTS
5512 m = mem_find (po);
5513 if (m == MEM_NIL && !GC_SUBRP (obj)
5514 && po != &buffer_defaults
5515 && po != &buffer_local_symbols)
5516 abort ();
5517#endif /* GC_CHECK_MARKED_OBJECTS */
5518
5519 if (GC_BUFFERP (obj))
5520 {
5521 if (!VECTOR_MARKED_P (XBUFFER (obj)))
5522 {
5523#ifdef GC_CHECK_MARKED_OBJECTS
5524 if (po != &buffer_defaults && po != &buffer_local_symbols)
5525 {
5526 struct buffer *b;
5527 for (b = all_buffers; b && b != po; b = b->next)
5528 ;
5529 if (b == NULL)
5530 abort ();
5531 }
5532#endif /* GC_CHECK_MARKED_OBJECTS */
5533 mark_buffer (obj);
5534 }
5535 }
5536 else if (GC_SUBRP (obj))
5537 break;
5538 else if (GC_COMPILEDP (obj))
5539 /* We could treat this just like a vector, but it is better to
5540 save the COMPILED_CONSTANTS element for last and avoid
5541 recursion there. */
5542 {
5543 register struct Lisp_Vector *ptr = XVECTOR (obj);
5544 register EMACS_INT size = ptr->size;
5545 register int i;
5546
5547 if (VECTOR_MARKED_P (ptr))
5548 break; /* Already marked */
5549
5550 CHECK_LIVE (live_vector_p);
5551 VECTOR_MARK (ptr); /* Else mark it */
5552 size &= PSEUDOVECTOR_SIZE_MASK;
5553 for (i = 0; i < size; i++) /* and then mark its elements */
5554 {
5555 if (i != COMPILED_CONSTANTS)
5556 mark_object (ptr->contents[i]);
5557 }
5558 obj = ptr->contents[COMPILED_CONSTANTS];
5559 goto loop;
5560 }
5561 else if (GC_FRAMEP (obj))
5562 {
5563 register struct frame *ptr = XFRAME (obj);
5564
5565 if (VECTOR_MARKED_P (ptr)) break; /* Already marked */
5566 VECTOR_MARK (ptr); /* Else mark it */
5567
5568 CHECK_LIVE (live_vector_p);
5569 mark_object (ptr->name);
5570 mark_object (ptr->icon_name);
5571 mark_object (ptr->title);
5572 mark_object (ptr->focus_frame);
5573 mark_object (ptr->selected_window);
5574 mark_object (ptr->minibuffer_window);
5575 mark_object (ptr->param_alist);
5576 mark_object (ptr->scroll_bars);
5577 mark_object (ptr->condemned_scroll_bars);
5578 mark_object (ptr->menu_bar_items);
5579 mark_object (ptr->face_alist);
5580 mark_object (ptr->menu_bar_vector);
5581 mark_object (ptr->buffer_predicate);
5582 mark_object (ptr->buffer_list);
5583 mark_object (ptr->menu_bar_window);
5584 mark_object (ptr->tool_bar_window);
5585 mark_face_cache (ptr->face_cache);
5586#ifdef HAVE_WINDOW_SYSTEM
5587 mark_image_cache (ptr);
5588 mark_object (ptr->tool_bar_items);
5589 mark_object (ptr->desired_tool_bar_string);
5590 mark_object (ptr->current_tool_bar_string);
5591#endif /* HAVE_WINDOW_SYSTEM */
5592 }
5593 else if (GC_BOOL_VECTOR_P (obj))
5594 {
5595 register struct Lisp_Vector *ptr = XVECTOR (obj);
5596
5597 if (VECTOR_MARKED_P (ptr))
5598 break; /* Already marked */
5599 CHECK_LIVE (live_vector_p);
5600 VECTOR_MARK (ptr); /* Else mark it */
5601 }
5602 else if (GC_WINDOWP (obj))
5603 {
5604 register struct Lisp_Vector *ptr = XVECTOR (obj);
5605 struct window *w = XWINDOW (obj);
5606 register int i;
5607
5608 /* Stop if already marked. */
5609 if (VECTOR_MARKED_P (ptr))
5610 break;
5611
5612 /* Mark it. */
5613 CHECK_LIVE (live_vector_p);
5614 VECTOR_MARK (ptr);
5615
5616 /* There is no Lisp data above The member CURRENT_MATRIX in
5617 struct WINDOW. Stop marking when that slot is reached. */
5618 for (i = 0;
5619 (char *) &ptr->contents[i] < (char *) &w->current_matrix;
5620 i++)
5621 mark_object (ptr->contents[i]);
5622
5623 /* Mark glyphs for leaf windows. Marking window matrices is
5624 sufficient because frame matrices use the same glyph
5625 memory. */
5626 if (NILP (w->hchild)
5627 && NILP (w->vchild)
5628 && w->current_matrix)
5629 {
5630 mark_glyph_matrix (w->current_matrix);
5631 mark_glyph_matrix (w->desired_matrix);
5632 }
5633 }
5634 else if (GC_HASH_TABLE_P (obj))
5635 {
5636 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
5637
5638 /* Stop if already marked. */
5639 if (VECTOR_MARKED_P (h))
5640 break;
5641
5642 /* Mark it. */
5643 CHECK_LIVE (live_vector_p);
5644 VECTOR_MARK (h);
5645
5646 /* Mark contents. */
5647 /* Do not mark next_free or next_weak.
5648 Being in the next_weak chain
5649 should not keep the hash table alive.
5650 No need to mark `count' since it is an integer. */
5651 mark_object (h->test);
5652 mark_object (h->weak);
5653 mark_object (h->rehash_size);
5654 mark_object (h->rehash_threshold);
5655 mark_object (h->hash);
5656 mark_object (h->next);
5657 mark_object (h->index);
5658 mark_object (h->user_hash_function);
5659 mark_object (h->user_cmp_function);
5660
5661 /* If hash table is not weak, mark all keys and values.
5662 For weak tables, mark only the vector. */
5663 if (GC_NILP (h->weak))
5664 mark_object (h->key_and_value);
5665 else
5666 VECTOR_MARK (XVECTOR (h->key_and_value));
5667 }
5668 else
5669 {
5670 register struct Lisp_Vector *ptr = XVECTOR (obj);
5671 register EMACS_INT size = ptr->size;
5672 register int i;
5673
5674 if (VECTOR_MARKED_P (ptr)) break; /* Already marked */
5675 CHECK_LIVE (live_vector_p);
5676 VECTOR_MARK (ptr); /* Else mark it */
5677 if (size & PSEUDOVECTOR_FLAG)
5678 size &= PSEUDOVECTOR_SIZE_MASK;
5679
5680 /* Note that this size is not the memory-footprint size, but only
5681 the number of Lisp_Object fields that we should trace.
5682 The distinction is used e.g. by Lisp_Process which places extra
5683 non-Lisp_Object fields at the end of the structure. */
5684 for (i = 0; i < size; i++) /* and then mark its elements */
5685 mark_object (ptr->contents[i]);
5686 }
5687 break;
5688
5689 case Lisp_Symbol:
5690 {
5691 register struct Lisp_Symbol *ptr = XSYMBOL (obj);
5692 struct Lisp_Symbol *ptrx;
5693
5694 if (ptr->gcmarkbit) break;
5695 CHECK_ALLOCATED_AND_LIVE (live_symbol_p);
5696 ptr->gcmarkbit = 1;
5697 mark_object (ptr->value);
5698 mark_object (ptr->function);
5699 mark_object (ptr->plist);
5700
5701 if (!PURE_POINTER_P (XSTRING (ptr->xname)))
5702 MARK_STRING (XSTRING (ptr->xname));
5703 MARK_INTERVAL_TREE (STRING_INTERVALS (ptr->xname));
5704
5705 /* Note that we do not mark the obarray of the symbol.
5706 It is safe not to do so because nothing accesses that
5707 slot except to check whether it is nil. */
5708 ptr = ptr->next;
5709 if (ptr)
5710 {
5711 ptrx = ptr; /* Use of ptrx avoids compiler bug on Sun */
5712 XSETSYMBOL (obj, ptrx);
5713 goto loop;
5714 }
5715 }
5716 break;
5717
5718 case Lisp_Misc:
5719 CHECK_ALLOCATED_AND_LIVE (live_misc_p);
5720 if (XMARKER (obj)->gcmarkbit)
5721 break;
5722 XMARKER (obj)->gcmarkbit = 1;
5723
5724 switch (XMISCTYPE (obj))
5725 {
5726 case Lisp_Misc_Buffer_Local_Value:
5727 case Lisp_Misc_Some_Buffer_Local_Value:
5728 {
5729 register struct Lisp_Buffer_Local_Value *ptr
5730 = XBUFFER_LOCAL_VALUE (obj);
5731 /* If the cdr is nil, avoid recursion for the car. */
5732 if (EQ (ptr->cdr, Qnil))
5733 {
5734 obj = ptr->realvalue;
5735 goto loop;
5736 }
5737 mark_object (ptr->realvalue);
5738 mark_object (ptr->buffer);
5739 mark_object (ptr->frame);
5740 obj = ptr->cdr;
5741 goto loop;
5742 }
5743
5744 case Lisp_Misc_Marker:
5745 /* DO NOT mark thru the marker's chain.
5746 The buffer's markers chain does not preserve markers from gc;
5747 instead, markers are removed from the chain when freed by gc. */
5748 break;
5749
5750 case Lisp_Misc_Intfwd:
5751 case Lisp_Misc_Boolfwd:
5752 case Lisp_Misc_Objfwd:
5753 case Lisp_Misc_Buffer_Objfwd:
5754 case Lisp_Misc_Kboard_Objfwd:
5755 /* Don't bother with Lisp_Buffer_Objfwd,
5756 since all markable slots in current buffer marked anyway. */
5757 /* Don't need to do Lisp_Objfwd, since the places they point
5758 are protected with staticpro. */
5759 break;
5760
5761 case Lisp_Misc_Save_Value:
5762#if GC_MARK_STACK
5763 {
5764 register struct Lisp_Save_Value *ptr = XSAVE_VALUE (obj);
5765 /* If DOGC is set, POINTER is the address of a memory
5766 area containing INTEGER potential Lisp_Objects. */
5767 if (ptr->dogc)
5768 {
5769 Lisp_Object *p = (Lisp_Object *) ptr->pointer;
5770 int nelt;
5771 for (nelt = ptr->integer; nelt > 0; nelt--, p++)
5772 mark_maybe_object (*p);
5773 }
5774 }
5775#endif
5776 break;
5777
5778 case Lisp_Misc_Overlay:
5779 {
5780 struct Lisp_Overlay *ptr = XOVERLAY (obj);
5781 mark_object (ptr->start);
5782 mark_object (ptr->end);
5783 mark_object (ptr->plist);
5784 if (ptr->next)
5785 {
5786 XSETMISC (obj, ptr->next);
5787 goto loop;
5788 }
5789 }
5790 break;
5791
5792 default:
5793 abort ();
5794 }
5795 break;
5796
5797 case Lisp_Cons:
5798 {
5799 register struct Lisp_Cons *ptr = XCONS (obj);
5800 if (CONS_MARKED_P (ptr)) break;
5801 CHECK_ALLOCATED_AND_LIVE (live_cons_p);
5802 CONS_MARK (ptr);
5803 /* If the cdr is nil, avoid recursion for the car. */
5804 if (EQ (ptr->u.cdr, Qnil))
5805 {
5806 obj = ptr->car;
5807 cdr_count = 0;
5808 goto loop;
5809 }
5810 mark_object (ptr->car);
5811 obj = ptr->u.cdr;
5812 cdr_count++;
5813 if (cdr_count == mark_object_loop_halt)
5814 abort ();
5815 goto loop;
5816 }
5817
5818 case Lisp_Float:
5819 CHECK_ALLOCATED_AND_LIVE (live_float_p);
5820 FLOAT_MARK (XFLOAT (obj));
5821 break;
5822
5823 case Lisp_Int:
5824 break;
5825
5826 default:
5827 abort ();
5828 }
5829
5830#undef CHECK_LIVE
5831#undef CHECK_ALLOCATED
5832#undef CHECK_ALLOCATED_AND_LIVE
5833}
5834
5835/* Mark the pointers in a buffer structure. */
5836
5837static void
5838mark_buffer (buf)
5839 Lisp_Object buf;
5840{
5841 register struct buffer *buffer = XBUFFER (buf);
5842 register Lisp_Object *ptr, tmp;
5843 Lisp_Object base_buffer;
5844
5845 VECTOR_MARK (buffer);
5846
5847 MARK_INTERVAL_TREE (BUF_INTERVALS (buffer));
5848
5849 /* For now, we just don't mark the undo_list. It's done later in
5850 a special way just before the sweep phase, and after stripping
5851 some of its elements that are not needed any more. */
5852
5853 if (buffer->overlays_before)
5854 {
5855 XSETMISC (tmp, buffer->overlays_before);
5856 mark_object (tmp);
5857 }
5858 if (buffer->overlays_after)
5859 {
5860 XSETMISC (tmp, buffer->overlays_after);
5861 mark_object (tmp);
5862 }
5863
5864 for (ptr = &buffer->name;
5865 (char *)ptr < (char *)buffer + sizeof (struct buffer);
5866 ptr++)
5867 mark_object (*ptr);
5868
5869 /* If this is an indirect buffer, mark its base buffer. */
5870 if (buffer->base_buffer && !VECTOR_MARKED_P (buffer->base_buffer))
5871 {
5872 XSETBUFFER (base_buffer, buffer->base_buffer);
5873 mark_buffer (base_buffer);
5874 }
5875}
5876
5877
5878/* Value is non-zero if OBJ will survive the current GC because it's
5879 either marked or does not need to be marked to survive. */
5880
5881int
5882survives_gc_p (obj)
5883 Lisp_Object obj;
5884{
5885 int survives_p;
5886
5887 switch (XGCTYPE (obj))
5888 {
5889 case Lisp_Int:
5890 survives_p = 1;
5891 break;
5892
5893 case Lisp_Symbol:
5894 survives_p = XSYMBOL (obj)->gcmarkbit;
5895 break;
5896
5897 case Lisp_Misc:
5898 survives_p = XMARKER (obj)->gcmarkbit;
5899 break;
5900
5901 case Lisp_String:
5902 survives_p = STRING_MARKED_P (XSTRING (obj));
5903 break;
5904
5905 case Lisp_Vectorlike:
5906 survives_p = GC_SUBRP (obj) || VECTOR_MARKED_P (XVECTOR (obj));
5907 break;
5908
5909 case Lisp_Cons:
5910 survives_p = CONS_MARKED_P (XCONS (obj));
5911 break;
5912
5913 case Lisp_Float:
5914 survives_p = FLOAT_MARKED_P (XFLOAT (obj));
5915 break;
5916
5917 default:
5918 abort ();
5919 }
5920
5921 return survives_p || PURE_POINTER_P ((void *) XPNTR (obj));
5922}
5923
5924
5925\f
5926/* Sweep: find all structures not marked, and free them. */
5927
5928static void
5929gc_sweep ()
5930{
5931 /* Remove or mark entries in weak hash tables.
5932 This must be done before any object is unmarked. */
5933 sweep_weak_hash_tables ();
5934
5935 sweep_strings ();
5936#ifdef GC_CHECK_STRING_BYTES
5937 if (!noninteractive)
5938 check_string_bytes (1);
5939#endif
5940
5941 /* Put all unmarked conses on free list */
5942 {
5943 register struct cons_block *cblk;
5944 struct cons_block **cprev = &cons_block;
5945 register int lim = cons_block_index;
5946 register int num_free = 0, num_used = 0;
5947
5948 cons_free_list = 0;
5949
5950 for (cblk = cons_block; cblk; cblk = *cprev)
5951 {
5952 register int i;
5953 int this_free = 0;
5954 for (i = 0; i < lim; i++)
5955 if (!CONS_MARKED_P (&cblk->conses[i]))
5956 {
5957 this_free++;
5958 cblk->conses[i].u.chain = cons_free_list;
5959 cons_free_list = &cblk->conses[i];
5960#if GC_MARK_STACK
5961 cons_free_list->car = Vdead;
5962#endif
5963 }
5964 else
5965 {
5966 num_used++;
5967 CONS_UNMARK (&cblk->conses[i]);
5968 }
5969 lim = CONS_BLOCK_SIZE;
5970 /* If this block contains only free conses and we have already
5971 seen more than two blocks worth of free conses then deallocate
5972 this block. */
5973 if (this_free == CONS_BLOCK_SIZE && num_free > CONS_BLOCK_SIZE)
5974 {
5975 *cprev = cblk->next;
5976 /* Unhook from the free list. */
5977 cons_free_list = cblk->conses[0].u.chain;
5978 lisp_align_free (cblk);
5979 n_cons_blocks--;
5980 }
5981 else
5982 {
5983 num_free += this_free;
5984 cprev = &cblk->next;
5985 }
5986 }
5987 total_conses = num_used;
5988 total_free_conses = num_free;
5989 }
5990
5991 /* Put all unmarked floats on free list */
5992 {
5993 register struct float_block *fblk;
5994 struct float_block **fprev = &float_block;
5995 register int lim = float_block_index;
5996 register int num_free = 0, num_used = 0;
5997
5998 float_free_list = 0;
5999
6000 for (fblk = float_block; fblk; fblk = *fprev)
6001 {
6002 register int i;
6003 int this_free = 0;
6004 for (i = 0; i < lim; i++)
6005 if (!FLOAT_MARKED_P (&fblk->floats[i]))
6006 {
6007 this_free++;
6008 fblk->floats[i].u.chain = float_free_list;
6009 float_free_list = &fblk->floats[i];
6010 }
6011 else
6012 {
6013 num_used++;
6014 FLOAT_UNMARK (&fblk->floats[i]);
6015 }
6016 lim = FLOAT_BLOCK_SIZE;
6017 /* If this block contains only free floats and we have already
6018 seen more than two blocks worth of free floats then deallocate
6019 this block. */
6020 if (this_free == FLOAT_BLOCK_SIZE && num_free > FLOAT_BLOCK_SIZE)
6021 {
6022 *fprev = fblk->next;
6023 /* Unhook from the free list. */
6024 float_free_list = fblk->floats[0].u.chain;
6025 lisp_align_free (fblk);
6026 n_float_blocks--;
6027 }
6028 else
6029 {
6030 num_free += this_free;
6031 fprev = &fblk->next;
6032 }
6033 }
6034 total_floats = num_used;
6035 total_free_floats = num_free;
6036 }
6037
6038 /* Put all unmarked intervals on free list */
6039 {
6040 register struct interval_block *iblk;
6041 struct interval_block **iprev = &interval_block;
6042 register int lim = interval_block_index;
6043 register int num_free = 0, num_used = 0;
6044
6045 interval_free_list = 0;
6046
6047 for (iblk = interval_block; iblk; iblk = *iprev)
6048 {
6049 register int i;
6050 int this_free = 0;
6051
6052 for (i = 0; i < lim; i++)
6053 {
6054 if (!iblk->intervals[i].gcmarkbit)
6055 {
6056 SET_INTERVAL_PARENT (&iblk->intervals[i], interval_free_list);
6057 interval_free_list = &iblk->intervals[i];
6058 this_free++;
6059 }
6060 else
6061 {
6062 num_used++;
6063 iblk->intervals[i].gcmarkbit = 0;
6064 }
6065 }
6066 lim = INTERVAL_BLOCK_SIZE;
6067 /* If this block contains only free intervals and we have already
6068 seen more than two blocks worth of free intervals then
6069 deallocate this block. */
6070 if (this_free == INTERVAL_BLOCK_SIZE && num_free > INTERVAL_BLOCK_SIZE)
6071 {
6072 *iprev = iblk->next;
6073 /* Unhook from the free list. */
6074 interval_free_list = INTERVAL_PARENT (&iblk->intervals[0]);
6075 lisp_free (iblk);
6076 n_interval_blocks--;
6077 }
6078 else
6079 {
6080 num_free += this_free;
6081 iprev = &iblk->next;
6082 }
6083 }
6084 total_intervals = num_used;
6085 total_free_intervals = num_free;
6086 }
6087
6088 /* Put all unmarked symbols on free list */
6089 {
6090 register struct symbol_block *sblk;
6091 struct symbol_block **sprev = &symbol_block;
6092 register int lim = symbol_block_index;
6093 register int num_free = 0, num_used = 0;
6094
6095 symbol_free_list = NULL;
6096
6097 for (sblk = symbol_block; sblk; sblk = *sprev)
6098 {
6099 int this_free = 0;
6100 struct Lisp_Symbol *sym = sblk->symbols;
6101 struct Lisp_Symbol *end = sym + lim;
6102
6103 for (; sym < end; ++sym)
6104 {
6105 /* Check if the symbol was created during loadup. In such a case
6106 it might be pointed to by pure bytecode which we don't trace,
6107 so we conservatively assume that it is live. */
6108 int pure_p = PURE_POINTER_P (XSTRING (sym->xname));
6109
6110 if (!sym->gcmarkbit && !pure_p)
6111 {
6112 sym->next = symbol_free_list;
6113 symbol_free_list = sym;
6114#if GC_MARK_STACK
6115 symbol_free_list->function = Vdead;
6116#endif
6117 ++this_free;
6118 }
6119 else
6120 {
6121 ++num_used;
6122 if (!pure_p)
6123 UNMARK_STRING (XSTRING (sym->xname));
6124 sym->gcmarkbit = 0;
6125 }
6126 }
6127
6128 lim = SYMBOL_BLOCK_SIZE;
6129 /* If this block contains only free symbols and we have already
6130 seen more than two blocks worth of free symbols then deallocate
6131 this block. */
6132 if (this_free == SYMBOL_BLOCK_SIZE && num_free > SYMBOL_BLOCK_SIZE)
6133 {
6134 *sprev = sblk->next;
6135 /* Unhook from the free list. */
6136 symbol_free_list = sblk->symbols[0].next;
6137 lisp_free (sblk);
6138 n_symbol_blocks--;
6139 }
6140 else
6141 {
6142 num_free += this_free;
6143 sprev = &sblk->next;
6144 }
6145 }
6146 total_symbols = num_used;
6147 total_free_symbols = num_free;
6148 }
6149
6150 /* Put all unmarked misc's on free list.
6151 For a marker, first unchain it from the buffer it points into. */
6152 {
6153 register struct marker_block *mblk;
6154 struct marker_block **mprev = &marker_block;
6155 register int lim = marker_block_index;
6156 register int num_free = 0, num_used = 0;
6157
6158 marker_free_list = 0;
6159
6160 for (mblk = marker_block; mblk; mblk = *mprev)
6161 {
6162 register int i;
6163 int this_free = 0;
6164
6165 for (i = 0; i < lim; i++)
6166 {
6167 if (!mblk->markers[i].u_marker.gcmarkbit)
6168 {
6169 if (mblk->markers[i].u_marker.type == Lisp_Misc_Marker)
6170 unchain_marker (&mblk->markers[i].u_marker);
6171 /* Set the type of the freed object to Lisp_Misc_Free.
6172 We could leave the type alone, since nobody checks it,
6173 but this might catch bugs faster. */
6174 mblk->markers[i].u_marker.type = Lisp_Misc_Free;
6175 mblk->markers[i].u_free.chain = marker_free_list;
6176 marker_free_list = &mblk->markers[i];
6177 this_free++;
6178 }
6179 else
6180 {
6181 num_used++;
6182 mblk->markers[i].u_marker.gcmarkbit = 0;
6183 }
6184 }
6185 lim = MARKER_BLOCK_SIZE;
6186 /* If this block contains only free markers and we have already
6187 seen more than two blocks worth of free markers then deallocate
6188 this block. */
6189 if (this_free == MARKER_BLOCK_SIZE && num_free > MARKER_BLOCK_SIZE)
6190 {
6191 *mprev = mblk->next;
6192 /* Unhook from the free list. */
6193 marker_free_list = mblk->markers[0].u_free.chain;
6194 lisp_free (mblk);
6195 n_marker_blocks--;
6196 }
6197 else
6198 {
6199 num_free += this_free;
6200 mprev = &mblk->next;
6201 }
6202 }
6203
6204 total_markers = num_used;
6205 total_free_markers = num_free;
6206 }
6207
6208 /* Free all unmarked buffers */
6209 {
6210 register struct buffer *buffer = all_buffers, *prev = 0, *next;
6211
6212 while (buffer)
6213 if (!VECTOR_MARKED_P (buffer))
6214 {
6215 if (prev)
6216 prev->next = buffer->next;
6217 else
6218 all_buffers = buffer->next;
6219 next = buffer->next;
6220 lisp_free (buffer);
6221 buffer = next;
6222 }
6223 else
6224 {
6225 VECTOR_UNMARK (buffer);
6226 UNMARK_BALANCE_INTERVALS (BUF_INTERVALS (buffer));
6227 prev = buffer, buffer = buffer->next;
6228 }
6229 }
6230
6231 /* Free all unmarked vectors */
6232 {
6233 register struct Lisp_Vector *vector = all_vectors, *prev = 0, *next;
6234 total_vector_size = 0;
6235
6236 while (vector)
6237 if (!VECTOR_MARKED_P (vector))
6238 {
6239 if (prev)
6240 prev->next = vector->next;
6241 else
6242 all_vectors = vector->next;
6243 next = vector->next;
6244 lisp_free (vector);
6245 n_vectors--;
6246 vector = next;
6247
6248 }
6249 else
6250 {
6251 VECTOR_UNMARK (vector);
6252 if (vector->size & PSEUDOVECTOR_FLAG)
6253 total_vector_size += (PSEUDOVECTOR_SIZE_MASK & vector->size);
6254 else
6255 total_vector_size += vector->size;
6256 prev = vector, vector = vector->next;
6257 }
6258 }
6259
6260#ifdef GC_CHECK_STRING_BYTES
6261 if (!noninteractive)
6262 check_string_bytes (1);
6263#endif
6264}
6265
6266
6267
6268\f
6269/* Debugging aids. */
6270
6271DEFUN ("memory-limit", Fmemory_limit, Smemory_limit, 0, 0, 0,
6272 doc: /* Return the address of the last byte Emacs has allocated, divided by 1024.
6273This may be helpful in debugging Emacs's memory usage.
6274We divide the value by 1024 to make sure it fits in a Lisp integer. */)
6275 ()
6276{
6277 Lisp_Object end;
6278
6279 XSETINT (end, (EMACS_INT) sbrk (0) / 1024);
6280
6281 return end;
6282}
6283
6284DEFUN ("memory-use-counts", Fmemory_use_counts, Smemory_use_counts, 0, 0, 0,
6285 doc: /* Return a list of counters that measure how much consing there has been.
6286Each of these counters increments for a certain kind of object.
6287The counters wrap around from the largest positive integer to zero.
6288Garbage collection does not decrease them.
6289The elements of the value are as follows:
6290 (CONSES FLOATS VECTOR-CELLS SYMBOLS STRING-CHARS MISCS INTERVALS STRINGS)
6291All are in units of 1 = one object consed
6292except for VECTOR-CELLS and STRING-CHARS, which count the total length of
6293objects consed.
6294MISCS include overlays, markers, and some internal types.
6295Frames, windows, buffers, and subprocesses count as vectors
6296 (but the contents of a buffer's text do not count here). */)
6297 ()
6298{
6299 Lisp_Object consed[8];
6300
6301 consed[0] = make_number (min (MOST_POSITIVE_FIXNUM, cons_cells_consed));
6302 consed[1] = make_number (min (MOST_POSITIVE_FIXNUM, floats_consed));
6303 consed[2] = make_number (min (MOST_POSITIVE_FIXNUM, vector_cells_consed));
6304 consed[3] = make_number (min (MOST_POSITIVE_FIXNUM, symbols_consed));
6305 consed[4] = make_number (min (MOST_POSITIVE_FIXNUM, string_chars_consed));
6306 consed[5] = make_number (min (MOST_POSITIVE_FIXNUM, misc_objects_consed));
6307 consed[6] = make_number (min (MOST_POSITIVE_FIXNUM, intervals_consed));
6308 consed[7] = make_number (min (MOST_POSITIVE_FIXNUM, strings_consed));
6309
6310 return Flist (8, consed);
6311}
6312
6313int suppress_checking;
6314void
6315die (msg, file, line)
6316 const char *msg;
6317 const char *file;
6318 int line;
6319{
6320 fprintf (stderr, "\r\nEmacs fatal error: %s:%d: %s\r\n",
6321 file, line, msg);
6322 abort ();
6323}
6324\f
6325/* Initialization */
6326
6327void
6328init_alloc_once ()
6329{
6330 /* Used to do Vpurify_flag = Qt here, but Qt isn't set up yet! */
6331 purebeg = PUREBEG;
6332 pure_size = PURESIZE;
6333 pure_bytes_used = 0;
6334 pure_bytes_used_lisp = pure_bytes_used_non_lisp = 0;
6335 pure_bytes_used_before_overflow = 0;
6336
6337 /* Initialize the list of free aligned blocks. */
6338 free_ablock = NULL;
6339
6340#if GC_MARK_STACK || defined GC_MALLOC_CHECK
6341 mem_init ();
6342 Vdead = make_pure_string ("DEAD", 4, 4, 0);
6343#endif
6344
6345 all_vectors = 0;
6346 ignore_warnings = 1;
6347#ifdef DOUG_LEA_MALLOC
6348 mallopt (M_TRIM_THRESHOLD, 128*1024); /* trim threshold */
6349 mallopt (M_MMAP_THRESHOLD, 64*1024); /* mmap threshold */
6350 mallopt (M_MMAP_MAX, MMAP_MAX_AREAS); /* max. number of mmap'ed areas */
6351#endif
6352 init_strings ();
6353 init_cons ();
6354 init_symbol ();
6355 init_marker ();
6356 init_float ();
6357 init_intervals ();
6358
6359#ifdef REL_ALLOC
6360 malloc_hysteresis = 32;
6361#else
6362 malloc_hysteresis = 0;
6363#endif
6364
6365 refill_memory_reserve ();
6366
6367 ignore_warnings = 0;
6368 gcprolist = 0;
6369 byte_stack_list = 0;
6370 staticidx = 0;
6371 consing_since_gc = 0;
6372 gc_cons_threshold = 100000 * sizeof (Lisp_Object);
6373 gc_relative_threshold = 0;
6374
6375#ifdef VIRT_ADDR_VARIES
6376 malloc_sbrk_unused = 1<<22; /* A large number */
6377 malloc_sbrk_used = 100000; /* as reasonable as any number */
6378#endif /* VIRT_ADDR_VARIES */
6379}
6380
6381void
6382init_alloc ()
6383{
6384 gcprolist = 0;
6385 byte_stack_list = 0;
6386#if GC_MARK_STACK
6387#if !defined GC_SAVE_REGISTERS_ON_STACK && !defined GC_SETJMP_WORKS
6388 setjmp_tested_p = longjmps_done = 0;
6389#endif
6390#endif
6391 Vgc_elapsed = make_float (0.0);
6392 gcs_done = 0;
6393}
6394
6395void
6396syms_of_alloc ()
6397{
6398 DEFVAR_INT ("gc-cons-threshold", &gc_cons_threshold,
6399 doc: /* *Number of bytes of consing between garbage collections.
6400Garbage collection can happen automatically once this many bytes have been
6401allocated since the last garbage collection. All data types count.
6402
6403Garbage collection happens automatically only when `eval' is called.
6404
6405By binding this temporarily to a large number, you can effectively
6406prevent garbage collection during a part of the program.
6407See also `gc-cons-percentage'. */);
6408
6409 DEFVAR_LISP ("gc-cons-percentage", &Vgc_cons_percentage,
6410 doc: /* *Portion of the heap used for allocation.
6411Garbage collection can happen automatically once this portion of the heap
6412has been allocated since the last garbage collection.
6413If this portion is smaller than `gc-cons-threshold', this is ignored. */);
6414 Vgc_cons_percentage = make_float (0.1);
6415
6416 DEFVAR_INT ("pure-bytes-used", &pure_bytes_used,
6417 doc: /* Number of bytes of sharable Lisp data allocated so far. */);
6418
6419 DEFVAR_INT ("cons-cells-consed", &cons_cells_consed,
6420 doc: /* Number of cons cells that have been consed so far. */);
6421
6422 DEFVAR_INT ("floats-consed", &floats_consed,
6423 doc: /* Number of floats that have been consed so far. */);
6424
6425 DEFVAR_INT ("vector-cells-consed", &vector_cells_consed,
6426 doc: /* Number of vector cells that have been consed so far. */);
6427
6428 DEFVAR_INT ("symbols-consed", &symbols_consed,
6429 doc: /* Number of symbols that have been consed so far. */);
6430
6431 DEFVAR_INT ("string-chars-consed", &string_chars_consed,
6432 doc: /* Number of string characters that have been consed so far. */);
6433
6434 DEFVAR_INT ("misc-objects-consed", &misc_objects_consed,
6435 doc: /* Number of miscellaneous objects that have been consed so far. */);
6436
6437 DEFVAR_INT ("intervals-consed", &intervals_consed,
6438 doc: /* Number of intervals that have been consed so far. */);
6439
6440 DEFVAR_INT ("strings-consed", &strings_consed,
6441 doc: /* Number of strings that have been consed so far. */);
6442
6443 DEFVAR_LISP ("purify-flag", &Vpurify_flag,
6444 doc: /* Non-nil means loading Lisp code in order to dump an executable.
6445This means that certain objects should be allocated in shared (pure) space. */);
6446
6447 DEFVAR_BOOL ("garbage-collection-messages", &garbage_collection_messages,
6448 doc: /* Non-nil means display messages at start and end of garbage collection. */);
6449 garbage_collection_messages = 0;
6450
6451 DEFVAR_LISP ("post-gc-hook", &Vpost_gc_hook,
6452 doc: /* Hook run after garbage collection has finished. */);
6453 Vpost_gc_hook = Qnil;
6454 Qpost_gc_hook = intern ("post-gc-hook");
6455 staticpro (&Qpost_gc_hook);
6456
6457 DEFVAR_LISP ("memory-signal-data", &Vmemory_signal_data,
6458 doc: /* Precomputed `signal' argument for memory-full error. */);
6459 /* We build this in advance because if we wait until we need it, we might
6460 not be able to allocate the memory to hold it. */
6461 Vmemory_signal_data
6462 = list2 (Qerror,
6463 build_string ("Memory exhausted--use M-x save-some-buffers then exit and restart Emacs"));
6464
6465 DEFVAR_LISP ("memory-full", &Vmemory_full,
6466 doc: /* Non-nil means Emacs cannot get much more Lisp memory. */);
6467 Vmemory_full = Qnil;
6468
6469 staticpro (&Qgc_cons_threshold);
6470 Qgc_cons_threshold = intern ("gc-cons-threshold");
6471
6472 staticpro (&Qchar_table_extra_slots);
6473 Qchar_table_extra_slots = intern ("char-table-extra-slots");
6474
6475 DEFVAR_LISP ("gc-elapsed", &Vgc_elapsed,
6476 doc: /* Accumulated time elapsed in garbage collections.
6477The time is in seconds as a floating point value. */);
6478 DEFVAR_INT ("gcs-done", &gcs_done,
6479 doc: /* Accumulated number of garbage collections done. */);
6480
6481 defsubr (&Scons);
6482 defsubr (&Slist);
6483 defsubr (&Svector);
6484 defsubr (&Smake_byte_code);
6485 defsubr (&Smake_list);
6486 defsubr (&Smake_vector);
6487 defsubr (&Smake_char_table);
6488 defsubr (&Smake_string);
6489 defsubr (&Smake_bool_vector);
6490 defsubr (&Smake_symbol);
6491 defsubr (&Smake_marker);
6492 defsubr (&Spurecopy);
6493 defsubr (&Sgarbage_collect);
6494 defsubr (&Smemory_limit);
6495 defsubr (&Smemory_use_counts);
6496
6497#if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
6498 defsubr (&Sgc_status);
6499#endif
6500}
6501
6502/* arch-tag: 6695ca10-e3c5-4c2c-8bc3-ed26a7dda857
6503 (do not change this comment) */