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