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