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