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