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