2 * C-level stuff to implement Lisp-level PURIFY
6 * This software is part of the SBCL system. See the README file for
9 * This software is derived from the CMU CL system, which was
10 * written at Carnegie Mellon University and released into the
11 * public domain. The software is in the public domain and is
12 * provided with absolutely no warranty. See the COPYING and CREDITS
13 * files for more information.
17 #include <sys/types.h>
26 #include "interrupt.h"
30 #include "gc-internal.h"
31 #include "genesis/primitive-objects.h"
32 #include "genesis/static-symbols.h"
37 /* again, what's so special about the x86 that this is differently
38 * visible there than on other platforms? -dan 20010125
40 static lispobj *dynamic_space_free_pointer;
44 lose("GC invariant lost, file \"%s\", line %d", __FILE__, __LINE__)
47 #define gc_assert(ex) do { \
48 if (!(ex)) gc_abort(); \
55 /* These hold the original end of the read_only and static spaces so
56 * we can tell what are forwarding pointers. */
58 static lispobj *read_only_end, *static_end;
60 static lispobj *read_only_free, *static_free;
62 static lispobj *pscav(lispobj *addr, int nwords, boolean constant);
64 #define LATERBLOCKSIZE 1020
65 #define LATERMAXCOUNT 10
74 } *later_blocks = NULL;
75 static int later_count = 0;
77 #define CEILING(x,y) (((x) + ((y) - 1)) & (~((y) - 1)))
78 #define NWORDS(x,y) (CEILING((x),(y)) / (y))
80 /* FIXME: Shouldn't this be defined in sbcl.h? See also notes in
84 #define FUN_RAW_ADDR_OFFSET 0
86 #define FUN_RAW_ADDR_OFFSET (6*sizeof(lispobj) - FUN_POINTER_LOWTAG)
90 forwarding_pointer_p(lispobj obj)
92 lispobj *ptr = native_pointer(obj);
94 return ((static_end <= ptr && ptr <= static_free) ||
95 (read_only_end <= ptr && ptr <= read_only_free));
99 dynamic_pointer_p(lispobj ptr)
102 return (ptr >= (lispobj)current_dynamic_space
104 ptr < (lispobj)dynamic_space_free_pointer);
106 /* Be more conservative, and remember, this is a maybe. */
107 return (ptr >= (lispobj)DYNAMIC_SPACE_START
109 ptr < (lispobj)dynamic_space_free_pointer);
116 #ifdef LISP_FEATURE_GENCGC
118 * enhanced x86/GENCGC stack scavenging by Douglas Crosher
120 * Scavenging the stack on the i386 is problematic due to conservative
121 * roots and raw return addresses. Here it is handled in two passes:
122 * the first pass runs before any objects are moved and tries to
123 * identify valid pointers and return address on the stack, the second
124 * pass scavenges these.
127 static unsigned pointer_filter_verbose = 0;
129 /* FIXME: This is substantially the same code as in gencgc.c. (There
130 * are some differences, at least (1) the gencgc.c code needs to worry
131 * about return addresses on the stack pinning code objects, (2) the
132 * gencgc.c code needs to worry about the GC maybe happening in an
133 * interrupt service routine when the main thread of control was
134 * interrupted just as it had allocated memory and before it
135 * initialized it, while PURIFY needn't worry about that, and (3) the
136 * gencgc.c code has mutated more under maintenance since the fork
137 * from CMU CL than the code here has.) The two versions should be
138 * made to explicitly share common code, instead of just two different
139 * cut-and-pasted versions. */
141 valid_dynamic_space_pointer(lispobj *pointer, lispobj *start_addr)
143 /* If it's not a return address then it needs to be a valid Lisp
145 if (!is_lisp_pointer((lispobj)pointer))
148 /* Check that the object pointed to is consistent with the pointer
150 switch (lowtag_of((lispobj)pointer)) {
151 case FUN_POINTER_LOWTAG:
152 /* Start_addr should be the enclosing code object, or a closure
154 switch (widetag_of(*start_addr)) {
155 case CODE_HEADER_WIDETAG:
156 /* This case is probably caught above. */
158 case CLOSURE_HEADER_WIDETAG:
159 case FUNCALLABLE_INSTANCE_HEADER_WIDETAG:
160 if ((int)pointer != ((int)start_addr+FUN_POINTER_LOWTAG)) {
161 if (pointer_filter_verbose) {
162 fprintf(stderr,"*Wf2: %x %x %x\n", (unsigned int) pointer,
163 (unsigned int) start_addr, *start_addr);
169 if (pointer_filter_verbose) {
170 fprintf(stderr,"*Wf3: %x %x %x\n", (unsigned int) pointer,
171 (unsigned int) start_addr, *start_addr);
176 case LIST_POINTER_LOWTAG:
177 if ((int)pointer != ((int)start_addr+LIST_POINTER_LOWTAG)) {
178 if (pointer_filter_verbose)
179 fprintf(stderr,"*Wl1: %x %x %x\n", (unsigned int) pointer,
180 (unsigned int) start_addr, *start_addr);
183 /* Is it plausible cons? */
184 if ((is_lisp_pointer(start_addr[0])
185 || ((start_addr[0] & 3) == 0) /* fixnum */
186 || (widetag_of(start_addr[0]) == BASE_CHAR_WIDETAG)
187 || (widetag_of(start_addr[0]) == UNBOUND_MARKER_WIDETAG))
188 && (is_lisp_pointer(start_addr[1])
189 || ((start_addr[1] & 3) == 0) /* fixnum */
190 || (widetag_of(start_addr[1]) == BASE_CHAR_WIDETAG)
191 || (widetag_of(start_addr[1]) == UNBOUND_MARKER_WIDETAG))) {
194 if (pointer_filter_verbose) {
195 fprintf(stderr,"*Wl2: %x %x %x\n", (unsigned int) pointer,
196 (unsigned int) start_addr, *start_addr);
200 case INSTANCE_POINTER_LOWTAG:
201 if ((int)pointer != ((int)start_addr+INSTANCE_POINTER_LOWTAG)) {
202 if (pointer_filter_verbose) {
203 fprintf(stderr,"*Wi1: %x %x %x\n", (unsigned int) pointer,
204 (unsigned int) start_addr, *start_addr);
208 if (widetag_of(start_addr[0]) != INSTANCE_HEADER_WIDETAG) {
209 if (pointer_filter_verbose) {
210 fprintf(stderr,"*Wi2: %x %x %x\n", (unsigned int) pointer,
211 (unsigned int) start_addr, *start_addr);
216 case OTHER_POINTER_LOWTAG:
217 if ((int)pointer != ((int)start_addr+OTHER_POINTER_LOWTAG)) {
218 if (pointer_filter_verbose) {
219 fprintf(stderr,"*Wo1: %x %x %x\n", (unsigned int) pointer,
220 (unsigned int) start_addr, *start_addr);
224 /* Is it plausible? Not a cons. XXX should check the headers. */
225 if (is_lisp_pointer(start_addr[0]) || ((start_addr[0] & 3) == 0)) {
226 if (pointer_filter_verbose) {
227 fprintf(stderr,"*Wo2: %x %x %x\n", (unsigned int) pointer,
228 (unsigned int) start_addr, *start_addr);
232 switch (widetag_of(start_addr[0])) {
233 case UNBOUND_MARKER_WIDETAG:
234 case BASE_CHAR_WIDETAG:
235 if (pointer_filter_verbose) {
236 fprintf(stderr,"*Wo3: %x %x %x\n", (unsigned int) pointer,
237 (unsigned int) start_addr, *start_addr);
241 /* only pointed to by function pointers? */
242 case CLOSURE_HEADER_WIDETAG:
243 case FUNCALLABLE_INSTANCE_HEADER_WIDETAG:
244 if (pointer_filter_verbose) {
245 fprintf(stderr,"*Wo4: %x %x %x\n", (unsigned int) pointer,
246 (unsigned int) start_addr, *start_addr);
250 case INSTANCE_HEADER_WIDETAG:
251 if (pointer_filter_verbose) {
252 fprintf(stderr,"*Wo5: %x %x %x\n", (unsigned int) pointer,
253 (unsigned int) start_addr, *start_addr);
257 /* the valid other immediate pointer objects */
258 case SIMPLE_VECTOR_WIDETAG:
260 case COMPLEX_WIDETAG:
261 #ifdef COMPLEX_SINGLE_FLOAT_WIDETAG
262 case COMPLEX_SINGLE_FLOAT_WIDETAG:
264 #ifdef COMPLEX_DOUBLE_FLOAT_WIDETAG
265 case COMPLEX_DOUBLE_FLOAT_WIDETAG:
267 #ifdef COMPLEX_LONG_FLOAT_WIDETAG
268 case COMPLEX_LONG_FLOAT_WIDETAG:
270 case SIMPLE_ARRAY_WIDETAG:
271 case COMPLEX_STRING_WIDETAG:
272 case COMPLEX_BIT_VECTOR_WIDETAG:
273 case COMPLEX_VECTOR_WIDETAG:
274 case COMPLEX_ARRAY_WIDETAG:
275 case VALUE_CELL_HEADER_WIDETAG:
276 case SYMBOL_HEADER_WIDETAG:
278 case CODE_HEADER_WIDETAG:
280 case SINGLE_FLOAT_WIDETAG:
281 case DOUBLE_FLOAT_WIDETAG:
282 #ifdef LONG_FLOAT_WIDETAG
283 case LONG_FLOAT_WIDETAG:
285 case SIMPLE_STRING_WIDETAG:
286 case SIMPLE_BIT_VECTOR_WIDETAG:
287 case SIMPLE_ARRAY_UNSIGNED_BYTE_2_WIDETAG:
288 case SIMPLE_ARRAY_UNSIGNED_BYTE_4_WIDETAG:
289 case SIMPLE_ARRAY_UNSIGNED_BYTE_8_WIDETAG:
290 case SIMPLE_ARRAY_UNSIGNED_BYTE_16_WIDETAG:
291 case SIMPLE_ARRAY_UNSIGNED_BYTE_32_WIDETAG:
292 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG
293 case SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG:
295 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG
296 case SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG:
298 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG
299 case SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG:
301 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG
302 case SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG:
304 case SIMPLE_ARRAY_SINGLE_FLOAT_WIDETAG:
305 case SIMPLE_ARRAY_DOUBLE_FLOAT_WIDETAG:
306 #ifdef SIMPLE_ARRAY_LONG_FLOAT_WIDETAG
307 case SIMPLE_ARRAY_LONG_FLOAT_WIDETAG:
309 #ifdef SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG
310 case SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG:
312 #ifdef SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG
313 case SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG:
315 #ifdef SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG
316 case SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG:
319 case WEAK_POINTER_WIDETAG:
323 if (pointer_filter_verbose) {
324 fprintf(stderr,"*Wo6: %x %x %x\n", (unsigned int) pointer,
325 (unsigned int) start_addr, *start_addr);
331 if (pointer_filter_verbose) {
332 fprintf(stderr,"*W?: %x %x %x\n", (unsigned int) pointer,
333 (unsigned int) start_addr, *start_addr);
342 #define MAX_STACK_POINTERS 256
343 lispobj *valid_stack_locations[MAX_STACK_POINTERS];
344 unsigned int num_valid_stack_locations;
346 #define MAX_STACK_RETURN_ADDRESSES 128
347 lispobj *valid_stack_ra_locations[MAX_STACK_RETURN_ADDRESSES];
348 lispobj *valid_stack_ra_code_objects[MAX_STACK_RETURN_ADDRESSES];
349 unsigned int num_valid_stack_ra_locations;
351 /* Identify valid stack slots. */
353 setup_i386_stack_scav(lispobj *lowaddr, lispobj *base)
355 lispobj *sp = lowaddr;
356 num_valid_stack_locations = 0;
357 num_valid_stack_ra_locations = 0;
358 for (sp = lowaddr; sp < base; sp++) {
360 /* Find the object start address */
361 lispobj *start_addr = search_dynamic_space((void *)thing);
363 /* We need to allow raw pointers into Code objects for
364 * return addresses. This will also pick up pointers to
365 * functions in code objects. */
366 if (widetag_of(*start_addr) == CODE_HEADER_WIDETAG) {
367 /* FIXME asserting here is a really dumb thing to do.
368 * If we've overflowed some arbitrary static limit, we
369 * should just refuse to purify, instead of killing
370 * the whole lisp session
372 gc_assert(num_valid_stack_ra_locations <
373 MAX_STACK_RETURN_ADDRESSES);
374 valid_stack_ra_locations[num_valid_stack_ra_locations] = sp;
375 valid_stack_ra_code_objects[num_valid_stack_ra_locations++] =
376 (lispobj *)((int)start_addr + OTHER_POINTER_LOWTAG);
378 if (valid_dynamic_space_pointer((void *)thing, start_addr)) {
379 gc_assert(num_valid_stack_locations < MAX_STACK_POINTERS);
380 valid_stack_locations[num_valid_stack_locations++] = sp;
385 if (pointer_filter_verbose) {
386 fprintf(stderr, "number of valid stack pointers = %d\n",
387 num_valid_stack_locations);
388 fprintf(stderr, "number of stack return addresses = %d\n",
389 num_valid_stack_ra_locations);
394 pscav_i386_stack(void)
398 for (i = 0; i < num_valid_stack_locations; i++)
399 pscav(valid_stack_locations[i], 1, 0);
401 for (i = 0; i < num_valid_stack_ra_locations; i++) {
402 lispobj code_obj = (lispobj)valid_stack_ra_code_objects[i];
403 pscav(&code_obj, 1, 0);
404 if (pointer_filter_verbose) {
405 fprintf(stderr,"*C moved RA %x to %x; for code object %x to %x\n",
406 *valid_stack_ra_locations[i],
407 (int)(*valid_stack_ra_locations[i])
408 - ((int)valid_stack_ra_code_objects[i] - (int)code_obj),
409 (unsigned int) valid_stack_ra_code_objects[i], code_obj);
411 *valid_stack_ra_locations[i] =
412 ((int)(*valid_stack_ra_locations[i])
413 - ((int)valid_stack_ra_code_objects[i] - (int)code_obj));
421 pscav_later(lispobj *where, int count)
425 if (count > LATERMAXCOUNT) {
426 while (count > LATERMAXCOUNT) {
427 pscav_later(where, LATERMAXCOUNT);
428 count -= LATERMAXCOUNT;
429 where += LATERMAXCOUNT;
433 if (later_blocks == NULL || later_count == LATERBLOCKSIZE ||
434 (later_count == LATERBLOCKSIZE-1 && count > 1)) {
435 new = (struct later *)malloc(sizeof(struct later));
436 new->next = later_blocks;
437 if (later_blocks && later_count < LATERBLOCKSIZE)
438 later_blocks->u[later_count].ptr = NULL;
444 later_blocks->u[later_count++].count = count;
445 later_blocks->u[later_count++].ptr = where;
450 ptrans_boxed(lispobj thing, lispobj header, boolean constant)
453 lispobj result, *new, *old;
455 nwords = 1 + HeaderValue(header);
458 old = (lispobj *)native_pointer(thing);
460 new = read_only_free;
461 read_only_free += CEILING(nwords, 2);
465 static_free += CEILING(nwords, 2);
469 bcopy(old, new, nwords * sizeof(lispobj));
471 /* Deposit forwarding pointer. */
472 result = make_lispobj(new, lowtag_of(thing));
476 pscav(new, nwords, constant);
481 /* We need to look at the layout to see whether it is a pure structure
482 * class, and only then can we transport as constant. If it is pure,
483 * we can ALWAYS transport as a constant. */
485 ptrans_instance(lispobj thing, lispobj header, boolean constant)
487 lispobj layout = ((struct instance *)native_pointer(thing))->slots[0];
488 lispobj pure = ((struct instance *)native_pointer(layout))->slots[15];
492 return (ptrans_boxed(thing, header, 1));
494 return (ptrans_boxed(thing, header, 0));
497 /* Substructure: special case for the COMPACT-INFO-ENVs,
498 * where the instance may have a point to the dynamic
499 * space placed into it (e.g. the cache-name slot), but
500 * the lists and arrays at the time of a purify can be
501 * moved to the RO space. */
503 lispobj result, *new, *old;
505 nwords = 1 + HeaderValue(header);
508 old = (lispobj *)native_pointer(thing);
510 static_free += CEILING(nwords, 2);
513 bcopy(old, new, nwords * sizeof(lispobj));
515 /* Deposit forwarding pointer. */
516 result = make_lispobj(new, lowtag_of(thing));
520 pscav(new, nwords, 1);
526 return NIL; /* dummy value: return something ... */
531 ptrans_fdefn(lispobj thing, lispobj header)
534 lispobj result, *new, *old, oldfn;
537 nwords = 1 + HeaderValue(header);
540 old = (lispobj *)native_pointer(thing);
542 static_free += CEILING(nwords, 2);
545 bcopy(old, new, nwords * sizeof(lispobj));
547 /* Deposit forwarding pointer. */
548 result = make_lispobj(new, lowtag_of(thing));
551 /* Scavenge the function. */
552 fdefn = (struct fdefn *)new;
554 pscav(&fdefn->fun, 1, 0);
555 if ((char *)oldfn + FUN_RAW_ADDR_OFFSET == fdefn->raw_addr)
556 fdefn->raw_addr = (char *)fdefn->fun + FUN_RAW_ADDR_OFFSET;
562 ptrans_unboxed(lispobj thing, lispobj header)
565 lispobj result, *new, *old;
567 nwords = 1 + HeaderValue(header);
570 old = (lispobj *)native_pointer(thing);
571 new = read_only_free;
572 read_only_free += CEILING(nwords, 2);
575 bcopy(old, new, nwords * sizeof(lispobj));
577 /* Deposit forwarding pointer. */
578 result = make_lispobj(new , lowtag_of(thing));
585 ptrans_vector(lispobj thing, int bits, int extra,
586 boolean boxed, boolean constant)
588 struct vector *vector;
590 lispobj result, *new;
592 vector = (struct vector *)native_pointer(thing);
593 nwords = 2 + (CEILING((fixnum_value(vector->length)+extra)*bits,32)>>5);
595 if (boxed && !constant) {
597 static_free += CEILING(nwords, 2);
600 new = read_only_free;
601 read_only_free += CEILING(nwords, 2);
604 bcopy(vector, new, nwords * sizeof(lispobj));
606 result = make_lispobj(new, lowtag_of(thing));
607 vector->header = result;
610 pscav(new, nwords, constant);
617 apply_code_fixups_during_purify(struct code *old_code, struct code *new_code)
619 int nheader_words, ncode_words, nwords;
620 void *constants_start_addr, *constants_end_addr;
621 void *code_start_addr, *code_end_addr;
622 lispobj fixups = NIL;
623 unsigned displacement = (unsigned)new_code - (unsigned)old_code;
624 struct vector *fixups_vector;
626 ncode_words = fixnum_value(new_code->code_size);
627 nheader_words = HeaderValue(*(lispobj *)new_code);
628 nwords = ncode_words + nheader_words;
630 constants_start_addr = (void *)new_code + 5*4;
631 constants_end_addr = (void *)new_code + nheader_words*4;
632 code_start_addr = (void *)new_code + nheader_words*4;
633 code_end_addr = (void *)new_code + nwords*4;
635 /* The first constant should be a pointer to the fixups for this
636 * code objects. Check. */
637 fixups = new_code->constants[0];
639 /* It will be 0 or the unbound-marker if there are no fixups, and
640 * will be an other-pointer to a vector if it is valid. */
642 (fixups==UNBOUND_MARKER_WIDETAG) ||
643 !is_lisp_pointer(fixups)) {
644 #ifdef LISP_FEATURE_GENCGC
645 /* Check for a possible errors. */
646 sniff_code_object(new_code,displacement);
651 fixups_vector = (struct vector *)native_pointer(fixups);
653 /* Could be pointing to a forwarding pointer. */
654 if (is_lisp_pointer(fixups) && (dynamic_pointer_p(fixups))
655 && forwarding_pointer_p(*(lispobj *)fixups_vector)) {
656 /* If so then follow it. */
658 (struct vector *)native_pointer(*(lispobj *)fixups_vector);
661 if (widetag_of(fixups_vector->header) ==
662 SIMPLE_ARRAY_UNSIGNED_BYTE_32_WIDETAG) {
663 /* We got the fixups for the code block. Now work through the
664 * vector, and apply a fixup at each address. */
665 int length = fixnum_value(fixups_vector->length);
667 for (i=0; i<length; i++) {
668 unsigned offset = fixups_vector->data[i];
669 /* Now check the current value of offset. */
671 *(unsigned *)((unsigned)code_start_addr + offset);
673 /* If it's within the old_code object then it must be an
674 * absolute fixup (relative ones are not saved) */
675 if ((old_value>=(unsigned)old_code)
676 && (old_value<((unsigned)old_code + nwords*4)))
677 /* So add the dispacement. */
678 *(unsigned *)((unsigned)code_start_addr + offset) = old_value
681 /* It is outside the old code object so it must be a relative
682 * fixup (absolute fixups are not saved). So subtract the
684 *(unsigned *)((unsigned)code_start_addr + offset) = old_value
689 /* No longer need the fixups. */
690 new_code->constants[0] = 0;
692 #ifdef LISP_FEATURE_GENCGC
693 /* Check for possible errors. */
694 sniff_code_object(new_code,displacement);
700 ptrans_code(lispobj thing)
702 struct code *code, *new;
704 lispobj func, result;
706 code = (struct code *)native_pointer(thing);
707 nwords = HeaderValue(code->header) + fixnum_value(code->code_size);
709 new = (struct code *)read_only_free;
710 read_only_free += CEILING(nwords, 2);
712 bcopy(code, new, nwords * sizeof(lispobj));
714 #ifdef LISP_FEATURE_X86
715 apply_code_fixups_during_purify(code,new);
718 result = make_lispobj(new, OTHER_POINTER_LOWTAG);
720 /* Stick in a forwarding pointer for the code object. */
721 *(lispobj *)code = result;
723 /* Put in forwarding pointers for all the functions. */
724 for (func = code->entry_points;
726 func = ((struct simple_fun *)native_pointer(func))->next) {
728 gc_assert(lowtag_of(func) == FUN_POINTER_LOWTAG);
730 *(lispobj *)native_pointer(func) = result + (func - thing);
733 /* Arrange to scavenge the debug info later. */
734 pscav_later(&new->debug_info, 1);
736 if (new->trace_table_offset & 0x3)
738 pscav(&new->trace_table_offset, 1, 0);
740 new->trace_table_offset = NIL; /* limit lifetime */
743 /* Scavenge the constants. */
744 pscav(new->constants, HeaderValue(new->header)-5, 1);
746 /* Scavenge all the functions. */
747 pscav(&new->entry_points, 1, 1);
748 for (func = new->entry_points;
750 func = ((struct simple_fun *)native_pointer(func))->next) {
751 gc_assert(lowtag_of(func) == FUN_POINTER_LOWTAG);
752 gc_assert(!dynamic_pointer_p(func));
755 /* Temporarly convert the self pointer to a real function pointer. */
756 ((struct simple_fun *)native_pointer(func))->self
757 -= FUN_RAW_ADDR_OFFSET;
759 pscav(&((struct simple_fun *)native_pointer(func))->self, 2, 1);
761 ((struct simple_fun *)native_pointer(func))->self
762 += FUN_RAW_ADDR_OFFSET;
764 pscav_later(&((struct simple_fun *)native_pointer(func))->name, 3);
771 ptrans_func(lispobj thing, lispobj header)
774 lispobj code, *new, *old, result;
775 struct simple_fun *function;
777 /* Thing can either be a function header, a closure function
778 * header, a closure, or a funcallable-instance. If it's a closure
779 * or a funcallable-instance, we do the same as ptrans_boxed.
780 * Otherwise we have to do something strange, 'cause it is buried
781 * inside a code object. */
783 if (widetag_of(header) == SIMPLE_FUN_HEADER_WIDETAG ||
784 widetag_of(header) == CLOSURE_FUN_HEADER_WIDETAG) {
786 /* We can only end up here if the code object has not been
787 * scavenged, because if it had been scavenged, forwarding pointers
788 * would have been left behind for all the entry points. */
790 function = (struct simple_fun *)native_pointer(thing);
793 ((native_pointer(thing) -
794 (HeaderValue(function->header))), OTHER_POINTER_LOWTAG);
796 /* This will cause the function's header to be replaced with a
797 * forwarding pointer. */
801 /* So we can just return that. */
802 return function->header;
805 /* It's some kind of closure-like thing. */
806 nwords = 1 + HeaderValue(header);
807 old = (lispobj *)native_pointer(thing);
809 /* Allocate the new one. */
810 if (widetag_of(header) == FUNCALLABLE_INSTANCE_HEADER_WIDETAG) {
811 /* FINs *must* not go in read_only space. */
813 static_free += CEILING(nwords, 2);
816 /* Closures can always go in read-only space, 'cause they
819 new = read_only_free;
820 read_only_free += CEILING(nwords, 2);
823 bcopy(old, new, nwords * sizeof(lispobj));
825 /* Deposit forwarding pointer. */
826 result = make_lispobj(new, lowtag_of(thing));
830 pscav(new, nwords, 0);
837 ptrans_returnpc(lispobj thing, lispobj header)
841 /* Find the corresponding code object. */
842 code = thing - HeaderValue(header)*sizeof(lispobj);
844 /* Make sure it's been transported. */
845 new = *(lispobj *)native_pointer(code);
846 if (!forwarding_pointer_p(new))
847 new = ptrans_code(code);
849 /* Maintain the offset: */
850 return new + (thing - code);
853 #define WORDS_PER_CONS CEILING(sizeof(struct cons) / sizeof(lispobj), 2)
856 ptrans_list(lispobj thing, boolean constant)
858 struct cons *old, *new, *orig;
862 orig = (struct cons *)read_only_free;
864 orig = (struct cons *)static_free;
868 /* Allocate a new cons cell. */
869 old = (struct cons *)native_pointer(thing);
871 new = (struct cons *)read_only_free;
872 read_only_free += WORDS_PER_CONS;
875 new = (struct cons *)static_free;
876 static_free += WORDS_PER_CONS;
879 /* Copy the cons cell and keep a pointer to the cdr. */
881 thing = new->cdr = old->cdr;
883 /* Set up the forwarding pointer. */
884 *(lispobj *)old = make_lispobj(new, LIST_POINTER_LOWTAG);
886 /* And count this cell. */
888 } while (lowtag_of(thing) == LIST_POINTER_LOWTAG &&
889 dynamic_pointer_p(thing) &&
890 !(forwarding_pointer_p(*(lispobj *)native_pointer(thing))));
892 /* Scavenge the list we just copied. */
893 pscav((lispobj *)orig, length * WORDS_PER_CONS, constant);
895 return make_lispobj(orig, LIST_POINTER_LOWTAG);
899 ptrans_otherptr(lispobj thing, lispobj header, boolean constant)
901 switch (widetag_of(header)) {
903 case SINGLE_FLOAT_WIDETAG:
904 case DOUBLE_FLOAT_WIDETAG:
905 #ifdef LONG_FLOAT_WIDETAG
906 case LONG_FLOAT_WIDETAG:
908 #ifdef COMPLEX_SINGLE_FLOAT_WIDETAG
909 case COMPLEX_SINGLE_FLOAT_WIDETAG:
911 #ifdef COMPLEX_DOUBLE_FLOAT_WIDETAG
912 case COMPLEX_DOUBLE_FLOAT_WIDETAG:
914 #ifdef COMPLEX_LONG_FLOAT_WIDETAG
915 case COMPLEX_LONG_FLOAT_WIDETAG:
918 return ptrans_unboxed(thing, header);
921 case COMPLEX_WIDETAG:
922 case SIMPLE_ARRAY_WIDETAG:
923 case COMPLEX_STRING_WIDETAG:
924 case COMPLEX_VECTOR_WIDETAG:
925 case COMPLEX_ARRAY_WIDETAG:
926 return ptrans_boxed(thing, header, constant);
928 case VALUE_CELL_HEADER_WIDETAG:
929 case WEAK_POINTER_WIDETAG:
930 return ptrans_boxed(thing, header, 0);
932 case SYMBOL_HEADER_WIDETAG:
933 return ptrans_boxed(thing, header, 0);
935 case SIMPLE_STRING_WIDETAG:
936 return ptrans_vector(thing, 8, 1, 0, constant);
938 case SIMPLE_BIT_VECTOR_WIDETAG:
939 return ptrans_vector(thing, 1, 0, 0, constant);
941 case SIMPLE_VECTOR_WIDETAG:
942 return ptrans_vector(thing, 32, 0, 1, constant);
944 case SIMPLE_ARRAY_UNSIGNED_BYTE_2_WIDETAG:
945 return ptrans_vector(thing, 2, 0, 0, constant);
947 case SIMPLE_ARRAY_UNSIGNED_BYTE_4_WIDETAG:
948 return ptrans_vector(thing, 4, 0, 0, constant);
950 case SIMPLE_ARRAY_UNSIGNED_BYTE_8_WIDETAG:
951 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG
952 case SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG:
954 return ptrans_vector(thing, 8, 0, 0, constant);
956 case SIMPLE_ARRAY_UNSIGNED_BYTE_16_WIDETAG:
957 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG
958 case SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG:
960 return ptrans_vector(thing, 16, 0, 0, constant);
962 case SIMPLE_ARRAY_UNSIGNED_BYTE_32_WIDETAG:
963 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG
964 case SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG:
966 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG
967 case SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG:
969 return ptrans_vector(thing, 32, 0, 0, constant);
971 case SIMPLE_ARRAY_SINGLE_FLOAT_WIDETAG:
972 return ptrans_vector(thing, 32, 0, 0, constant);
974 case SIMPLE_ARRAY_DOUBLE_FLOAT_WIDETAG:
975 return ptrans_vector(thing, 64, 0, 0, constant);
977 #ifdef SIMPLE_ARRAY_LONG_FLOAT_WIDETAG
978 case SIMPLE_ARRAY_LONG_FLOAT_WIDETAG:
980 return ptrans_vector(thing, 96, 0, 0, constant);
983 return ptrans_vector(thing, 128, 0, 0, constant);
987 #ifdef SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG
988 case SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG:
989 return ptrans_vector(thing, 64, 0, 0, constant);
992 #ifdef SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG
993 case SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG:
994 return ptrans_vector(thing, 128, 0, 0, constant);
997 #ifdef SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG
998 case SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG:
1000 return ptrans_vector(thing, 192, 0, 0, constant);
1003 return ptrans_vector(thing, 256, 0, 0, constant);
1007 case CODE_HEADER_WIDETAG:
1008 return ptrans_code(thing);
1010 case RETURN_PC_HEADER_WIDETAG:
1011 return ptrans_returnpc(thing, header);
1014 return ptrans_fdefn(thing, header);
1017 /* Should only come across other pointers to the above stuff. */
1024 pscav_fdefn(struct fdefn *fdefn)
1028 fix_func = ((char *)(fdefn->fun+FUN_RAW_ADDR_OFFSET) == fdefn->raw_addr);
1029 pscav(&fdefn->name, 1, 1);
1030 pscav(&fdefn->fun, 1, 0);
1032 fdefn->raw_addr = (char *)(fdefn->fun + FUN_RAW_ADDR_OFFSET);
1033 return sizeof(struct fdefn) / sizeof(lispobj);
1037 /* now putting code objects in static space */
1039 pscav_code(struct code*code)
1043 nwords = HeaderValue(code->header) + fixnum_value(code->code_size);
1045 /* Arrange to scavenge the debug info later. */
1046 pscav_later(&code->debug_info, 1);
1048 /* Scavenge the constants. */
1049 pscav(code->constants, HeaderValue(code->header)-5, 1);
1051 /* Scavenge all the functions. */
1052 pscav(&code->entry_points, 1, 1);
1053 for (func = code->entry_points;
1055 func = ((struct simple_fun *)native_pointer(func))->next) {
1056 gc_assert(lowtag_of(func) == FUN_POINTER_LOWTAG);
1057 gc_assert(!dynamic_pointer_p(func));
1060 /* Temporarly convert the self pointer to a real function
1062 ((struct simple_fun *)native_pointer(func))->self
1063 -= FUN_RAW_ADDR_OFFSET;
1065 pscav(&((struct simple_fun *)native_pointer(func))->self, 2, 1);
1067 ((struct simple_fun *)native_pointer(func))->self
1068 += FUN_RAW_ADDR_OFFSET;
1070 pscav_later(&((struct simple_fun *)native_pointer(func))->name, 3);
1073 return CEILING(nwords,2);
1078 pscav(lispobj *addr, int nwords, boolean constant)
1080 lispobj thing, *thingp, header;
1081 int count = 0; /* (0 = dummy init value to stop GCC warning) */
1082 struct vector *vector;
1084 while (nwords > 0) {
1086 if (is_lisp_pointer(thing)) {
1087 /* It's a pointer. Is it something we might have to move? */
1088 if (dynamic_pointer_p(thing)) {
1089 /* Maybe. Have we already moved it? */
1090 thingp = (lispobj *)native_pointer(thing);
1092 if (is_lisp_pointer(header) && forwarding_pointer_p(header))
1093 /* Yep, so just copy the forwarding pointer. */
1096 /* Nope, copy the object. */
1097 switch (lowtag_of(thing)) {
1098 case FUN_POINTER_LOWTAG:
1099 thing = ptrans_func(thing, header);
1102 case LIST_POINTER_LOWTAG:
1103 thing = ptrans_list(thing, constant);
1106 case INSTANCE_POINTER_LOWTAG:
1107 thing = ptrans_instance(thing, header, constant);
1110 case OTHER_POINTER_LOWTAG:
1111 thing = ptrans_otherptr(thing, header, constant);
1115 /* It was a pointer, but not one of them? */
1123 else if (thing & 3) {
1124 /* It's an other immediate. Maybe the header for an unboxed */
1126 switch (widetag_of(thing)) {
1127 case BIGNUM_WIDETAG:
1128 case SINGLE_FLOAT_WIDETAG:
1129 case DOUBLE_FLOAT_WIDETAG:
1130 #ifdef LONG_FLOAT_WIDETAG
1131 case LONG_FLOAT_WIDETAG:
1134 /* It's an unboxed simple object. */
1135 count = HeaderValue(thing)+1;
1138 case SIMPLE_VECTOR_WIDETAG:
1139 if (HeaderValue(thing) == subtype_VectorValidHashing) {
1140 *addr = (subtype_VectorMustRehash << N_WIDETAG_BITS) |
1141 SIMPLE_VECTOR_WIDETAG;
1146 case SIMPLE_STRING_WIDETAG:
1147 vector = (struct vector *)addr;
1148 count = CEILING(NWORDS(fixnum_value(vector->length)+1,4)+2,2);
1151 case SIMPLE_BIT_VECTOR_WIDETAG:
1152 vector = (struct vector *)addr;
1153 count = CEILING(NWORDS(fixnum_value(vector->length),32)+2,2);
1156 case SIMPLE_ARRAY_UNSIGNED_BYTE_2_WIDETAG:
1157 vector = (struct vector *)addr;
1158 count = CEILING(NWORDS(fixnum_value(vector->length),16)+2,2);
1161 case SIMPLE_ARRAY_UNSIGNED_BYTE_4_WIDETAG:
1162 vector = (struct vector *)addr;
1163 count = CEILING(NWORDS(fixnum_value(vector->length),8)+2,2);
1166 case SIMPLE_ARRAY_UNSIGNED_BYTE_8_WIDETAG:
1167 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG
1168 case SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG:
1170 vector = (struct vector *)addr;
1171 count = CEILING(NWORDS(fixnum_value(vector->length),4)+2,2);
1174 case SIMPLE_ARRAY_UNSIGNED_BYTE_16_WIDETAG:
1175 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG
1176 case SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG:
1178 vector = (struct vector *)addr;
1179 count = CEILING(NWORDS(fixnum_value(vector->length),2)+2,2);
1182 case SIMPLE_ARRAY_UNSIGNED_BYTE_32_WIDETAG:
1183 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG
1184 case SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG:
1186 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG
1187 case SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG:
1189 vector = (struct vector *)addr;
1190 count = CEILING(fixnum_value(vector->length)+2,2);
1193 case SIMPLE_ARRAY_SINGLE_FLOAT_WIDETAG:
1194 vector = (struct vector *)addr;
1195 count = CEILING(fixnum_value(vector->length)+2,2);
1198 case SIMPLE_ARRAY_DOUBLE_FLOAT_WIDETAG:
1199 #ifdef SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG
1200 case SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG:
1202 vector = (struct vector *)addr;
1203 count = fixnum_value(vector->length)*2+2;
1206 #ifdef SIMPLE_ARRAY_LONG_FLOAT_WIDETAG
1207 case SIMPLE_ARRAY_LONG_FLOAT_WIDETAG:
1208 vector = (struct vector *)addr;
1210 count = fixnum_value(vector->length)*3+2;
1213 count = fixnum_value(vector->length)*4+2;
1218 #ifdef SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG
1219 case SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG:
1220 vector = (struct vector *)addr;
1221 count = fixnum_value(vector->length)*4+2;
1225 #ifdef SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG
1226 case SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG:
1227 vector = (struct vector *)addr;
1229 count = fixnum_value(vector->length)*6+2;
1232 count = fixnum_value(vector->length)*8+2;
1237 case CODE_HEADER_WIDETAG:
1239 gc_abort(); /* no code headers in static space */
1241 count = pscav_code((struct code*)addr);
1245 case SIMPLE_FUN_HEADER_WIDETAG:
1246 case CLOSURE_FUN_HEADER_WIDETAG:
1247 case RETURN_PC_HEADER_WIDETAG:
1248 /* We should never hit any of these, 'cause they occur
1249 * buried in the middle of code objects. */
1254 case CLOSURE_HEADER_WIDETAG:
1255 case FUNCALLABLE_INSTANCE_HEADER_WIDETAG:
1256 /* The function self pointer needs special care on the
1257 * x86 because it is the real entry point. */
1259 lispobj fun = ((struct closure *)addr)->fun
1260 - FUN_RAW_ADDR_OFFSET;
1261 pscav(&fun, 1, constant);
1262 ((struct closure *)addr)->fun = fun + FUN_RAW_ADDR_OFFSET;
1268 case WEAK_POINTER_WIDETAG:
1269 /* Weak pointers get preserved during purify, 'cause I
1270 * don't feel like figuring out how to break them. */
1271 pscav(addr+1, 2, constant);
1276 /* We have to handle fdefn objects specially, so we
1277 * can fix up the raw function address. */
1278 count = pscav_fdefn((struct fdefn *)addr);
1287 /* It's a fixnum. */
1299 purify(lispobj static_roots, lispobj read_only_roots)
1303 struct later *laters, *next;
1307 printf("[doing purification:");
1310 #ifdef LISP_FEATURE_GENCGC
1311 gc_alloc_update_all_page_tables();
1313 if (fixnum_value(SymbolValue(FREE_INTERRUPT_CONTEXT_INDEX)) != 0) {
1314 /* FIXME: 1. What does this mean? 2. It shouldn't be reporting
1315 * its error simply by a. printing a string b. to stdout instead
1317 printf(" Ack! Can't purify interrupt contexts. ");
1322 #if defined(__i386__)
1323 dynamic_space_free_pointer =
1324 (lispobj*)SymbolValue(ALLOCATION_POINTER);
1327 read_only_end = read_only_free =
1328 (lispobj *)SymbolValue(READ_ONLY_SPACE_FREE_POINTER);
1329 static_end = static_free =
1330 (lispobj *)SymbolValue(STATIC_SPACE_FREE_POINTER);
1337 #if (defined(LISP_FEATURE_GENCGC) && defined(LISP_FEATURE_X86))
1338 gc_assert((lispobj *)CONTROL_STACK_END > ((&read_only_roots)+1));
1339 setup_i386_stack_scav(((&static_roots)-2), (lispobj *)CONTROL_STACK_END);
1342 pscav(&static_roots, 1, 0);
1343 pscav(&read_only_roots, 1, 1);
1346 printf(" handlers");
1349 pscav((lispobj *) interrupt_handlers,
1350 sizeof(interrupt_handlers) / sizeof(lispobj),
1358 pscav((lispobj *)CONTROL_STACK_START,
1359 current_control_stack_pointer - (lispobj *)CONTROL_STACK_START,
1362 #ifdef LISP_FEATURE_GENCGC
1368 printf(" bindings");
1371 #if !defined(__i386__)
1372 pscav( (lispobj *)BINDING_STACK_START,
1373 (lispobj *)current_binding_stack_pointer - (lispobj *)BINDING_STACK_START,
1376 pscav( (lispobj *)BINDING_STACK_START,
1377 (lispobj *)SymbolValue(BINDING_STACK_POINTER) -
1378 (lispobj *)BINDING_STACK_START,
1382 /* The original CMU CL code had scavenge-read-only-space code
1383 * controlled by the Lisp-level variable
1384 * *SCAVENGE-READ-ONLY-SPACE*. It was disabled by default, and it
1385 * wasn't documented under what circumstances it was useful or
1386 * safe to turn it on, so it's been turned off in SBCL. If you
1387 * want/need this functionality, and can test and document it,
1388 * please submit a patch. */
1390 if (SymbolValue(SCAVENGE_READ_ONLY_SPACE) != UNBOUND_MARKER_WIDETAG
1391 && SymbolValue(SCAVENGE_READ_ONLY_SPACE) != NIL) {
1392 unsigned read_only_space_size =
1393 (lispobj *)SymbolValue(READ_ONLY_SPACE_FREE_POINTER) -
1394 (lispobj *)READ_ONLY_SPACE_START;
1396 "scavenging read only space: %d bytes\n",
1397 read_only_space_size * sizeof(lispobj));
1398 pscav( (lispobj *)READ_ONLY_SPACE_START, read_only_space_size, 0);
1406 clean = (lispobj *)STATIC_SPACE_START;
1408 while (clean != static_free)
1409 clean = pscav(clean, static_free - clean, 0);
1410 laters = later_blocks;
1411 count = later_count;
1412 later_blocks = NULL;
1414 while (laters != NULL) {
1415 for (i = 0; i < count; i++) {
1416 if (laters->u[i].count == 0) {
1418 } else if (laters->u[i].count <= LATERMAXCOUNT) {
1419 pscav(laters->u[i+1].ptr, laters->u[i].count, 1);
1422 pscav(laters->u[i].ptr, 1, 1);
1425 next = laters->next;
1428 count = LATERBLOCKSIZE;
1430 } while (clean != static_free || later_blocks != NULL);
1437 os_zero((os_vm_address_t) current_dynamic_space,
1438 (os_vm_size_t) DYNAMIC_SPACE_SIZE);
1440 /* Zero the stack. Note that the stack is also zeroed by SUB-GC
1441 * calling SCRUB-CONTROL-STACK - this zeros the stack on the x86. */
1443 os_zero((os_vm_address_t) current_control_stack_pointer,
1444 (os_vm_size_t) (CONTROL_STACK_SIZE -
1445 ((current_control_stack_pointer -
1446 (lispobj *)CONTROL_STACK_START) *
1450 /* It helps to update the heap free pointers so that free_heap can
1451 * verify after it's done. */
1452 SetSymbolValue(READ_ONLY_SPACE_FREE_POINTER, (lispobj)read_only_free);
1453 SetSymbolValue(STATIC_SPACE_FREE_POINTER, (lispobj)static_free);
1455 #if !defined(__i386__)
1456 dynamic_space_free_pointer = current_dynamic_space;
1458 #if defined LISP_FEATURE_GENCGC
1461 #error unsupported case /* in CMU CL, was "ibmrt using GC" */