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