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>
20 #include <sys/ptrace.h>
21 #include <linux/user.h>
29 #include "interrupt.h"
33 #include "gc-internal.h"
35 #include "genesis/primitive-objects.h"
36 #include "genesis/static-symbols.h"
41 /* again, what's so special about the x86 that this is differently
42 * visible there than on other platforms? -dan 20010125
44 static lispobj *dynamic_space_free_pointer;
48 lose("GC invariant lost, file \"%s\", line %d", __FILE__, __LINE__)
51 #define gc_assert(ex) do { \
52 if (!(ex)) gc_abort(); \
59 /* These hold the original end of the read_only and static spaces so
60 * we can tell what are forwarding pointers. */
62 static lispobj *read_only_end, *static_end;
64 static lispobj *read_only_free, *static_free;
66 static lispobj *pscav(lispobj *addr, int nwords, boolean constant);
68 #define LATERBLOCKSIZE 1020
69 #define LATERMAXCOUNT 10
78 } *later_blocks = NULL;
79 static int later_count = 0;
81 #define CEILING(x,y) (((x) + ((y) - 1)) & (~((y) - 1)))
82 #define NWORDS(x,y) (CEILING((x),(y)) / (y))
84 /* FIXME: Shouldn't this be defined in sbcl.h? See also notes in
88 #define FUN_RAW_ADDR_OFFSET 0
90 #define FUN_RAW_ADDR_OFFSET (6*sizeof(lispobj) - FUN_POINTER_LOWTAG)
94 forwarding_pointer_p(lispobj obj)
96 lispobj *ptr = native_pointer(obj);
98 return ((static_end <= ptr && ptr <= static_free) ||
99 (read_only_end <= ptr && ptr <= read_only_free));
103 dynamic_pointer_p(lispobj ptr)
106 return (ptr >= (lispobj)current_dynamic_space
108 ptr < (lispobj)dynamic_space_free_pointer);
110 /* Be more conservative, and remember, this is a maybe. */
111 return (ptr >= (lispobj)DYNAMIC_SPACE_START
113 ptr < (lispobj)dynamic_space_free_pointer);
120 #ifdef LISP_FEATURE_GENCGC
122 * enhanced x86/GENCGC stack scavenging by Douglas Crosher
124 * Scavenging the stack on the i386 is problematic due to conservative
125 * roots and raw return addresses. Here it is handled in two passes:
126 * the first pass runs before any objects are moved and tries to
127 * identify valid pointers and return address on the stack, the second
128 * pass scavenges these.
131 static unsigned pointer_filter_verbose = 0;
133 /* FIXME: This is substantially the same code as in gencgc.c. (There
134 * are some differences, at least (1) the gencgc.c code needs to worry
135 * about return addresses on the stack pinning code objects, (2) the
136 * gencgc.c code needs to worry about the GC maybe happening in an
137 * interrupt service routine when the main thread of control was
138 * interrupted just as it had allocated memory and before it
139 * initialized it, while PURIFY needn't worry about that, and (3) the
140 * gencgc.c code has mutated more under maintenance since the fork
141 * from CMU CL than the code here has.) The two versions should be
142 * made to explicitly share common code, instead of just two different
143 * cut-and-pasted versions. */
145 valid_dynamic_space_pointer(lispobj *pointer, lispobj *start_addr)
147 /* If it's not a return address then it needs to be a valid Lisp
149 if (!is_lisp_pointer((lispobj)pointer))
152 /* Check that the object pointed to is consistent with the pointer
154 switch (lowtag_of((lispobj)pointer)) {
155 case FUN_POINTER_LOWTAG:
156 /* Start_addr should be the enclosing code object, or a closure
158 switch (widetag_of(*start_addr)) {
159 case CODE_HEADER_WIDETAG:
160 /* This case is probably caught above. */
162 case CLOSURE_HEADER_WIDETAG:
163 case FUNCALLABLE_INSTANCE_HEADER_WIDETAG:
164 if ((int)pointer != ((int)start_addr+FUN_POINTER_LOWTAG)) {
165 if (pointer_filter_verbose) {
166 fprintf(stderr,"*Wf2: %x %x %x\n", (unsigned int) pointer,
167 (unsigned int) start_addr, *start_addr);
173 if (pointer_filter_verbose) {
174 fprintf(stderr,"*Wf3: %x %x %x\n", (unsigned int) pointer,
175 (unsigned int) start_addr, *start_addr);
180 case LIST_POINTER_LOWTAG:
181 if ((int)pointer != ((int)start_addr+LIST_POINTER_LOWTAG)) {
182 if (pointer_filter_verbose)
183 fprintf(stderr,"*Wl1: %x %x %x\n", (unsigned int) pointer,
184 (unsigned int) start_addr, *start_addr);
187 /* Is it plausible cons? */
188 if ((is_lisp_pointer(start_addr[0])
189 || ((start_addr[0] & 3) == 0) /* fixnum */
190 || (widetag_of(start_addr[0]) == BASE_CHAR_WIDETAG)
191 || (widetag_of(start_addr[0]) == UNBOUND_MARKER_WIDETAG))
192 && (is_lisp_pointer(start_addr[1])
193 || ((start_addr[1] & 3) == 0) /* fixnum */
194 || (widetag_of(start_addr[1]) == BASE_CHAR_WIDETAG)
195 || (widetag_of(start_addr[1]) == UNBOUND_MARKER_WIDETAG))) {
198 if (pointer_filter_verbose) {
199 fprintf(stderr,"*Wl2: %x %x %x\n", (unsigned int) pointer,
200 (unsigned int) start_addr, *start_addr);
204 case INSTANCE_POINTER_LOWTAG:
205 if ((int)pointer != ((int)start_addr+INSTANCE_POINTER_LOWTAG)) {
206 if (pointer_filter_verbose) {
207 fprintf(stderr,"*Wi1: %x %x %x\n", (unsigned int) pointer,
208 (unsigned int) start_addr, *start_addr);
212 if (widetag_of(start_addr[0]) != INSTANCE_HEADER_WIDETAG) {
213 if (pointer_filter_verbose) {
214 fprintf(stderr,"*Wi2: %x %x %x\n", (unsigned int) pointer,
215 (unsigned int) start_addr, *start_addr);
220 case OTHER_POINTER_LOWTAG:
221 if ((int)pointer != ((int)start_addr+OTHER_POINTER_LOWTAG)) {
222 if (pointer_filter_verbose) {
223 fprintf(stderr,"*Wo1: %x %x %x\n", (unsigned int) pointer,
224 (unsigned int) start_addr, *start_addr);
228 /* Is it plausible? Not a cons. XXX should check the headers. */
229 if (is_lisp_pointer(start_addr[0]) || ((start_addr[0] & 3) == 0)) {
230 if (pointer_filter_verbose) {
231 fprintf(stderr,"*Wo2: %x %x %x\n", (unsigned int) pointer,
232 (unsigned int) start_addr, *start_addr);
236 switch (widetag_of(start_addr[0])) {
237 case UNBOUND_MARKER_WIDETAG:
238 case BASE_CHAR_WIDETAG:
239 if (pointer_filter_verbose) {
240 fprintf(stderr,"*Wo3: %x %x %x\n", (unsigned int) pointer,
241 (unsigned int) start_addr, *start_addr);
245 /* only pointed to by function pointers? */
246 case CLOSURE_HEADER_WIDETAG:
247 case FUNCALLABLE_INSTANCE_HEADER_WIDETAG:
248 if (pointer_filter_verbose) {
249 fprintf(stderr,"*Wo4: %x %x %x\n", (unsigned int) pointer,
250 (unsigned int) start_addr, *start_addr);
254 case INSTANCE_HEADER_WIDETAG:
255 if (pointer_filter_verbose) {
256 fprintf(stderr,"*Wo5: %x %x %x\n", (unsigned int) pointer,
257 (unsigned int) start_addr, *start_addr);
261 /* the valid other immediate pointer objects */
262 case SIMPLE_VECTOR_WIDETAG:
264 case COMPLEX_WIDETAG:
265 #ifdef COMPLEX_SINGLE_FLOAT_WIDETAG
266 case COMPLEX_SINGLE_FLOAT_WIDETAG:
268 #ifdef COMPLEX_DOUBLE_FLOAT_WIDETAG
269 case COMPLEX_DOUBLE_FLOAT_WIDETAG:
271 #ifdef COMPLEX_LONG_FLOAT_WIDETAG
272 case COMPLEX_LONG_FLOAT_WIDETAG:
274 case SIMPLE_ARRAY_WIDETAG:
275 case COMPLEX_STRING_WIDETAG:
276 case COMPLEX_BIT_VECTOR_WIDETAG:
277 case COMPLEX_VECTOR_WIDETAG:
278 case COMPLEX_ARRAY_WIDETAG:
279 case VALUE_CELL_HEADER_WIDETAG:
280 case SYMBOL_HEADER_WIDETAG:
282 case CODE_HEADER_WIDETAG:
284 case SINGLE_FLOAT_WIDETAG:
285 case DOUBLE_FLOAT_WIDETAG:
286 #ifdef LONG_FLOAT_WIDETAG
287 case LONG_FLOAT_WIDETAG:
289 case SIMPLE_STRING_WIDETAG:
290 case SIMPLE_BIT_VECTOR_WIDETAG:
291 case SIMPLE_ARRAY_UNSIGNED_BYTE_2_WIDETAG:
292 case SIMPLE_ARRAY_UNSIGNED_BYTE_4_WIDETAG:
293 case SIMPLE_ARRAY_UNSIGNED_BYTE_8_WIDETAG:
294 case SIMPLE_ARRAY_UNSIGNED_BYTE_16_WIDETAG:
295 case SIMPLE_ARRAY_UNSIGNED_BYTE_32_WIDETAG:
296 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG
297 case SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG:
299 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG
300 case SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG:
302 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG
303 case SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG:
305 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG
306 case SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG:
308 case SIMPLE_ARRAY_SINGLE_FLOAT_WIDETAG:
309 case SIMPLE_ARRAY_DOUBLE_FLOAT_WIDETAG:
310 #ifdef SIMPLE_ARRAY_LONG_FLOAT_WIDETAG
311 case SIMPLE_ARRAY_LONG_FLOAT_WIDETAG:
313 #ifdef SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG
314 case SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG:
316 #ifdef SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG
317 case SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG:
319 #ifdef SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG
320 case SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG:
323 case WEAK_POINTER_WIDETAG:
327 if (pointer_filter_verbose) {
328 fprintf(stderr,"*Wo6: %x %x %x\n", (unsigned int) pointer,
329 (unsigned int) start_addr, *start_addr);
335 if (pointer_filter_verbose) {
336 fprintf(stderr,"*W?: %x %x %x\n", (unsigned int) pointer,
337 (unsigned int) start_addr, *start_addr);
346 #define MAX_STACK_POINTERS 256
347 lispobj *valid_stack_locations[MAX_STACK_POINTERS];
348 unsigned int num_valid_stack_locations;
350 #define MAX_STACK_RETURN_ADDRESSES 128
351 lispobj *valid_stack_ra_locations[MAX_STACK_RETURN_ADDRESSES];
352 lispobj *valid_stack_ra_code_objects[MAX_STACK_RETURN_ADDRESSES];
353 unsigned int num_valid_stack_ra_locations;
355 /* Identify valid stack slots. */
357 setup_i386_stack_scav(lispobj *lowaddr, lispobj *base)
359 lispobj *sp = lowaddr;
360 num_valid_stack_locations = 0;
361 num_valid_stack_ra_locations = 0;
362 for (sp = lowaddr; sp < base; sp++) {
364 /* Find the object start address */
365 lispobj *start_addr = search_dynamic_space((void *)thing);
367 /* We need to allow raw pointers into Code objects for
368 * return addresses. This will also pick up pointers to
369 * functions in code objects. */
370 if (widetag_of(*start_addr) == CODE_HEADER_WIDETAG) {
371 /* FIXME asserting here is a really dumb thing to do.
372 * If we've overflowed some arbitrary static limit, we
373 * should just refuse to purify, instead of killing
374 * the whole lisp session
376 gc_assert(num_valid_stack_ra_locations <
377 MAX_STACK_RETURN_ADDRESSES);
378 valid_stack_ra_locations[num_valid_stack_ra_locations] = sp;
379 valid_stack_ra_code_objects[num_valid_stack_ra_locations++] =
380 (lispobj *)((int)start_addr + OTHER_POINTER_LOWTAG);
382 if (valid_dynamic_space_pointer((void *)thing, start_addr)) {
383 gc_assert(num_valid_stack_locations < MAX_STACK_POINTERS);
384 valid_stack_locations[num_valid_stack_locations++] = sp;
389 if (pointer_filter_verbose) {
390 fprintf(stderr, "number of valid stack pointers = %d\n",
391 num_valid_stack_locations);
392 fprintf(stderr, "number of stack return addresses = %d\n",
393 num_valid_stack_ra_locations);
398 pscav_i386_stack(void)
402 for (i = 0; i < num_valid_stack_locations; i++)
403 pscav(valid_stack_locations[i], 1, 0);
405 for (i = 0; i < num_valid_stack_ra_locations; i++) {
406 lispobj code_obj = (lispobj)valid_stack_ra_code_objects[i];
407 pscav(&code_obj, 1, 0);
408 if (pointer_filter_verbose) {
409 fprintf(stderr,"*C moved RA %x to %x; for code object %x to %x\n",
410 *valid_stack_ra_locations[i],
411 (int)(*valid_stack_ra_locations[i])
412 - ((int)valid_stack_ra_code_objects[i] - (int)code_obj),
413 (unsigned int) valid_stack_ra_code_objects[i], code_obj);
415 *valid_stack_ra_locations[i] =
416 ((int)(*valid_stack_ra_locations[i])
417 - ((int)valid_stack_ra_code_objects[i] - (int)code_obj));
425 pscav_later(lispobj *where, int count)
429 if (count > LATERMAXCOUNT) {
430 while (count > LATERMAXCOUNT) {
431 pscav_later(where, LATERMAXCOUNT);
432 count -= LATERMAXCOUNT;
433 where += LATERMAXCOUNT;
437 if (later_blocks == NULL || later_count == LATERBLOCKSIZE ||
438 (later_count == LATERBLOCKSIZE-1 && count > 1)) {
439 new = (struct later *)malloc(sizeof(struct later));
440 new->next = later_blocks;
441 if (later_blocks && later_count < LATERBLOCKSIZE)
442 later_blocks->u[later_count].ptr = NULL;
448 later_blocks->u[later_count++].count = count;
449 later_blocks->u[later_count++].ptr = where;
454 ptrans_boxed(lispobj thing, lispobj header, boolean constant)
457 lispobj result, *new, *old;
459 nwords = 1 + HeaderValue(header);
462 old = (lispobj *)native_pointer(thing);
464 new = read_only_free;
465 read_only_free += CEILING(nwords, 2);
469 static_free += CEILING(nwords, 2);
473 bcopy(old, new, nwords * sizeof(lispobj));
475 /* Deposit forwarding pointer. */
476 result = make_lispobj(new, lowtag_of(thing));
480 pscav(new, nwords, constant);
485 /* We need to look at the layout to see whether it is a pure structure
486 * class, and only then can we transport as constant. If it is pure,
487 * we can ALWAYS transport as a constant. */
489 ptrans_instance(lispobj thing, lispobj header, boolean constant)
491 lispobj layout = ((struct instance *)native_pointer(thing))->slots[0];
492 lispobj pure = ((struct instance *)native_pointer(layout))->slots[15];
496 return (ptrans_boxed(thing, header, 1));
498 return (ptrans_boxed(thing, header, 0));
501 /* Substructure: special case for the COMPACT-INFO-ENVs,
502 * where the instance may have a point to the dynamic
503 * space placed into it (e.g. the cache-name slot), but
504 * the lists and arrays at the time of a purify can be
505 * moved to the RO space. */
507 lispobj result, *new, *old;
509 nwords = 1 + HeaderValue(header);
512 old = (lispobj *)native_pointer(thing);
514 static_free += CEILING(nwords, 2);
517 bcopy(old, new, nwords * sizeof(lispobj));
519 /* Deposit forwarding pointer. */
520 result = make_lispobj(new, lowtag_of(thing));
524 pscav(new, nwords, 1);
530 return NIL; /* dummy value: return something ... */
535 ptrans_fdefn(lispobj thing, lispobj header)
538 lispobj result, *new, *old, oldfn;
541 nwords = 1 + HeaderValue(header);
544 old = (lispobj *)native_pointer(thing);
546 static_free += CEILING(nwords, 2);
549 bcopy(old, new, nwords * sizeof(lispobj));
551 /* Deposit forwarding pointer. */
552 result = make_lispobj(new, lowtag_of(thing));
555 /* Scavenge the function. */
556 fdefn = (struct fdefn *)new;
558 pscav(&fdefn->fun, 1, 0);
559 if ((char *)oldfn + FUN_RAW_ADDR_OFFSET == fdefn->raw_addr)
560 fdefn->raw_addr = (char *)fdefn->fun + FUN_RAW_ADDR_OFFSET;
566 ptrans_unboxed(lispobj thing, lispobj header)
569 lispobj result, *new, *old;
571 nwords = 1 + HeaderValue(header);
574 old = (lispobj *)native_pointer(thing);
575 new = read_only_free;
576 read_only_free += CEILING(nwords, 2);
579 bcopy(old, new, nwords * sizeof(lispobj));
581 /* Deposit forwarding pointer. */
582 result = make_lispobj(new , lowtag_of(thing));
589 ptrans_vector(lispobj thing, int bits, int extra,
590 boolean boxed, boolean constant)
592 struct vector *vector;
594 lispobj result, *new;
596 vector = (struct vector *)native_pointer(thing);
597 nwords = 2 + (CEILING((fixnum_value(vector->length)+extra)*bits,32)>>5);
599 if (boxed && !constant) {
601 static_free += CEILING(nwords, 2);
604 new = read_only_free;
605 read_only_free += CEILING(nwords, 2);
608 bcopy(vector, new, nwords * sizeof(lispobj));
610 result = make_lispobj(new, lowtag_of(thing));
611 vector->header = result;
614 pscav(new, nwords, constant);
621 apply_code_fixups_during_purify(struct code *old_code, struct code *new_code)
623 int nheader_words, ncode_words, nwords;
624 void *constants_start_addr, *constants_end_addr;
625 void *code_start_addr, *code_end_addr;
626 lispobj fixups = NIL;
627 unsigned displacement = (unsigned)new_code - (unsigned)old_code;
628 struct vector *fixups_vector;
630 ncode_words = fixnum_value(new_code->code_size);
631 nheader_words = HeaderValue(*(lispobj *)new_code);
632 nwords = ncode_words + nheader_words;
634 constants_start_addr = (void *)new_code + 5*4;
635 constants_end_addr = (void *)new_code + nheader_words*4;
636 code_start_addr = (void *)new_code + nheader_words*4;
637 code_end_addr = (void *)new_code + nwords*4;
639 /* The first constant should be a pointer to the fixups for this
640 * code objects. Check. */
641 fixups = new_code->constants[0];
643 /* It will be 0 or the unbound-marker if there are no fixups, and
644 * will be an other-pointer to a vector if it is valid. */
646 (fixups==UNBOUND_MARKER_WIDETAG) ||
647 !is_lisp_pointer(fixups)) {
648 #ifdef LISP_FEATURE_GENCGC
649 /* Check for a possible errors. */
650 sniff_code_object(new_code,displacement);
655 fixups_vector = (struct vector *)native_pointer(fixups);
657 /* Could be pointing to a forwarding pointer. */
658 if (is_lisp_pointer(fixups) && (dynamic_pointer_p(fixups))
659 && forwarding_pointer_p(*(lispobj *)fixups_vector)) {
660 /* If so then follow it. */
662 (struct vector *)native_pointer(*(lispobj *)fixups_vector);
665 if (widetag_of(fixups_vector->header) ==
666 SIMPLE_ARRAY_UNSIGNED_BYTE_32_WIDETAG) {
667 /* We got the fixups for the code block. Now work through the
668 * vector, and apply a fixup at each address. */
669 int length = fixnum_value(fixups_vector->length);
671 for (i=0; i<length; i++) {
672 unsigned offset = fixups_vector->data[i];
673 /* Now check the current value of offset. */
675 *(unsigned *)((unsigned)code_start_addr + offset);
677 /* If it's within the old_code object then it must be an
678 * absolute fixup (relative ones are not saved) */
679 if ((old_value>=(unsigned)old_code)
680 && (old_value<((unsigned)old_code + nwords*4)))
681 /* So add the dispacement. */
682 *(unsigned *)((unsigned)code_start_addr + offset) = old_value
685 /* It is outside the old code object so it must be a relative
686 * fixup (absolute fixups are not saved). So subtract the
688 *(unsigned *)((unsigned)code_start_addr + offset) = old_value
693 /* No longer need the fixups. */
694 new_code->constants[0] = 0;
696 #ifdef LISP_FEATURE_GENCGC
697 /* Check for possible errors. */
698 sniff_code_object(new_code,displacement);
704 ptrans_code(lispobj thing)
706 struct code *code, *new;
708 lispobj func, result;
710 code = (struct code *)native_pointer(thing);
711 nwords = HeaderValue(code->header) + fixnum_value(code->code_size);
713 new = (struct code *)read_only_free;
714 read_only_free += CEILING(nwords, 2);
716 bcopy(code, new, nwords * sizeof(lispobj));
718 #ifdef LISP_FEATURE_X86
719 apply_code_fixups_during_purify(code,new);
722 result = make_lispobj(new, OTHER_POINTER_LOWTAG);
724 /* Stick in a forwarding pointer for the code object. */
725 *(lispobj *)code = result;
727 /* Put in forwarding pointers for all the functions. */
728 for (func = code->entry_points;
730 func = ((struct simple_fun *)native_pointer(func))->next) {
732 gc_assert(lowtag_of(func) == FUN_POINTER_LOWTAG);
734 *(lispobj *)native_pointer(func) = result + (func - thing);
737 /* Arrange to scavenge the debug info later. */
738 pscav_later(&new->debug_info, 1);
740 if (new->trace_table_offset & 0x3)
742 pscav(&new->trace_table_offset, 1, 0);
744 new->trace_table_offset = NIL; /* limit lifetime */
747 /* Scavenge the constants. */
748 pscav(new->constants, HeaderValue(new->header)-5, 1);
750 /* Scavenge all the functions. */
751 pscav(&new->entry_points, 1, 1);
752 for (func = new->entry_points;
754 func = ((struct simple_fun *)native_pointer(func))->next) {
755 gc_assert(lowtag_of(func) == FUN_POINTER_LOWTAG);
756 gc_assert(!dynamic_pointer_p(func));
759 /* Temporarly convert the self pointer to a real function pointer. */
760 ((struct simple_fun *)native_pointer(func))->self
761 -= FUN_RAW_ADDR_OFFSET;
763 pscav(&((struct simple_fun *)native_pointer(func))->self, 2, 1);
765 ((struct simple_fun *)native_pointer(func))->self
766 += FUN_RAW_ADDR_OFFSET;
768 pscav_later(&((struct simple_fun *)native_pointer(func))->name, 3);
775 ptrans_func(lispobj thing, lispobj header)
778 lispobj code, *new, *old, result;
779 struct simple_fun *function;
781 /* Thing can either be a function header, a closure function
782 * header, a closure, or a funcallable-instance. If it's a closure
783 * or a funcallable-instance, we do the same as ptrans_boxed.
784 * Otherwise we have to do something strange, 'cause it is buried
785 * inside a code object. */
787 if (widetag_of(header) == SIMPLE_FUN_HEADER_WIDETAG ||
788 widetag_of(header) == CLOSURE_FUN_HEADER_WIDETAG) {
790 /* We can only end up here if the code object has not been
791 * scavenged, because if it had been scavenged, forwarding pointers
792 * would have been left behind for all the entry points. */
794 function = (struct simple_fun *)native_pointer(thing);
797 ((native_pointer(thing) -
798 (HeaderValue(function->header))), OTHER_POINTER_LOWTAG);
800 /* This will cause the function's header to be replaced with a
801 * forwarding pointer. */
805 /* So we can just return that. */
806 return function->header;
809 /* It's some kind of closure-like thing. */
810 nwords = 1 + HeaderValue(header);
811 old = (lispobj *)native_pointer(thing);
813 /* Allocate the new one. */
814 if (widetag_of(header) == FUNCALLABLE_INSTANCE_HEADER_WIDETAG) {
815 /* FINs *must* not go in read_only space. */
817 static_free += CEILING(nwords, 2);
820 /* Closures can always go in read-only space, 'cause they
823 new = read_only_free;
824 read_only_free += CEILING(nwords, 2);
827 bcopy(old, new, nwords * sizeof(lispobj));
829 /* Deposit forwarding pointer. */
830 result = make_lispobj(new, lowtag_of(thing));
834 pscav(new, nwords, 0);
841 ptrans_returnpc(lispobj thing, lispobj header)
845 /* Find the corresponding code object. */
846 code = thing - HeaderValue(header)*sizeof(lispobj);
848 /* Make sure it's been transported. */
849 new = *(lispobj *)native_pointer(code);
850 if (!forwarding_pointer_p(new))
851 new = ptrans_code(code);
853 /* Maintain the offset: */
854 return new + (thing - code);
857 #define WORDS_PER_CONS CEILING(sizeof(struct cons) / sizeof(lispobj), 2)
860 ptrans_list(lispobj thing, boolean constant)
862 struct cons *old, *new, *orig;
866 orig = (struct cons *)read_only_free;
868 orig = (struct cons *)static_free;
872 /* Allocate a new cons cell. */
873 old = (struct cons *)native_pointer(thing);
875 new = (struct cons *)read_only_free;
876 read_only_free += WORDS_PER_CONS;
879 new = (struct cons *)static_free;
880 static_free += WORDS_PER_CONS;
883 /* Copy the cons cell and keep a pointer to the cdr. */
885 thing = new->cdr = old->cdr;
887 /* Set up the forwarding pointer. */
888 *(lispobj *)old = make_lispobj(new, LIST_POINTER_LOWTAG);
890 /* And count this cell. */
892 } while (lowtag_of(thing) == LIST_POINTER_LOWTAG &&
893 dynamic_pointer_p(thing) &&
894 !(forwarding_pointer_p(*(lispobj *)native_pointer(thing))));
896 /* Scavenge the list we just copied. */
897 pscav((lispobj *)orig, length * WORDS_PER_CONS, constant);
899 return make_lispobj(orig, LIST_POINTER_LOWTAG);
903 ptrans_otherptr(lispobj thing, lispobj header, boolean constant)
905 switch (widetag_of(header)) {
907 case SINGLE_FLOAT_WIDETAG:
908 case DOUBLE_FLOAT_WIDETAG:
909 #ifdef LONG_FLOAT_WIDETAG
910 case LONG_FLOAT_WIDETAG:
912 #ifdef COMPLEX_SINGLE_FLOAT_WIDETAG
913 case COMPLEX_SINGLE_FLOAT_WIDETAG:
915 #ifdef COMPLEX_DOUBLE_FLOAT_WIDETAG
916 case COMPLEX_DOUBLE_FLOAT_WIDETAG:
918 #ifdef COMPLEX_LONG_FLOAT_WIDETAG
919 case COMPLEX_LONG_FLOAT_WIDETAG:
922 return ptrans_unboxed(thing, header);
925 case COMPLEX_WIDETAG:
926 case SIMPLE_ARRAY_WIDETAG:
927 case COMPLEX_STRING_WIDETAG:
928 case COMPLEX_VECTOR_WIDETAG:
929 case COMPLEX_ARRAY_WIDETAG:
930 return ptrans_boxed(thing, header, constant);
932 case VALUE_CELL_HEADER_WIDETAG:
933 case WEAK_POINTER_WIDETAG:
934 return ptrans_boxed(thing, header, 0);
936 case SYMBOL_HEADER_WIDETAG:
937 return ptrans_boxed(thing, header, 0);
939 case SIMPLE_STRING_WIDETAG:
940 return ptrans_vector(thing, 8, 1, 0, constant);
942 case SIMPLE_BIT_VECTOR_WIDETAG:
943 return ptrans_vector(thing, 1, 0, 0, constant);
945 case SIMPLE_VECTOR_WIDETAG:
946 return ptrans_vector(thing, 32, 0, 1, constant);
948 case SIMPLE_ARRAY_UNSIGNED_BYTE_2_WIDETAG:
949 return ptrans_vector(thing, 2, 0, 0, constant);
951 case SIMPLE_ARRAY_UNSIGNED_BYTE_4_WIDETAG:
952 return ptrans_vector(thing, 4, 0, 0, constant);
954 case SIMPLE_ARRAY_UNSIGNED_BYTE_8_WIDETAG:
955 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG
956 case SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG:
958 return ptrans_vector(thing, 8, 0, 0, constant);
960 case SIMPLE_ARRAY_UNSIGNED_BYTE_16_WIDETAG:
961 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG
962 case SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG:
964 return ptrans_vector(thing, 16, 0, 0, constant);
966 case SIMPLE_ARRAY_UNSIGNED_BYTE_32_WIDETAG:
967 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG
968 case SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG:
970 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG
971 case SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG:
973 return ptrans_vector(thing, 32, 0, 0, constant);
975 case SIMPLE_ARRAY_SINGLE_FLOAT_WIDETAG:
976 return ptrans_vector(thing, 32, 0, 0, constant);
978 case SIMPLE_ARRAY_DOUBLE_FLOAT_WIDETAG:
979 return ptrans_vector(thing, 64, 0, 0, constant);
981 #ifdef SIMPLE_ARRAY_LONG_FLOAT_WIDETAG
982 case SIMPLE_ARRAY_LONG_FLOAT_WIDETAG:
984 return ptrans_vector(thing, 96, 0, 0, constant);
987 return ptrans_vector(thing, 128, 0, 0, constant);
991 #ifdef SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG
992 case SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG:
993 return ptrans_vector(thing, 64, 0, 0, constant);
996 #ifdef SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG
997 case SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG:
998 return ptrans_vector(thing, 128, 0, 0, constant);
1001 #ifdef SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG
1002 case SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG:
1004 return ptrans_vector(thing, 192, 0, 0, constant);
1007 return ptrans_vector(thing, 256, 0, 0, constant);
1011 case CODE_HEADER_WIDETAG:
1012 return ptrans_code(thing);
1014 case RETURN_PC_HEADER_WIDETAG:
1015 return ptrans_returnpc(thing, header);
1018 return ptrans_fdefn(thing, header);
1021 /* Should only come across other pointers to the above stuff. */
1028 pscav_fdefn(struct fdefn *fdefn)
1032 fix_func = ((char *)(fdefn->fun+FUN_RAW_ADDR_OFFSET) == fdefn->raw_addr);
1033 pscav(&fdefn->name, 1, 1);
1034 pscav(&fdefn->fun, 1, 0);
1036 fdefn->raw_addr = (char *)(fdefn->fun + FUN_RAW_ADDR_OFFSET);
1037 return sizeof(struct fdefn) / sizeof(lispobj);
1041 /* now putting code objects in static space */
1043 pscav_code(struct code*code)
1047 nwords = HeaderValue(code->header) + fixnum_value(code->code_size);
1049 /* Arrange to scavenge the debug info later. */
1050 pscav_later(&code->debug_info, 1);
1052 /* Scavenge the constants. */
1053 pscav(code->constants, HeaderValue(code->header)-5, 1);
1055 /* Scavenge all the functions. */
1056 pscav(&code->entry_points, 1, 1);
1057 for (func = code->entry_points;
1059 func = ((struct simple_fun *)native_pointer(func))->next) {
1060 gc_assert(lowtag_of(func) == FUN_POINTER_LOWTAG);
1061 gc_assert(!dynamic_pointer_p(func));
1064 /* Temporarly convert the self pointer to a real function
1066 ((struct simple_fun *)native_pointer(func))->self
1067 -= FUN_RAW_ADDR_OFFSET;
1069 pscav(&((struct simple_fun *)native_pointer(func))->self, 2, 1);
1071 ((struct simple_fun *)native_pointer(func))->self
1072 += FUN_RAW_ADDR_OFFSET;
1074 pscav_later(&((struct simple_fun *)native_pointer(func))->name, 3);
1077 return CEILING(nwords,2);
1082 pscav(lispobj *addr, int nwords, boolean constant)
1084 lispobj thing, *thingp, header;
1085 int count = 0; /* (0 = dummy init value to stop GCC warning) */
1086 struct vector *vector;
1088 while (nwords > 0) {
1090 if (is_lisp_pointer(thing)) {
1091 /* It's a pointer. Is it something we might have to move? */
1092 if (dynamic_pointer_p(thing)) {
1093 /* Maybe. Have we already moved it? */
1094 thingp = (lispobj *)native_pointer(thing);
1096 if (is_lisp_pointer(header) && forwarding_pointer_p(header))
1097 /* Yep, so just copy the forwarding pointer. */
1100 /* Nope, copy the object. */
1101 switch (lowtag_of(thing)) {
1102 case FUN_POINTER_LOWTAG:
1103 thing = ptrans_func(thing, header);
1106 case LIST_POINTER_LOWTAG:
1107 thing = ptrans_list(thing, constant);
1110 case INSTANCE_POINTER_LOWTAG:
1111 thing = ptrans_instance(thing, header, constant);
1114 case OTHER_POINTER_LOWTAG:
1115 thing = ptrans_otherptr(thing, header, constant);
1119 /* It was a pointer, but not one of them? */
1127 else if (thing & 3) {
1128 /* It's an other immediate. Maybe the header for an unboxed */
1130 switch (widetag_of(thing)) {
1131 case BIGNUM_WIDETAG:
1132 case SINGLE_FLOAT_WIDETAG:
1133 case DOUBLE_FLOAT_WIDETAG:
1134 #ifdef LONG_FLOAT_WIDETAG
1135 case LONG_FLOAT_WIDETAG:
1138 /* It's an unboxed simple object. */
1139 count = HeaderValue(thing)+1;
1142 case SIMPLE_VECTOR_WIDETAG:
1143 if (HeaderValue(thing) == subtype_VectorValidHashing) {
1144 *addr = (subtype_VectorMustRehash << N_WIDETAG_BITS) |
1145 SIMPLE_VECTOR_WIDETAG;
1150 case SIMPLE_STRING_WIDETAG:
1151 vector = (struct vector *)addr;
1152 count = CEILING(NWORDS(fixnum_value(vector->length)+1,4)+2,2);
1155 case SIMPLE_BIT_VECTOR_WIDETAG:
1156 vector = (struct vector *)addr;
1157 count = CEILING(NWORDS(fixnum_value(vector->length),32)+2,2);
1160 case SIMPLE_ARRAY_UNSIGNED_BYTE_2_WIDETAG:
1161 vector = (struct vector *)addr;
1162 count = CEILING(NWORDS(fixnum_value(vector->length),16)+2,2);
1165 case SIMPLE_ARRAY_UNSIGNED_BYTE_4_WIDETAG:
1166 vector = (struct vector *)addr;
1167 count = CEILING(NWORDS(fixnum_value(vector->length),8)+2,2);
1170 case SIMPLE_ARRAY_UNSIGNED_BYTE_8_WIDETAG:
1171 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG
1172 case SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG:
1174 vector = (struct vector *)addr;
1175 count = CEILING(NWORDS(fixnum_value(vector->length),4)+2,2);
1178 case SIMPLE_ARRAY_UNSIGNED_BYTE_16_WIDETAG:
1179 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG
1180 case SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG:
1182 vector = (struct vector *)addr;
1183 count = CEILING(NWORDS(fixnum_value(vector->length),2)+2,2);
1186 case SIMPLE_ARRAY_UNSIGNED_BYTE_32_WIDETAG:
1187 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG
1188 case SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG:
1190 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG
1191 case SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG:
1193 vector = (struct vector *)addr;
1194 count = CEILING(fixnum_value(vector->length)+2,2);
1197 case SIMPLE_ARRAY_SINGLE_FLOAT_WIDETAG:
1198 vector = (struct vector *)addr;
1199 count = CEILING(fixnum_value(vector->length)+2,2);
1202 case SIMPLE_ARRAY_DOUBLE_FLOAT_WIDETAG:
1203 #ifdef SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG
1204 case SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG:
1206 vector = (struct vector *)addr;
1207 count = fixnum_value(vector->length)*2+2;
1210 #ifdef SIMPLE_ARRAY_LONG_FLOAT_WIDETAG
1211 case SIMPLE_ARRAY_LONG_FLOAT_WIDETAG:
1212 vector = (struct vector *)addr;
1214 count = fixnum_value(vector->length)*3+2;
1217 count = fixnum_value(vector->length)*4+2;
1222 #ifdef SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG
1223 case SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG:
1224 vector = (struct vector *)addr;
1225 count = fixnum_value(vector->length)*4+2;
1229 #ifdef SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG
1230 case SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG:
1231 vector = (struct vector *)addr;
1233 count = fixnum_value(vector->length)*6+2;
1236 count = fixnum_value(vector->length)*8+2;
1241 case CODE_HEADER_WIDETAG:
1243 gc_abort(); /* no code headers in static space */
1245 count = pscav_code((struct code*)addr);
1249 case SIMPLE_FUN_HEADER_WIDETAG:
1250 case CLOSURE_FUN_HEADER_WIDETAG:
1251 case RETURN_PC_HEADER_WIDETAG:
1252 /* We should never hit any of these, 'cause they occur
1253 * buried in the middle of code objects. */
1258 case CLOSURE_HEADER_WIDETAG:
1259 case FUNCALLABLE_INSTANCE_HEADER_WIDETAG:
1260 /* The function self pointer needs special care on the
1261 * x86 because it is the real entry point. */
1263 lispobj fun = ((struct closure *)addr)->fun
1264 - FUN_RAW_ADDR_OFFSET;
1265 pscav(&fun, 1, constant);
1266 ((struct closure *)addr)->fun = fun + FUN_RAW_ADDR_OFFSET;
1272 case WEAK_POINTER_WIDETAG:
1273 /* Weak pointers get preserved during purify, 'cause I
1274 * don't feel like figuring out how to break them. */
1275 pscav(addr+1, 2, constant);
1280 /* We have to handle fdefn objects specially, so we
1281 * can fix up the raw function address. */
1282 count = pscav_fdefn((struct fdefn *)addr);
1291 /* It's a fixnum. */
1303 purify(lispobj static_roots, lispobj read_only_roots)
1307 struct later *laters, *next;
1308 struct thread *thread;
1311 printf("[doing purification:");
1314 #ifdef LISP_FEATURE_GENCGC
1315 gc_alloc_update_all_page_tables();
1317 for_each_thread(thread)
1318 if (fixnum_value(SymbolValue(FREE_INTERRUPT_CONTEXT_INDEX,thread)) != 0) {
1319 /* FIXME: 1. What does this mean? 2. It shouldn't be reporting
1320 * its error simply by a. printing a string b. to stdout instead
1322 printf(" Ack! Can't purify interrupt contexts. ");
1327 #if defined(__i386__)
1328 dynamic_space_free_pointer =
1329 (lispobj*)SymbolValue(ALLOCATION_POINTER,0);
1332 read_only_end = read_only_free =
1333 (lispobj *)SymbolValue(READ_ONLY_SPACE_FREE_POINTER,0);
1334 static_end = static_free =
1335 (lispobj *)SymbolValue(STATIC_SPACE_FREE_POINTER,0);
1343 /* can't do this unless the threads in question are suspended with
1346 #if (defined(LISP_FEATURE_GENCGC) && defined(LISP_FEATURE_X86))
1347 for_each_thread(thread) {
1349 struct user_regs_struct regs;
1350 if(ptrace(PTRACE_GETREGS,thread->pid,0,®s)){
1351 fprintf(stderr,"child pid %d, %s\n",thread->pid,strerror(errno));
1352 lose("PTRACE_GETREGS");
1354 setup_i386_stack_scav(regs.ebp,
1355 ((void *)thread->control_stack_end));
1359 setup_i386_stack_scav(((&static_roots)-2),
1360 ((void *)all_threads->control_stack_end));
1363 pscav(&static_roots, 1, 0);
1364 pscav(&read_only_roots, 1, 1);
1367 printf(" handlers");
1370 pscav((lispobj *) all_threads->interrupt_data->interrupt_handlers,
1371 sizeof(all_threads->interrupt_data->interrupt_handlers)
1380 pscav((lispobj *)CONTROL_STACK_START,
1381 current_control_stack_pointer - (lispobj *)CONTROL_STACK_START,
1384 #ifdef LISP_FEATURE_GENCGC
1390 printf(" bindings");
1393 #if !defined(__i386__)
1394 pscav( (lispobj *)BINDING_STACK_START,
1395 (lispobj *)current_binding_stack_pointer - (lispobj *)BINDING_STACK_START,
1398 for_each_thread(thread) {
1399 pscav( (lispobj *)thread->binding_stack_start,
1400 (lispobj *)SymbolValue(BINDING_STACK_POINTER,thread) -
1401 (lispobj *)thread->binding_stack_start,
1403 pscav( (lispobj *) (thread+1),
1404 fixnum_value(SymbolValue(FREE_TLS_INDEX,0)) -
1405 (sizeof (struct thread))/(sizeof (lispobj)),
1412 /* The original CMU CL code had scavenge-read-only-space code
1413 * controlled by the Lisp-level variable
1414 * *SCAVENGE-READ-ONLY-SPACE*. It was disabled by default, and it
1415 * wasn't documented under what circumstances it was useful or
1416 * safe to turn it on, so it's been turned off in SBCL. If you
1417 * want/need this functionality, and can test and document it,
1418 * please submit a patch. */
1420 if (SymbolValue(SCAVENGE_READ_ONLY_SPACE) != UNBOUND_MARKER_WIDETAG
1421 && SymbolValue(SCAVENGE_READ_ONLY_SPACE) != NIL) {
1422 unsigned read_only_space_size =
1423 (lispobj *)SymbolValue(READ_ONLY_SPACE_FREE_POINTER) -
1424 (lispobj *)READ_ONLY_SPACE_START;
1426 "scavenging read only space: %d bytes\n",
1427 read_only_space_size * sizeof(lispobj));
1428 pscav( (lispobj *)READ_ONLY_SPACE_START, read_only_space_size, 0);
1436 clean = (lispobj *)STATIC_SPACE_START;
1438 while (clean != static_free)
1439 clean = pscav(clean, static_free - clean, 0);
1440 laters = later_blocks;
1441 count = later_count;
1442 later_blocks = NULL;
1444 while (laters != NULL) {
1445 for (i = 0; i < count; i++) {
1446 if (laters->u[i].count == 0) {
1448 } else if (laters->u[i].count <= LATERMAXCOUNT) {
1449 pscav(laters->u[i+1].ptr, laters->u[i].count, 1);
1452 pscav(laters->u[i].ptr, 1, 1);
1455 next = laters->next;
1458 count = LATERBLOCKSIZE;
1460 } while (clean != static_free || later_blocks != NULL);
1467 os_zero((os_vm_address_t) current_dynamic_space,
1468 (os_vm_size_t) DYNAMIC_SPACE_SIZE);
1470 /* Zero the stack. Note that the stack is also zeroed by SUB-GC
1471 * calling SCRUB-CONTROL-STACK - this zeros the stack on the x86. */
1473 os_zero((os_vm_address_t) current_control_stack_pointer,
1474 (os_vm_size_t) (CONTROL_STACK_SIZE -
1475 ((current_control_stack_pointer -
1476 (lispobj *)CONTROL_STACK_START) *
1480 /* It helps to update the heap free pointers so that free_heap can
1481 * verify after it's done. */
1482 SetSymbolValue(READ_ONLY_SPACE_FREE_POINTER, (lispobj)read_only_free,0);
1483 SetSymbolValue(STATIC_SPACE_FREE_POINTER, (lispobj)static_free,0);
1485 #if !defined(__i386__)
1486 dynamic_space_free_pointer = current_dynamic_space;
1488 #if defined LISP_FEATURE_GENCGC
1491 #error unsupported case /* in CMU CL, was "ibmrt using GC" */