1 /* Storage allocation and gc for XEmacs Lisp interpreter.
2 Copyright (C) 1985-1998 Free Software Foundation, Inc.
3 Copyright (C) 1995 Sun Microsystems, Inc.
4 Copyright (C) 1995, 1996 Ben Wing.
6 This file is part of XEmacs.
8 XEmacs is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 2, or (at your option) any
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with XEmacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 /* Synched up with: FSF 19.28, Mule 2.0. Substantially different from
28 FSF: Original version; a long time ago.
29 Mly: Significantly rewritten to use new 3-bit tags and
30 nicely abstracted object definitions, for 19.8.
31 JWZ: Improved code to keep track of purespace usage and
32 issue nice purespace and GC stats.
33 Ben Wing: Cleaned up frob-block lrecord code, added error-checking
34 and various changes for Mule, for 19.12.
35 Added bit vectors for 19.13.
36 Added lcrecord lists for 19.14.
37 slb: Lots of work on the purification and dump time code.
38 Synched Doug Lea malloc support from Emacs 20.2.
39 og: Killed the purespace. Portable dumper.
45 #include "backtrace.h"
56 #include "redisplay.h"
57 #include "specifier.h"
60 #include "console-stream.h"
62 #ifdef DOUG_LEA_MALLOC
74 const struct lrecord_description *desc;
78 static char *pdump_rt_list = 0;
81 EXFUN (Fgarbage_collect, 0);
83 /* Return the true size of a struct with a variable-length array field. */
84 #define STRETCHY_STRUCT_SIZEOF(stretchy_struct_type, \
85 stretchy_array_field, \
86 stretchy_array_length) \
87 (offsetof (stretchy_struct_type, stretchy_array_field) + \
88 (offsetof (stretchy_struct_type, stretchy_array_field[1]) - \
89 offsetof (stretchy_struct_type, stretchy_array_field[0])) * \
90 (stretchy_array_length))
92 #if 0 /* this is _way_ too slow to be part of the standard debug options */
93 #if defined(DEBUG_XEMACS) && defined(MULE)
94 #define VERIFY_STRING_CHARS_INTEGRITY
98 /* Define this to use malloc/free with no freelist for all datatypes,
99 the hope being that some debugging tools may help detect
100 freed memory references */
101 #ifdef USE_DEBUG_MALLOC /* Taking the above comment at face value -slb */
103 #define ALLOC_NO_POOLS
107 static int debug_allocation;
108 static int debug_allocation_backtrace_length;
111 /* Number of bytes of consing done since the last gc */
112 EMACS_INT consing_since_gc;
113 #define INCREMENT_CONS_COUNTER_1(size) (consing_since_gc += (size))
115 #define debug_allocation_backtrace() \
117 if (debug_allocation_backtrace_length > 0) \
118 debug_short_backtrace (debug_allocation_backtrace_length); \
122 #define INCREMENT_CONS_COUNTER(foosize, type) \
124 if (debug_allocation) \
126 stderr_out ("allocating %s (size %ld)\n", type, (long)foosize); \
127 debug_allocation_backtrace (); \
129 INCREMENT_CONS_COUNTER_1 (foosize); \
131 #define NOSEEUM_INCREMENT_CONS_COUNTER(foosize, type) \
133 if (debug_allocation > 1) \
135 stderr_out ("allocating noseeum %s (size %ld)\n", type, (long)foosize); \
136 debug_allocation_backtrace (); \
138 INCREMENT_CONS_COUNTER_1 (foosize); \
141 #define INCREMENT_CONS_COUNTER(size, type) INCREMENT_CONS_COUNTER_1 (size)
142 #define NOSEEUM_INCREMENT_CONS_COUNTER(size, type) \
143 INCREMENT_CONS_COUNTER_1 (size)
146 #define DECREMENT_CONS_COUNTER(size) do { \
147 consing_since_gc -= (size); \
148 if (consing_since_gc < 0) \
149 consing_since_gc = 0; \
152 /* Number of bytes of consing since gc before another gc should be done. */
153 EMACS_INT gc_cons_threshold;
155 /* Nonzero during gc */
158 /* Number of times GC has happened at this level or below.
159 * Level 0 is most volatile, contrary to usual convention.
160 * (Of course, there's only one level at present) */
161 EMACS_INT gc_generation_number[1];
163 /* This is just for use by the printer, to allow things to print uniquely */
164 static int lrecord_uid_counter;
166 /* Nonzero when calling certain hooks or doing other things where
168 int gc_currently_forbidden;
171 Lisp_Object Vpre_gc_hook, Qpre_gc_hook;
172 Lisp_Object Vpost_gc_hook, Qpost_gc_hook;
174 /* "Garbage collecting" */
175 Lisp_Object Vgc_message;
176 Lisp_Object Vgc_pointer_glyph;
177 static CONST char gc_default_message[] = "Garbage collecting";
178 Lisp_Object Qgarbage_collecting;
180 #ifndef VIRT_ADDR_VARIES
182 #endif /* VIRT_ADDR_VARIES */
183 EMACS_INT malloc_sbrk_used;
185 #ifndef VIRT_ADDR_VARIES
187 #endif /* VIRT_ADDR_VARIES */
188 EMACS_INT malloc_sbrk_unused;
190 /* Non-zero means we're in the process of doing the dump */
193 #ifdef ERROR_CHECK_TYPECHECK
195 Error_behavior ERROR_ME, ERROR_ME_NOT, ERROR_ME_WARN;
200 c_readonly (Lisp_Object obj)
202 return POINTER_TYPE_P (XTYPE (obj)) && C_READONLY (obj);
206 lisp_readonly (Lisp_Object obj)
208 return POINTER_TYPE_P (XTYPE (obj)) && LISP_READONLY (obj);
212 /* Maximum amount of C stack to save when a GC happens. */
214 #ifndef MAX_SAVE_STACK
215 #define MAX_SAVE_STACK 0 /* 16000 */
218 /* Non-zero means ignore malloc warnings. Set during initialization. */
219 int ignore_malloc_warnings;
222 static void *breathing_space;
225 release_breathing_space (void)
229 void *tmp = breathing_space;
235 /* malloc calls this if it finds we are near exhausting storage */
237 malloc_warning (CONST char *str)
239 if (ignore_malloc_warnings)
245 "Killing some buffers may delay running out of memory.\n"
246 "However, certainly by the time you receive the 95%% warning,\n"
247 "you should clean up, kill this Emacs, and start a new one.",
251 /* Called if malloc returns zero */
255 /* Force a GC next time eval is called.
256 It's better to loop garbage-collecting (we might reclaim enough
257 to win) than to loop beeping and barfing "Memory exhausted"
259 consing_since_gc = gc_cons_threshold + 1;
260 release_breathing_space ();
262 /* Flush some histories which might conceivably contain garbalogical
264 if (!NILP (Fboundp (Qvalues)))
265 Fset (Qvalues, Qnil);
266 Vcommand_history = Qnil;
268 error ("Memory exhausted");
271 /* like malloc and realloc but check for no memory left, and block input. */
278 xmalloc (size_t size)
280 void *val = malloc (size);
282 if (!val && (size != 0)) memory_full ();
291 xcalloc (size_t nelem, size_t elsize)
293 void *val = calloc (nelem, elsize);
295 if (!val && (nelem != 0)) memory_full ();
300 xmalloc_and_zero (size_t size)
302 return xcalloc (size, sizeof (char));
310 xrealloc (void *block, size_t size)
312 /* We must call malloc explicitly when BLOCK is 0, since some
313 reallocs don't do this. */
314 void *val = block ? realloc (block, size) : malloc (size);
316 if (!val && (size != 0)) memory_full ();
321 #ifdef ERROR_CHECK_MALLOC
322 xfree_1 (void *block)
327 #ifdef ERROR_CHECK_MALLOC
328 /* Unbelievably, calling free() on 0xDEADBEEF doesn't cause an
329 error until much later on for many system mallocs, such as
330 the one that comes with Solaris 2.3. FMH!! */
331 assert (block != (void *) 0xDEADBEEF);
333 #endif /* ERROR_CHECK_MALLOC */
337 #ifdef ERROR_CHECK_GC
340 typedef unsigned int four_byte_t;
341 #elif SIZEOF_LONG == 4
342 typedef unsigned long four_byte_t;
343 #elif SIZEOF_SHORT == 4
344 typedef unsigned short four_byte_t;
346 What kind of strange-ass system are we running on?
350 deadbeef_memory (void *ptr, size_t size)
352 four_byte_t *ptr4 = (four_byte_t *) ptr;
353 size_t beefs = size >> 2;
355 /* In practice, size will always be a multiple of four. */
357 (*ptr4++) = 0xDEADBEEF;
360 #else /* !ERROR_CHECK_GC */
363 #define deadbeef_memory(ptr, size)
365 #endif /* !ERROR_CHECK_GC */
372 xstrdup (CONST char *str)
374 int len = strlen (str) + 1; /* for stupid terminating 0 */
376 void *val = xmalloc (len);
377 if (val == 0) return 0;
378 return (char *) memcpy (val, str, len);
383 strdup (CONST char *s)
387 #endif /* NEED_STRDUP */
391 allocate_lisp_storage (size_t size)
393 return xmalloc (size);
397 /* lrecords are chained together through their "next.v" field.
398 * After doing the mark phase, the GC will walk this linked
399 * list and free any record which hasn't been marked.
401 static struct lcrecord_header *all_lcrecords;
404 alloc_lcrecord (size_t size, CONST struct lrecord_implementation *implementation)
406 struct lcrecord_header *lcheader;
408 #ifdef ERROR_CHECK_GC
409 if (implementation->static_size == 0)
410 assert (implementation->size_in_bytes_method);
412 assert (implementation->static_size == size);
415 lcheader = (struct lcrecord_header *) allocate_lisp_storage (size);
416 set_lheader_implementation (&(lcheader->lheader), implementation);
417 lcheader->next = all_lcrecords;
418 #if 1 /* mly prefers to see small ID numbers */
419 lcheader->uid = lrecord_uid_counter++;
420 #else /* jwz prefers to see real addrs */
421 lcheader->uid = (int) &lcheader;
424 all_lcrecords = lcheader;
425 INCREMENT_CONS_COUNTER (size, implementation->name);
429 #if 0 /* Presently unused */
430 /* Very, very poor man's EGC?
431 * This may be slow and thrash pages all over the place.
432 * Only call it if you really feel you must (and if the
433 * lrecord was fairly recently allocated).
434 * Otherwise, just let the GC do its job -- that's what it's there for
437 free_lcrecord (struct lcrecord_header *lcrecord)
439 if (all_lcrecords == lcrecord)
441 all_lcrecords = lcrecord->next;
445 struct lrecord_header *header = all_lcrecords;
448 struct lrecord_header *next = header->next;
449 if (next == lcrecord)
451 header->next = lrecord->next;
460 if (lrecord->implementation->finalizer)
461 lrecord->implementation->finalizer (lrecord, 0);
469 disksave_object_finalization_1 (void)
471 struct lcrecord_header *header;
473 for (header = all_lcrecords; header; header = header->next)
475 if (LHEADER_IMPLEMENTATION(&header->lheader)->finalizer &&
477 ((LHEADER_IMPLEMENTATION(&header->lheader)->finalizer)
482 /* Semi-kludge -- lrecord_symbol_value_forward objects get stuck
483 in CONST space and you get SEGV's if you attempt to mark them.
484 This sits in lheader->implementation->marker. */
487 this_one_is_unmarkable (Lisp_Object obj)
494 /************************************************************************/
495 /* Debugger support */
496 /************************************************************************/
497 /* Give gdb/dbx enough information to decode Lisp Objects. We make
498 sure certain symbols are always defined, so gdb doesn't complain
499 about expressions in src/.gdbinit. See src/.gdbinit or src/.dbxrc
500 to see how this is used. */
502 EMACS_UINT dbg_valmask = ((1UL << VALBITS) - 1) << GCBITS;
503 EMACS_UINT dbg_typemask = (1UL << GCTYPEBITS) - 1;
505 #ifdef USE_UNION_TYPE
506 unsigned char dbg_USE_UNION_TYPE = 1;
508 unsigned char dbg_USE_UNION_TYPE = 0;
511 unsigned char Lisp_Type_Int = 100;
512 unsigned char Lisp_Type_Cons = 101;
513 unsigned char Lisp_Type_String = 102;
514 unsigned char Lisp_Type_Vector = 103;
515 unsigned char Lisp_Type_Symbol = 104;
518 unsigned char lrecord_char_table_entry;
519 unsigned char lrecord_charset;
521 unsigned char lrecord_coding_system;
525 #ifndef HAVE_TOOLBARS
526 unsigned char lrecord_toolbar_button;
530 unsigned char lrecord_tooltalk_message;
531 unsigned char lrecord_tooltalk_pattern;
534 #ifndef HAVE_DATABASE
535 unsigned char lrecord_database;
538 unsigned char dbg_valbits = VALBITS;
539 unsigned char dbg_gctypebits = GCTYPEBITS;
541 /* Macros turned into functions for ease of debugging.
542 Debuggers don't know about macros! */
543 int dbg_eq (Lisp_Object obj1, Lisp_Object obj2);
545 dbg_eq (Lisp_Object obj1, Lisp_Object obj2)
547 return EQ (obj1, obj2);
551 /************************************************************************/
552 /* Fixed-size type macros */
553 /************************************************************************/
555 /* For fixed-size types that are commonly used, we malloc() large blocks
556 of memory at a time and subdivide them into chunks of the correct
557 size for an object of that type. This is more efficient than
558 malloc()ing each object separately because we save on malloc() time
559 and overhead due to the fewer number of malloc()ed blocks, and
560 also because we don't need any extra pointers within each object
561 to keep them threaded together for GC purposes. For less common
562 (and frequently large-size) types, we use lcrecords, which are
563 malloc()ed individually and chained together through a pointer
564 in the lcrecord header. lcrecords do not need to be fixed-size
565 (i.e. two objects of the same type need not have the same size;
566 however, the size of a particular object cannot vary dynamically).
567 It is also much easier to create a new lcrecord type because no
568 additional code needs to be added to alloc.c. Finally, lcrecords
569 may be more efficient when there are only a small number of them.
571 The types that are stored in these large blocks (or "frob blocks")
572 are cons, float, compiled-function, symbol, marker, extent, event,
575 Note that strings are special in that they are actually stored in
576 two parts: a structure containing information about the string, and
577 the actual data associated with the string. The former structure
578 (a struct Lisp_String) is a fixed-size structure and is managed the
579 same way as all the other such types. This structure contains a
580 pointer to the actual string data, which is stored in structures of
581 type struct string_chars_block. Each string_chars_block consists
582 of a pointer to a struct Lisp_String, followed by the data for that
583 string, followed by another pointer to a struct Lisp_String,
584 followed by the data for that string, etc. At GC time, the data in
585 these blocks is compacted by searching sequentially through all the
586 blocks and compressing out any holes created by unmarked strings.
587 Strings that are more than a certain size (bigger than the size of
588 a string_chars_block, although something like half as big might
589 make more sense) are malloc()ed separately and not stored in
590 string_chars_blocks. Furthermore, no one string stretches across
591 two string_chars_blocks.
593 Vectors are each malloc()ed separately, similar to lcrecords.
595 In the following discussion, we use conses, but it applies equally
596 well to the other fixed-size types.
598 We store cons cells inside of cons_blocks, allocating a new
599 cons_block with malloc() whenever necessary. Cons cells reclaimed
600 by GC are put on a free list to be reallocated before allocating
601 any new cons cells from the latest cons_block. Each cons_block is
602 just under 2^n - MALLOC_OVERHEAD bytes long, since malloc (at least
603 the versions in malloc.c and gmalloc.c) really allocates in units
604 of powers of two and uses 4 bytes for its own overhead.
606 What GC actually does is to search through all the cons_blocks,
607 from the most recently allocated to the oldest, and put all
608 cons cells that are not marked (whether or not they're already
609 free) on a cons_free_list. The cons_free_list is a stack, and
610 so the cons cells in the oldest-allocated cons_block end up
611 at the head of the stack and are the first to be reallocated.
612 If any cons_block is entirely free, it is freed with free()
613 and its cons cells removed from the cons_free_list. Because
614 the cons_free_list ends up basically in memory order, we have
615 a high locality of reference (assuming a reasonable turnover
616 of allocating and freeing) and have a reasonable probability
617 of entirely freeing up cons_blocks that have been more recently
618 allocated. This stage is called the "sweep stage" of GC, and
619 is executed after the "mark stage", which involves starting
620 from all places that are known to point to in-use Lisp objects
621 (e.g. the obarray, where are all symbols are stored; the
622 current catches and condition-cases; the backtrace list of
623 currently executing functions; the gcpro list; etc.) and
624 recursively marking all objects that are accessible.
626 At the beginning of the sweep stage, the conses in the cons
627 blocks are in one of three states: in use and marked, in use
628 but not marked, and not in use (already freed). Any conses
629 that are marked have been marked in the mark stage just
630 executed, because as part of the sweep stage we unmark any
631 marked objects. The way we tell whether or not a cons cell
632 is in use is through the FREE_STRUCT_P macro. This basically
633 looks at the first 4 bytes (or however many bytes a pointer
634 fits in) to see if all the bits in those bytes are 1. The
635 resulting value (0xFFFFFFFF) is not a valid pointer and is
636 not a valid Lisp_Object. All current fixed-size types have
637 a pointer or Lisp_Object as their first element with the
638 exception of strings; they have a size value, which can
639 never be less than zero, and so 0xFFFFFFFF is invalid for
640 strings as well. Now assuming that a cons cell is in use,
641 the way we tell whether or not it is marked is to look at
642 the mark bit of its car (each Lisp_Object has one bit
643 reserved as a mark bit, in case it's needed). Note that
644 different types of objects use different fields to indicate
645 whether the object is marked, but the principle is the same.
647 Conses on the free_cons_list are threaded through a pointer
648 stored in the bytes directly after the bytes that are set
649 to 0xFFFFFFFF (we cannot overwrite these because the cons
650 is still in a cons_block and needs to remain marked as
651 not in use for the next time that GC happens). This
652 implies that all fixed-size types must be at least big
653 enough to store two pointers, which is indeed the case
654 for all current fixed-size types.
656 Some types of objects need additional "finalization" done
657 when an object is converted from in use to not in use;
658 this is the purpose of the ADDITIONAL_FREE_type macro.
659 For example, markers need to be removed from the chain
660 of markers that is kept in each buffer. This is because
661 markers in a buffer automatically disappear if the marker
662 is no longer referenced anywhere (the same does not
663 apply to extents, however).
665 WARNING: Things are in an extremely bizarre state when
666 the ADDITIONAL_FREE_type macros are called, so beware!
668 When ERROR_CHECK_GC is defined, we do things differently
669 so as to maximize our chances of catching places where
670 there is insufficient GCPROing. The thing we want to
671 avoid is having an object that we're using but didn't
672 GCPRO get freed by GC and then reallocated while we're
673 in the process of using it -- this will result in something
674 seemingly unrelated getting trashed, and is extremely
675 difficult to track down. If the object gets freed but
676 not reallocated, we can usually catch this because we
677 set all bytes of a freed object to 0xDEADBEEF. (The
678 first four bytes, however, are 0xFFFFFFFF, and the next
679 four are a pointer used to chain freed objects together;
680 we play some tricks with this pointer to make it more
681 bogus, so crashes are more likely to occur right away.)
683 We want freed objects to stay free as long as possible,
684 so instead of doing what we do above, we maintain the
685 free objects in a first-in first-out queue. We also
686 don't recompute the free list each GC, unlike above;
687 this ensures that the queue ordering is preserved.
688 [This means that we are likely to have worse locality
689 of reference, and that we can never free a frob block
690 once it's allocated. (Even if we know that all cells
691 in it are free, there's no easy way to remove all those
692 cells from the free list because the objects on the
693 free list are unlikely to be in memory order.)]
694 Furthermore, we never take objects off the free list
695 unless there's a large number (usually 1000, but
696 varies depending on type) of them already on the list.
697 This way, we ensure that an object that gets freed will
698 remain free for the next 1000 (or whatever) times that
699 an object of that type is allocated.
702 #ifndef MALLOC_OVERHEAD
704 #define MALLOC_OVERHEAD 0
705 #elif defined (rcheck)
706 #define MALLOC_OVERHEAD 20
708 #define MALLOC_OVERHEAD 8
710 #endif /* MALLOC_OVERHEAD */
712 #if !defined(HAVE_MMAP) || defined(DOUG_LEA_MALLOC)
713 /* If we released our reserve (due to running out of memory),
714 and we have a fair amount free once again,
715 try to set aside another reserve in case we run out once more.
717 This is called when a relocatable block is freed in ralloc.c. */
718 void refill_memory_reserve (void);
720 refill_memory_reserve ()
722 if (breathing_space == 0)
723 breathing_space = (char *) malloc (4096 - MALLOC_OVERHEAD);
727 #ifdef ALLOC_NO_POOLS
728 # define TYPE_ALLOC_SIZE(type, structtype) 1
730 # define TYPE_ALLOC_SIZE(type, structtype) \
731 ((2048 - MALLOC_OVERHEAD - sizeof (struct type##_block *)) \
732 / sizeof (structtype))
733 #endif /* ALLOC_NO_POOLS */
735 #define DECLARE_FIXED_TYPE_ALLOC(type, structtype) \
737 struct type##_block \
739 struct type##_block *prev; \
740 structtype block[TYPE_ALLOC_SIZE (type, structtype)]; \
743 static struct type##_block *current_##type##_block; \
744 static int current_##type##_block_index; \
746 static structtype *type##_free_list; \
747 static structtype *type##_free_list_tail; \
750 init_##type##_alloc (void) \
752 current_##type##_block = 0; \
753 current_##type##_block_index = \
754 countof (current_##type##_block->block); \
755 type##_free_list = 0; \
756 type##_free_list_tail = 0; \
759 static int gc_count_num_##type##_in_use; \
760 static int gc_count_num_##type##_freelist
762 #define ALLOCATE_FIXED_TYPE_FROM_BLOCK(type, result) do { \
763 if (current_##type##_block_index \
764 == countof (current_##type##_block->block)) \
766 struct type##_block *AFTFB_new = (struct type##_block *) \
767 allocate_lisp_storage (sizeof (struct type##_block)); \
768 AFTFB_new->prev = current_##type##_block; \
769 current_##type##_block = AFTFB_new; \
770 current_##type##_block_index = 0; \
773 &(current_##type##_block->block[current_##type##_block_index++]); \
776 /* Allocate an instance of a type that is stored in blocks.
777 TYPE is the "name" of the type, STRUCTTYPE is the corresponding
780 #ifdef ERROR_CHECK_GC
782 /* Note: if you get crashes in this function, suspect incorrect calls
783 to free_cons() and friends. This happened once because the cons
784 cell was not GC-protected and was getting collected before
785 free_cons() was called. */
787 #define ALLOCATE_FIXED_TYPE_1(type, structtype, result) \
790 if (gc_count_num_##type##_freelist > \
791 MINIMUM_ALLOWED_FIXED_TYPE_CELLS_##type) \
793 result = type##_free_list; \
794 /* Before actually using the chain pointer, we complement all its \
795 bits; see FREE_FIXED_TYPE(). */ \
797 (structtype *) ~(unsigned long) \
798 (* (structtype **) ((char *) result + sizeof (void *))); \
799 gc_count_num_##type##_freelist--; \
802 ALLOCATE_FIXED_TYPE_FROM_BLOCK (type, result); \
803 MARK_STRUCT_AS_NOT_FREE (result); \
806 #else /* !ERROR_CHECK_GC */
808 #define ALLOCATE_FIXED_TYPE_1(type, structtype, result) \
811 if (type##_free_list) \
813 result = type##_free_list; \
815 * (structtype **) ((char *) result + sizeof (void *)); \
818 ALLOCATE_FIXED_TYPE_FROM_BLOCK (type, result); \
819 MARK_STRUCT_AS_NOT_FREE (result); \
822 #endif /* !ERROR_CHECK_GC */
824 #define ALLOCATE_FIXED_TYPE(type, structtype, result) \
827 ALLOCATE_FIXED_TYPE_1 (type, structtype, result); \
828 INCREMENT_CONS_COUNTER (sizeof (structtype), #type); \
831 #define NOSEEUM_ALLOCATE_FIXED_TYPE(type, structtype, result) \
834 ALLOCATE_FIXED_TYPE_1 (type, structtype, result); \
835 NOSEEUM_INCREMENT_CONS_COUNTER (sizeof (structtype), #type); \
838 /* INVALID_POINTER_VALUE should be a value that is invalid as a pointer
839 to a Lisp object and invalid as an actual Lisp_Object value. We have
840 to make sure that this value cannot be an integer in Lisp_Object form.
841 0xFFFFFFFF could be so on a 64-bit system, so we extend it to 64 bits.
842 On a 32-bit system, the type bits will be non-zero, making the value
843 be a pointer, and the pointer will be misaligned.
845 Even if Emacs is run on some weirdo system that allows and allocates
846 byte-aligned pointers, this pointer is at the very top of the address
847 space and so it's almost inconceivable that it could ever be valid. */
850 # define INVALID_POINTER_VALUE 0xFFFFFFFF
852 # define INVALID_POINTER_VALUE 0xFFFFFFFFFFFF
854 # define INVALID_POINTER_VALUE 0xFFFFFFFFFFFFFFFF
856 You have some weird system and need to supply a reasonable value here.
859 #define FREE_STRUCT_P(ptr) \
860 (* (void **) ptr == (void *) INVALID_POINTER_VALUE)
861 #define MARK_STRUCT_AS_FREE(ptr) \
862 (* (void **) ptr = (void *) INVALID_POINTER_VALUE)
863 #define MARK_STRUCT_AS_NOT_FREE(ptr) \
864 (* (void **) ptr = 0)
866 #ifdef ERROR_CHECK_GC
868 #define PUT_FIXED_TYPE_ON_FREE_LIST(type, structtype, ptr) \
869 do { if (type##_free_list_tail) \
871 /* When we store the chain pointer, we complement all \
872 its bits; this should significantly increase its \
873 bogosity in case someone tries to use the value, and \
874 should make us dump faster if someone stores something \
875 over the pointer because when it gets un-complemented in \
876 ALLOCATED_FIXED_TYPE(), the resulting pointer will be \
877 extremely bogus. */ \
879 ((char *) type##_free_list_tail + sizeof (void *)) = \
880 (structtype *) ~(unsigned long) ptr; \
883 type##_free_list = ptr; \
884 type##_free_list_tail = ptr; \
887 #else /* !ERROR_CHECK_GC */
889 #define PUT_FIXED_TYPE_ON_FREE_LIST(type, structtype, ptr) \
890 do { * (structtype **) ((char *) (ptr) + sizeof (void *)) = \
892 type##_free_list = (ptr); \
895 #endif /* !ERROR_CHECK_GC */
897 /* TYPE and STRUCTTYPE are the same as in ALLOCATE_FIXED_TYPE(). */
899 #define FREE_FIXED_TYPE(type, structtype, ptr) do { \
900 structtype *FFT_ptr = (ptr); \
901 ADDITIONAL_FREE_##type (FFT_ptr); \
902 deadbeef_memory (FFT_ptr, sizeof (structtype)); \
903 PUT_FIXED_TYPE_ON_FREE_LIST (type, structtype, FFT_ptr); \
904 MARK_STRUCT_AS_FREE (FFT_ptr); \
907 /* Like FREE_FIXED_TYPE() but used when we are explicitly
908 freeing a structure through free_cons(), free_marker(), etc.
909 rather than through the normal process of sweeping.
910 We attempt to undo the changes made to the allocation counters
911 as a result of this structure being allocated. This is not
912 completely necessary but helps keep things saner: e.g. this way,
913 repeatedly allocating and freeing a cons will not result in
914 the consing-since-gc counter advancing, which would cause a GC
915 and somewhat defeat the purpose of explicitly freeing. */
917 #define FREE_FIXED_TYPE_WHEN_NOT_IN_GC(type, structtype, ptr) \
918 do { FREE_FIXED_TYPE (type, structtype, ptr); \
919 DECREMENT_CONS_COUNTER (sizeof (structtype)); \
920 gc_count_num_##type##_freelist++; \
925 /************************************************************************/
926 /* Cons allocation */
927 /************************************************************************/
929 DECLARE_FIXED_TYPE_ALLOC (cons, struct Lisp_Cons);
930 /* conses are used and freed so often that we set this really high */
931 /* #define MINIMUM_ALLOWED_FIXED_TYPE_CELLS_cons 20000 */
932 #define MINIMUM_ALLOWED_FIXED_TYPE_CELLS_cons 2000
935 mark_cons (Lisp_Object obj)
937 if (NILP (XCDR (obj)))
940 mark_object (XCAR (obj));
945 cons_equal (Lisp_Object ob1, Lisp_Object ob2, int depth)
947 while (internal_equal (XCAR (ob1), XCAR (ob2), depth + 1))
951 if (! CONSP (ob1) || ! CONSP (ob2))
952 return internal_equal (ob1, ob2, depth + 1);
957 static const struct lrecord_description cons_description[] = {
958 { XD_LISP_OBJECT, offsetof(struct Lisp_Cons, car), 2 },
962 DEFINE_BASIC_LRECORD_IMPLEMENTATION ("cons", cons,
963 mark_cons, print_cons, 0,
966 * No `hash' method needed.
967 * internal_hash knows how to
974 DEFUN ("cons", Fcons, 2, 2, 0, /*
975 Create a new cons, give it CAR and CDR as components, and return it.
979 /* This cannot GC. */
983 ALLOCATE_FIXED_TYPE (cons, struct Lisp_Cons, c);
984 set_lheader_implementation (&(c->lheader), &lrecord_cons);
991 /* This is identical to Fcons() but it used for conses that we're
992 going to free later, and is useful when trying to track down
995 noseeum_cons (Lisp_Object car, Lisp_Object cdr)
1000 NOSEEUM_ALLOCATE_FIXED_TYPE (cons, struct Lisp_Cons, c);
1001 set_lheader_implementation (&(c->lheader), &lrecord_cons);
1008 DEFUN ("list", Flist, 0, MANY, 0, /*
1009 Return a newly created list with specified arguments as elements.
1010 Any number of arguments, even zero arguments, are allowed.
1012 (int nargs, Lisp_Object *args))
1014 Lisp_Object val = Qnil;
1015 Lisp_Object *argp = args + nargs;
1018 val = Fcons (*--argp, val);
1023 list1 (Lisp_Object obj0)
1025 /* This cannot GC. */
1026 return Fcons (obj0, Qnil);
1030 list2 (Lisp_Object obj0, Lisp_Object obj1)
1032 /* This cannot GC. */
1033 return Fcons (obj0, Fcons (obj1, Qnil));
1037 list3 (Lisp_Object obj0, Lisp_Object obj1, Lisp_Object obj2)
1039 /* This cannot GC. */
1040 return Fcons (obj0, Fcons (obj1, Fcons (obj2, Qnil)));
1044 cons3 (Lisp_Object obj0, Lisp_Object obj1, Lisp_Object obj2)
1046 /* This cannot GC. */
1047 return Fcons (obj0, Fcons (obj1, obj2));
1051 acons (Lisp_Object key, Lisp_Object value, Lisp_Object alist)
1053 return Fcons (Fcons (key, value), alist);
1057 list4 (Lisp_Object obj0, Lisp_Object obj1, Lisp_Object obj2, Lisp_Object obj3)
1059 /* This cannot GC. */
1060 return Fcons (obj0, Fcons (obj1, Fcons (obj2, Fcons (obj3, Qnil))));
1064 list5 (Lisp_Object obj0, Lisp_Object obj1, Lisp_Object obj2, Lisp_Object obj3,
1067 /* This cannot GC. */
1068 return Fcons (obj0, Fcons (obj1, Fcons (obj2, Fcons (obj3, Fcons (obj4, Qnil)))));
1072 list6 (Lisp_Object obj0, Lisp_Object obj1, Lisp_Object obj2, Lisp_Object obj3,
1073 Lisp_Object obj4, Lisp_Object obj5)
1075 /* This cannot GC. */
1076 return Fcons (obj0, Fcons (obj1, Fcons (obj2, Fcons (obj3, Fcons (obj4, Fcons (obj5, Qnil))))));
1079 DEFUN ("make-list", Fmake_list, 2, 2, 0, /*
1080 Return a new list of length LENGTH, with each element being INIT.
1084 CHECK_NATNUM (length);
1087 Lisp_Object val = Qnil;
1088 size_t size = XINT (length);
1091 val = Fcons (init, val);
1097 /************************************************************************/
1098 /* Float allocation */
1099 /************************************************************************/
1101 #ifdef LISP_FLOAT_TYPE
1103 DECLARE_FIXED_TYPE_ALLOC (float, struct Lisp_Float);
1104 #define MINIMUM_ALLOWED_FIXED_TYPE_CELLS_float 1000
1107 make_float (double float_value)
1110 struct Lisp_Float *f;
1112 ALLOCATE_FIXED_TYPE (float, struct Lisp_Float, f);
1113 set_lheader_implementation (&(f->lheader), &lrecord_float);
1114 float_data (f) = float_value;
1119 #endif /* LISP_FLOAT_TYPE */
1122 /************************************************************************/
1123 /* Vector allocation */
1124 /************************************************************************/
1127 mark_vector (Lisp_Object obj)
1129 Lisp_Vector *ptr = XVECTOR (obj);
1130 int len = vector_length (ptr);
1133 for (i = 0; i < len - 1; i++)
1134 mark_object (ptr->contents[i]);
1135 return (len > 0) ? ptr->contents[len - 1] : Qnil;
1139 size_vector (CONST void *lheader)
1141 return STRETCHY_STRUCT_SIZEOF (Lisp_Vector, contents,
1142 ((Lisp_Vector *) lheader)->size);
1146 vector_equal (Lisp_Object obj1, Lisp_Object obj2, int depth)
1148 int len = XVECTOR_LENGTH (obj1);
1149 if (len != XVECTOR_LENGTH (obj2))
1153 Lisp_Object *ptr1 = XVECTOR_DATA (obj1);
1154 Lisp_Object *ptr2 = XVECTOR_DATA (obj2);
1156 if (!internal_equal (*ptr1++, *ptr2++, depth + 1))
1162 static const struct lrecord_description vector_description[] = {
1163 { XD_LONG, offsetof(struct Lisp_Vector, size) },
1164 { XD_LISP_OBJECT, offsetof(struct Lisp_Vector, contents), XD_INDIRECT(0, 0) },
1168 DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION("vector", vector,
1169 mark_vector, print_vector, 0,
1172 * No `hash' method needed for
1173 * vectors. internal_hash
1174 * knows how to handle vectors.
1178 size_vector, Lisp_Vector);
1180 /* #### should allocate `small' vectors from a frob-block */
1181 static Lisp_Vector *
1182 make_vector_internal (size_t sizei)
1184 /* no vector_next */
1185 size_t sizem = STRETCHY_STRUCT_SIZEOF (Lisp_Vector, contents, sizei);
1186 Lisp_Vector *p = (Lisp_Vector *) alloc_lcrecord (sizem, &lrecord_vector);
1193 make_vector (size_t length, Lisp_Object init)
1195 Lisp_Vector *vecp = make_vector_internal (length);
1196 Lisp_Object *p = vector_data (vecp);
1203 XSETVECTOR (vector, vecp);
1208 DEFUN ("make-vector", Fmake_vector, 2, 2, 0, /*
1209 Return a new vector of length LENGTH, with each element being INIT.
1210 See also the function `vector'.
1214 CONCHECK_NATNUM (length);
1215 return make_vector (XINT (length), init);
1218 DEFUN ("vector", Fvector, 0, MANY, 0, /*
1219 Return a newly created vector with specified arguments as elements.
1220 Any number of arguments, even zero arguments, are allowed.
1222 (int nargs, Lisp_Object *args))
1224 Lisp_Vector *vecp = make_vector_internal (nargs);
1225 Lisp_Object *p = vector_data (vecp);
1232 XSETVECTOR (vector, vecp);
1238 vector1 (Lisp_Object obj0)
1240 return Fvector (1, &obj0);
1244 vector2 (Lisp_Object obj0, Lisp_Object obj1)
1246 Lisp_Object args[2];
1249 return Fvector (2, args);
1253 vector3 (Lisp_Object obj0, Lisp_Object obj1, Lisp_Object obj2)
1255 Lisp_Object args[3];
1259 return Fvector (3, args);
1262 #if 0 /* currently unused */
1265 vector4 (Lisp_Object obj0, Lisp_Object obj1, Lisp_Object obj2,
1268 Lisp_Object args[4];
1273 return Fvector (4, args);
1277 vector5 (Lisp_Object obj0, Lisp_Object obj1, Lisp_Object obj2,
1278 Lisp_Object obj3, Lisp_Object obj4)
1280 Lisp_Object args[5];
1286 return Fvector (5, args);
1290 vector6 (Lisp_Object obj0, Lisp_Object obj1, Lisp_Object obj2,
1291 Lisp_Object obj3, Lisp_Object obj4, Lisp_Object obj5)
1293 Lisp_Object args[6];
1300 return Fvector (6, args);
1304 vector7 (Lisp_Object obj0, Lisp_Object obj1, Lisp_Object obj2,
1305 Lisp_Object obj3, Lisp_Object obj4, Lisp_Object obj5,
1308 Lisp_Object args[7];
1316 return Fvector (7, args);
1320 vector8 (Lisp_Object obj0, Lisp_Object obj1, Lisp_Object obj2,
1321 Lisp_Object obj3, Lisp_Object obj4, Lisp_Object obj5,
1322 Lisp_Object obj6, Lisp_Object obj7)
1324 Lisp_Object args[8];
1333 return Fvector (8, args);
1337 /************************************************************************/
1338 /* Bit Vector allocation */
1339 /************************************************************************/
1341 static Lisp_Object all_bit_vectors;
1343 /* #### should allocate `small' bit vectors from a frob-block */
1344 static struct Lisp_Bit_Vector *
1345 make_bit_vector_internal (size_t sizei)
1347 size_t num_longs = BIT_VECTOR_LONG_STORAGE (sizei);
1348 size_t sizem = STRETCHY_STRUCT_SIZEOF (Lisp_Bit_Vector, bits, num_longs);
1349 Lisp_Bit_Vector *p = (Lisp_Bit_Vector *) allocate_lisp_storage (sizem);
1350 set_lheader_implementation (&(p->lheader), &lrecord_bit_vector);
1352 INCREMENT_CONS_COUNTER (sizem, "bit-vector");
1354 bit_vector_length (p) = sizei;
1355 bit_vector_next (p) = all_bit_vectors;
1356 /* make sure the extra bits in the last long are 0; the calling
1357 functions might not set them. */
1358 p->bits[num_longs - 1] = 0;
1359 XSETBIT_VECTOR (all_bit_vectors, p);
1364 make_bit_vector (size_t length, Lisp_Object init)
1366 struct Lisp_Bit_Vector *p = make_bit_vector_internal (length);
1367 size_t num_longs = BIT_VECTOR_LONG_STORAGE (length);
1372 memset (p->bits, 0, num_longs * sizeof (long));
1375 size_t bits_in_last = length & (LONGBITS_POWER_OF_2 - 1);
1376 memset (p->bits, ~0, num_longs * sizeof (long));
1377 /* But we have to make sure that the unused bits in the
1378 last long are 0, so that equal/hash is easy. */
1380 p->bits[num_longs - 1] &= (1 << bits_in_last) - 1;
1384 Lisp_Object bit_vector;
1385 XSETBIT_VECTOR (bit_vector, p);
1391 make_bit_vector_from_byte_vector (unsigned char *bytevec, size_t length)
1394 Lisp_Bit_Vector *p = make_bit_vector_internal (length);
1396 for (i = 0; i < length; i++)
1397 set_bit_vector_bit (p, i, bytevec[i]);
1400 Lisp_Object bit_vector;
1401 XSETBIT_VECTOR (bit_vector, p);
1406 DEFUN ("make-bit-vector", Fmake_bit_vector, 2, 2, 0, /*
1407 Return a new bit vector of length LENGTH. with each bit being INIT.
1408 Each element is set to INIT. See also the function `bit-vector'.
1412 CONCHECK_NATNUM (length);
1414 return make_bit_vector (XINT (length), init);
1417 DEFUN ("bit-vector", Fbit_vector, 0, MANY, 0, /*
1418 Return a newly created bit vector with specified arguments as elements.
1419 Any number of arguments, even zero arguments, are allowed.
1421 (int nargs, Lisp_Object *args))
1424 Lisp_Bit_Vector *p = make_bit_vector_internal (nargs);
1426 for (i = 0; i < nargs; i++)
1428 CHECK_BIT (args[i]);
1429 set_bit_vector_bit (p, i, !ZEROP (args[i]));
1433 Lisp_Object bit_vector;
1434 XSETBIT_VECTOR (bit_vector, p);
1440 /************************************************************************/
1441 /* Compiled-function allocation */
1442 /************************************************************************/
1444 DECLARE_FIXED_TYPE_ALLOC (compiled_function, Lisp_Compiled_Function);
1445 #define MINIMUM_ALLOWED_FIXED_TYPE_CELLS_compiled_function 1000
1448 make_compiled_function (void)
1450 Lisp_Compiled_Function *f;
1453 ALLOCATE_FIXED_TYPE (compiled_function, Lisp_Compiled_Function, f);
1454 set_lheader_implementation (&(f->lheader), &lrecord_compiled_function);
1457 f->specpdl_depth = 0;
1458 f->flags.documentationp = 0;
1459 f->flags.interactivep = 0;
1460 f->flags.domainp = 0; /* I18N3 */
1461 f->instructions = Qzero;
1462 f->constants = Qzero;
1464 f->doc_and_interactive = Qnil;
1465 #ifdef COMPILED_FUNCTION_ANNOTATION_HACK
1466 f->annotated = Qnil;
1468 XSETCOMPILED_FUNCTION (fun, f);
1472 DEFUN ("make-byte-code", Fmake_byte_code, 4, MANY, 0, /*
1473 Return a new compiled-function object.
1474 Usage: (arglist instructions constants stack-depth
1475 &optional doc-string interactive)
1476 Note that, unlike all other emacs-lisp functions, calling this with five
1477 arguments is NOT the same as calling it with six arguments, the last of
1478 which is nil. If the INTERACTIVE arg is specified as nil, then that means
1479 that this function was defined with `(interactive)'. If the arg is not
1480 specified, then that means the function is not interactive.
1481 This is terrible behavior which is retained for compatibility with old
1482 `.elc' files which expect these semantics.
1484 (int nargs, Lisp_Object *args))
1486 /* In a non-insane world this function would have this arglist...
1487 (arglist instructions constants stack_depth &optional doc_string interactive)
1489 Lisp_Object fun = make_compiled_function ();
1490 Lisp_Compiled_Function *f = XCOMPILED_FUNCTION (fun);
1492 Lisp_Object arglist = args[0];
1493 Lisp_Object instructions = args[1];
1494 Lisp_Object constants = args[2];
1495 Lisp_Object stack_depth = args[3];
1496 Lisp_Object doc_string = (nargs > 4) ? args[4] : Qnil;
1497 Lisp_Object interactive = (nargs > 5) ? args[5] : Qunbound;
1499 if (nargs < 4 || nargs > 6)
1500 return Fsignal (Qwrong_number_of_arguments,
1501 list2 (intern ("make-byte-code"), make_int (nargs)));
1503 /* Check for valid formal parameter list now, to allow us to use
1504 SPECBIND_FAST_UNSAFE() later in funcall_compiled_function(). */
1506 Lisp_Object symbol, tail;
1507 EXTERNAL_LIST_LOOP_3 (symbol, arglist, tail)
1509 CHECK_SYMBOL (symbol);
1510 if (EQ (symbol, Qt) ||
1511 EQ (symbol, Qnil) ||
1512 SYMBOL_IS_KEYWORD (symbol))
1513 signal_simple_error_2
1514 ("Invalid constant symbol in formal parameter list",
1518 f->arglist = arglist;
1520 /* `instructions' is a string or a cons (string . int) for a
1521 lazy-loaded function. */
1522 if (CONSP (instructions))
1524 CHECK_STRING (XCAR (instructions));
1525 CHECK_INT (XCDR (instructions));
1529 CHECK_STRING (instructions);
1531 f->instructions = instructions;
1533 if (!NILP (constants))
1534 CHECK_VECTOR (constants);
1535 f->constants = constants;
1537 CHECK_NATNUM (stack_depth);
1538 f->stack_depth = XINT (stack_depth);
1540 #ifdef COMPILED_FUNCTION_ANNOTATION_HACK
1541 if (!NILP (Vcurrent_compiled_function_annotation))
1542 f->annotated = Fcopy (Vcurrent_compiled_function_annotation);
1543 else if (!NILP (Vload_file_name_internal_the_purecopy))
1544 f->annotated = Vload_file_name_internal_the_purecopy;
1545 else if (!NILP (Vload_file_name_internal))
1547 struct gcpro gcpro1;
1548 GCPRO1 (fun); /* don't let fun get reaped */
1549 Vload_file_name_internal_the_purecopy =
1550 Ffile_name_nondirectory (Vload_file_name_internal);
1551 f->annotated = Vload_file_name_internal_the_purecopy;
1554 #endif /* COMPILED_FUNCTION_ANNOTATION_HACK */
1556 /* doc_string may be nil, string, int, or a cons (string . int).
1557 interactive may be list or string (or unbound). */
1558 f->doc_and_interactive = Qunbound;
1560 if ((f->flags.domainp = !NILP (Vfile_domain)) != 0)
1561 f->doc_and_interactive = Vfile_domain;
1563 if ((f->flags.interactivep = !UNBOUNDP (interactive)) != 0)
1565 f->doc_and_interactive
1566 = (UNBOUNDP (f->doc_and_interactive) ? interactive :
1567 Fcons (interactive, f->doc_and_interactive));
1569 if ((f->flags.documentationp = !NILP (doc_string)) != 0)
1571 f->doc_and_interactive
1572 = (UNBOUNDP (f->doc_and_interactive) ? doc_string :
1573 Fcons (doc_string, f->doc_and_interactive));
1575 if (UNBOUNDP (f->doc_and_interactive))
1576 f->doc_and_interactive = Qnil;
1582 /************************************************************************/
1583 /* Symbol allocation */
1584 /************************************************************************/
1586 DECLARE_FIXED_TYPE_ALLOC (symbol, struct Lisp_Symbol);
1587 #define MINIMUM_ALLOWED_FIXED_TYPE_CELLS_symbol 1000
1589 DEFUN ("make-symbol", Fmake_symbol, 1, 1, 0, /*
1590 Return a newly allocated uninterned symbol whose name is NAME.
1591 Its value and function definition are void, and its property list is nil.
1596 struct Lisp_Symbol *p;
1598 CHECK_STRING (name);
1600 ALLOCATE_FIXED_TYPE (symbol, struct Lisp_Symbol, p);
1601 set_lheader_implementation (&(p->lheader), &lrecord_symbol);
1602 p->name = XSTRING (name);
1604 p->value = Qunbound;
1605 p->function = Qunbound;
1606 symbol_next (p) = 0;
1607 XSETSYMBOL (val, p);
1612 /************************************************************************/
1613 /* Extent allocation */
1614 /************************************************************************/
1616 DECLARE_FIXED_TYPE_ALLOC (extent, struct extent);
1617 #define MINIMUM_ALLOWED_FIXED_TYPE_CELLS_extent 1000
1620 allocate_extent (void)
1624 ALLOCATE_FIXED_TYPE (extent, struct extent, e);
1625 set_lheader_implementation (&(e->lheader), &lrecord_extent);
1626 extent_object (e) = Qnil;
1627 set_extent_start (e, -1);
1628 set_extent_end (e, -1);
1633 extent_face (e) = Qnil;
1634 e->flags.end_open = 1; /* default is for endpoints to behave like markers */
1635 e->flags.detachable = 1;
1641 /************************************************************************/
1642 /* Event allocation */
1643 /************************************************************************/
1645 DECLARE_FIXED_TYPE_ALLOC (event, struct Lisp_Event);
1646 #define MINIMUM_ALLOWED_FIXED_TYPE_CELLS_event 1000
1649 allocate_event (void)
1652 struct Lisp_Event *e;
1654 ALLOCATE_FIXED_TYPE (event, struct Lisp_Event, e);
1655 set_lheader_implementation (&(e->lheader), &lrecord_event);
1662 /************************************************************************/
1663 /* Marker allocation */
1664 /************************************************************************/
1666 DECLARE_FIXED_TYPE_ALLOC (marker, struct Lisp_Marker);
1667 #define MINIMUM_ALLOWED_FIXED_TYPE_CELLS_marker 1000
1669 DEFUN ("make-marker", Fmake_marker, 0, 0, 0, /*
1670 Return a new marker which does not point at any place.
1675 struct Lisp_Marker *p;
1677 ALLOCATE_FIXED_TYPE (marker, struct Lisp_Marker, p);
1678 set_lheader_implementation (&(p->lheader), &lrecord_marker);
1681 marker_next (p) = 0;
1682 marker_prev (p) = 0;
1683 p->insertion_type = 0;
1684 XSETMARKER (val, p);
1689 noseeum_make_marker (void)
1692 struct Lisp_Marker *p;
1694 NOSEEUM_ALLOCATE_FIXED_TYPE (marker, struct Lisp_Marker, p);
1695 set_lheader_implementation (&(p->lheader), &lrecord_marker);
1698 marker_next (p) = 0;
1699 marker_prev (p) = 0;
1700 p->insertion_type = 0;
1701 XSETMARKER (val, p);
1706 /************************************************************************/
1707 /* String allocation */
1708 /************************************************************************/
1710 /* The data for "short" strings generally resides inside of structs of type
1711 string_chars_block. The Lisp_String structure is allocated just like any
1712 other Lisp object (except for vectors), and these are freelisted when
1713 they get garbage collected. The data for short strings get compacted,
1714 but the data for large strings do not.
1716 Previously Lisp_String structures were relocated, but this caused a lot
1717 of bus-errors because the C code didn't include enough GCPRO's for
1718 strings (since EVERY REFERENCE to a short string needed to be GCPRO'd so
1719 that the reference would get relocated).
1721 This new method makes things somewhat bigger, but it is MUCH safer. */
1723 DECLARE_FIXED_TYPE_ALLOC (string, Lisp_String);
1724 /* strings are used and freed quite often */
1725 /* #define MINIMUM_ALLOWED_FIXED_TYPE_CELLS_string 10000 */
1726 #define MINIMUM_ALLOWED_FIXED_TYPE_CELLS_string 1000
1729 mark_string (Lisp_Object obj)
1731 Lisp_String *ptr = XSTRING (obj);
1733 if (CONSP (ptr->plist) && EXTENT_INFOP (XCAR (ptr->plist)))
1734 flush_cached_extent_info (XCAR (ptr->plist));
1739 string_equal (Lisp_Object obj1, Lisp_Object obj2, int depth)
1742 return (((len = XSTRING_LENGTH (obj1)) == XSTRING_LENGTH (obj2)) &&
1743 !memcmp (XSTRING_DATA (obj1), XSTRING_DATA (obj2), len));
1746 static const struct lrecord_description string_description[] = {
1747 { XD_BYTECOUNT, offsetof(Lisp_String, size) },
1748 { XD_OPAQUE_DATA_PTR, offsetof(Lisp_String, data), XD_INDIRECT(0, 1) },
1749 { XD_LISP_OBJECT, offsetof(Lisp_String, plist), 1 },
1753 DEFINE_BASIC_LRECORD_IMPLEMENTATION ("string", string,
1754 mark_string, print_string,
1756 * No `finalize', or `hash' methods.
1757 * internal_hash already knows how
1758 * to hash strings and finalization
1760 * ADDITIONAL_FREE_string macro,
1761 * which is the standard way to do
1762 * finalization when using
1763 * SWEEP_FIXED_TYPE_BLOCK().
1769 /* String blocks contain this many useful bytes. */
1770 #define STRING_CHARS_BLOCK_SIZE \
1771 ((Bytecount) (8192 - MALLOC_OVERHEAD - \
1772 ((2 * sizeof (struct string_chars_block *)) \
1773 + sizeof (EMACS_INT))))
1774 /* Block header for small strings. */
1775 struct string_chars_block
1778 struct string_chars_block *next;
1779 struct string_chars_block *prev;
1780 /* Contents of string_chars_block->string_chars are interleaved
1781 string_chars structures (see below) and the actual string data */
1782 unsigned char string_chars[STRING_CHARS_BLOCK_SIZE];
1785 static struct string_chars_block *first_string_chars_block;
1786 static struct string_chars_block *current_string_chars_block;
1788 /* If SIZE is the length of a string, this returns how many bytes
1789 * the string occupies in string_chars_block->string_chars
1790 * (including alignment padding).
1792 #define STRING_FULLSIZE(size) \
1793 ALIGN_SIZE (((size) + 1 + sizeof (Lisp_String *)),\
1794 ALIGNOF (Lisp_String *))
1796 #define BIG_STRING_FULLSIZE_P(fullsize) ((fullsize) >= STRING_CHARS_BLOCK_SIZE)
1797 #define BIG_STRING_SIZE_P(size) (BIG_STRING_FULLSIZE_P (STRING_FULLSIZE(size)))
1801 Lisp_String *string;
1802 unsigned char chars[1];
1805 struct unused_string_chars
1807 Lisp_String *string;
1812 init_string_chars_alloc (void)
1814 first_string_chars_block = xnew (struct string_chars_block);
1815 first_string_chars_block->prev = 0;
1816 first_string_chars_block->next = 0;
1817 first_string_chars_block->pos = 0;
1818 current_string_chars_block = first_string_chars_block;
1821 static struct string_chars *
1822 allocate_string_chars_struct (Lisp_String *string_it_goes_with,
1825 struct string_chars *s_chars;
1828 (countof (current_string_chars_block->string_chars)
1829 - current_string_chars_block->pos))
1831 /* This string can fit in the current string chars block */
1832 s_chars = (struct string_chars *)
1833 (current_string_chars_block->string_chars
1834 + current_string_chars_block->pos);
1835 current_string_chars_block->pos += fullsize;
1839 /* Make a new current string chars block */
1840 struct string_chars_block *new_scb = xnew (struct string_chars_block);
1842 current_string_chars_block->next = new_scb;
1843 new_scb->prev = current_string_chars_block;
1845 current_string_chars_block = new_scb;
1846 new_scb->pos = fullsize;
1847 s_chars = (struct string_chars *)
1848 current_string_chars_block->string_chars;
1851 s_chars->string = string_it_goes_with;
1853 INCREMENT_CONS_COUNTER (fullsize, "string chars");
1859 make_uninit_string (Bytecount length)
1862 EMACS_INT fullsize = STRING_FULLSIZE (length);
1865 assert (length >= 0 && fullsize > 0);
1867 /* Allocate the string header */
1868 ALLOCATE_FIXED_TYPE (string, Lisp_String, s);
1869 set_lheader_implementation (&(s->lheader), &lrecord_string);
1871 set_string_data (s, BIG_STRING_FULLSIZE_P (fullsize)
1872 ? xnew_array (Bufbyte, length + 1)
1873 : allocate_string_chars_struct (s, fullsize)->chars);
1875 set_string_length (s, length);
1878 set_string_byte (s, length, 0);
1880 XSETSTRING (val, s);
1884 #ifdef VERIFY_STRING_CHARS_INTEGRITY
1885 static void verify_string_chars_integrity (void);
1888 /* Resize the string S so that DELTA bytes can be inserted starting
1889 at POS. If DELTA < 0, it means deletion starting at POS. If
1890 POS < 0, resize the string but don't copy any characters. Use
1891 this if you're planning on completely overwriting the string.
1895 resize_string (Lisp_String *s, Bytecount pos, Bytecount delta)
1897 Bytecount oldfullsize, newfullsize;
1898 #ifdef VERIFY_STRING_CHARS_INTEGRITY
1899 verify_string_chars_integrity ();
1902 #ifdef ERROR_CHECK_BUFPOS
1905 assert (pos <= string_length (s));
1907 assert (pos + (-delta) <= string_length (s));
1912 assert ((-delta) <= string_length (s));
1914 #endif /* ERROR_CHECK_BUFPOS */
1917 /* simplest case: no size change. */
1920 if (pos >= 0 && delta < 0)
1921 /* If DELTA < 0, the functions below will delete the characters
1922 before POS. We want to delete characters *after* POS, however,
1923 so convert this to the appropriate form. */
1926 oldfullsize = STRING_FULLSIZE (string_length (s));
1927 newfullsize = STRING_FULLSIZE (string_length (s) + delta);
1929 if (BIG_STRING_FULLSIZE_P (oldfullsize))
1931 if (BIG_STRING_FULLSIZE_P (newfullsize))
1933 /* Both strings are big. We can just realloc(). */
1934 set_string_data (s, (Bufbyte *) xrealloc (string_data (s),
1935 string_length (s) + delta + 1));
1938 Bufbyte *addroff = pos + string_data (s);
1940 memmove (addroff + delta, addroff,
1941 string_length (s) + 1 - pos);
1944 else /* String has been demoted from BIG_STRING. */
1947 allocate_string_chars_struct (s, newfullsize)->chars;
1948 Bufbyte *old_data = string_data (s);
1952 memcpy (new_data, old_data, pos);
1953 memcpy (new_data + pos + delta, old_data + pos,
1954 string_length (s) + 1 - pos);
1956 set_string_data (s, new_data);
1960 else /* old string is small */
1962 if (oldfullsize == newfullsize)
1964 /* special case; size change but the necessary
1965 allocation size won't change (up or down; code
1966 somewhere depends on there not being any unused
1967 allocation space, modulo any alignment
1971 Bufbyte *addroff = pos + string_data (s);
1973 memmove (addroff + delta, addroff,
1974 /* +1 due to zero-termination. */
1975 string_length (s) + 1 - pos);
1980 Bufbyte *old_data = string_data (s);
1982 BIG_STRING_FULLSIZE_P (newfullsize)
1983 ? xnew_array (Bufbyte, string_length (s) + delta + 1)
1984 : allocate_string_chars_struct (s, newfullsize)->chars;
1988 memcpy (new_data, old_data, pos);
1989 memcpy (new_data + pos + delta, old_data + pos,
1990 string_length (s) + 1 - pos);
1992 set_string_data (s, new_data);
1995 /* We need to mark this chunk of the string_chars_block
1996 as unused so that compact_string_chars() doesn't
1998 struct string_chars *old_s_chars = (struct string_chars *)
1999 ((char *) old_data - offsetof (struct string_chars, chars));
2000 /* Sanity check to make sure we aren't hosed by strange
2001 alignment/padding. */
2002 assert (old_s_chars->string == s);
2003 MARK_STRUCT_AS_FREE (old_s_chars);
2004 ((struct unused_string_chars *) old_s_chars)->fullsize =
2010 set_string_length (s, string_length (s) + delta);
2011 /* If pos < 0, the string won't be zero-terminated.
2012 Terminate now just to make sure. */
2013 string_data (s)[string_length (s)] = '\0';
2019 XSETSTRING (string, s);
2020 /* We also have to adjust all of the extent indices after the
2021 place we did the change. We say "pos - 1" because
2022 adjust_extents() is exclusive of the starting position
2024 adjust_extents (string, pos - 1, string_length (s),
2028 #ifdef VERIFY_STRING_CHARS_INTEGRITY
2029 verify_string_chars_integrity ();
2036 set_string_char (Lisp_String *s, Charcount i, Emchar c)
2038 Bufbyte newstr[MAX_EMCHAR_LEN];
2039 Bytecount bytoff = charcount_to_bytecount (string_data (s), i);
2040 Bytecount oldlen = charcount_to_bytecount (string_data (s) + bytoff, 1);
2041 Bytecount newlen = set_charptr_emchar (newstr, c);
2043 if (oldlen != newlen)
2044 resize_string (s, bytoff, newlen - oldlen);
2045 /* Remember, string_data (s) might have changed so we can't cache it. */
2046 memcpy (string_data (s) + bytoff, newstr, newlen);
2051 DEFUN ("make-string", Fmake_string, 2, 2, 0, /*
2052 Return a new string of length LENGTH, with each character being INIT.
2053 LENGTH must be an integer and INIT must be a character.
2057 CHECK_NATNUM (length);
2058 CHECK_CHAR_COERCE_INT (init);
2060 Bufbyte init_str[MAX_EMCHAR_LEN];
2061 int len = set_charptr_emchar (init_str, XCHAR (init));
2062 Lisp_Object val = make_uninit_string (len * XINT (length));
2065 /* Optimize the single-byte case */
2066 memset (XSTRING_DATA (val), XCHAR (init), XSTRING_LENGTH (val));
2070 Bufbyte *ptr = XSTRING_DATA (val);
2072 for (i = XINT (length); i; i--)
2074 Bufbyte *init_ptr = init_str;
2078 case 6: *ptr++ = *init_ptr++;
2079 case 5: *ptr++ = *init_ptr++;
2081 case 4: *ptr++ = *init_ptr++;
2082 case 3: *ptr++ = *init_ptr++;
2083 case 2: *ptr++ = *init_ptr++;
2084 case 1: *ptr++ = *init_ptr++;
2092 DEFUN ("string", Fstring, 0, MANY, 0, /*
2093 Concatenate all the argument characters and make the result a string.
2095 (int nargs, Lisp_Object *args))
2097 Bufbyte *storage = alloca_array (Bufbyte, nargs * MAX_EMCHAR_LEN);
2098 Bufbyte *p = storage;
2100 for (; nargs; nargs--, args++)
2102 Lisp_Object lisp_char = *args;
2103 CHECK_CHAR_COERCE_INT (lisp_char);
2104 p += set_charptr_emchar (p, XCHAR (lisp_char));
2106 return make_string (storage, p - storage);
2110 /* Take some raw memory, which MUST already be in internal format,
2111 and package it up into a Lisp string. */
2113 make_string (CONST Bufbyte *contents, Bytecount length)
2117 /* Make sure we find out about bad make_string's when they happen */
2118 #if defined (ERROR_CHECK_BUFPOS) && defined (MULE)
2119 bytecount_to_charcount (contents, length); /* Just for the assertions */
2122 val = make_uninit_string (length);
2123 memcpy (XSTRING_DATA (val), contents, length);
2127 /* Take some raw memory, encoded in some external data format,
2128 and convert it into a Lisp string. */
2130 make_ext_string (CONST Extbyte *contents, EMACS_INT length,
2131 enum external_data_format fmt)
2136 GET_CHARPTR_INT_DATA_ALLOCA (contents, length, fmt, intstr, intlen);
2137 return make_string (intstr, intlen);
2141 build_string (CONST char *str)
2143 /* Some strlen's crash and burn if passed null. */
2144 return make_string ((CONST Bufbyte *) str, (str ? strlen(str) : 0));
2148 build_ext_string (CONST char *str, enum external_data_format fmt)
2150 /* Some strlen's crash and burn if passed null. */
2151 return make_ext_string ((CONST Extbyte *) str, (str ? strlen(str) : 0), fmt);
2155 build_translated_string (CONST char *str)
2157 return build_string (GETTEXT (str));
2161 make_string_nocopy (CONST Bufbyte *contents, Bytecount length)
2166 /* Make sure we find out about bad make_string_nocopy's when they happen */
2167 #if defined (ERROR_CHECK_BUFPOS) && defined (MULE)
2168 bytecount_to_charcount (contents, length); /* Just for the assertions */
2171 /* Allocate the string header */
2172 ALLOCATE_FIXED_TYPE (string, Lisp_String, s);
2173 set_lheader_implementation (&(s->lheader), &lrecord_string);
2174 SET_C_READONLY_RECORD_HEADER (&s->lheader);
2176 set_string_data (s, (Bufbyte *)contents);
2177 set_string_length (s, length);
2179 XSETSTRING (val, s);
2184 /************************************************************************/
2185 /* lcrecord lists */
2186 /************************************************************************/
2188 /* Lcrecord lists are used to manage the allocation of particular
2189 sorts of lcrecords, to avoid calling alloc_lcrecord() (and thus
2190 malloc() and garbage-collection junk) as much as possible.
2191 It is similar to the Blocktype class.
2195 1) Create an lcrecord-list object using make_lcrecord_list().
2196 This is often done at initialization. Remember to staticpro_nodump
2197 this object! The arguments to make_lcrecord_list() are the
2198 same as would be passed to alloc_lcrecord().
2199 2) Instead of calling alloc_lcrecord(), call allocate_managed_lcrecord()
2200 and pass the lcrecord-list earlier created.
2201 3) When done with the lcrecord, call free_managed_lcrecord().
2202 The standard freeing caveats apply: ** make sure there are no
2203 pointers to the object anywhere! **
2204 4) Calling free_managed_lcrecord() is just like kissing the
2205 lcrecord goodbye as if it were garbage-collected. This means:
2206 -- the contents of the freed lcrecord are undefined, and the
2207 contents of something produced by allocate_managed_lcrecord()
2208 are undefined, just like for alloc_lcrecord().
2209 -- the mark method for the lcrecord's type will *NEVER* be called
2211 -- the finalize method for the lcrecord's type will be called
2212 at the time that free_managed_lcrecord() is called.
2217 mark_lcrecord_list (Lisp_Object obj)
2219 struct lcrecord_list *list = XLCRECORD_LIST (obj);
2220 Lisp_Object chain = list->free;
2222 while (!NILP (chain))
2224 struct lrecord_header *lheader = XRECORD_LHEADER (chain);
2225 struct free_lcrecord_header *free_header =
2226 (struct free_lcrecord_header *) lheader;
2228 #ifdef ERROR_CHECK_GC
2229 CONST struct lrecord_implementation *implementation
2230 = LHEADER_IMPLEMENTATION(lheader);
2232 /* There should be no other pointers to the free list. */
2233 assert (!MARKED_RECORD_HEADER_P (lheader));
2234 /* Only lcrecords should be here. */
2235 assert (!implementation->basic_p);
2236 /* Only free lcrecords should be here. */
2237 assert (free_header->lcheader.free);
2238 /* The type of the lcrecord must be right. */
2239 assert (implementation == list->implementation);
2240 /* So must the size. */
2241 assert (implementation->static_size == 0
2242 || implementation->static_size == list->size);
2243 #endif /* ERROR_CHECK_GC */
2245 MARK_RECORD_HEADER (lheader);
2246 chain = free_header->chain;
2252 DEFINE_LRECORD_IMPLEMENTATION ("lcrecord-list", lcrecord_list,
2253 mark_lcrecord_list, internal_object_printer,
2254 0, 0, 0, 0, struct lcrecord_list);
2256 make_lcrecord_list (size_t size,
2257 CONST struct lrecord_implementation *implementation)
2259 struct lcrecord_list *p = alloc_lcrecord_type (struct lcrecord_list,
2260 &lrecord_lcrecord_list);
2263 p->implementation = implementation;
2266 XSETLCRECORD_LIST (val, p);
2271 allocate_managed_lcrecord (Lisp_Object lcrecord_list)
2273 struct lcrecord_list *list = XLCRECORD_LIST (lcrecord_list);
2274 if (!NILP (list->free))
2276 Lisp_Object val = list->free;
2277 struct free_lcrecord_header *free_header =
2278 (struct free_lcrecord_header *) XPNTR (val);
2280 #ifdef ERROR_CHECK_GC
2281 struct lrecord_header *lheader =
2282 (struct lrecord_header *) free_header;
2283 CONST struct lrecord_implementation *implementation
2284 = LHEADER_IMPLEMENTATION (lheader);
2286 /* There should be no other pointers to the free list. */
2287 assert (!MARKED_RECORD_HEADER_P (lheader));
2288 /* Only lcrecords should be here. */
2289 assert (!implementation->basic_p);
2290 /* Only free lcrecords should be here. */
2291 assert (free_header->lcheader.free);
2292 /* The type of the lcrecord must be right. */
2293 assert (implementation == list->implementation);
2294 /* So must the size. */
2295 assert (implementation->static_size == 0
2296 || implementation->static_size == list->size);
2297 #endif /* ERROR_CHECK_GC */
2298 list->free = free_header->chain;
2299 free_header->lcheader.free = 0;
2306 XSETOBJ (val, Lisp_Type_Record,
2307 alloc_lcrecord (list->size, list->implementation));
2313 free_managed_lcrecord (Lisp_Object lcrecord_list, Lisp_Object lcrecord)
2315 struct lcrecord_list *list = XLCRECORD_LIST (lcrecord_list);
2316 struct free_lcrecord_header *free_header =
2317 (struct free_lcrecord_header *) XPNTR (lcrecord);
2318 struct lrecord_header *lheader =
2319 (struct lrecord_header *) free_header;
2320 CONST struct lrecord_implementation *implementation
2321 = LHEADER_IMPLEMENTATION (lheader);
2323 #ifdef ERROR_CHECK_GC
2324 /* Make sure the size is correct. This will catch, for example,
2325 putting a window configuration on the wrong free list. */
2326 if (implementation->size_in_bytes_method)
2327 assert (implementation->size_in_bytes_method (lheader) == list->size);
2329 assert (implementation->static_size == list->size);
2330 #endif /* ERROR_CHECK_GC */
2332 if (implementation->finalizer)
2333 implementation->finalizer (lheader, 0);
2334 free_header->chain = list->free;
2335 free_header->lcheader.free = 1;
2336 list->free = lcrecord;
2342 DEFUN ("purecopy", Fpurecopy, 1, 1, 0, /*
2343 Kept for compatibility, returns its argument.
2345 Make a copy of OBJECT in pure storage.
2346 Recursively copies contents of vectors and cons cells.
2347 Does not copy symbols.
2356 /************************************************************************/
2357 /* Garbage Collection */
2358 /************************************************************************/
2360 /* This will be used more extensively In The Future */
2361 static int last_lrecord_type_index_assigned;
2363 CONST struct lrecord_implementation *lrecord_implementations_table[128];
2364 #define max_lrecord_type (countof (lrecord_implementations_table) - 1)
2366 struct gcpro *gcprolist;
2368 /* 415 used Mly 29-Jun-93 */
2369 /* 1327 used slb 28-Feb-98 */
2370 /* 1328 used og 03-Oct-99 (moving slowly, heh?) */
2372 #define NSTATICS 4000
2374 #define NSTATICS 2000
2376 /* Not "static" because of linker lossage on some systems */
2377 Lisp_Object *staticvec[NSTATICS]
2378 /* Force it into data space! */
2380 static int staticidx;
2382 /* Put an entry in staticvec, pointing at the variable whose address is given
2385 staticpro (Lisp_Object *varaddress)
2387 if (staticidx >= countof (staticvec))
2388 /* #### This is now a dubious abort() since this routine may be called */
2389 /* by Lisp attempting to load a DLL. */
2391 staticvec[staticidx++] = varaddress;
2394 /* Not "static" because of linker lossage on some systems */
2395 Lisp_Object *staticvec_nodump[200]
2396 /* Force it into data space! */
2398 static int staticidx_nodump;
2400 /* Put an entry in staticvec_nodump, pointing at the variable whose address is given
2403 staticpro_nodump (Lisp_Object *varaddress)
2405 if (staticidx_nodump >= countof (staticvec_nodump))
2406 /* #### This is now a dubious abort() since this routine may be called */
2407 /* by Lisp attempting to load a DLL. */
2409 staticvec_nodump[staticidx_nodump++] = varaddress;
2412 /* Not "static" because of linker lossage on some systems */
2415 const struct struct_description *desc;
2416 } dumpstructvec[200];
2418 static int dumpstructidx;
2420 /* Put an entry in dumpstructvec, pointing at the variable whose address is given
2423 dumpstruct (void *varaddress, const struct struct_description *desc)
2425 if (dumpstructidx >= countof (dumpstructvec))
2427 dumpstructvec[dumpstructidx].data = varaddress;
2428 dumpstructvec[dumpstructidx].desc = desc;
2432 Lisp_Object *pdump_wirevec[50];
2433 static int pdump_wireidx;
2435 /* Put an entry in pdump_wirevec, pointing at the variable whose address is given
2438 pdump_wire (Lisp_Object *varaddress)
2440 if (pdump_wireidx >= countof (pdump_wirevec))
2442 pdump_wirevec[pdump_wireidx++] = varaddress;
2446 Lisp_Object *pdump_wirevec_list[50];
2447 static int pdump_wireidx_list;
2449 /* Put an entry in pdump_wirevec_list, pointing at the variable whose address is given
2452 pdump_wire_list (Lisp_Object *varaddress)
2454 if (pdump_wireidx_list >= countof (pdump_wirevec_list))
2456 pdump_wirevec_list[pdump_wireidx_list++] = varaddress;
2460 /* Mark reference to a Lisp_Object. If the object referred to has not been
2461 seen yet, recursively mark all the references contained in it. */
2464 mark_object (Lisp_Object obj)
2468 #ifdef ERROR_CHECK_GC
2469 assert (! (EQ (obj, Qnull_pointer)));
2471 /* Checks we used to perform */
2472 /* if (EQ (obj, Qnull_pointer)) return; */
2473 /* if (!POINTER_TYPE_P (XGCTYPE (obj))) return; */
2474 /* if (PURIFIED (XPNTR (obj))) return; */
2476 if (XTYPE (obj) == Lisp_Type_Record)
2478 struct lrecord_header *lheader = XRECORD_LHEADER (obj);
2479 #if defined (ERROR_CHECK_GC)
2480 assert (lheader->type <= last_lrecord_type_index_assigned);
2482 if (C_READONLY_RECORD_HEADER_P (lheader))
2485 if (! MARKED_RECORD_HEADER_P (lheader) &&
2486 ! UNMARKABLE_RECORD_HEADER_P (lheader))
2488 CONST struct lrecord_implementation *implementation =
2489 LHEADER_IMPLEMENTATION (lheader);
2490 MARK_RECORD_HEADER (lheader);
2491 #ifdef ERROR_CHECK_GC
2492 if (!implementation->basic_p)
2493 assert (! ((struct lcrecord_header *) lheader)->free);
2495 if (implementation->marker)
2497 obj = implementation->marker (obj);
2498 if (!NILP (obj)) goto tail_recurse;
2504 /* mark all of the conses in a list and mark the final cdr; but
2505 DO NOT mark the cars.
2507 Use only for internal lists! There should never be other pointers
2508 to the cons cells, because if so, the cars will remain unmarked
2509 even when they maybe should be marked. */
2511 mark_conses_in_list (Lisp_Object obj)
2515 for (rest = obj; CONSP (rest); rest = XCDR (rest))
2517 if (CONS_MARKED_P (XCONS (rest)))
2519 MARK_CONS (XCONS (rest));
2526 /* Find all structures not marked, and free them. */
2528 static int gc_count_num_bit_vector_used, gc_count_bit_vector_total_size;
2529 static int gc_count_bit_vector_storage;
2530 static int gc_count_num_short_string_in_use;
2531 static int gc_count_string_total_size;
2532 static int gc_count_short_string_total_size;
2534 /* static int gc_count_total_records_used, gc_count_records_total_size; */
2538 lrecord_type_index (CONST struct lrecord_implementation *implementation)
2540 int type_index = *(implementation->lrecord_type_index);
2541 /* Have to do this circuitous validation test because of problems
2542 dumping out initialized variables (ie can't set xxx_type_index to -1
2543 because that would make xxx_type_index read-only in a dumped emacs. */
2544 if (type_index < 0 || type_index > max_lrecord_type
2545 || lrecord_implementations_table[type_index] != implementation)
2547 assert (last_lrecord_type_index_assigned < max_lrecord_type);
2548 type_index = ++last_lrecord_type_index_assigned;
2549 lrecord_implementations_table[type_index] = implementation;
2550 *(implementation->lrecord_type_index) = type_index;
2555 /* stats on lcrecords in use - kinda kludgy */
2559 int instances_in_use;
2561 int instances_freed;
2563 int instances_on_free_list;
2564 } lcrecord_stats [countof (lrecord_implementations_table)];
2567 tick_lcrecord_stats (CONST struct lrecord_header *h, int free_p)
2569 CONST struct lrecord_implementation *implementation =
2570 LHEADER_IMPLEMENTATION (h);
2571 int type_index = lrecord_type_index (implementation);
2573 if (((struct lcrecord_header *) h)->free)
2576 lcrecord_stats[type_index].instances_on_free_list++;
2580 size_t sz = (implementation->size_in_bytes_method
2581 ? implementation->size_in_bytes_method (h)
2582 : implementation->static_size);
2586 lcrecord_stats[type_index].instances_freed++;
2587 lcrecord_stats[type_index].bytes_freed += sz;
2591 lcrecord_stats[type_index].instances_in_use++;
2592 lcrecord_stats[type_index].bytes_in_use += sz;
2598 /* Free all unmarked records */
2600 sweep_lcrecords_1 (struct lcrecord_header **prev, int *used)
2602 struct lcrecord_header *header;
2604 /* int total_size = 0; */
2606 xzero (lcrecord_stats); /* Reset all statistics to 0. */
2608 /* First go through and call all the finalize methods.
2609 Then go through and free the objects. There used to
2610 be only one loop here, with the call to the finalizer
2611 occurring directly before the xfree() below. That
2612 is marginally faster but much less safe -- if the
2613 finalize method for an object needs to reference any
2614 other objects contained within it (and many do),
2615 we could easily be screwed by having already freed that
2618 for (header = *prev; header; header = header->next)
2620 struct lrecord_header *h = &(header->lheader);
2621 if (!C_READONLY_RECORD_HEADER_P(h)
2622 && !MARKED_RECORD_HEADER_P (h)
2623 && ! (header->free))
2625 if (LHEADER_IMPLEMENTATION (h)->finalizer)
2626 LHEADER_IMPLEMENTATION (h)->finalizer (h, 0);
2630 for (header = *prev; header; )
2632 struct lrecord_header *h = &(header->lheader);
2633 if (C_READONLY_RECORD_HEADER_P(h) || MARKED_RECORD_HEADER_P (h))
2635 if (MARKED_RECORD_HEADER_P (h))
2636 UNMARK_RECORD_HEADER (h);
2638 /* total_size += n->implementation->size_in_bytes (h);*/
2639 /* ### May modify header->next on a C_READONLY lcrecord */
2640 prev = &(header->next);
2642 tick_lcrecord_stats (h, 0);
2646 struct lcrecord_header *next = header->next;
2648 tick_lcrecord_stats (h, 1);
2649 /* used to call finalizer right here. */
2655 /* *total = total_size; */
2660 sweep_bit_vectors_1 (Lisp_Object *prev,
2661 int *used, int *total, int *storage)
2663 Lisp_Object bit_vector;
2666 int total_storage = 0;
2668 /* BIT_VECTORP fails because the objects are marked, which changes
2669 their implementation */
2670 for (bit_vector = *prev; !EQ (bit_vector, Qzero); )
2672 Lisp_Bit_Vector *v = XBIT_VECTOR (bit_vector);
2674 if (C_READONLY_RECORD_HEADER_P(&(v->lheader)) || MARKED_RECORD_P (bit_vector))
2676 if (MARKED_RECORD_P (bit_vector))
2677 UNMARK_RECORD_HEADER (&(v->lheader));
2681 STRETCHY_STRUCT_SIZEOF (Lisp_Bit_Vector, bits,
2682 BIT_VECTOR_LONG_STORAGE (len));
2684 /* ### May modify next on a C_READONLY bitvector */
2685 prev = &(bit_vector_next (v));
2690 Lisp_Object next = bit_vector_next (v);
2697 *total = total_size;
2698 *storage = total_storage;
2701 /* And the Lord said: Thou shalt use the `c-backslash-region' command
2702 to make macros prettier. */
2704 #ifdef ERROR_CHECK_GC
2706 #define SWEEP_FIXED_TYPE_BLOCK(typename, obj_type) \
2708 struct typename##_block *SFTB_current; \
2709 struct typename##_block **SFTB_prev; \
2711 int num_free = 0, num_used = 0; \
2713 for (SFTB_prev = ¤t_##typename##_block, \
2714 SFTB_current = current_##typename##_block, \
2715 SFTB_limit = current_##typename##_block_index; \
2721 for (SFTB_iii = 0; SFTB_iii < SFTB_limit; SFTB_iii++) \
2723 obj_type *SFTB_victim = &(SFTB_current->block[SFTB_iii]); \
2725 if (FREE_STRUCT_P (SFTB_victim)) \
2729 else if (C_READONLY_RECORD_HEADER_P (&SFTB_victim->lheader)) \
2733 else if (!MARKED_RECORD_HEADER_P (&SFTB_victim->lheader)) \
2736 FREE_FIXED_TYPE (typename, obj_type, SFTB_victim); \
2741 UNMARK_##typename (SFTB_victim); \
2744 SFTB_prev = &(SFTB_current->prev); \
2745 SFTB_current = SFTB_current->prev; \
2746 SFTB_limit = countof (current_##typename##_block->block); \
2749 gc_count_num_##typename##_in_use = num_used; \
2750 gc_count_num_##typename##_freelist = num_free; \
2753 #else /* !ERROR_CHECK_GC */
2755 #define SWEEP_FIXED_TYPE_BLOCK(typename, obj_type) \
2757 struct typename##_block *SFTB_current; \
2758 struct typename##_block **SFTB_prev; \
2760 int num_free = 0, num_used = 0; \
2762 typename##_free_list = 0; \
2764 for (SFTB_prev = ¤t_##typename##_block, \
2765 SFTB_current = current_##typename##_block, \
2766 SFTB_limit = current_##typename##_block_index; \
2771 int SFTB_empty = 1; \
2772 obj_type *SFTB_old_free_list = typename##_free_list; \
2774 for (SFTB_iii = 0; SFTB_iii < SFTB_limit; SFTB_iii++) \
2776 obj_type *SFTB_victim = &(SFTB_current->block[SFTB_iii]); \
2778 if (FREE_STRUCT_P (SFTB_victim)) \
2781 PUT_FIXED_TYPE_ON_FREE_LIST (typename, obj_type, SFTB_victim); \
2783 else if (C_READONLY_RECORD_HEADER_P (&SFTB_victim->lheader)) \
2788 else if (!MARKED_RECORD_HEADER_P (&SFTB_victim->lheader)) \
2791 FREE_FIXED_TYPE (typename, obj_type, SFTB_victim); \
2797 UNMARK_##typename (SFTB_victim); \
2802 SFTB_prev = &(SFTB_current->prev); \
2803 SFTB_current = SFTB_current->prev; \
2805 else if (SFTB_current == current_##typename##_block \
2806 && !SFTB_current->prev) \
2808 /* No real point in freeing sole allocation block */ \
2813 struct typename##_block *SFTB_victim_block = SFTB_current; \
2814 if (SFTB_victim_block == current_##typename##_block) \
2815 current_##typename##_block_index \
2816 = countof (current_##typename##_block->block); \
2817 SFTB_current = SFTB_current->prev; \
2819 *SFTB_prev = SFTB_current; \
2820 xfree (SFTB_victim_block); \
2821 /* Restore free list to what it was before victim was swept */ \
2822 typename##_free_list = SFTB_old_free_list; \
2823 num_free -= SFTB_limit; \
2826 SFTB_limit = countof (current_##typename##_block->block); \
2829 gc_count_num_##typename##_in_use = num_used; \
2830 gc_count_num_##typename##_freelist = num_free; \
2833 #endif /* !ERROR_CHECK_GC */
2841 #define UNMARK_cons(ptr) UNMARK_RECORD_HEADER (&((ptr)->lheader))
2842 #define ADDITIONAL_FREE_cons(ptr)
2844 SWEEP_FIXED_TYPE_BLOCK (cons, struct Lisp_Cons);
2847 /* Explicitly free a cons cell. */
2849 free_cons (struct Lisp_Cons *ptr)
2851 #ifdef ERROR_CHECK_GC
2852 /* If the CAR is not an int, then it will be a pointer, which will
2853 always be four-byte aligned. If this cons cell has already been
2854 placed on the free list, however, its car will probably contain
2855 a chain pointer to the next cons on the list, which has cleverly
2856 had all its 0's and 1's inverted. This allows for a quick
2857 check to make sure we're not freeing something already freed. */
2858 if (POINTER_TYPE_P (XTYPE (ptr->car)))
2859 ASSERT_VALID_POINTER (XPNTR (ptr->car));
2860 #endif /* ERROR_CHECK_GC */
2862 #ifndef ALLOC_NO_POOLS
2863 FREE_FIXED_TYPE_WHEN_NOT_IN_GC (cons, struct Lisp_Cons, ptr);
2864 #endif /* ALLOC_NO_POOLS */
2867 /* explicitly free a list. You **must make sure** that you have
2868 created all the cons cells that make up this list and that there
2869 are no pointers to any of these cons cells anywhere else. If there
2870 are, you will lose. */
2873 free_list (Lisp_Object list)
2875 Lisp_Object rest, next;
2877 for (rest = list; !NILP (rest); rest = next)
2880 free_cons (XCONS (rest));
2884 /* explicitly free an alist. You **must make sure** that you have
2885 created all the cons cells that make up this alist and that there
2886 are no pointers to any of these cons cells anywhere else. If there
2887 are, you will lose. */
2890 free_alist (Lisp_Object alist)
2892 Lisp_Object rest, next;
2894 for (rest = alist; !NILP (rest); rest = next)
2897 free_cons (XCONS (XCAR (rest)));
2898 free_cons (XCONS (rest));
2903 sweep_compiled_functions (void)
2905 #define UNMARK_compiled_function(ptr) UNMARK_RECORD_HEADER (&((ptr)->lheader))
2906 #define ADDITIONAL_FREE_compiled_function(ptr)
2908 SWEEP_FIXED_TYPE_BLOCK (compiled_function, Lisp_Compiled_Function);
2912 #ifdef LISP_FLOAT_TYPE
2916 #define UNMARK_float(ptr) UNMARK_RECORD_HEADER (&((ptr)->lheader))
2917 #define ADDITIONAL_FREE_float(ptr)
2919 SWEEP_FIXED_TYPE_BLOCK (float, struct Lisp_Float);
2921 #endif /* LISP_FLOAT_TYPE */
2924 sweep_symbols (void)
2926 #define UNMARK_symbol(ptr) UNMARK_RECORD_HEADER (&((ptr)->lheader))
2927 #define ADDITIONAL_FREE_symbol(ptr)
2929 SWEEP_FIXED_TYPE_BLOCK (symbol, struct Lisp_Symbol);
2933 sweep_extents (void)
2935 #define UNMARK_extent(ptr) UNMARK_RECORD_HEADER (&((ptr)->lheader))
2936 #define ADDITIONAL_FREE_extent(ptr)
2938 SWEEP_FIXED_TYPE_BLOCK (extent, struct extent);
2944 #define UNMARK_event(ptr) UNMARK_RECORD_HEADER (&((ptr)->lheader))
2945 #define ADDITIONAL_FREE_event(ptr)
2947 SWEEP_FIXED_TYPE_BLOCK (event, struct Lisp_Event);
2951 sweep_markers (void)
2953 #define UNMARK_marker(ptr) UNMARK_RECORD_HEADER (&((ptr)->lheader))
2954 #define ADDITIONAL_FREE_marker(ptr) \
2955 do { Lisp_Object tem; \
2956 XSETMARKER (tem, ptr); \
2957 unchain_marker (tem); \
2960 SWEEP_FIXED_TYPE_BLOCK (marker, struct Lisp_Marker);
2963 /* Explicitly free a marker. */
2965 free_marker (struct Lisp_Marker *ptr)
2967 #ifdef ERROR_CHECK_GC
2968 /* Perhaps this will catch freeing an already-freed marker. */
2970 XSETMARKER (temmy, ptr);
2971 assert (MARKERP (temmy));
2972 #endif /* ERROR_CHECK_GC */
2974 #ifndef ALLOC_NO_POOLS
2975 FREE_FIXED_TYPE_WHEN_NOT_IN_GC (marker, struct Lisp_Marker, ptr);
2976 #endif /* ALLOC_NO_POOLS */
2980 #if defined (MULE) && defined (VERIFY_STRING_CHARS_INTEGRITY)
2983 verify_string_chars_integrity (void)
2985 struct string_chars_block *sb;
2987 /* Scan each existing string block sequentially, string by string. */
2988 for (sb = first_string_chars_block; sb; sb = sb->next)
2991 /* POS is the index of the next string in the block. */
2992 while (pos < sb->pos)
2994 struct string_chars *s_chars =
2995 (struct string_chars *) &(sb->string_chars[pos]);
2996 Lisp_String *string;
3000 /* If the string_chars struct is marked as free (i.e. the STRING
3001 pointer is 0xFFFFFFFF) then this is an unused chunk of string
3002 storage. (See below.) */
3004 if (FREE_STRUCT_P (s_chars))
3006 fullsize = ((struct unused_string_chars *) s_chars)->fullsize;
3011 string = s_chars->string;
3012 /* Must be 32-bit aligned. */
3013 assert ((((int) string) & 3) == 0);
3015 size = string_length (string);
3016 fullsize = STRING_FULLSIZE (size);
3018 assert (!BIG_STRING_FULLSIZE_P (fullsize));
3019 assert (string_data (string) == s_chars->chars);
3022 assert (pos == sb->pos);
3026 #endif /* MULE && ERROR_CHECK_GC */
3028 /* Compactify string chars, relocating the reference to each --
3029 free any empty string_chars_block we see. */
3031 compact_string_chars (void)
3033 struct string_chars_block *to_sb = first_string_chars_block;
3035 struct string_chars_block *from_sb;
3037 /* Scan each existing string block sequentially, string by string. */
3038 for (from_sb = first_string_chars_block; from_sb; from_sb = from_sb->next)
3041 /* FROM_POS is the index of the next string in the block. */
3042 while (from_pos < from_sb->pos)
3044 struct string_chars *from_s_chars =
3045 (struct string_chars *) &(from_sb->string_chars[from_pos]);
3046 struct string_chars *to_s_chars;
3047 Lisp_String *string;
3051 /* If the string_chars struct is marked as free (i.e. the STRING
3052 pointer is 0xFFFFFFFF) then this is an unused chunk of string
3053 storage. This happens under Mule when a string's size changes
3054 in such a way that its fullsize changes. (Strings can change
3055 size because a different-length character can be substituted
3056 for another character.) In this case, after the bogus string
3057 pointer is the "fullsize" of this entry, i.e. how many bytes
3060 if (FREE_STRUCT_P (from_s_chars))
3062 fullsize = ((struct unused_string_chars *) from_s_chars)->fullsize;
3063 from_pos += fullsize;
3067 string = from_s_chars->string;
3068 assert (!(FREE_STRUCT_P (string)));
3070 size = string_length (string);
3071 fullsize = STRING_FULLSIZE (size);
3073 if (BIG_STRING_FULLSIZE_P (fullsize))
3076 /* Just skip it if it isn't marked. */
3077 if (! MARKED_RECORD_HEADER_P (&(string->lheader)))
3079 from_pos += fullsize;
3083 /* If it won't fit in what's left of TO_SB, close TO_SB out
3084 and go on to the next string_chars_block. We know that TO_SB
3085 cannot advance past FROM_SB here since FROM_SB is large enough
3086 to currently contain this string. */
3087 if ((to_pos + fullsize) > countof (to_sb->string_chars))
3089 to_sb->pos = to_pos;
3090 to_sb = to_sb->next;
3094 /* Compute new address of this string
3095 and update TO_POS for the space being used. */
3096 to_s_chars = (struct string_chars *) &(to_sb->string_chars[to_pos]);
3098 /* Copy the string_chars to the new place. */
3099 if (from_s_chars != to_s_chars)
3100 memmove (to_s_chars, from_s_chars, fullsize);
3102 /* Relocate FROM_S_CHARS's reference */
3103 set_string_data (string, &(to_s_chars->chars[0]));
3105 from_pos += fullsize;
3110 /* Set current to the last string chars block still used and
3111 free any that follow. */
3113 struct string_chars_block *victim;
3115 for (victim = to_sb->next; victim; )
3117 struct string_chars_block *next = victim->next;
3122 current_string_chars_block = to_sb;
3123 current_string_chars_block->pos = to_pos;
3124 current_string_chars_block->next = 0;
3128 #if 1 /* Hack to debug missing purecopy's */
3129 static int debug_string_purity;
3132 debug_string_purity_print (Lisp_String *p)
3135 Charcount s = string_char_length (p);
3136 putc ('\"', stderr);
3137 for (i = 0; i < s; i++)
3139 Emchar ch = string_char (p, i);
3140 if (ch < 32 || ch >= 126)
3141 stderr_out ("\\%03o", ch);
3142 else if (ch == '\\' || ch == '\"')
3143 stderr_out ("\\%c", ch);
3145 stderr_out ("%c", ch);
3147 stderr_out ("\"\n");
3153 sweep_strings (void)
3155 int num_small_used = 0, num_small_bytes = 0, num_bytes = 0;
3156 int debug = debug_string_purity;
3158 #define UNMARK_string(ptr) do { \
3159 Lisp_String *p = (ptr); \
3160 size_t size = string_length (p); \
3161 UNMARK_RECORD_HEADER (&(p->lheader)); \
3162 num_bytes += size; \
3163 if (!BIG_STRING_SIZE_P (size)) \
3164 { num_small_bytes += size; \
3168 debug_string_purity_print (p); \
3170 #define ADDITIONAL_FREE_string(ptr) do { \
3171 size_t size = string_length (ptr); \
3172 if (BIG_STRING_SIZE_P (size)) \
3173 xfree (ptr->data); \
3176 SWEEP_FIXED_TYPE_BLOCK (string, Lisp_String);
3178 gc_count_num_short_string_in_use = num_small_used;
3179 gc_count_string_total_size = num_bytes;
3180 gc_count_short_string_total_size = num_small_bytes;
3184 /* I hate duplicating all this crap! */
3186 marked_p (Lisp_Object obj)
3188 #ifdef ERROR_CHECK_GC
3189 assert (! (EQ (obj, Qnull_pointer)));
3191 /* Checks we used to perform. */
3192 /* if (EQ (obj, Qnull_pointer)) return 1; */
3193 /* if (!POINTER_TYPE_P (XGCTYPE (obj))) return 1; */
3194 /* if (PURIFIED (XPNTR (obj))) return 1; */
3196 if (XTYPE (obj) == Lisp_Type_Record)
3198 struct lrecord_header *lheader = XRECORD_LHEADER (obj);
3199 #if defined (ERROR_CHECK_GC)
3200 assert (lheader->type <= last_lrecord_type_index_assigned);
3202 return C_READONLY_RECORD_HEADER_P (lheader) || MARKED_RECORD_HEADER_P (lheader);
3210 /* Free all unmarked records. Do this at the very beginning,
3211 before anything else, so that the finalize methods can safely
3212 examine items in the objects. sweep_lcrecords_1() makes
3213 sure to call all the finalize methods *before* freeing anything,
3214 to complete the safety. */
3217 sweep_lcrecords_1 (&all_lcrecords, &ignored);
3220 compact_string_chars ();
3222 /* Finalize methods below (called through the ADDITIONAL_FREE_foo
3223 macros) must be *extremely* careful to make sure they're not
3224 referencing freed objects. The only two existing finalize
3225 methods (for strings and markers) pass muster -- the string
3226 finalizer doesn't look at anything but its own specially-
3227 created block, and the marker finalizer only looks at live
3228 buffers (which will never be freed) and at the markers before
3229 and after it in the chain (which, by induction, will never be
3230 freed because if so, they would have already removed themselves
3233 /* Put all unmarked strings on free list, free'ing the string chars
3234 of large unmarked strings */
3237 /* Put all unmarked conses on free list */
3240 /* Free all unmarked bit vectors */
3241 sweep_bit_vectors_1 (&all_bit_vectors,
3242 &gc_count_num_bit_vector_used,
3243 &gc_count_bit_vector_total_size,
3244 &gc_count_bit_vector_storage);
3246 /* Free all unmarked compiled-function objects */
3247 sweep_compiled_functions ();
3249 #ifdef LISP_FLOAT_TYPE
3250 /* Put all unmarked floats on free list */
3254 /* Put all unmarked symbols on free list */
3257 /* Put all unmarked extents on free list */
3260 /* Put all unmarked markers on free list.
3261 Dechain each one first from the buffer into which it points. */
3267 /* Unmark all dumped objects */
3270 char *p = pdump_rt_list;
3274 pdump_reloc_table *rt = (pdump_reloc_table *)p;
3275 p += sizeof (pdump_reloc_table);
3277 for (i=0; i<rt->count; i++)
3279 UNMARK_RECORD_HEADER ((struct lrecord_header *)(*(EMACS_INT *)p));
3280 p += sizeof (EMACS_INT);
3289 /* Clearing for disksave. */
3292 disksave_object_finalization (void)
3294 /* It's important that certain information from the environment not get
3295 dumped with the executable (pathnames, environment variables, etc.).
3296 To make it easier to tell when this has happened with strings(1) we
3297 clear some known-to-be-garbage blocks of memory, so that leftover
3298 results of old evaluation don't look like potential problems.
3299 But first we set some notable variables to nil and do one more GC,
3300 to turn those strings into garbage.
3303 /* Yeah, this list is pretty ad-hoc... */
3304 Vprocess_environment = Qnil;
3305 Vexec_directory = Qnil;
3306 Vdata_directory = Qnil;
3307 Vsite_directory = Qnil;
3308 Vdoc_directory = Qnil;
3309 Vconfigure_info_directory = Qnil;
3312 /* Vdump_load_path = Qnil; */
3313 /* Release hash tables for locate_file */
3314 Flocate_file_clear_hashing (Qt);
3315 uncache_home_directory();
3317 #if defined(LOADHIST) && !(defined(LOADHIST_DUMPED) || \
3318 defined(LOADHIST_BUILTIN))
3319 Vload_history = Qnil;
3321 Vshell_file_name = Qnil;
3323 garbage_collect_1 ();
3325 /* Run the disksave finalization methods of all live objects. */
3326 disksave_object_finalization_1 ();
3328 /* Zero out the uninitialized (really, unused) part of the containers
3329 for the live strings. */
3331 struct string_chars_block *scb;
3332 for (scb = first_string_chars_block; scb; scb = scb->next)
3334 int count = sizeof (scb->string_chars) - scb->pos;
3336 assert (count >= 0 && count < STRING_CHARS_BLOCK_SIZE);
3338 /* from the block's fill ptr to the end */
3339 memset ((scb->string_chars + scb->pos), 0, count);
3344 /* There, that ought to be enough... */
3350 restore_gc_inhibit (Lisp_Object val)
3352 gc_currently_forbidden = XINT (val);
3356 /* Maybe we want to use this when doing a "panic" gc after memory_full()? */
3357 static int gc_hooks_inhibited;
3361 garbage_collect_1 (void)
3363 #if MAX_SAVE_STACK > 0
3364 char stack_top_variable;
3365 extern char *stack_bottom;
3370 Lisp_Object pre_gc_cursor;
3371 struct gcpro gcpro1;
3374 || gc_currently_forbidden
3376 || preparing_for_armageddon)
3379 /* We used to call selected_frame() here.
3381 The following functions cannot be called inside GC
3382 so we move to after the above tests. */
3385 Lisp_Object device = Fselected_device (Qnil);
3386 if (NILP (device)) /* Could happen during startup, eg. if always_gc */
3388 frame = DEVICE_SELECTED_FRAME (XDEVICE (device));
3390 signal_simple_error ("No frames exist on device", device);
3394 pre_gc_cursor = Qnil;
3397 GCPRO1 (pre_gc_cursor);
3399 /* Very important to prevent GC during any of the following
3400 stuff that might run Lisp code; otherwise, we'll likely
3401 have infinite GC recursion. */
3402 speccount = specpdl_depth ();
3403 record_unwind_protect (restore_gc_inhibit,
3404 make_int (gc_currently_forbidden));
3405 gc_currently_forbidden = 1;
3407 if (!gc_hooks_inhibited)
3408 run_hook_trapping_errors ("Error in pre-gc-hook", Qpre_gc_hook);
3410 /* Now show the GC cursor/message. */
3411 if (!noninteractive)
3413 if (FRAME_WIN_P (f))
3415 Lisp_Object frame = make_frame (f);
3416 Lisp_Object cursor = glyph_image_instance (Vgc_pointer_glyph,
3417 FRAME_SELECTED_WINDOW (f),
3419 pre_gc_cursor = f->pointer;
3420 if (POINTER_IMAGE_INSTANCEP (cursor)
3421 /* don't change if we don't know how to change back. */
3422 && POINTER_IMAGE_INSTANCEP (pre_gc_cursor))
3425 Fset_frame_pointer (frame, cursor);
3429 /* Don't print messages to the stream device. */
3430 if (!cursor_changed && !FRAME_STREAM_P (f))
3432 char *msg = (STRINGP (Vgc_message)
3433 ? GETTEXT ((char *) XSTRING_DATA (Vgc_message))
3435 Lisp_Object args[2], whole_msg;
3436 args[0] = build_string (msg ? msg :
3437 GETTEXT ((CONST char *) gc_default_message));
3438 args[1] = build_string ("...");
3439 whole_msg = Fconcat (2, args);
3440 echo_area_message (f, (Bufbyte *) 0, whole_msg, 0, -1,
3441 Qgarbage_collecting);
3445 /***** Now we actually start the garbage collection. */
3449 gc_generation_number[0]++;
3451 #if MAX_SAVE_STACK > 0
3453 /* Save a copy of the contents of the stack, for debugging. */
3456 /* Static buffer in which we save a copy of the C stack at each GC. */
3457 static char *stack_copy;
3458 static size_t stack_copy_size;
3460 ptrdiff_t stack_diff = &stack_top_variable - stack_bottom;
3461 size_t stack_size = (stack_diff > 0 ? stack_diff : -stack_diff);
3462 if (stack_size < MAX_SAVE_STACK)
3464 if (stack_copy_size < stack_size)
3466 stack_copy = (char *) xrealloc (stack_copy, stack_size);
3467 stack_copy_size = stack_size;
3471 stack_diff > 0 ? stack_bottom : &stack_top_variable,
3475 #endif /* MAX_SAVE_STACK > 0 */
3477 /* Do some totally ad-hoc resource clearing. */
3478 /* #### generalize this? */
3479 clear_event_resource ();
3480 cleanup_specifiers ();
3482 /* Mark all the special slots that serve as the roots of accessibility. */
3486 for (i = 0; i < staticidx; i++)
3487 mark_object (*(staticvec[i]));
3488 for (i = 0; i < staticidx_nodump; i++)
3489 mark_object (*(staticvec_nodump[i]));
3495 for (tail = gcprolist; tail; tail = tail->next)
3496 for (i = 0; i < tail->nvars; i++)
3497 mark_object (tail->var[i]);
3501 struct specbinding *bind;
3502 for (bind = specpdl; bind != specpdl_ptr; bind++)
3504 mark_object (bind->symbol);
3505 mark_object (bind->old_value);
3510 struct catchtag *catch;
3511 for (catch = catchlist; catch; catch = catch->next)
3513 mark_object (catch->tag);
3514 mark_object (catch->val);
3519 struct backtrace *backlist;
3520 for (backlist = backtrace_list; backlist; backlist = backlist->next)
3522 int nargs = backlist->nargs;
3525 mark_object (*backlist->function);
3526 if (nargs == UNEVALLED || nargs == MANY)
3527 mark_object (backlist->args[0]);
3529 for (i = 0; i < nargs; i++)
3530 mark_object (backlist->args[i]);
3535 mark_profiling_info ();
3537 /* OK, now do the after-mark stuff. This is for things that
3538 are only marked when something else is marked (e.g. weak hash tables).
3539 There may be complex dependencies between such objects -- e.g.
3540 a weak hash table might be unmarked, but after processing a later
3541 weak hash table, the former one might get marked. So we have to
3542 iterate until nothing more gets marked. */
3544 while (finish_marking_weak_hash_tables () > 0 ||
3545 finish_marking_weak_lists () > 0)
3548 /* And prune (this needs to be called after everything else has been
3549 marked and before we do any sweeping). */
3550 /* #### this is somewhat ad-hoc and should probably be an object
3552 prune_weak_hash_tables ();
3553 prune_weak_lists ();
3554 prune_specifiers ();
3555 prune_syntax_tables ();
3559 consing_since_gc = 0;
3560 #ifndef DEBUG_XEMACS
3561 /* Allow you to set it really fucking low if you really want ... */
3562 if (gc_cons_threshold < 10000)
3563 gc_cons_threshold = 10000;
3568 /******* End of garbage collection ********/
3570 run_hook_trapping_errors ("Error in post-gc-hook", Qpost_gc_hook);
3572 /* Now remove the GC cursor/message */
3573 if (!noninteractive)
3576 Fset_frame_pointer (make_frame (f), pre_gc_cursor);
3577 else if (!FRAME_STREAM_P (f))
3579 char *msg = (STRINGP (Vgc_message)
3580 ? GETTEXT ((char *) XSTRING_DATA (Vgc_message))
3583 /* Show "...done" only if the echo area would otherwise be empty. */
3584 if (NILP (clear_echo_area (selected_frame (),
3585 Qgarbage_collecting, 0)))
3587 Lisp_Object args[2], whole_msg;
3588 args[0] = build_string (msg ? msg :
3589 GETTEXT ((CONST char *)
3590 gc_default_message));
3591 args[1] = build_string ("... done");
3592 whole_msg = Fconcat (2, args);
3593 echo_area_message (selected_frame (), (Bufbyte *) 0,
3595 Qgarbage_collecting);
3600 /* now stop inhibiting GC */
3601 unbind_to (speccount, Qnil);
3603 if (!breathing_space)
3605 breathing_space = malloc (4096 - MALLOC_OVERHEAD);
3612 /* Debugging aids. */
3615 gc_plist_hack (CONST char *name, int value, Lisp_Object tail)
3617 /* C doesn't have local functions (or closures, or GC, or readable syntax,
3618 or portable numeric datatypes, or bit-vectors, or characters, or
3619 arrays, or exceptions, or ...) */
3620 return cons3 (intern (name), make_int (value), tail);
3623 #define HACK_O_MATIC(type, name, pl) do { \
3625 struct type##_block *x = current_##type##_block; \
3626 while (x) { s += sizeof (*x) + MALLOC_OVERHEAD; x = x->prev; } \
3627 (pl) = gc_plist_hack ((name), s, (pl)); \
3630 DEFUN ("garbage-collect", Fgarbage_collect, 0, 0, "", /*
3631 Reclaim storage for Lisp objects no longer needed.
3632 Return info on amount of space in use:
3633 ((USED-CONSES . FREE-CONSES) (USED-SYMS . FREE-SYMS)
3634 (USED-MARKERS . FREE-MARKERS) USED-STRING-CHARS USED-VECTOR-SLOTS
3636 where `PLIST' is a list of alternating keyword/value pairs providing
3637 more detailed information.
3638 Garbage collection happens automatically if you cons more than
3639 `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
3643 Lisp_Object pl = Qnil;
3645 int gc_count_vector_total_size = 0;
3647 garbage_collect_1 ();
3649 for (i = 0; i <= last_lrecord_type_index_assigned; i++)
3651 if (lcrecord_stats[i].bytes_in_use != 0
3652 || lcrecord_stats[i].bytes_freed != 0
3653 || lcrecord_stats[i].instances_on_free_list != 0)
3656 CONST char *name = lrecord_implementations_table[i]->name;
3657 int len = strlen (name);
3658 /* save this for the FSFmacs-compatible part of the summary */
3659 if (i == *lrecord_vector.lrecord_type_index)
3660 gc_count_vector_total_size =
3661 lcrecord_stats[i].bytes_in_use + lcrecord_stats[i].bytes_freed;
3663 sprintf (buf, "%s-storage", name);
3664 pl = gc_plist_hack (buf, lcrecord_stats[i].bytes_in_use, pl);
3665 /* Okay, simple pluralization check for `symbol-value-varalias' */
3666 if (name[len-1] == 's')
3667 sprintf (buf, "%ses-freed", name);
3669 sprintf (buf, "%ss-freed", name);
3670 if (lcrecord_stats[i].instances_freed != 0)
3671 pl = gc_plist_hack (buf, lcrecord_stats[i].instances_freed, pl);
3672 if (name[len-1] == 's')
3673 sprintf (buf, "%ses-on-free-list", name);
3675 sprintf (buf, "%ss-on-free-list", name);
3676 if (lcrecord_stats[i].instances_on_free_list != 0)
3677 pl = gc_plist_hack (buf, lcrecord_stats[i].instances_on_free_list,
3679 if (name[len-1] == 's')
3680 sprintf (buf, "%ses-used", name);
3682 sprintf (buf, "%ss-used", name);
3683 pl = gc_plist_hack (buf, lcrecord_stats[i].instances_in_use, pl);
3687 HACK_O_MATIC (extent, "extent-storage", pl);
3688 pl = gc_plist_hack ("extents-free", gc_count_num_extent_freelist, pl);
3689 pl = gc_plist_hack ("extents-used", gc_count_num_extent_in_use, pl);
3690 HACK_O_MATIC (event, "event-storage", pl);
3691 pl = gc_plist_hack ("events-free", gc_count_num_event_freelist, pl);
3692 pl = gc_plist_hack ("events-used", gc_count_num_event_in_use, pl);
3693 HACK_O_MATIC (marker, "marker-storage", pl);
3694 pl = gc_plist_hack ("markers-free", gc_count_num_marker_freelist, pl);
3695 pl = gc_plist_hack ("markers-used", gc_count_num_marker_in_use, pl);
3696 #ifdef LISP_FLOAT_TYPE
3697 HACK_O_MATIC (float, "float-storage", pl);
3698 pl = gc_plist_hack ("floats-free", gc_count_num_float_freelist, pl);
3699 pl = gc_plist_hack ("floats-used", gc_count_num_float_in_use, pl);
3700 #endif /* LISP_FLOAT_TYPE */
3701 HACK_O_MATIC (string, "string-header-storage", pl);
3702 pl = gc_plist_hack ("long-strings-total-length",
3703 gc_count_string_total_size
3704 - gc_count_short_string_total_size, pl);
3705 HACK_O_MATIC (string_chars, "short-string-storage", pl);
3706 pl = gc_plist_hack ("short-strings-total-length",
3707 gc_count_short_string_total_size, pl);
3708 pl = gc_plist_hack ("strings-free", gc_count_num_string_freelist, pl);
3709 pl = gc_plist_hack ("long-strings-used",
3710 gc_count_num_string_in_use
3711 - gc_count_num_short_string_in_use, pl);
3712 pl = gc_plist_hack ("short-strings-used",
3713 gc_count_num_short_string_in_use, pl);
3715 HACK_O_MATIC (compiled_function, "compiled-function-storage", pl);
3716 pl = gc_plist_hack ("compiled-functions-free",
3717 gc_count_num_compiled_function_freelist, pl);
3718 pl = gc_plist_hack ("compiled-functions-used",
3719 gc_count_num_compiled_function_in_use, pl);
3721 pl = gc_plist_hack ("bit-vector-storage", gc_count_bit_vector_storage, pl);
3722 pl = gc_plist_hack ("bit-vectors-total-length",
3723 gc_count_bit_vector_total_size, pl);
3724 pl = gc_plist_hack ("bit-vectors-used", gc_count_num_bit_vector_used, pl);
3726 HACK_O_MATIC (symbol, "symbol-storage", pl);
3727 pl = gc_plist_hack ("symbols-free", gc_count_num_symbol_freelist, pl);
3728 pl = gc_plist_hack ("symbols-used", gc_count_num_symbol_in_use, pl);
3730 HACK_O_MATIC (cons, "cons-storage", pl);
3731 pl = gc_plist_hack ("conses-free", gc_count_num_cons_freelist, pl);
3732 pl = gc_plist_hack ("conses-used", gc_count_num_cons_in_use, pl);
3734 /* The things we do for backwards-compatibility */
3736 list6 (Fcons (make_int (gc_count_num_cons_in_use),
3737 make_int (gc_count_num_cons_freelist)),
3738 Fcons (make_int (gc_count_num_symbol_in_use),
3739 make_int (gc_count_num_symbol_freelist)),
3740 Fcons (make_int (gc_count_num_marker_in_use),
3741 make_int (gc_count_num_marker_freelist)),
3742 make_int (gc_count_string_total_size),
3743 make_int (gc_count_vector_total_size),
3748 DEFUN ("consing-since-gc", Fconsing_since_gc, 0, 0, "", /*
3749 Return the number of bytes consed since the last garbage collection.
3750 \"Consed\" is a misnomer in that this actually counts allocation
3751 of all different kinds of objects, not just conses.
3753 If this value exceeds `gc-cons-threshold', a garbage collection happens.
3757 return make_int (consing_since_gc);
3760 DEFUN ("memory-limit", Fmemory_limit, 0, 0, "", /*
3761 Return the address of the last byte Emacs has allocated, divided by 1024.
3762 This may be helpful in debugging Emacs's memory usage.
3763 The value is divided by 1024 to make sure it will fit in a lisp integer.
3767 return make_int ((EMACS_INT) sbrk (0) / 1024);
3773 object_dead_p (Lisp_Object obj)
3775 return ((BUFFERP (obj) && !BUFFER_LIVE_P (XBUFFER (obj))) ||
3776 (FRAMEP (obj) && !FRAME_LIVE_P (XFRAME (obj))) ||
3777 (WINDOWP (obj) && !WINDOW_LIVE_P (XWINDOW (obj))) ||
3778 (DEVICEP (obj) && !DEVICE_LIVE_P (XDEVICE (obj))) ||
3779 (CONSOLEP (obj) && !CONSOLE_LIVE_P (XCONSOLE (obj))) ||
3780 (EVENTP (obj) && !EVENT_LIVE_P (XEVENT (obj))) ||
3781 (EXTENTP (obj) && !EXTENT_LIVE_P (XEXTENT (obj))));
3784 #ifdef MEMORY_USAGE_STATS
3786 /* Attempt to determine the actual amount of space that is used for
3787 the block allocated starting at PTR, supposedly of size "CLAIMED_SIZE".
3789 It seems that the following holds:
3791 1. When using the old allocator (malloc.c):
3793 -- blocks are always allocated in chunks of powers of two. For
3794 each block, there is an overhead of 8 bytes if rcheck is not
3795 defined, 20 bytes if it is defined. In other words, a
3796 one-byte allocation needs 8 bytes of overhead for a total of
3797 9 bytes, and needs to have 16 bytes of memory chunked out for
3800 2. When using the new allocator (gmalloc.c):
3802 -- blocks are always allocated in chunks of powers of two up
3803 to 4096 bytes. Larger blocks are allocated in chunks of
3804 an integral multiple of 4096 bytes. The minimum block
3805 size is 2*sizeof (void *), or 16 bytes if SUNOS_LOCALTIME_BUG
3806 is defined. There is no per-block overhead, but there
3807 is an overhead of 3*sizeof (size_t) for each 4096 bytes
3810 3. When using the system malloc, anything goes, but they are
3811 generally slower and more space-efficient than the GNU
3812 allocators. One possibly reasonable assumption to make
3813 for want of better data is that sizeof (void *), or maybe
3814 2 * sizeof (void *), is required as overhead and that
3815 blocks are allocated in the minimum required size except
3816 that some minimum block size is imposed (e.g. 16 bytes). */
3819 malloced_storage_size (void *ptr, size_t claimed_size,
3820 struct overhead_stats *stats)
3822 size_t orig_claimed_size = claimed_size;
3826 if (claimed_size < 2 * sizeof (void *))
3827 claimed_size = 2 * sizeof (void *);
3828 # ifdef SUNOS_LOCALTIME_BUG
3829 if (claimed_size < 16)
3832 if (claimed_size < 4096)
3836 /* compute the log base two, more or less, then use it to compute
3837 the block size needed. */
3839 /* It's big, it's heavy, it's wood! */
3840 while ((claimed_size /= 2) != 0)
3843 /* It's better than bad, it's good! */
3849 /* We have to come up with some average about the amount of
3851 if ((size_t) (rand () & 4095) < claimed_size)
3852 claimed_size += 3 * sizeof (void *);
3856 claimed_size += 4095;
3857 claimed_size &= ~4095;
3858 claimed_size += (claimed_size / 4096) * 3 * sizeof (size_t);
3861 #elif defined (SYSTEM_MALLOC)
3863 if (claimed_size < 16)
3865 claimed_size += 2 * sizeof (void *);
3867 #else /* old GNU allocator */
3869 # ifdef rcheck /* #### may not be defined here */
3877 /* compute the log base two, more or less, then use it to compute
3878 the block size needed. */
3880 /* It's big, it's heavy, it's wood! */
3881 while ((claimed_size /= 2) != 0)
3884 /* It's better than bad, it's good! */
3892 #endif /* old GNU allocator */
3896 stats->was_requested += orig_claimed_size;
3897 stats->malloc_overhead += claimed_size - orig_claimed_size;
3899 return claimed_size;
3903 fixed_type_block_overhead (size_t size)
3905 size_t per_block = TYPE_ALLOC_SIZE (cons, unsigned char);
3906 size_t overhead = 0;
3907 size_t storage_size = malloced_storage_size (0, per_block, 0);
3908 while (size >= per_block)
3911 overhead += sizeof (void *) + per_block - storage_size;
3913 if (rand () % per_block < size)
3914 overhead += sizeof (void *) + per_block - storage_size;
3918 #endif /* MEMORY_USAGE_STATS */
3921 /* Initialization */
3923 reinit_alloc_once_early (void)
3925 gc_generation_number[0] = 0;
3926 breathing_space = 0;
3927 XSETINT (all_bit_vectors, 0); /* Qzero may not be set yet. */
3928 XSETINT (Vgc_message, 0);
3930 ignore_malloc_warnings = 1;
3931 #ifdef DOUG_LEA_MALLOC
3932 mallopt (M_TRIM_THRESHOLD, 128*1024); /* trim threshold */
3933 mallopt (M_MMAP_THRESHOLD, 64*1024); /* mmap threshold */
3934 #if 0 /* Moved to emacs.c */
3935 mallopt (M_MMAP_MAX, 64); /* max. number of mmap'ed areas */
3938 init_string_alloc ();
3939 init_string_chars_alloc ();
3941 init_symbol_alloc ();
3942 init_compiled_function_alloc ();
3943 #ifdef LISP_FLOAT_TYPE
3944 init_float_alloc ();
3945 #endif /* LISP_FLOAT_TYPE */
3946 init_marker_alloc ();
3947 init_extent_alloc ();
3948 init_event_alloc ();
3950 ignore_malloc_warnings = 0;
3952 staticidx_nodump = 0;
3956 consing_since_gc = 0;
3958 gc_cons_threshold = 500000; /* XEmacs change */
3960 gc_cons_threshold = 15000; /* debugging */
3962 #ifdef VIRT_ADDR_VARIES
3963 malloc_sbrk_unused = 1<<22; /* A large number */
3964 malloc_sbrk_used = 100000; /* as reasonable as any number */
3965 #endif /* VIRT_ADDR_VARIES */
3966 lrecord_uid_counter = 259;
3967 debug_string_purity = 0;
3970 gc_currently_forbidden = 0;
3971 gc_hooks_inhibited = 0;
3973 #ifdef ERROR_CHECK_TYPECHECK
3974 ERROR_ME.really_unlikely_name_to_have_accidentally_in_a_non_errb_structure =
3977 really_unlikely_name_to_have_accidentally_in_a_non_errb_structure = 42;
3979 really_unlikely_name_to_have_accidentally_in_a_non_errb_structure =
3981 #endif /* ERROR_CHECK_TYPECHECK */
3985 init_alloc_once_early (void)
3989 reinit_alloc_once_early ();
3991 last_lrecord_type_index_assigned = -1;
3992 for (iii = 0; iii < countof (lrecord_implementations_table); iii++)
3994 lrecord_implementations_table[iii] = 0;
3999 * defined subr lrecords were initialized with lheader->type == 0.
4000 * See subr_lheader_initializer in lisp.h. Force type index 0 to be
4001 * assigned to lrecord_subr so that those predefined indexes match
4004 lrecord_type_index (&lrecord_subr);
4005 assert (*(lrecord_subr.lrecord_type_index) == 0);
4007 * The same is true for symbol_value_forward objects, except the
4010 lrecord_type_index (&lrecord_symbol_value_forward);
4011 assert (*(lrecord_symbol_value_forward.lrecord_type_index) == 1);
4016 int pure_bytes_used = 0;
4025 syms_of_alloc (void)
4027 defsymbol (&Qpre_gc_hook, "pre-gc-hook");
4028 defsymbol (&Qpost_gc_hook, "post-gc-hook");
4029 defsymbol (&Qgarbage_collecting, "garbage-collecting");
4034 DEFSUBR (Fbit_vector);
4035 DEFSUBR (Fmake_byte_code);
4036 DEFSUBR (Fmake_list);
4037 DEFSUBR (Fmake_vector);
4038 DEFSUBR (Fmake_bit_vector);
4039 DEFSUBR (Fmake_string);
4041 DEFSUBR (Fmake_symbol);
4042 DEFSUBR (Fmake_marker);
4043 DEFSUBR (Fpurecopy);
4044 DEFSUBR (Fgarbage_collect);
4045 DEFSUBR (Fmemory_limit);
4046 DEFSUBR (Fconsing_since_gc);
4050 vars_of_alloc (void)
4052 DEFVAR_INT ("gc-cons-threshold", &gc_cons_threshold /*
4053 *Number of bytes of consing between garbage collections.
4054 \"Consing\" is a misnomer in that this actually counts allocation
4055 of all different kinds of objects, not just conses.
4056 Garbage collection can happen automatically once this many bytes have been
4057 allocated since the last garbage collection. All data types count.
4059 Garbage collection happens automatically when `eval' or `funcall' are
4060 called. (Note that `funcall' is called implicitly as part of evaluation.)
4061 By binding this temporarily to a large number, you can effectively
4062 prevent garbage collection during a part of the program.
4064 See also `consing-since-gc'.
4067 DEFVAR_INT ("pure-bytes-used", &pure_bytes_used /*
4068 Number of bytes of sharable Lisp data allocated so far.
4072 DEFVAR_INT ("data-bytes-used", &malloc_sbrk_used /*
4073 Number of bytes of unshared memory allocated in this session.
4076 DEFVAR_INT ("data-bytes-free", &malloc_sbrk_unused /*
4077 Number of bytes of unshared memory remaining available in this session.
4082 DEFVAR_INT ("debug-allocation", &debug_allocation /*
4083 If non-zero, print out information to stderr about all objects allocated.
4084 See also `debug-allocation-backtrace-length'.
4086 debug_allocation = 0;
4088 DEFVAR_INT ("debug-allocation-backtrace-length",
4089 &debug_allocation_backtrace_length /*
4090 Length (in stack frames) of short backtrace printed out by `debug-allocation'.
4092 debug_allocation_backtrace_length = 2;
4095 DEFVAR_BOOL ("purify-flag", &purify_flag /*
4096 Non-nil means loading Lisp code in order to dump an executable.
4097 This means that certain objects should be allocated in readonly space.
4100 DEFVAR_LISP ("pre-gc-hook", &Vpre_gc_hook /*
4101 Function or functions to be run just before each garbage collection.
4102 Interrupts, garbage collection, and errors are inhibited while this hook
4103 runs, so be extremely careful in what you add here. In particular, avoid
4104 consing, and do not interact with the user.
4106 Vpre_gc_hook = Qnil;
4108 DEFVAR_LISP ("post-gc-hook", &Vpost_gc_hook /*
4109 Function or functions to be run just after each garbage collection.
4110 Interrupts, garbage collection, and errors are inhibited while this hook
4111 runs, so be extremely careful in what you add here. In particular, avoid
4112 consing, and do not interact with the user.
4114 Vpost_gc_hook = Qnil;
4116 DEFVAR_LISP ("gc-message", &Vgc_message /*
4117 String to print to indicate that a garbage collection is in progress.
4118 This is printed in the echo area. If the selected frame is on a
4119 window system and `gc-pointer-glyph' specifies a value (i.e. a pointer
4120 image instance) in the domain of the selected frame, the mouse pointer
4121 will change instead of this message being printed.
4123 Vgc_message = build_string (gc_default_message);
4125 DEFVAR_LISP ("gc-pointer-glyph", &Vgc_pointer_glyph /*
4126 Pointer glyph used to indicate that a garbage collection is in progress.
4127 If the selected window is on a window system and this glyph specifies a
4128 value (i.e. a pointer image instance) in the domain of the selected
4129 window, the pointer will be changed as specified during garbage collection.
4130 Otherwise, a message will be printed in the echo area, as controlled
4136 complex_vars_of_alloc (void)
4138 Vgc_pointer_glyph = Fmake_glyph_internal (Qpointer);
4144 /* The structure of the file
4147 * 256 - dumped objects
4148 * stab_offset - nb_staticpro*(Lisp_Object *) from staticvec
4149 * - nb_staticpro*(relocated Lisp_Object) pointed to by staticpro
4150 * - nb_structdmp*pair(void *, adr) for pointers to structures
4151 * - lrecord_implementations_table[]
4152 * - relocation table
4153 * - wired variable address/value couples with the count preceding the list
4158 EMACS_UINT stab_offset;
4159 EMACS_UINT reloc_address;
4165 char *pdump_start, *pdump_end;
4167 static const unsigned char align_table[256] =
4169 8, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4170 4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4171 5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4172 4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4173 6, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4174 4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4175 5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4176 4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4177 7, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4178 4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4179 5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4180 4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4181 6, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4182 4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4183 5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4184 4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0
4187 typedef struct pdump_entry_list_elmt
4189 struct pdump_entry_list_elmt *next;
4194 EMACS_INT save_offset;
4195 } pdump_entry_list_elmt;
4199 pdump_entry_list_elmt *first;
4204 typedef struct pdump_struct_list_elmt
4206 pdump_entry_list list;
4207 const struct struct_description *sdesc;
4208 } pdump_struct_list_elmt;
4212 pdump_struct_list_elmt *list;
4215 } pdump_struct_list;
4217 static pdump_entry_list pdump_object_table[256];
4218 static pdump_entry_list pdump_opaque_data_list;
4219 static pdump_struct_list pdump_struct_table;
4220 static pdump_entry_list_elmt *pdump_qnil;
4222 static int pdump_alert_undump_object[256];
4224 static unsigned long cur_offset;
4225 static size_t max_size;
4226 static int pdump_fd;
4227 static void *pdump_buf;
4229 #define PDUMP_HASHSIZE 200001
4231 static pdump_entry_list_elmt **pdump_hash;
4233 /* Since most pointers are eight bytes aligned, the >>3 allows for a better hash */
4235 pdump_make_hash (const void *obj)
4237 return ((unsigned long)(obj)>>3) % PDUMP_HASHSIZE;
4240 static pdump_entry_list_elmt *
4241 pdump_get_entry (const void *obj)
4243 int pos = pdump_make_hash(obj);
4244 pdump_entry_list_elmt *e;
4245 while ((e = pdump_hash[pos]) != 0)
4251 if (pos == PDUMP_HASHSIZE)
4258 pdump_add_entry (pdump_entry_list *list, const void *obj, size_t size, int count, int is_lrecord)
4260 pdump_entry_list_elmt *e;
4262 int pos = pdump_make_hash (obj);
4264 while ((e = pdump_hash[pos]) != 0)
4270 if (pos == PDUMP_HASHSIZE)
4274 e = malloc (sizeof (pdump_entry_list_elmt));
4276 e->next = list->first;
4280 e->is_lrecord = is_lrecord;
4283 list->count += count;
4284 pdump_hash[pos] = e;
4286 align = align_table[size & 255];
4287 if (align<2 && is_lrecord)
4290 if(align < list->align)
4291 list->align = align;
4294 static pdump_entry_list *
4295 pdump_get_entry_list(const struct struct_description *sdesc)
4298 for(i=0; i<pdump_struct_table.count; i++)
4299 if (pdump_struct_table.list[i].sdesc == sdesc)
4300 return &pdump_struct_table.list[i].list;
4302 if (pdump_struct_table.size <= pdump_struct_table.count)
4304 if (pdump_struct_table.size == -1)
4305 pdump_struct_table.size = 10;
4307 pdump_struct_table.size = pdump_struct_table.size * 2;
4308 pdump_struct_table.list = xrealloc (pdump_struct_table.list,
4309 pdump_struct_table.size*sizeof (pdump_struct_list_elmt));
4311 pdump_struct_table.list[pdump_struct_table.count].list.first = 0;
4312 pdump_struct_table.list[pdump_struct_table.count].list.align = 8;
4313 pdump_struct_table.list[pdump_struct_table.count].list.count = 0;
4314 pdump_struct_table.list[pdump_struct_table.count].sdesc = sdesc;
4316 return &pdump_struct_table.list[pdump_struct_table.count++].list;
4327 static void pdump_backtrace (void)
4330 fprintf (stderr, "pdump backtrace :\n");
4331 for (i=0;i<depth;i++)
4333 if (!backtrace[i].obj)
4334 fprintf (stderr, " - ind. (%d, %d)\n", backtrace[i].position, backtrace[i].offset);
4337 fprintf (stderr, " - %s (%d, %d)\n",
4338 XRECORD_LHEADER_IMPLEMENTATION (backtrace[i].obj)->name,
4339 backtrace[i].position,
4340 backtrace[i].offset);
4345 static void pdump_register_object (Lisp_Object obj);
4346 static void pdump_register_struct (const void *data, const struct struct_description *sdesc, int count);
4349 pdump_get_indirect_count (EMACS_INT code, const struct lrecord_description *idesc, const void *idata)
4354 int line = XD_INDIRECT_VAL (code);
4355 int delta = XD_INDIRECT_DELTA (code);
4357 irdata = ((char *)idata) + idesc[line].offset;
4358 switch (idesc[line].type) {
4360 count = *(size_t *)irdata;
4363 count = *(int *)irdata;
4366 count = *(long *)irdata;
4369 count = *(Bytecount *)irdata;
4372 fprintf (stderr, "Unsupported count type : %d (line = %d, code=%ld)\n", idesc[line].type, line, (long)code);
4381 pdump_register_sub (const void *data, const struct lrecord_description *desc, int me)
4387 for (pos = 0; desc[pos].type != XD_END; pos++)
4389 backtrace[me].position = pos;
4390 backtrace[me].offset = desc[pos].offset;
4392 rdata = ((const char *)data) + desc[pos].offset;
4393 switch(desc[pos].type)
4395 case XD_SPECIFIER_END:
4397 desc = ((const struct Lisp_Specifier *)data)->methods->extra_description;
4403 case XD_LO_RESET_NIL:
4407 case XD_OPAQUE_DATA_PTR:
4409 EMACS_INT count = desc[pos].data1;
4410 if (XD_IS_INDIRECT(count))
4411 count = pdump_get_indirect_count (count, desc, data);
4413 pdump_add_entry (&pdump_opaque_data_list,
4422 const char *str = *(const char **)rdata;
4424 pdump_add_entry (&pdump_opaque_data_list, str, strlen (str)+1, 1, 0);
4429 const char *str = *(const char **)rdata;
4430 if ((EMACS_INT)str > 0)
4431 pdump_add_entry (&pdump_opaque_data_list, str, strlen (str)+1, 1, 0);
4434 case XD_LISP_OBJECT:
4436 EMACS_INT count = desc[pos].data1;
4438 if (XD_IS_INDIRECT (count))
4439 count = pdump_get_indirect_count (count, desc, data);
4441 for(i=0;i<count;i++) {
4442 const Lisp_Object *pobj = ((const Lisp_Object *)rdata) + i;
4443 Lisp_Object dobj = *pobj;
4445 backtrace[me].offset = (const char *)pobj - (const char *)data;
4446 pdump_register_object (dobj);
4452 EMACS_INT count = desc[pos].data1;
4453 const struct struct_description *sdesc = desc[pos].data2;
4454 const char *dobj = *(const char **)rdata;
4456 if (XD_IS_INDIRECT (count))
4457 count = pdump_get_indirect_count (count, desc, data);
4459 pdump_register_struct (dobj, sdesc, count);
4464 fprintf (stderr, "Unsupported dump type : %d\n", desc[pos].type);
4472 pdump_register_object (Lisp_Object obj)
4475 !POINTER_TYPE_P (XTYPE (obj)) ||
4476 pdump_get_entry (XRECORD_LHEADER (obj)))
4479 if (XRECORD_LHEADER_IMPLEMENTATION (obj)->description)
4484 fprintf (stderr, "Backtrace overflow, loop ?\n");
4487 backtrace[me].obj = obj;
4488 backtrace[me].position = 0;
4489 backtrace[me].offset = 0;
4491 pdump_add_entry (pdump_object_table + XRECORD_LHEADER (obj)->type,
4492 XRECORD_LHEADER (obj),
4493 XRECORD_LHEADER_IMPLEMENTATION (obj)->static_size ?
4494 XRECORD_LHEADER_IMPLEMENTATION (obj)->static_size :
4495 XRECORD_LHEADER_IMPLEMENTATION (obj)->size_in_bytes_method (XRECORD_LHEADER (obj)),
4498 pdump_register_sub (XRECORD_LHEADER (obj),
4499 XRECORD_LHEADER_IMPLEMENTATION (obj)->description,
4505 pdump_alert_undump_object[XRECORD_LHEADER (obj)->type]++;
4506 fprintf (stderr, "Undumpable object type : %s\n", XRECORD_LHEADER_IMPLEMENTATION (obj)->name);
4512 pdump_register_struct (const void *data, const struct struct_description *sdesc, int count)
4514 if (data && !pdump_get_entry (data))
4520 fprintf (stderr, "Backtrace overflow, loop ?\n");
4523 backtrace[me].obj = 0;
4524 backtrace[me].position = 0;
4525 backtrace[me].offset = 0;
4527 pdump_add_entry (pdump_get_entry_list (sdesc),
4532 for (i=0; i<count; i++)
4534 pdump_register_sub (((char *)data) + sdesc->size*i,
4543 pdump_dump_data (pdump_entry_list_elmt *elmt, const struct lrecord_description *desc)
4545 size_t size = elmt->size;
4546 int count = elmt->count;
4551 memcpy (pdump_buf, elmt->obj, size*count);
4553 for (i=0; i<count; i++)
4555 char *cur = ((char *)pdump_buf) + i*size;
4557 for (pos = 0; desc[pos].type != XD_END; pos++)
4559 rdata = cur + desc[pos].offset;
4560 switch (desc[pos].type)
4562 case XD_SPECIFIER_END:
4564 desc = ((const struct Lisp_Specifier *)(elmt->obj))->methods->extra_description;
4571 case XD_LO_RESET_NIL:
4573 EMACS_INT count = desc[pos].data1;
4575 if (XD_IS_INDIRECT (count))
4576 count = pdump_get_indirect_count (count, desc, elmt->obj);
4577 for (i=0; i<count; i++)
4578 ((EMACS_INT *)rdata)[i] = pdump_qnil->save_offset;
4583 EMACS_INT val = desc[pos].data1;
4584 if (XD_IS_INDIRECT (val))
4585 val = pdump_get_indirect_count (val, desc, elmt->obj);
4586 *(int *)rdata = val;
4589 case XD_OPAQUE_DATA_PTR:
4593 void *ptr = *(void **)rdata;
4595 *(EMACS_INT *)rdata = pdump_get_entry (ptr)->save_offset;
4600 Lisp_Object obj = *(Lisp_Object *)rdata;
4601 pdump_entry_list_elmt *elmt1;
4604 elmt1 = pdump_get_entry (XRECORD_LHEADER(obj));
4607 obj = *(Lisp_Object *)(desc[pos].offset + (char *)(XRECORD_LHEADER (obj)));
4609 *(EMACS_INT *)rdata = elmt1->save_offset;
4612 case XD_LISP_OBJECT:
4614 EMACS_INT count = desc[pos].data1;
4616 if (XD_IS_INDIRECT (count))
4617 count = pdump_get_indirect_count (count, desc, elmt->obj);
4619 for(i=0; i<count; i++)
4621 Lisp_Object *pobj = ((Lisp_Object *)rdata) + i;
4622 Lisp_Object dobj = *pobj;
4623 if (dobj && POINTER_TYPE_P (XTYPE (dobj)))
4624 *pobj = pdump_get_entry (XRECORD_LHEADER (dobj))->save_offset;
4630 EMACS_INT str = *(EMACS_INT *)rdata;
4632 *(EMACS_INT *)rdata = pdump_get_entry ((void *)str)->save_offset;
4636 fprintf (stderr, "Unsupported dump type : %d\n", desc[pos].type);
4642 write (pdump_fd, desc ? pdump_buf : elmt->obj, size*count);
4643 if (elmt->is_lrecord && ((size*count) & 3))
4644 write (pdump_fd, "\0\0\0", 4-((size*count) & 3));
4648 pdump_reloc_one (void *data, EMACS_INT delta, const struct lrecord_description *desc)
4654 for (pos = 0; desc[pos].type != XD_END; pos++)
4656 rdata = ((char *)data) + desc[pos].offset;
4657 switch (desc[pos].type) {
4658 case XD_SPECIFIER_END:
4660 desc = ((const struct Lisp_Specifier *)data)->methods->extra_description;
4668 case XD_OPAQUE_DATA_PTR:
4673 EMACS_INT ptr = *(EMACS_INT *)rdata;
4675 *(EMACS_INT *)rdata = ptr+delta;
4678 case XD_LISP_OBJECT:
4679 case XD_LO_RESET_NIL:
4681 EMACS_INT count = desc[pos].data1;
4683 if (XD_IS_INDIRECT (count))
4684 count = pdump_get_indirect_count (count, desc, data);
4686 for (i=0; i<count; i++)
4688 Lisp_Object *pobj = ((Lisp_Object *)rdata) + i;
4689 Lisp_Object dobj = *pobj;
4690 if (dobj && POINTER_TYPE_P (XTYPE (dobj)))
4691 *pobj = dobj + delta;
4697 EMACS_INT str = *(EMACS_INT *)rdata;
4699 *(EMACS_INT *)rdata = str + delta;
4703 fprintf (stderr, "Unsupported dump type : %d\n", desc[pos].type);
4710 pdump_allocate_offset (pdump_entry_list_elmt *elmt, const struct lrecord_description *desc)
4712 size_t size = (elmt->is_lrecord ? (elmt->size + 3) & ~3 : elmt->size)*elmt->count;
4713 elmt->save_offset = cur_offset;
4720 pdump_scan_by_alignement (void (*f)(pdump_entry_list_elmt *, const struct lrecord_description *))
4723 const struct lrecord_description *idesc;
4724 pdump_entry_list_elmt *elmt;
4725 for (align=8; align>=0; align--)
4727 for (i=0; i<=last_lrecord_type_index_assigned; i++)
4728 if (pdump_object_table[i].align == align)
4730 elmt = pdump_object_table[i].first;
4733 idesc = lrecord_implementations_table[i]->description;
4741 for (i=0; i<pdump_struct_table.count; i++)
4742 if (pdump_struct_table.list[i].list.align == align) {
4743 elmt = pdump_struct_table.list[i].list.first;
4744 idesc = pdump_struct_table.list[i].sdesc->description;
4752 elmt = pdump_opaque_data_list.first;
4755 if (align_table[elmt->size & 255] == align)
4763 pdump_dump_staticvec (void)
4765 Lisp_Object *reloc = malloc (staticidx*sizeof (Lisp_Object));
4767 write (pdump_fd, staticvec, staticidx*sizeof (Lisp_Object *));
4769 for(i=0; i<staticidx; i++)
4771 Lisp_Object obj = *staticvec[i];
4772 if (obj && POINTER_TYPE_P (XTYPE (obj)))
4773 reloc[i] = pdump_get_entry (XRECORD_LHEADER (obj))->save_offset;
4777 write (pdump_fd, reloc, staticidx*sizeof (Lisp_Object));
4782 pdump_dump_structvec (void)
4785 for (i=0; i<dumpstructidx; i++)
4788 write (pdump_fd, &(dumpstructvec[i].data), sizeof (void *));
4789 adr = pdump_get_entry (*(void **)(dumpstructvec[i].data))->save_offset;
4790 write (pdump_fd, &adr, sizeof (adr));
4795 pdump_dump_itable (void)
4797 write (pdump_fd, lrecord_implementations_table, sizeof (lrecord_implementations_table));
4801 pdump_dump_rtables (void)
4804 pdump_entry_list_elmt *elmt;
4805 pdump_reloc_table rt;
4807 for (i=0; i<=last_lrecord_type_index_assigned; i++)
4809 elmt = pdump_object_table[i].first;
4812 rt.desc = lrecord_implementations_table[i]->description;
4813 rt.count = pdump_object_table[i].count;
4814 write (pdump_fd, &rt, sizeof (rt));
4817 EMACS_INT rdata = pdump_get_entry (XRECORD_LHEADER (elmt->obj))->save_offset;
4818 write (pdump_fd, &rdata, sizeof (rdata));
4825 write (pdump_fd, &rt, sizeof (rt));
4827 for (i=0; i<pdump_struct_table.count; i++)
4829 elmt = pdump_struct_table.list[i].list.first;
4830 rt.desc = pdump_struct_table.list[i].sdesc->description;
4831 rt.count = pdump_struct_table.list[i].list.count;
4832 write (pdump_fd, &rt, sizeof (rt));
4835 EMACS_INT rdata = pdump_get_entry (XRECORD_LHEADER (elmt->obj))->save_offset;
4836 for (j=0; j<elmt->count; j++) {
4837 write (pdump_fd, &rdata, sizeof (rdata));
4838 rdata += elmt->size;
4845 write (pdump_fd, &rt, sizeof (rt));
4849 pdump_dump_wired (void)
4851 EMACS_INT count = pdump_wireidx + pdump_wireidx_list;
4854 write (pdump_fd, &count, sizeof (count));
4856 for (i=0; i<pdump_wireidx; i++)
4858 Lisp_Object obj = pdump_get_entry (XRECORD_LHEADER (*(pdump_wirevec[i])))->save_offset;
4859 write (pdump_fd, &pdump_wirevec[i], sizeof (pdump_wirevec[i]));
4860 write (pdump_fd, &obj, sizeof (obj));
4863 for (i=0; i<pdump_wireidx_list; i++)
4865 Lisp_Object obj = *(pdump_wirevec_list[i]);
4866 pdump_entry_list_elmt *elmt;
4871 const struct lrecord_description *desc;
4873 elmt = pdump_get_entry (XRECORD_LHEADER (obj));
4876 desc = XRECORD_LHEADER_IMPLEMENTATION (obj)->description;
4877 for (pos = 0; desc[pos].type != XD_LO_LINK; pos++)
4878 if (desc[pos].type == XD_END)
4881 obj = *(Lisp_Object *)(desc[pos].offset + (char *)(XRECORD_LHEADER (obj)));
4883 res = elmt->save_offset;
4885 write (pdump_fd, &pdump_wirevec_list[i], sizeof (pdump_wirevec_list[i]));
4886 write (pdump_fd, &res, sizeof (res));
4894 Lisp_Object t_console, t_device, t_frame;
4898 /* These appear in a DEFVAR_LISP, which does a staticpro() */
4899 t_console = Vterminal_console;
4900 t_frame = Vterminal_frame;
4901 t_device = Vterminal_device;
4903 Vterminal_console = Qnil;
4904 Vterminal_frame = Qnil;
4905 Vterminal_device = Qnil;
4907 pdump_hash = malloc (PDUMP_HASHSIZE*sizeof (pdump_entry_list_elmt *));
4908 memset (pdump_hash, 0, PDUMP_HASHSIZE*sizeof (pdump_entry_list_elmt *));
4910 for (i=0; i<=last_lrecord_type_index_assigned; i++)
4912 pdump_object_table[i].first = 0;
4913 pdump_object_table[i].align = 8;
4914 pdump_object_table[i].count = 0;
4915 pdump_alert_undump_object[i] = 0;
4917 pdump_struct_table.count = 0;
4918 pdump_struct_table.size = -1;
4920 pdump_opaque_data_list.first = 0;
4921 pdump_opaque_data_list.align = 8;
4922 pdump_opaque_data_list.count = 0;
4925 for (i=0; i<staticidx; i++)
4926 pdump_register_object (*staticvec[i]);
4927 for (i=0; i<pdump_wireidx; i++)
4928 pdump_register_object (*pdump_wirevec[i]);
4931 for(i=0;i<=last_lrecord_type_index_assigned;i++)
4932 if (pdump_alert_undump_object[i])
4935 printf ("Undumpable types list :\n");
4937 printf (" - %s (%d)\n", lrecord_implementations_table[i]->name, pdump_alert_undump_object[i]);
4942 for (i=0; i<dumpstructidx; i++)
4943 pdump_register_struct (*(void **)(dumpstructvec[i].data), dumpstructvec[i].desc, 1);
4945 memcpy (hd.signature, "XEmacsDP", 8);
4946 hd.reloc_address = 0;
4947 hd.nb_staticpro = staticidx;
4948 hd.nb_structdmp = dumpstructidx;
4949 hd.last_type = last_lrecord_type_index_assigned;
4954 pdump_scan_by_alignement (pdump_allocate_offset);
4955 pdump_qnil = pdump_get_entry (XRECORD_LHEADER (Qnil));
4957 pdump_buf = malloc (max_size);
4958 pdump_fd = open ("xemacs.dmp", O_WRONLY|O_CREAT|O_TRUNC, 0666);
4959 hd.stab_offset = (cur_offset + 3) & ~3;
4961 write (pdump_fd, &hd, sizeof (hd));
4962 lseek (pdump_fd, 256, SEEK_SET);
4964 pdump_scan_by_alignement (pdump_dump_data);
4966 lseek (pdump_fd, hd.stab_offset, SEEK_SET);
4968 pdump_dump_staticvec ();
4969 pdump_dump_structvec ();
4970 pdump_dump_itable ();
4971 pdump_dump_rtables ();
4972 pdump_dump_wired ();
4979 Vterminal_console = t_console;
4980 Vterminal_frame = t_frame;
4981 Vterminal_device = t_device;
4993 pdump_start = pdump_end = 0;
4995 pdump_fd = open ("xemacs.dmp", O_RDONLY);
4999 length = lseek (pdump_fd, 0, SEEK_END);
5000 lseek (pdump_fd, 0, SEEK_SET);
5003 pdump_start = mmap (0, length, PROT_READ|PROT_WRITE, MAP_PRIVATE, pdump_fd, 0);
5004 if (pdump_start == MAP_FAILED)
5010 pdump_start = (void *)((((unsigned long)(malloc(length+255))) + 255) & ~255);
5011 read(pdump_fd, pdump_start, length);
5016 pdump_end = pdump_start + length;
5018 staticidx = ((dump_header *)(pdump_start))->nb_staticpro;
5019 last_lrecord_type_index_assigned = ((dump_header *)(pdump_start))->last_type;
5020 delta = ((EMACS_INT)pdump_start) - ((dump_header *)pdump_start)->reloc_address;
5021 p = pdump_start + ((dump_header *)pdump_start)->stab_offset;
5023 /* Put back the staticvec in place */
5024 memcpy (staticvec, p, staticidx*sizeof (Lisp_Object *));
5025 p += staticidx*sizeof (Lisp_Object *);
5026 for (i=0; i<staticidx; i++)
5028 Lisp_Object obj = *(Lisp_Object *)p;
5029 p += sizeof (Lisp_Object);
5030 if (obj && POINTER_TYPE_P (XTYPE (obj)))
5032 *staticvec[i] = obj;
5035 /* Put back the dumpstructs */
5036 for (i=0; i<((dump_header *)pdump_start)->nb_structdmp; i++)
5038 void **adr = *(void **)p;
5039 p += sizeof (void *);
5040 *adr = (void *)((*(EMACS_INT *)p) + delta);
5041 p += sizeof (EMACS_INT);
5044 /* Put back the lrecord_implementations_table */
5045 memcpy (lrecord_implementations_table, p, sizeof (lrecord_implementations_table));
5046 p += sizeof (lrecord_implementations_table);
5048 /* Give back their numbers to the lrecord implementations */
5049 for (i=0; i<sizeof(lrecord_implementations_table)/sizeof(lrecord_implementations_table[0]); i++)
5050 if (lrecord_implementations_table[i])
5052 *(lrecord_implementations_table[i]->lrecord_type_index) = i;
5053 last_lrecord_type_index_assigned = i;
5056 /* Do the relocations */
5061 pdump_reloc_table *rt = (pdump_reloc_table *)p;
5062 p += sizeof (pdump_reloc_table);
5064 for (i=0; i<rt->count; i++)
5066 EMACS_INT adr = delta + *(EMACS_INT *)p;
5067 *(EMACS_INT *)p = adr;
5068 pdump_reloc_one ((void *)adr, delta, rt->desc);
5069 p += sizeof (EMACS_INT);
5076 /* Put the pdump_wire variables in place */
5077 count = *(EMACS_INT *)p;
5078 p += sizeof(EMACS_INT);
5080 for (i=0; i<count; i++)
5082 Lisp_Object *var, obj;
5083 var = *(Lisp_Object **)p;
5084 p += sizeof (Lisp_Object *);
5086 obj = *(Lisp_Object *)p;
5087 p += sizeof (Lisp_Object);
5089 if (obj && POINTER_TYPE_P (XTYPE (obj)))
5094 /* Final cleanups */
5095 /* reorganize hash tables */
5099 pdump_reloc_table *rt = (pdump_reloc_table *)p;
5100 p += sizeof (pdump_reloc_table);
5103 if (rt->desc == hash_table_description)
5105 for (i=0; i<rt->count; i++)
5107 struct Lisp_Hash_Table *ht = XHASH_TABLE (*(EMACS_INT *)p);
5108 reorganize_hash_table (ht);
5109 p += sizeof (EMACS_INT);
5113 p += sizeof (EMACS_INT)*rt->count;