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