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