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