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