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