fix bug in SYMBOL-VALUE CAS expansion for constant arguments
[sbcl.git] / src / runtime / gencgc.c
1 /*
2  * GENerational Conservative Garbage Collector for SBCL
3  */
4
5 /*
6  * This software is part of the SBCL system. See the README file for
7  * more information.
8  *
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.
14  */
15
16 /*
17  * For a review of garbage collection techniques (e.g. generational
18  * GC) and terminology (e.g. "scavenging") see Paul R. Wilson,
19  * "Uniprocessor Garbage Collection Techniques". As of 20000618, this
20  * had been accepted for _ACM Computing Surveys_ and was available
21  * as a PostScript preprint through
22  *   <http://www.cs.utexas.edu/users/oops/papers.html>
23  * as
24  *   <ftp://ftp.cs.utexas.edu/pub/garbage/bigsurv.ps>.
25  */
26
27 #include <stdlib.h>
28 #include <stdio.h>
29 #include <signal.h>
30 #include <errno.h>
31 #include <string.h>
32 #include "sbcl.h"
33 #include "runtime.h"
34 #include "os.h"
35 #include "interr.h"
36 #include "globals.h"
37 #include "interrupt.h"
38 #include "validate.h"
39 #include "lispregs.h"
40 #include "arch.h"
41 #include "gc.h"
42 #include "gc-internal.h"
43 #include "thread.h"
44 #include "pseudo-atomic.h"
45 #include "alloc.h"
46 #include "genesis/vector.h"
47 #include "genesis/weak-pointer.h"
48 #include "genesis/fdefn.h"
49 #include "genesis/simple-fun.h"
50 #include "save.h"
51 #include "genesis/hash-table.h"
52 #include "genesis/instance.h"
53 #include "genesis/layout.h"
54 #include "gencgc.h"
55 #if !defined(LISP_FEATURE_X86) && !defined(LISP_FEATURE_X86_64)
56 #include "genesis/cons.h"
57 #endif
58
59 /* forward declarations */
60 page_index_t  gc_find_freeish_pages(page_index_t *restart_page_ptr, long nbytes,
61                                     int page_type_flag);
62
63 \f
64 /*
65  * GC parameters
66  */
67
68 /* Generations 0-5 are normal collected generations, 6 is only used as
69  * scratch space by the collector, and should never get collected.
70  */
71 enum {
72     SCRATCH_GENERATION = PSEUDO_STATIC_GENERATION+1,
73     NUM_GENERATIONS
74 };
75
76 /* Should we use page protection to help avoid the scavenging of pages
77  * that don't have pointers to younger generations? */
78 boolean enable_page_protection = 1;
79
80 /* the minimum size (in bytes) for a large object*/
81 #if (GENCGC_ALLOC_GRANULARITY >= PAGE_BYTES) && (GENCGC_ALLOC_GRANULARITY >= GENCGC_CARD_BYTES)
82 os_vm_size_t large_object_size = 4 * GENCGC_ALLOC_GRANULARITY;
83 #elif (GENCGC_CARD_BYTES >= PAGE_BYTES) && (GENCGC_CARD_BYTES >= GENCGC_ALLOC_GRANULARITY)
84 os_vm_size_t large_object_size = 4 * GENCGC_CARD_BYTES;
85 #else
86 os_vm_size_t large_object_size = 4 * PAGE_BYTES;
87 #endif
88
89 /* Largest allocation seen since last GC. */
90 os_vm_size_t large_allocation = 0;
91
92 \f
93 /*
94  * debugging
95  */
96
97 /* the verbosity level. All non-error messages are disabled at level 0;
98  * and only a few rare messages are printed at level 1. */
99 #if QSHOW
100 boolean gencgc_verbose = 1;
101 #else
102 boolean gencgc_verbose = 0;
103 #endif
104
105 /* FIXME: At some point enable the various error-checking things below
106  * and see what they say. */
107
108 /* We hunt for pointers to old-space, when GCing generations >= verify_gen.
109  * Set verify_gens to HIGHEST_NORMAL_GENERATION + 1 to disable this kind of
110  * check. */
111 generation_index_t verify_gens = HIGHEST_NORMAL_GENERATION + 1;
112
113 /* Should we do a pre-scan verify of generation 0 before it's GCed? */
114 boolean pre_verify_gen_0 = 0;
115
116 /* Should we check for bad pointers after gc_free_heap is called
117  * from Lisp PURIFY? */
118 boolean verify_after_free_heap = 0;
119
120 /* Should we print a note when code objects are found in the dynamic space
121  * during a heap verify? */
122 boolean verify_dynamic_code_check = 0;
123
124 /* Should we check code objects for fixup errors after they are transported? */
125 boolean check_code_fixups = 0;
126
127 /* Should we check that newly allocated regions are zero filled? */
128 boolean gencgc_zero_check = 0;
129
130 /* Should we check that the free space is zero filled? */
131 boolean gencgc_enable_verify_zero_fill = 0;
132
133 /* Should we check that free pages are zero filled during gc_free_heap
134  * called after Lisp PURIFY? */
135 boolean gencgc_zero_check_during_free_heap = 0;
136
137 /* When loading a core, don't do a full scan of the memory for the
138  * memory region boundaries. (Set to true by coreparse.c if the core
139  * contained a pagetable entry).
140  */
141 boolean gencgc_partial_pickup = 0;
142
143 /* If defined, free pages are read-protected to ensure that nothing
144  * accesses them.
145  */
146
147 /* #define READ_PROTECT_FREE_PAGES */
148
149 \f
150 /*
151  * GC structures and variables
152  */
153
154 /* the total bytes allocated. These are seen by Lisp DYNAMIC-USAGE. */
155 os_vm_size_t bytes_allocated = 0;
156 os_vm_size_t auto_gc_trigger = 0;
157
158 /* the source and destination generations. These are set before a GC starts
159  * scavenging. */
160 generation_index_t from_space;
161 generation_index_t new_space;
162
163 /* Set to 1 when in GC */
164 boolean gc_active_p = 0;
165
166 /* should the GC be conservative on stack. If false (only right before
167  * saving a core), don't scan the stack / mark pages dont_move. */
168 static boolean conservative_stack = 1;
169
170 /* An array of page structures is allocated on gc initialization.
171  * This helps to quickly map between an address and its page structure.
172  * page_table_pages is set from the size of the dynamic space. */
173 page_index_t page_table_pages;
174 struct page *page_table;
175
176 static inline boolean page_allocated_p(page_index_t page) {
177     return (page_table[page].allocated != FREE_PAGE_FLAG);
178 }
179
180 static inline boolean page_no_region_p(page_index_t page) {
181     return !(page_table[page].allocated & OPEN_REGION_PAGE_FLAG);
182 }
183
184 static inline boolean page_allocated_no_region_p(page_index_t page) {
185     return ((page_table[page].allocated & (UNBOXED_PAGE_FLAG | BOXED_PAGE_FLAG))
186             && page_no_region_p(page));
187 }
188
189 static inline boolean page_free_p(page_index_t page) {
190     return (page_table[page].allocated == FREE_PAGE_FLAG);
191 }
192
193 static inline boolean page_boxed_p(page_index_t page) {
194     return (page_table[page].allocated & BOXED_PAGE_FLAG);
195 }
196
197 static inline boolean code_page_p(page_index_t page) {
198     return (page_table[page].allocated & CODE_PAGE_FLAG);
199 }
200
201 static inline boolean page_boxed_no_region_p(page_index_t page) {
202     return page_boxed_p(page) && page_no_region_p(page);
203 }
204
205 static inline boolean page_unboxed_p(page_index_t page) {
206     /* Both flags set == boxed code page */
207     return ((page_table[page].allocated & UNBOXED_PAGE_FLAG)
208             && !page_boxed_p(page));
209 }
210
211 static inline boolean protect_page_p(page_index_t page, generation_index_t generation) {
212     return (page_boxed_no_region_p(page)
213             && (page_table[page].bytes_used != 0)
214             && !page_table[page].dont_move
215             && (page_table[page].gen == generation));
216 }
217
218 /* To map addresses to page structures the address of the first page
219  * is needed. */
220 static void *heap_base = NULL;
221
222 /* Calculate the start address for the given page number. */
223 inline void *
224 page_address(page_index_t page_num)
225 {
226     return (heap_base + (page_num * GENCGC_CARD_BYTES));
227 }
228
229 /* Calculate the address where the allocation region associated with
230  * the page starts. */
231 static inline void *
232 page_region_start(page_index_t page_index)
233 {
234     return page_address(page_index)-page_table[page_index].region_start_offset;
235 }
236
237 /* Find the page index within the page_table for the given
238  * address. Return -1 on failure. */
239 inline page_index_t
240 find_page_index(void *addr)
241 {
242     if (addr >= heap_base) {
243         page_index_t index = ((pointer_sized_uint_t)addr -
244                               (pointer_sized_uint_t)heap_base) / GENCGC_CARD_BYTES;
245         if (index < page_table_pages)
246             return (index);
247     }
248     return (-1);
249 }
250
251 static os_vm_size_t
252 npage_bytes(page_index_t npages)
253 {
254     gc_assert(npages>=0);
255     return ((os_vm_size_t)npages)*GENCGC_CARD_BYTES;
256 }
257
258 /* Check that X is a higher address than Y and return offset from Y to
259  * X in bytes. */
260 static inline os_vm_size_t
261 void_diff(void *x, void *y)
262 {
263     gc_assert(x >= y);
264     return (pointer_sized_uint_t)x - (pointer_sized_uint_t)y;
265 }
266
267 /* a structure to hold the state of a generation
268  *
269  * CAUTION: If you modify this, make sure to touch up the alien
270  * definition in src/code/gc.lisp accordingly. ...or better yes,
271  * deal with the FIXME there...
272  */
273 struct generation {
274
275     /* the first page that gc_alloc() checks on its next call */
276     page_index_t alloc_start_page;
277
278     /* the first page that gc_alloc_unboxed() checks on its next call */
279     page_index_t alloc_unboxed_start_page;
280
281     /* the first page that gc_alloc_large (boxed) considers on its next
282      * call. (Although it always allocates after the boxed_region.) */
283     page_index_t alloc_large_start_page;
284
285     /* the first page that gc_alloc_large (unboxed) considers on its
286      * next call. (Although it always allocates after the
287      * current_unboxed_region.) */
288     page_index_t alloc_large_unboxed_start_page;
289
290     /* the bytes allocated to this generation */
291     os_vm_size_t bytes_allocated;
292
293     /* the number of bytes at which to trigger a GC */
294     os_vm_size_t gc_trigger;
295
296     /* to calculate a new level for gc_trigger */
297     os_vm_size_t bytes_consed_between_gc;
298
299     /* the number of GCs since the last raise */
300     int num_gc;
301
302     /* the number of GCs to run on the generations before raising objects to the
303      * next generation */
304     int number_of_gcs_before_promotion;
305
306     /* the cumulative sum of the bytes allocated to this generation. It is
307      * cleared after a GC on this generations, and update before new
308      * objects are added from a GC of a younger generation. Dividing by
309      * the bytes_allocated will give the average age of the memory in
310      * this generation since its last GC. */
311     os_vm_size_t cum_sum_bytes_allocated;
312
313     /* a minimum average memory age before a GC will occur helps
314      * prevent a GC when a large number of new live objects have been
315      * added, in which case a GC could be a waste of time */
316     double minimum_age_before_gc;
317 };
318
319 /* an array of generation structures. There needs to be one more
320  * generation structure than actual generations as the oldest
321  * generation is temporarily raised then lowered. */
322 struct generation generations[NUM_GENERATIONS];
323
324 /* the oldest generation that is will currently be GCed by default.
325  * Valid values are: 0, 1, ... HIGHEST_NORMAL_GENERATION
326  *
327  * The default of HIGHEST_NORMAL_GENERATION enables GC on all generations.
328  *
329  * Setting this to 0 effectively disables the generational nature of
330  * the GC. In some applications generational GC may not be useful
331  * because there are no long-lived objects.
332  *
333  * An intermediate value could be handy after moving long-lived data
334  * into an older generation so an unnecessary GC of this long-lived
335  * data can be avoided. */
336 generation_index_t gencgc_oldest_gen_to_gc = HIGHEST_NORMAL_GENERATION;
337
338 /* The maximum free page in the heap is maintained and used to update
339  * ALLOCATION_POINTER which is used by the room function to limit its
340  * search of the heap. XX Gencgc obviously needs to be better
341  * integrated with the Lisp code. */
342 page_index_t last_free_page;
343 \f
344 #ifdef LISP_FEATURE_SB_THREAD
345 /* This lock is to prevent multiple threads from simultaneously
346  * allocating new regions which overlap each other.  Note that the
347  * majority of GC is single-threaded, but alloc() may be called from
348  * >1 thread at a time and must be thread-safe.  This lock must be
349  * seized before all accesses to generations[] or to parts of
350  * page_table[] that other threads may want to see */
351 static pthread_mutex_t free_pages_lock = PTHREAD_MUTEX_INITIALIZER;
352 /* This lock is used to protect non-thread-local allocation. */
353 static pthread_mutex_t allocation_lock = PTHREAD_MUTEX_INITIALIZER;
354 #endif
355
356 extern os_vm_size_t gencgc_release_granularity;
357 os_vm_size_t gencgc_release_granularity = GENCGC_RELEASE_GRANULARITY;
358
359 extern os_vm_size_t gencgc_alloc_granularity;
360 os_vm_size_t gencgc_alloc_granularity = GENCGC_ALLOC_GRANULARITY;
361
362 \f
363 /*
364  * miscellaneous heap functions
365  */
366
367 /* Count the number of pages which are write-protected within the
368  * given generation. */
369 static page_index_t
370 count_write_protect_generation_pages(generation_index_t generation)
371 {
372     page_index_t i, count = 0;
373
374     for (i = 0; i < last_free_page; i++)
375         if (page_allocated_p(i)
376             && (page_table[i].gen == generation)
377             && (page_table[i].write_protected == 1))
378             count++;
379     return count;
380 }
381
382 /* Count the number of pages within the given generation. */
383 static page_index_t
384 count_generation_pages(generation_index_t generation)
385 {
386     page_index_t i;
387     page_index_t count = 0;
388
389     for (i = 0; i < last_free_page; i++)
390         if (page_allocated_p(i)
391             && (page_table[i].gen == generation))
392             count++;
393     return count;
394 }
395
396 #if QSHOW
397 static page_index_t
398 count_dont_move_pages(void)
399 {
400     page_index_t i;
401     page_index_t count = 0;
402     for (i = 0; i < last_free_page; i++) {
403         if (page_allocated_p(i)
404             && (page_table[i].dont_move != 0)) {
405             ++count;
406         }
407     }
408     return count;
409 }
410 #endif /* QSHOW */
411
412 /* Work through the pages and add up the number of bytes used for the
413  * given generation. */
414 static os_vm_size_t
415 count_generation_bytes_allocated (generation_index_t gen)
416 {
417     page_index_t i;
418     os_vm_size_t result = 0;
419     for (i = 0; i < last_free_page; i++) {
420         if (page_allocated_p(i)
421             && (page_table[i].gen == gen))
422             result += page_table[i].bytes_used;
423     }
424     return result;
425 }
426
427 /* Return the average age of the memory in a generation. */
428 extern double
429 generation_average_age(generation_index_t gen)
430 {
431     if (generations[gen].bytes_allocated == 0)
432         return 0.0;
433
434     return
435         ((double)generations[gen].cum_sum_bytes_allocated)
436         / ((double)generations[gen].bytes_allocated);
437 }
438
439 extern void
440 write_generation_stats(FILE *file)
441 {
442     generation_index_t i;
443
444 #if defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
445 #define FPU_STATE_SIZE 27
446     int fpu_state[FPU_STATE_SIZE];
447 #elif defined(LISP_FEATURE_PPC)
448 #define FPU_STATE_SIZE 32
449     long long fpu_state[FPU_STATE_SIZE];
450 #endif
451
452     /* This code uses the FP instructions which may be set up for Lisp
453      * so they need to be saved and reset for C. */
454     fpu_save(fpu_state);
455
456     /* Print the heap stats. */
457     fprintf(file,
458             " Gen StaPg UbSta LaSta LUbSt Boxed Unboxed LB   LUB  !move  Alloc  Waste   Trig    WP  GCs Mem-age\n");
459
460     for (i = 0; i < SCRATCH_GENERATION; i++) {
461         page_index_t j;
462         page_index_t boxed_cnt = 0;
463         page_index_t unboxed_cnt = 0;
464         page_index_t large_boxed_cnt = 0;
465         page_index_t large_unboxed_cnt = 0;
466         page_index_t pinned_cnt=0;
467
468         for (j = 0; j < last_free_page; j++)
469             if (page_table[j].gen == i) {
470
471                 /* Count the number of boxed pages within the given
472                  * generation. */
473                 if (page_boxed_p(j)) {
474                     if (page_table[j].large_object)
475                         large_boxed_cnt++;
476                     else
477                         boxed_cnt++;
478                 }
479                 if(page_table[j].dont_move) pinned_cnt++;
480                 /* Count the number of unboxed pages within the given
481                  * generation. */
482                 if (page_unboxed_p(j)) {
483                     if (page_table[j].large_object)
484                         large_unboxed_cnt++;
485                     else
486                         unboxed_cnt++;
487                 }
488             }
489
490         gc_assert(generations[i].bytes_allocated
491                   == count_generation_bytes_allocated(i));
492         fprintf(file,
493                 "   %1d: %5ld %5ld %5ld %5ld",
494                 i,
495                 generations[i].alloc_start_page,
496                 generations[i].alloc_unboxed_start_page,
497                 generations[i].alloc_large_start_page,
498                 generations[i].alloc_large_unboxed_start_page);
499         fprintf(file,
500                 " %5"PAGE_INDEX_FMT" %5"PAGE_INDEX_FMT" %5"PAGE_INDEX_FMT
501                 " %5"PAGE_INDEX_FMT" %5"PAGE_INDEX_FMT,
502                 boxed_cnt, unboxed_cnt, large_boxed_cnt,
503                 large_unboxed_cnt, pinned_cnt);
504         fprintf(file,
505                 " %8"OS_VM_SIZE_FMT
506                 " %5"OS_VM_SIZE_FMT
507                 " %8"OS_VM_SIZE_FMT
508                 " %4"PAGE_INDEX_FMT" %3d %7.4f\n",
509                 generations[i].bytes_allocated,
510                 (npage_bytes(count_generation_pages(i)) - generations[i].bytes_allocated),
511                 generations[i].gc_trigger,
512                 count_write_protect_generation_pages(i),
513                 generations[i].num_gc,
514                 generation_average_age(i));
515     }
516     fprintf(file,"   Total bytes allocated    = %"OS_VM_SIZE_FMT"\n", bytes_allocated);
517     fprintf(file,"   Dynamic-space-size bytes = %"OS_VM_SIZE_FMT"\n", dynamic_space_size);
518
519     fpu_restore(fpu_state);
520 }
521
522 extern void
523 write_heap_exhaustion_report(FILE *file, long available, long requested,
524                              struct thread *thread)
525 {
526     fprintf(file,
527             "Heap exhausted during %s: %ld bytes available, %ld requested.\n",
528             gc_active_p ? "garbage collection" : "allocation",
529             available,
530             requested);
531     write_generation_stats(file);
532     fprintf(file, "GC control variables:\n");
533     fprintf(file, "   *GC-INHIBIT* = %s\n   *GC-PENDING* = %s\n",
534             SymbolValue(GC_INHIBIT,thread)==NIL ? "false" : "true",
535             (SymbolValue(GC_PENDING, thread) == T) ?
536             "true" : ((SymbolValue(GC_PENDING, thread) == NIL) ?
537                       "false" : "in progress"));
538 #ifdef LISP_FEATURE_SB_THREAD
539     fprintf(file, "   *STOP-FOR-GC-PENDING* = %s\n",
540             SymbolValue(STOP_FOR_GC_PENDING,thread)==NIL ? "false" : "true");
541 #endif
542 }
543
544 extern void
545 print_generation_stats(void)
546 {
547     write_generation_stats(stderr);
548 }
549
550 extern char* gc_logfile;
551 char * gc_logfile = NULL;
552
553 extern void
554 log_generation_stats(char *logfile, char *header)
555 {
556     if (logfile) {
557         FILE * log = fopen(logfile, "a");
558         if (log) {
559             fprintf(log, "%s\n", header);
560             write_generation_stats(log);
561             fclose(log);
562         } else {
563             fprintf(stderr, "Could not open gc logfile: %s\n", logfile);
564             fflush(stderr);
565         }
566     }
567 }
568
569 extern void
570 report_heap_exhaustion(long available, long requested, struct thread *th)
571 {
572     if (gc_logfile) {
573         FILE * log = fopen(gc_logfile, "a");
574         if (log) {
575             write_heap_exhaustion_report(log, available, requested, th);
576             fclose(log);
577         } else {
578             fprintf(stderr, "Could not open gc logfile: %s\n", gc_logfile);
579             fflush(stderr);
580         }
581     }
582     /* Always to stderr as well. */
583     write_heap_exhaustion_report(stderr, available, requested, th);
584 }
585 \f
586
587 #if defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
588 void fast_bzero(void*, size_t); /* in <arch>-assem.S */
589 #endif
590
591 /* Zero the pages from START to END (inclusive), but use mmap/munmap instead
592  * if zeroing it ourselves, i.e. in practice give the memory back to the
593  * OS. Generally done after a large GC.
594  */
595 void zero_pages_with_mmap(page_index_t start, page_index_t end) {
596     page_index_t i;
597     void *addr = page_address(start), *new_addr;
598     os_vm_size_t length = npage_bytes(1+end-start);
599
600     if (start > end)
601       return;
602
603     gc_assert(length >= gencgc_release_granularity);
604     gc_assert((length % gencgc_release_granularity) == 0);
605
606     os_invalidate(addr, length);
607     new_addr = os_validate(addr, length);
608     if (new_addr == NULL || new_addr != addr) {
609         lose("remap_free_pages: page moved, 0x%08x ==> 0x%08x",
610              start, new_addr);
611     }
612
613     for (i = start; i <= end; i++) {
614         page_table[i].need_to_zero = 0;
615     }
616 }
617
618 /* Zero the pages from START to END (inclusive). Generally done just after
619  * a new region has been allocated.
620  */
621 static void
622 zero_pages(page_index_t start, page_index_t end) {
623     if (start > end)
624       return;
625
626 #if defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
627     fast_bzero(page_address(start), npage_bytes(1+end-start));
628 #else
629     bzero(page_address(start), npage_bytes(1+end-start));
630 #endif
631
632 }
633
634 static void
635 zero_and_mark_pages(page_index_t start, page_index_t end) {
636     page_index_t i;
637
638     zero_pages(start, end);
639     for (i = start; i <= end; i++)
640         page_table[i].need_to_zero = 0;
641 }
642
643 /* Zero the pages from START to END (inclusive), except for those
644  * pages that are known to already zeroed. Mark all pages in the
645  * ranges as non-zeroed.
646  */
647 static void
648 zero_dirty_pages(page_index_t start, page_index_t end) {
649     page_index_t i, j;
650
651     for (i = start; i <= end; i++) {
652         if (!page_table[i].need_to_zero) continue;
653         for (j = i+1; (j <= end) && (page_table[j].need_to_zero); j++);
654         zero_pages(i, j-1);
655         i = j;
656     }
657
658     for (i = start; i <= end; i++) {
659         page_table[i].need_to_zero = 1;
660     }
661 }
662
663
664 /*
665  * To support quick and inline allocation, regions of memory can be
666  * allocated and then allocated from with just a free pointer and a
667  * check against an end address.
668  *
669  * Since objects can be allocated to spaces with different properties
670  * e.g. boxed/unboxed, generation, ages; there may need to be many
671  * allocation regions.
672  *
673  * Each allocation region may start within a partly used page. Many
674  * features of memory use are noted on a page wise basis, e.g. the
675  * generation; so if a region starts within an existing allocated page
676  * it must be consistent with this page.
677  *
678  * During the scavenging of the newspace, objects will be transported
679  * into an allocation region, and pointers updated to point to this
680  * allocation region. It is possible that these pointers will be
681  * scavenged again before the allocation region is closed, e.g. due to
682  * trans_list which jumps all over the place to cleanup the list. It
683  * is important to be able to determine properties of all objects
684  * pointed to when scavenging, e.g to detect pointers to the oldspace.
685  * Thus it's important that the allocation regions have the correct
686  * properties set when allocated, and not just set when closed. The
687  * region allocation routines return regions with the specified
688  * properties, and grab all the pages, setting their properties
689  * appropriately, except that the amount used is not known.
690  *
691  * These regions are used to support quicker allocation using just a
692  * free pointer. The actual space used by the region is not reflected
693  * in the pages tables until it is closed. It can't be scavenged until
694  * closed.
695  *
696  * When finished with the region it should be closed, which will
697  * update the page tables for the actual space used returning unused
698  * space. Further it may be noted in the new regions which is
699  * necessary when scavenging the newspace.
700  *
701  * Large objects may be allocated directly without an allocation
702  * region, the page tables are updated immediately.
703  *
704  * Unboxed objects don't contain pointers to other objects and so
705  * don't need scavenging. Further they can't contain pointers to
706  * younger generations so WP is not needed. By allocating pages to
707  * unboxed objects the whole page never needs scavenging or
708  * write-protecting. */
709
710 /* We are only using two regions at present. Both are for the current
711  * newspace generation. */
712 struct alloc_region boxed_region;
713 struct alloc_region unboxed_region;
714
715 /* The generation currently being allocated to. */
716 static generation_index_t gc_alloc_generation;
717
718 static inline page_index_t
719 generation_alloc_start_page(generation_index_t generation, int page_type_flag, int large)
720 {
721     if (large) {
722         if (UNBOXED_PAGE_FLAG == page_type_flag) {
723             return generations[generation].alloc_large_unboxed_start_page;
724         } else if (BOXED_PAGE_FLAG & page_type_flag) {
725             /* Both code and data. */
726             return generations[generation].alloc_large_start_page;
727         } else {
728             lose("bad page type flag: %d", page_type_flag);
729         }
730     } else {
731         if (UNBOXED_PAGE_FLAG == page_type_flag) {
732             return generations[generation].alloc_unboxed_start_page;
733         } else if (BOXED_PAGE_FLAG & page_type_flag) {
734             /* Both code and data. */
735             return generations[generation].alloc_start_page;
736         } else {
737             lose("bad page_type_flag: %d", page_type_flag);
738         }
739     }
740 }
741
742 static inline void
743 set_generation_alloc_start_page(generation_index_t generation, int page_type_flag, int large,
744                                 page_index_t page)
745 {
746     if (large) {
747         if (UNBOXED_PAGE_FLAG == page_type_flag) {
748             generations[generation].alloc_large_unboxed_start_page = page;
749         } else if (BOXED_PAGE_FLAG & page_type_flag) {
750             /* Both code and data. */
751             generations[generation].alloc_large_start_page = page;
752         } else {
753             lose("bad page type flag: %d", page_type_flag);
754         }
755     } else {
756         if (UNBOXED_PAGE_FLAG == page_type_flag) {
757             generations[generation].alloc_unboxed_start_page = page;
758         } else if (BOXED_PAGE_FLAG & page_type_flag) {
759             /* Both code and data. */
760             generations[generation].alloc_start_page = page;
761         } else {
762             lose("bad page type flag: %d", page_type_flag);
763         }
764     }
765 }
766
767 /* Find a new region with room for at least the given number of bytes.
768  *
769  * It starts looking at the current generation's alloc_start_page. So
770  * may pick up from the previous region if there is enough space. This
771  * keeps the allocation contiguous when scavenging the newspace.
772  *
773  * The alloc_region should have been closed by a call to
774  * gc_alloc_update_page_tables(), and will thus be in an empty state.
775  *
776  * To assist the scavenging functions write-protected pages are not
777  * used. Free pages should not be write-protected.
778  *
779  * It is critical to the conservative GC that the start of regions be
780  * known. To help achieve this only small regions are allocated at a
781  * time.
782  *
783  * During scavenging, pointers may be found to within the current
784  * region and the page generation must be set so that pointers to the
785  * from space can be recognized. Therefore the generation of pages in
786  * the region are set to gc_alloc_generation. To prevent another
787  * allocation call using the same pages, all the pages in the region
788  * are allocated, although they will initially be empty.
789  */
790 static void
791 gc_alloc_new_region(long nbytes, int page_type_flag, struct alloc_region *alloc_region)
792 {
793     page_index_t first_page;
794     page_index_t last_page;
795     os_vm_size_t bytes_found;
796     page_index_t i;
797     int ret;
798
799     /*
800     FSHOW((stderr,
801            "/alloc_new_region for %d bytes from gen %d\n",
802            nbytes, gc_alloc_generation));
803     */
804
805     /* Check that the region is in a reset state. */
806     gc_assert((alloc_region->first_page == 0)
807               && (alloc_region->last_page == -1)
808               && (alloc_region->free_pointer == alloc_region->end_addr));
809     ret = thread_mutex_lock(&free_pages_lock);
810     gc_assert(ret == 0);
811     first_page = generation_alloc_start_page(gc_alloc_generation, page_type_flag, 0);
812     last_page=gc_find_freeish_pages(&first_page, nbytes, page_type_flag);
813     bytes_found=(GENCGC_CARD_BYTES - page_table[first_page].bytes_used)
814             + npage_bytes(last_page-first_page);
815
816     /* Set up the alloc_region. */
817     alloc_region->first_page = first_page;
818     alloc_region->last_page = last_page;
819     alloc_region->start_addr = page_table[first_page].bytes_used
820         + page_address(first_page);
821     alloc_region->free_pointer = alloc_region->start_addr;
822     alloc_region->end_addr = alloc_region->start_addr + bytes_found;
823
824     /* Set up the pages. */
825
826     /* The first page may have already been in use. */
827     if (page_table[first_page].bytes_used == 0) {
828         page_table[first_page].allocated = page_type_flag;
829         page_table[first_page].gen = gc_alloc_generation;
830         page_table[first_page].large_object = 0;
831         page_table[first_page].region_start_offset = 0;
832     }
833
834     gc_assert(page_table[first_page].allocated == page_type_flag);
835     page_table[first_page].allocated |= OPEN_REGION_PAGE_FLAG;
836
837     gc_assert(page_table[first_page].gen == gc_alloc_generation);
838     gc_assert(page_table[first_page].large_object == 0);
839
840     for (i = first_page+1; i <= last_page; i++) {
841         page_table[i].allocated = page_type_flag;
842         page_table[i].gen = gc_alloc_generation;
843         page_table[i].large_object = 0;
844         /* This may not be necessary for unboxed regions (think it was
845          * broken before!) */
846         page_table[i].region_start_offset =
847             void_diff(page_address(i),alloc_region->start_addr);
848         page_table[i].allocated |= OPEN_REGION_PAGE_FLAG ;
849     }
850     /* Bump up last_free_page. */
851     if (last_page+1 > last_free_page) {
852         last_free_page = last_page+1;
853         /* do we only want to call this on special occasions? like for
854          * boxed_region? */
855         set_alloc_pointer((lispobj)page_address(last_free_page));
856     }
857     ret = thread_mutex_unlock(&free_pages_lock);
858     gc_assert(ret == 0);
859
860 #ifdef READ_PROTECT_FREE_PAGES
861     os_protect(page_address(first_page),
862                npage_bytes(1+last_page-first_page),
863                OS_VM_PROT_ALL);
864 #endif
865
866     /* If the first page was only partial, don't check whether it's
867      * zeroed (it won't be) and don't zero it (since the parts that
868      * we're interested in are guaranteed to be zeroed).
869      */
870     if (page_table[first_page].bytes_used) {
871         first_page++;
872     }
873
874     zero_dirty_pages(first_page, last_page);
875
876     /* we can do this after releasing free_pages_lock */
877     if (gencgc_zero_check) {
878         word_t *p;
879         for (p = (word_t *)alloc_region->start_addr;
880              p < (word_t *)alloc_region->end_addr; p++) {
881             if (*p != 0) {
882                 lose("The new region is not zero at %p (start=%p, end=%p).\n",
883                      p, alloc_region->start_addr, alloc_region->end_addr);
884             }
885         }
886     }
887 }
888
889 /* If the record_new_objects flag is 2 then all new regions created
890  * are recorded.
891  *
892  * If it's 1 then then it is only recorded if the first page of the
893  * current region is <= new_areas_ignore_page. This helps avoid
894  * unnecessary recording when doing full scavenge pass.
895  *
896  * The new_object structure holds the page, byte offset, and size of
897  * new regions of objects. Each new area is placed in the array of
898  * these structures pointer to by new_areas. new_areas_index holds the
899  * offset into new_areas.
900  *
901  * If new_area overflows NUM_NEW_AREAS then it stops adding them. The
902  * later code must detect this and handle it, probably by doing a full
903  * scavenge of a generation. */
904 #define NUM_NEW_AREAS 512
905 static int record_new_objects = 0;
906 static page_index_t new_areas_ignore_page;
907 struct new_area {
908     page_index_t page;
909     size_t offset;
910     size_t size;
911 };
912 static struct new_area (*new_areas)[];
913 static size_t new_areas_index;
914 size_t max_new_areas;
915
916 /* Add a new area to new_areas. */
917 static void
918 add_new_area(page_index_t first_page, size_t offset, size_t size)
919 {
920     size_t new_area_start, c;
921     ssize_t i;
922
923     /* Ignore if full. */
924     if (new_areas_index >= NUM_NEW_AREAS)
925         return;
926
927     switch (record_new_objects) {
928     case 0:
929         return;
930     case 1:
931         if (first_page > new_areas_ignore_page)
932             return;
933         break;
934     case 2:
935         break;
936     default:
937         gc_abort();
938     }
939
940     new_area_start = npage_bytes(first_page) + offset;
941
942     /* Search backwards for a prior area that this follows from. If
943        found this will save adding a new area. */
944     for (i = new_areas_index-1, c = 0; (i >= 0) && (c < 8); i--, c++) {
945         size_t area_end =
946             npage_bytes((*new_areas)[i].page)
947             + (*new_areas)[i].offset
948             + (*new_areas)[i].size;
949         /*FSHOW((stderr,
950                "/add_new_area S1 %d %d %d %d\n",
951                i, c, new_area_start, area_end));*/
952         if (new_area_start == area_end) {
953             /*FSHOW((stderr,
954                    "/adding to [%d] %d %d %d with %d %d %d:\n",
955                    i,
956                    (*new_areas)[i].page,
957                    (*new_areas)[i].offset,
958                    (*new_areas)[i].size,
959                    first_page,
960                    offset,
961                     size);*/
962             (*new_areas)[i].size += size;
963             return;
964         }
965     }
966
967     (*new_areas)[new_areas_index].page = first_page;
968     (*new_areas)[new_areas_index].offset = offset;
969     (*new_areas)[new_areas_index].size = size;
970     /*FSHOW((stderr,
971            "/new_area %d page %d offset %d size %d\n",
972            new_areas_index, first_page, offset, size));*/
973     new_areas_index++;
974
975     /* Note the max new_areas used. */
976     if (new_areas_index > max_new_areas)
977         max_new_areas = new_areas_index;
978 }
979
980 /* Update the tables for the alloc_region. The region may be added to
981  * the new_areas.
982  *
983  * When done the alloc_region is set up so that the next quick alloc
984  * will fail safely and thus a new region will be allocated. Further
985  * it is safe to try to re-update the page table of this reset
986  * alloc_region. */
987 void
988 gc_alloc_update_page_tables(int page_type_flag, struct alloc_region *alloc_region)
989 {
990     boolean more;
991     page_index_t first_page;
992     page_index_t next_page;
993     os_vm_size_t bytes_used;
994     os_vm_size_t region_size;
995     os_vm_size_t byte_cnt;
996     page_bytes_t orig_first_page_bytes_used;
997     int ret;
998
999
1000     first_page = alloc_region->first_page;
1001
1002     /* Catch an unused alloc_region. */
1003     if ((first_page == 0) && (alloc_region->last_page == -1))
1004         return;
1005
1006     next_page = first_page+1;
1007
1008     ret = thread_mutex_lock(&free_pages_lock);
1009     gc_assert(ret == 0);
1010     if (alloc_region->free_pointer != alloc_region->start_addr) {
1011         /* some bytes were allocated in the region */
1012         orig_first_page_bytes_used = page_table[first_page].bytes_used;
1013
1014         gc_assert(alloc_region->start_addr ==
1015                   (page_address(first_page)
1016                    + page_table[first_page].bytes_used));
1017
1018         /* All the pages used need to be updated */
1019
1020         /* Update the first page. */
1021
1022         /* If the page was free then set up the gen, and
1023          * region_start_offset. */
1024         if (page_table[first_page].bytes_used == 0)
1025             gc_assert(page_table[first_page].region_start_offset == 0);
1026         page_table[first_page].allocated &= ~(OPEN_REGION_PAGE_FLAG);
1027
1028         gc_assert(page_table[first_page].allocated & page_type_flag);
1029         gc_assert(page_table[first_page].gen == gc_alloc_generation);
1030         gc_assert(page_table[first_page].large_object == 0);
1031
1032         byte_cnt = 0;
1033
1034         /* Calculate the number of bytes used in this page. This is not
1035          * always the number of new bytes, unless it was free. */
1036         more = 0;
1037         if ((bytes_used = void_diff(alloc_region->free_pointer,
1038                                     page_address(first_page)))
1039             >GENCGC_CARD_BYTES) {
1040             bytes_used = GENCGC_CARD_BYTES;
1041             more = 1;
1042         }
1043         page_table[first_page].bytes_used = bytes_used;
1044         byte_cnt += bytes_used;
1045
1046
1047         /* All the rest of the pages should be free. We need to set
1048          * their region_start_offset pointer to the start of the
1049          * region, and set the bytes_used. */
1050         while (more) {
1051             page_table[next_page].allocated &= ~(OPEN_REGION_PAGE_FLAG);
1052             gc_assert(page_table[next_page].allocated & page_type_flag);
1053             gc_assert(page_table[next_page].bytes_used == 0);
1054             gc_assert(page_table[next_page].gen == gc_alloc_generation);
1055             gc_assert(page_table[next_page].large_object == 0);
1056
1057             gc_assert(page_table[next_page].region_start_offset ==
1058                       void_diff(page_address(next_page),
1059                                 alloc_region->start_addr));
1060
1061             /* Calculate the number of bytes used in this page. */
1062             more = 0;
1063             if ((bytes_used = void_diff(alloc_region->free_pointer,
1064                                         page_address(next_page)))>GENCGC_CARD_BYTES) {
1065                 bytes_used = GENCGC_CARD_BYTES;
1066                 more = 1;
1067             }
1068             page_table[next_page].bytes_used = bytes_used;
1069             byte_cnt += bytes_used;
1070
1071             next_page++;
1072         }
1073
1074         region_size = void_diff(alloc_region->free_pointer,
1075                                 alloc_region->start_addr);
1076         bytes_allocated += region_size;
1077         generations[gc_alloc_generation].bytes_allocated += region_size;
1078
1079         gc_assert((byte_cnt- orig_first_page_bytes_used) == region_size);
1080
1081         /* Set the generations alloc restart page to the last page of
1082          * the region. */
1083         set_generation_alloc_start_page(gc_alloc_generation, page_type_flag, 0, next_page-1);
1084
1085         /* Add the region to the new_areas if requested. */
1086         if (BOXED_PAGE_FLAG & page_type_flag)
1087             add_new_area(first_page,orig_first_page_bytes_used, region_size);
1088
1089         /*
1090         FSHOW((stderr,
1091                "/gc_alloc_update_page_tables update %d bytes to gen %d\n",
1092                region_size,
1093                gc_alloc_generation));
1094         */
1095     } else {
1096         /* There are no bytes allocated. Unallocate the first_page if
1097          * there are 0 bytes_used. */
1098         page_table[first_page].allocated &= ~(OPEN_REGION_PAGE_FLAG);
1099         if (page_table[first_page].bytes_used == 0)
1100             page_table[first_page].allocated = FREE_PAGE_FLAG;
1101     }
1102
1103     /* Unallocate any unused pages. */
1104     while (next_page <= alloc_region->last_page) {
1105         gc_assert(page_table[next_page].bytes_used == 0);
1106         page_table[next_page].allocated = FREE_PAGE_FLAG;
1107         next_page++;
1108     }
1109     ret = thread_mutex_unlock(&free_pages_lock);
1110     gc_assert(ret == 0);
1111
1112     /* alloc_region is per-thread, we're ok to do this unlocked */
1113     gc_set_region_empty(alloc_region);
1114 }
1115
1116 static inline void *gc_quick_alloc(long nbytes);
1117
1118 /* Allocate a possibly large object. */
1119 void *
1120 gc_alloc_large(long nbytes, int page_type_flag, struct alloc_region *alloc_region)
1121 {
1122     boolean more;
1123     page_index_t first_page, next_page, last_page;
1124     page_bytes_t orig_first_page_bytes_used;
1125     os_vm_size_t byte_cnt;
1126     os_vm_size_t bytes_used;
1127     int ret;
1128
1129     ret = thread_mutex_lock(&free_pages_lock);
1130     gc_assert(ret == 0);
1131
1132     first_page = generation_alloc_start_page(gc_alloc_generation, page_type_flag, 1);
1133     if (first_page <= alloc_region->last_page) {
1134         first_page = alloc_region->last_page+1;
1135     }
1136
1137     last_page=gc_find_freeish_pages(&first_page,nbytes, page_type_flag);
1138
1139     gc_assert(first_page > alloc_region->last_page);
1140
1141     set_generation_alloc_start_page(gc_alloc_generation, page_type_flag, 1, last_page);
1142
1143     /* Set up the pages. */
1144     orig_first_page_bytes_used = page_table[first_page].bytes_used;
1145
1146     /* If the first page was free then set up the gen, and
1147      * region_start_offset. */
1148     if (page_table[first_page].bytes_used == 0) {
1149         page_table[first_page].allocated = page_type_flag;
1150         page_table[first_page].gen = gc_alloc_generation;
1151         page_table[first_page].region_start_offset = 0;
1152         page_table[first_page].large_object = 1;
1153     }
1154
1155     gc_assert(page_table[first_page].allocated == page_type_flag);
1156     gc_assert(page_table[first_page].gen == gc_alloc_generation);
1157     gc_assert(page_table[first_page].large_object == 1);
1158
1159     byte_cnt = 0;
1160
1161     /* Calc. the number of bytes used in this page. This is not
1162      * always the number of new bytes, unless it was free. */
1163     more = 0;
1164     if ((bytes_used = nbytes+orig_first_page_bytes_used) > GENCGC_CARD_BYTES) {
1165         bytes_used = GENCGC_CARD_BYTES;
1166         more = 1;
1167     }
1168     page_table[first_page].bytes_used = bytes_used;
1169     byte_cnt += bytes_used;
1170
1171     next_page = first_page+1;
1172
1173     /* All the rest of the pages should be free. We need to set their
1174      * region_start_offset pointer to the start of the region, and set
1175      * the bytes_used. */
1176     while (more) {
1177         gc_assert(page_free_p(next_page));
1178         gc_assert(page_table[next_page].bytes_used == 0);
1179         page_table[next_page].allocated = page_type_flag;
1180         page_table[next_page].gen = gc_alloc_generation;
1181         page_table[next_page].large_object = 1;
1182
1183         page_table[next_page].region_start_offset =
1184             npage_bytes(next_page-first_page) - orig_first_page_bytes_used;
1185
1186         /* Calculate the number of bytes used in this page. */
1187         more = 0;
1188         bytes_used=(nbytes+orig_first_page_bytes_used)-byte_cnt;
1189         if (bytes_used > GENCGC_CARD_BYTES) {
1190             bytes_used = GENCGC_CARD_BYTES;
1191             more = 1;
1192         }
1193         page_table[next_page].bytes_used = bytes_used;
1194         page_table[next_page].write_protected=0;
1195         page_table[next_page].dont_move=0;
1196         byte_cnt += bytes_used;
1197         next_page++;
1198     }
1199
1200     gc_assert((byte_cnt-orig_first_page_bytes_used) == nbytes);
1201
1202     bytes_allocated += nbytes;
1203     generations[gc_alloc_generation].bytes_allocated += nbytes;
1204
1205     /* Add the region to the new_areas if requested. */
1206     if (BOXED_PAGE_FLAG & page_type_flag)
1207         add_new_area(first_page,orig_first_page_bytes_used,nbytes);
1208
1209     /* Bump up last_free_page */
1210     if (last_page+1 > last_free_page) {
1211         last_free_page = last_page+1;
1212         set_alloc_pointer((lispobj)(page_address(last_free_page)));
1213     }
1214     ret = thread_mutex_unlock(&free_pages_lock);
1215     gc_assert(ret == 0);
1216
1217 #ifdef READ_PROTECT_FREE_PAGES
1218     os_protect(page_address(first_page),
1219                npage_bytes(1+last_page-first_page),
1220                OS_VM_PROT_ALL);
1221 #endif
1222
1223     zero_dirty_pages(first_page, last_page);
1224
1225     return page_address(first_page);
1226 }
1227
1228 static page_index_t gencgc_alloc_start_page = -1;
1229
1230 void
1231 gc_heap_exhausted_error_or_lose (long available, long requested)
1232 {
1233     struct thread *thread = arch_os_get_current_thread();
1234     /* Write basic information before doing anything else: if we don't
1235      * call to lisp this is a must, and even if we do there is always
1236      * the danger that we bounce back here before the error has been
1237      * handled, or indeed even printed.
1238      */
1239     report_heap_exhaustion(available, requested, thread);
1240     if (gc_active_p || (available == 0)) {
1241         /* If we are in GC, or totally out of memory there is no way
1242          * to sanely transfer control to the lisp-side of things.
1243          */
1244         lose("Heap exhausted, game over.");
1245     }
1246     else {
1247         /* FIXME: assert free_pages_lock held */
1248         (void)thread_mutex_unlock(&free_pages_lock);
1249         gc_assert(get_pseudo_atomic_atomic(thread));
1250         clear_pseudo_atomic_atomic(thread);
1251         if (get_pseudo_atomic_interrupted(thread))
1252             do_pending_interrupt();
1253         /* Another issue is that signalling HEAP-EXHAUSTED error leads
1254          * to running user code at arbitrary places, even in a
1255          * WITHOUT-INTERRUPTS which may lead to a deadlock without
1256          * running out of the heap. So at this point all bets are
1257          * off. */
1258         if (SymbolValue(INTERRUPTS_ENABLED,thread) == NIL)
1259             corruption_warning_and_maybe_lose
1260                 ("Signalling HEAP-EXHAUSTED in a WITHOUT-INTERRUPTS.");
1261         funcall2(StaticSymbolFunction(HEAP_EXHAUSTED_ERROR),
1262                  alloc_number(available), alloc_number(requested));
1263         lose("HEAP-EXHAUSTED-ERROR fell through");
1264     }
1265 }
1266
1267 page_index_t
1268 gc_find_freeish_pages(page_index_t *restart_page_ptr, long bytes,
1269                       int page_type_flag)
1270 {
1271     page_index_t most_bytes_found_from = 0, most_bytes_found_to = 0;
1272     page_index_t first_page, last_page, restart_page = *restart_page_ptr;
1273     os_vm_size_t nbytes = bytes;
1274     os_vm_size_t nbytes_goal = nbytes;
1275     os_vm_size_t bytes_found = 0;
1276     os_vm_size_t most_bytes_found = 0;
1277     boolean small_object = nbytes < GENCGC_CARD_BYTES;
1278     /* FIXME: assert(free_pages_lock is held); */
1279
1280     if (nbytes_goal < gencgc_alloc_granularity)
1281         nbytes_goal = gencgc_alloc_granularity;
1282
1283     /* Toggled by gc_and_save for heap compaction, normally -1. */
1284     if (gencgc_alloc_start_page != -1) {
1285         restart_page = gencgc_alloc_start_page;
1286     }
1287
1288     /* FIXME: This is on bytes instead of nbytes pending cleanup of
1289      * long from the interface. */
1290     gc_assert(bytes>=0);
1291     /* Search for a page with at least nbytes of space. We prefer
1292      * not to split small objects on multiple pages, to reduce the
1293      * number of contiguous allocation regions spaning multiple
1294      * pages: this helps avoid excessive conservativism.
1295      *
1296      * For other objects, we guarantee that they start on their own
1297      * page boundary.
1298      */
1299     first_page = restart_page;
1300     while (first_page < page_table_pages) {
1301         bytes_found = 0;
1302         if (page_free_p(first_page)) {
1303                 gc_assert(0 == page_table[first_page].bytes_used);
1304                 bytes_found = GENCGC_CARD_BYTES;
1305         } else if (small_object &&
1306                    (page_table[first_page].allocated == page_type_flag) &&
1307                    (page_table[first_page].large_object == 0) &&
1308                    (page_table[first_page].gen == gc_alloc_generation) &&
1309                    (page_table[first_page].write_protected == 0) &&
1310                    (page_table[first_page].dont_move == 0)) {
1311             bytes_found = GENCGC_CARD_BYTES - page_table[first_page].bytes_used;
1312             if (bytes_found < nbytes) {
1313                 if (bytes_found > most_bytes_found)
1314                     most_bytes_found = bytes_found;
1315                 first_page++;
1316                 continue;
1317             }
1318         } else {
1319             first_page++;
1320             continue;
1321         }
1322
1323         gc_assert(page_table[first_page].write_protected == 0);
1324         for (last_page = first_page+1;
1325              ((last_page < page_table_pages) &&
1326               page_free_p(last_page) &&
1327               (bytes_found < nbytes_goal));
1328              last_page++) {
1329             bytes_found += GENCGC_CARD_BYTES;
1330             gc_assert(0 == page_table[last_page].bytes_used);
1331             gc_assert(0 == page_table[last_page].write_protected);
1332         }
1333
1334         if (bytes_found > most_bytes_found) {
1335             most_bytes_found = bytes_found;
1336             most_bytes_found_from = first_page;
1337             most_bytes_found_to = last_page;
1338         }
1339         if (bytes_found >= nbytes_goal)
1340             break;
1341
1342         first_page = last_page;
1343     }
1344
1345     bytes_found = most_bytes_found;
1346     restart_page = first_page + 1;
1347
1348     /* Check for a failure */
1349     if (bytes_found < nbytes) {
1350         gc_assert(restart_page >= page_table_pages);
1351         gc_heap_exhausted_error_or_lose(most_bytes_found, nbytes);
1352     }
1353
1354     gc_assert(most_bytes_found_to);
1355     *restart_page_ptr = most_bytes_found_from;
1356     return most_bytes_found_to-1;
1357 }
1358
1359 /* Allocate bytes.  All the rest of the special-purpose allocation
1360  * functions will eventually call this  */
1361
1362 void *
1363 gc_alloc_with_region(long nbytes,int page_type_flag, struct alloc_region *my_region,
1364                      int quick_p)
1365 {
1366     void *new_free_pointer;
1367
1368     if (nbytes>=large_object_size)
1369         return gc_alloc_large(nbytes, page_type_flag, my_region);
1370
1371     /* Check whether there is room in the current alloc region. */
1372     new_free_pointer = my_region->free_pointer + nbytes;
1373
1374     /* fprintf(stderr, "alloc %d bytes from %p to %p\n", nbytes,
1375        my_region->free_pointer, new_free_pointer); */
1376
1377     if (new_free_pointer <= my_region->end_addr) {
1378         /* If so then allocate from the current alloc region. */
1379         void *new_obj = my_region->free_pointer;
1380         my_region->free_pointer = new_free_pointer;
1381
1382         /* Unless a `quick' alloc was requested, check whether the
1383            alloc region is almost empty. */
1384         if (!quick_p &&
1385             void_diff(my_region->end_addr,my_region->free_pointer) <= 32) {
1386             /* If so, finished with the current region. */
1387             gc_alloc_update_page_tables(page_type_flag, my_region);
1388             /* Set up a new region. */
1389             gc_alloc_new_region(32 /*bytes*/, page_type_flag, my_region);
1390         }
1391
1392         return((void *)new_obj);
1393     }
1394
1395     /* Else not enough free space in the current region: retry with a
1396      * new region. */
1397
1398     gc_alloc_update_page_tables(page_type_flag, my_region);
1399     gc_alloc_new_region(nbytes, page_type_flag, my_region);
1400     return gc_alloc_with_region(nbytes, page_type_flag, my_region,0);
1401 }
1402
1403 /* these are only used during GC: all allocation from the mutator calls
1404  * alloc() -> gc_alloc_with_region() with the appropriate per-thread
1405  * region */
1406
1407 static inline void *
1408 gc_quick_alloc(long nbytes)
1409 {
1410     return gc_general_alloc(nbytes, BOXED_PAGE_FLAG, ALLOC_QUICK);
1411 }
1412
1413 static inline void *
1414 gc_alloc_unboxed(long nbytes)
1415 {
1416     return gc_general_alloc(nbytes, UNBOXED_PAGE_FLAG, 0);
1417 }
1418
1419 static inline void *
1420 gc_quick_alloc_unboxed(long nbytes)
1421 {
1422     return gc_general_alloc(nbytes, UNBOXED_PAGE_FLAG, ALLOC_QUICK);
1423 }
1424 \f
1425 /* Copy a large object. If the object is in a large object region then
1426  * it is simply promoted, else it is copied. If it's large enough then
1427  * it's copied to a large object region.
1428  *
1429  * Bignums and vectors may have shrunk. If the object is not copied
1430  * the space needs to be reclaimed, and the page_tables corrected. */
1431 static lispobj
1432 general_copy_large_object(lispobj object, long nwords, boolean boxedp)
1433 {
1434     int tag;
1435     lispobj *new;
1436     page_index_t first_page;
1437
1438     gc_assert(is_lisp_pointer(object));
1439     gc_assert(from_space_p(object));
1440     gc_assert((nwords & 0x01) == 0);
1441
1442     if ((nwords > 1024*1024) && gencgc_verbose) {
1443         FSHOW((stderr, "/general_copy_large_object: %d bytes\n",
1444                nwords*N_WORD_BYTES));
1445     }
1446
1447     /* Check whether it's a large object. */
1448     first_page = find_page_index((void *)object);
1449     gc_assert(first_page >= 0);
1450
1451     if (page_table[first_page].large_object) {
1452         /* Promote the object. Note: Unboxed objects may have been
1453          * allocated to a BOXED region so it may be necessary to
1454          * change the region to UNBOXED. */
1455         os_vm_size_t remaining_bytes;
1456         os_vm_size_t bytes_freed;
1457         page_index_t next_page;
1458         page_bytes_t old_bytes_used;
1459
1460         /* FIXME: This comment is somewhat stale.
1461          *
1462          * Note: Any page write-protection must be removed, else a
1463          * later scavenge_newspace may incorrectly not scavenge these
1464          * pages. This would not be necessary if they are added to the
1465          * new areas, but let's do it for them all (they'll probably
1466          * be written anyway?). */
1467
1468         gc_assert(page_table[first_page].region_start_offset == 0);
1469         next_page = first_page;
1470         remaining_bytes = nwords*N_WORD_BYTES;
1471
1472         while (remaining_bytes > GENCGC_CARD_BYTES) {
1473             gc_assert(page_table[next_page].gen == from_space);
1474             gc_assert(page_table[next_page].large_object);
1475             gc_assert(page_table[next_page].region_start_offset ==
1476                       npage_bytes(next_page-first_page));
1477             gc_assert(page_table[next_page].bytes_used == GENCGC_CARD_BYTES);
1478             /* Should have been unprotected by unprotect_oldspace()
1479              * for boxed objects, and after promotion unboxed ones
1480              * should not be on protected pages at all. */
1481             gc_assert(!page_table[next_page].write_protected);
1482
1483             if (boxedp)
1484                 gc_assert(page_boxed_p(next_page));
1485             else {
1486                 gc_assert(page_allocated_no_region_p(next_page));
1487                 page_table[next_page].allocated = UNBOXED_PAGE_FLAG;
1488             }
1489             page_table[next_page].gen = new_space;
1490
1491             remaining_bytes -= GENCGC_CARD_BYTES;
1492             next_page++;
1493         }
1494
1495         /* Now only one page remains, but the object may have shrunk so
1496          * there may be more unused pages which will be freed. */
1497
1498         /* Object may have shrunk but shouldn't have grown - check. */
1499         gc_assert(page_table[next_page].bytes_used >= remaining_bytes);
1500
1501         page_table[next_page].gen = new_space;
1502
1503         if (boxedp)
1504             gc_assert(page_boxed_p(next_page));
1505         else
1506             page_table[next_page].allocated = UNBOXED_PAGE_FLAG;
1507
1508         /* Adjust the bytes_used. */
1509         old_bytes_used = page_table[next_page].bytes_used;
1510         page_table[next_page].bytes_used = remaining_bytes;
1511
1512         bytes_freed = old_bytes_used - remaining_bytes;
1513
1514         /* Free any remaining pages; needs care. */
1515         next_page++;
1516         while ((old_bytes_used == GENCGC_CARD_BYTES) &&
1517                (page_table[next_page].gen == from_space) &&
1518                /* FIXME: It is not obvious to me why this is necessary
1519                 * as a loop condition: it seems to me that the
1520                 * region_start_offset test should be sufficient, but
1521                 * experimentally that is not the case. --NS
1522                 * 2011-11-28 */
1523                (boxedp ?
1524                 page_boxed_p(next_page) :
1525                 page_allocated_no_region_p(next_page)) &&
1526                page_table[next_page].large_object &&
1527                (page_table[next_page].region_start_offset ==
1528                 npage_bytes(next_page - first_page))) {
1529             /* Checks out OK, free the page. Don't need to both zeroing
1530              * pages as this should have been done before shrinking the
1531              * object. These pages shouldn't be write-protected, even if
1532              * boxed they should be zero filled. */
1533             gc_assert(page_table[next_page].write_protected == 0);
1534
1535             old_bytes_used = page_table[next_page].bytes_used;
1536             page_table[next_page].allocated = FREE_PAGE_FLAG;
1537             page_table[next_page].bytes_used = 0;
1538             bytes_freed += old_bytes_used;
1539             next_page++;
1540         }
1541
1542         if ((bytes_freed > 0) && gencgc_verbose) {
1543             FSHOW((stderr,
1544                    "/general_copy_large_object bytes_freed=%"OS_VM_SIZE_FMT"\n",
1545                    bytes_freed));
1546         }
1547
1548         generations[from_space].bytes_allocated -= nwords*N_WORD_BYTES
1549             + bytes_freed;
1550         generations[new_space].bytes_allocated += nwords*N_WORD_BYTES;
1551         bytes_allocated -= bytes_freed;
1552
1553         /* Add the region to the new_areas if requested. */
1554         if (boxedp)
1555             add_new_area(first_page,0,nwords*N_WORD_BYTES);
1556
1557         return(object);
1558
1559     } else {
1560         /* Get tag of object. */
1561         tag = lowtag_of(object);
1562
1563         /* Allocate space. */
1564         new = gc_general_alloc(nwords*N_WORD_BYTES,
1565                                (boxedp ? BOXED_PAGE_FLAG : UNBOXED_PAGE_FLAG),
1566                                ALLOC_QUICK);
1567
1568         /* Copy the object. */
1569         memcpy(new,native_pointer(object),nwords*N_WORD_BYTES);
1570
1571         /* Return Lisp pointer of new object. */
1572         return ((lispobj) new) | tag;
1573     }
1574 }
1575
1576 lispobj
1577 copy_large_object(lispobj object, long nwords)
1578 {
1579     return general_copy_large_object(object, nwords, 1);
1580 }
1581
1582 lispobj
1583 copy_large_unboxed_object(lispobj object, long nwords)
1584 {
1585     return general_copy_large_object(object, nwords, 0);
1586 }
1587
1588 /* to copy unboxed objects */
1589 lispobj
1590 copy_unboxed_object(lispobj object, long nwords)
1591 {
1592     return gc_general_copy_object(object, nwords, UNBOXED_PAGE_FLAG);
1593 }
1594 \f
1595
1596 /*
1597  * code and code-related objects
1598  */
1599 /*
1600 static lispobj trans_fun_header(lispobj object);
1601 static lispobj trans_boxed(lispobj object);
1602 */
1603
1604 /* Scan a x86 compiled code object, looking for possible fixups that
1605  * have been missed after a move.
1606  *
1607  * Two types of fixups are needed:
1608  * 1. Absolute fixups to within the code object.
1609  * 2. Relative fixups to outside the code object.
1610  *
1611  * Currently only absolute fixups to the constant vector, or to the
1612  * code area are checked. */
1613 void
1614 sniff_code_object(struct code *code, os_vm_size_t displacement)
1615 {
1616 #ifdef LISP_FEATURE_X86
1617     long nheader_words, ncode_words, nwords;
1618     os_vm_address_t constants_start_addr = NULL, constants_end_addr, p;
1619     os_vm_address_t code_start_addr, code_end_addr;
1620     os_vm_address_t code_addr = (os_vm_address_t)code;
1621     int fixup_found = 0;
1622
1623     if (!check_code_fixups)
1624         return;
1625
1626     FSHOW((stderr, "/sniffing code: %p, %lu\n", code, displacement));
1627
1628     ncode_words = fixnum_value(code->code_size);
1629     nheader_words = HeaderValue(*(lispobj *)code);
1630     nwords = ncode_words + nheader_words;
1631
1632     constants_start_addr = code_addr + 5*N_WORD_BYTES;
1633     constants_end_addr = code_addr + nheader_words*N_WORD_BYTES;
1634     code_start_addr = code_addr + nheader_words*N_WORD_BYTES;
1635     code_end_addr = code_addr + nwords*N_WORD_BYTES;
1636
1637     /* Work through the unboxed code. */
1638     for (p = code_start_addr; p < code_end_addr; p++) {
1639         void *data = *(void **)p;
1640         unsigned d1 = *((unsigned char *)p - 1);
1641         unsigned d2 = *((unsigned char *)p - 2);
1642         unsigned d3 = *((unsigned char *)p - 3);
1643         unsigned d4 = *((unsigned char *)p - 4);
1644 #if QSHOW
1645         unsigned d5 = *((unsigned char *)p - 5);
1646         unsigned d6 = *((unsigned char *)p - 6);
1647 #endif
1648
1649         /* Check for code references. */
1650         /* Check for a 32 bit word that looks like an absolute
1651            reference to within the code adea of the code object. */
1652         if ((data >= (void*)(code_start_addr-displacement))
1653             && (data < (void*)(code_end_addr-displacement))) {
1654             /* function header */
1655             if ((d4 == 0x5e)
1656                 && (((unsigned)p - 4 - 4*HeaderValue(*((unsigned *)p-1))) ==
1657                     (unsigned)code)) {
1658                 /* Skip the function header */
1659                 p += 6*4 - 4 - 1;
1660                 continue;
1661             }
1662             /* the case of PUSH imm32 */
1663             if (d1 == 0x68) {
1664                 fixup_found = 1;
1665                 FSHOW((stderr,
1666                        "/code ref @%x: %.2x %.2x %.2x %.2x %.2x %.2x (%.8x)\n",
1667                        p, d6, d5, d4, d3, d2, d1, data));
1668                 FSHOW((stderr, "/PUSH $0x%.8x\n", data));
1669             }
1670             /* the case of MOV [reg-8],imm32 */
1671             if ((d3 == 0xc7)
1672                 && (d2==0x40 || d2==0x41 || d2==0x42 || d2==0x43
1673                     || d2==0x45 || d2==0x46 || d2==0x47)
1674                 && (d1 == 0xf8)) {
1675                 fixup_found = 1;
1676                 FSHOW((stderr,
1677                        "/code ref @%x: %.2x %.2x %.2x %.2x %.2x %.2x (%.8x)\n",
1678                        p, d6, d5, d4, d3, d2, d1, data));
1679                 FSHOW((stderr, "/MOV [reg-8],$0x%.8x\n", data));
1680             }
1681             /* the case of LEA reg,[disp32] */
1682             if ((d2 == 0x8d) && ((d1 & 0xc7) == 5)) {
1683                 fixup_found = 1;
1684                 FSHOW((stderr,
1685                        "/code ref @%x: %.2x %.2x %.2x %.2x %.2x %.2x (%.8x)\n",
1686                        p, d6, d5, d4, d3, d2, d1, data));
1687                 FSHOW((stderr,"/LEA reg,[$0x%.8x]\n", data));
1688             }
1689         }
1690
1691         /* Check for constant references. */
1692         /* Check for a 32 bit word that looks like an absolute
1693            reference to within the constant vector. Constant references
1694            will be aligned. */
1695         if ((data >= (void*)(constants_start_addr-displacement))
1696             && (data < (void*)(constants_end_addr-displacement))
1697             && (((unsigned)data & 0x3) == 0)) {
1698             /*  Mov eax,m32 */
1699             if (d1 == 0xa1) {
1700                 fixup_found = 1;
1701                 FSHOW((stderr,
1702                        "/abs const ref @%x: %.2x %.2x %.2x %.2x %.2x %.2x (%.8x)\n",
1703                        p, d6, d5, d4, d3, d2, d1, data));
1704                 FSHOW((stderr,"/MOV eax,0x%.8x\n", data));
1705             }
1706
1707             /*  the case of MOV m32,EAX */
1708             if (d1 == 0xa3) {
1709                 fixup_found = 1;
1710                 FSHOW((stderr,
1711                        "/abs const ref @%x: %.2x %.2x %.2x %.2x %.2x %.2x (%.8x)\n",
1712                        p, d6, d5, d4, d3, d2, d1, data));
1713                 FSHOW((stderr, "/MOV 0x%.8x,eax\n", data));
1714             }
1715
1716             /* the case of CMP m32,imm32 */
1717             if ((d1 == 0x3d) && (d2 == 0x81)) {
1718                 fixup_found = 1;
1719                 FSHOW((stderr,
1720                        "/abs const ref @%x: %.2x %.2x %.2x %.2x %.2x %.2x (%.8x)\n",
1721                        p, d6, d5, d4, d3, d2, d1, data));
1722                 /* XX Check this */
1723                 FSHOW((stderr, "/CMP 0x%.8x,immed32\n", data));
1724             }
1725
1726             /* Check for a mod=00, r/m=101 byte. */
1727             if ((d1 & 0xc7) == 5) {
1728                 /* Cmp m32,reg */
1729                 if (d2 == 0x39) {
1730                     fixup_found = 1;
1731                     FSHOW((stderr,
1732                            "/abs const ref @%x: %.2x %.2x %.2x %.2x %.2x %.2x (%.8x)\n",
1733                            p, d6, d5, d4, d3, d2, d1, data));
1734                     FSHOW((stderr,"/CMP 0x%.8x,reg\n", data));
1735                 }
1736                 /* the case of CMP reg32,m32 */
1737                 if (d2 == 0x3b) {
1738                     fixup_found = 1;
1739                     FSHOW((stderr,
1740                            "/abs const ref @%x: %.2x %.2x %.2x %.2x %.2x %.2x (%.8x)\n",
1741                            p, d6, d5, d4, d3, d2, d1, data));
1742                     FSHOW((stderr, "/CMP reg32,0x%.8x\n", data));
1743                 }
1744                 /* the case of MOV m32,reg32 */
1745                 if (d2 == 0x89) {
1746                     fixup_found = 1;
1747                     FSHOW((stderr,
1748                            "/abs const ref @%x: %.2x %.2x %.2x %.2x %.2x %.2x (%.8x)\n",
1749                            p, d6, d5, d4, d3, d2, d1, data));
1750                     FSHOW((stderr, "/MOV 0x%.8x,reg32\n", data));
1751                 }
1752                 /* the case of MOV reg32,m32 */
1753                 if (d2 == 0x8b) {
1754                     fixup_found = 1;
1755                     FSHOW((stderr,
1756                            "/abs const ref @%x: %.2x %.2x %.2x %.2x %.2x %.2x (%.8x)\n",
1757                            p, d6, d5, d4, d3, d2, d1, data));
1758                     FSHOW((stderr, "/MOV reg32,0x%.8x\n", data));
1759                 }
1760                 /* the case of LEA reg32,m32 */
1761                 if (d2 == 0x8d) {
1762                     fixup_found = 1;
1763                     FSHOW((stderr,
1764                            "abs const ref @%x: %.2x %.2x %.2x %.2x %.2x %.2x (%.8x)\n",
1765                            p, d6, d5, d4, d3, d2, d1, data));
1766                     FSHOW((stderr, "/LEA reg32,0x%.8x\n", data));
1767                 }
1768             }
1769         }
1770     }
1771
1772     /* If anything was found, print some information on the code
1773      * object. */
1774     if (fixup_found) {
1775         FSHOW((stderr,
1776                "/compiled code object at %x: header words = %d, code words = %d\n",
1777                code, nheader_words, ncode_words));
1778         FSHOW((stderr,
1779                "/const start = %x, end = %x\n",
1780                constants_start_addr, constants_end_addr));
1781         FSHOW((stderr,
1782                "/code start = %x, end = %x\n",
1783                code_start_addr, code_end_addr));
1784     }
1785 #endif
1786 }
1787
1788 void
1789 gencgc_apply_code_fixups(struct code *old_code, struct code *new_code)
1790 {
1791 /* x86-64 uses pc-relative addressing instead of this kludge */
1792 #ifndef LISP_FEATURE_X86_64
1793     long nheader_words, ncode_words, nwords;
1794     os_vm_address_t constants_start_addr, constants_end_addr;
1795     os_vm_address_t code_start_addr, code_end_addr;
1796     os_vm_address_t code_addr = (os_vm_address_t)new_code;
1797     os_vm_address_t old_addr = (os_vm_address_t)old_code;
1798     os_vm_size_t displacement = code_addr - old_addr;
1799     lispobj fixups = NIL;
1800     struct vector *fixups_vector;
1801
1802     ncode_words = fixnum_value(new_code->code_size);
1803     nheader_words = HeaderValue(*(lispobj *)new_code);
1804     nwords = ncode_words + nheader_words;
1805     /* FSHOW((stderr,
1806              "/compiled code object at %x: header words = %d, code words = %d\n",
1807              new_code, nheader_words, ncode_words)); */
1808     constants_start_addr = code_addr + 5*N_WORD_BYTES;
1809     constants_end_addr = code_addr + nheader_words*N_WORD_BYTES;
1810     code_start_addr = code_addr + nheader_words*N_WORD_BYTES;
1811     code_end_addr = code_addr + nwords*N_WORD_BYTES;
1812     /*
1813     FSHOW((stderr,
1814            "/const start = %x, end = %x\n",
1815            constants_start_addr,constants_end_addr));
1816     FSHOW((stderr,
1817            "/code start = %x; end = %x\n",
1818            code_start_addr,code_end_addr));
1819     */
1820
1821     /* The first constant should be a pointer to the fixups for this
1822        code objects. Check. */
1823     fixups = new_code->constants[0];
1824
1825     /* It will be 0 or the unbound-marker if there are no fixups (as
1826      * will be the case if the code object has been purified, for
1827      * example) and will be an other pointer if it is valid. */
1828     if ((fixups == 0) || (fixups == UNBOUND_MARKER_WIDETAG) ||
1829         !is_lisp_pointer(fixups)) {
1830         /* Check for possible errors. */
1831         if (check_code_fixups)
1832             sniff_code_object(new_code, displacement);
1833
1834         return;
1835     }
1836
1837     fixups_vector = (struct vector *)native_pointer(fixups);
1838
1839     /* Could be pointing to a forwarding pointer. */
1840     /* FIXME is this always in from_space?  if so, could replace this code with
1841      * forwarding_pointer_p/forwarding_pointer_value */
1842     if (is_lisp_pointer(fixups) &&
1843         (find_page_index((void*)fixups_vector) != -1) &&
1844         (fixups_vector->header == 0x01)) {
1845         /* If so, then follow it. */
1846         /*SHOW("following pointer to a forwarding pointer");*/
1847         fixups_vector =
1848             (struct vector *)native_pointer((lispobj)fixups_vector->length);
1849     }
1850
1851     /*SHOW("got fixups");*/
1852
1853     if (widetag_of(fixups_vector->header) == SIMPLE_ARRAY_WORD_WIDETAG) {
1854         /* Got the fixups for the code block. Now work through the vector,
1855            and apply a fixup at each address. */
1856         long length = fixnum_value(fixups_vector->length);
1857         long i;
1858         for (i = 0; i < length; i++) {
1859             long offset = fixups_vector->data[i];
1860             /* Now check the current value of offset. */
1861             os_vm_address_t old_value = *(os_vm_address_t *)(code_start_addr + offset);
1862
1863             /* If it's within the old_code object then it must be an
1864              * absolute fixup (relative ones are not saved) */
1865             if ((old_value >= old_addr)
1866                 && (old_value < (old_addr + nwords*N_WORD_BYTES)))
1867                 /* So add the dispacement. */
1868                 *(os_vm_address_t *)(code_start_addr + offset) =
1869                     old_value + displacement;
1870             else
1871                 /* It is outside the old code object so it must be a
1872                  * relative fixup (absolute fixups are not saved). So
1873                  * subtract the displacement. */
1874                 *(os_vm_address_t *)(code_start_addr + offset) =
1875                     old_value - displacement;
1876         }
1877     } else {
1878         /* This used to just print a note to stderr, but a bogus fixup seems to
1879          * indicate real heap corruption, so a hard hailure is in order. */
1880         lose("fixup vector %p has a bad widetag: %d\n",
1881              fixups_vector, widetag_of(fixups_vector->header));
1882     }
1883
1884     /* Check for possible errors. */
1885     if (check_code_fixups) {
1886         sniff_code_object(new_code,displacement);
1887     }
1888 #endif
1889 }
1890
1891
1892 static lispobj
1893 trans_boxed_large(lispobj object)
1894 {
1895     lispobj header;
1896     unsigned long length;
1897
1898     gc_assert(is_lisp_pointer(object));
1899
1900     header = *((lispobj *) native_pointer(object));
1901     length = HeaderValue(header) + 1;
1902     length = CEILING(length, 2);
1903
1904     return copy_large_object(object, length);
1905 }
1906
1907 /* Doesn't seem to be used, delete it after the grace period. */
1908 #if 0
1909 static lispobj
1910 trans_unboxed_large(lispobj object)
1911 {
1912     lispobj header;
1913     unsigned long length;
1914
1915     gc_assert(is_lisp_pointer(object));
1916
1917     header = *((lispobj *) native_pointer(object));
1918     length = HeaderValue(header) + 1;
1919     length = CEILING(length, 2);
1920
1921     return copy_large_unboxed_object(object, length);
1922 }
1923 #endif
1924 \f
1925 /*
1926  * weak pointers
1927  */
1928
1929 /* XX This is a hack adapted from cgc.c. These don't work too
1930  * efficiently with the gencgc as a list of the weak pointers is
1931  * maintained within the objects which causes writes to the pages. A
1932  * limited attempt is made to avoid unnecessary writes, but this needs
1933  * a re-think. */
1934 #define WEAK_POINTER_NWORDS \
1935     CEILING((sizeof(struct weak_pointer) / sizeof(lispobj)), 2)
1936
1937 static long
1938 scav_weak_pointer(lispobj *where, lispobj object)
1939 {
1940     /* Since we overwrite the 'next' field, we have to make
1941      * sure not to do so for pointers already in the list.
1942      * Instead of searching the list of weak_pointers each
1943      * time, we ensure that next is always NULL when the weak
1944      * pointer isn't in the list, and not NULL otherwise.
1945      * Since we can't use NULL to denote end of list, we
1946      * use a pointer back to the same weak_pointer.
1947      */
1948     struct weak_pointer * wp = (struct weak_pointer*)where;
1949
1950     if (NULL == wp->next) {
1951         wp->next = weak_pointers;
1952         weak_pointers = wp;
1953         if (NULL == wp->next)
1954             wp->next = wp;
1955     }
1956
1957     /* Do not let GC scavenge the value slot of the weak pointer.
1958      * (That is why it is a weak pointer.) */
1959
1960     return WEAK_POINTER_NWORDS;
1961 }
1962
1963 \f
1964 lispobj *
1965 search_read_only_space(void *pointer)
1966 {
1967     lispobj *start = (lispobj *) READ_ONLY_SPACE_START;
1968     lispobj *end = (lispobj *) SymbolValue(READ_ONLY_SPACE_FREE_POINTER,0);
1969     if ((pointer < (void *)start) || (pointer >= (void *)end))
1970         return NULL;
1971     return (gc_search_space(start,
1972                             (((lispobj *)pointer)+2)-start,
1973                             (lispobj *) pointer));
1974 }
1975
1976 lispobj *
1977 search_static_space(void *pointer)
1978 {
1979     lispobj *start = (lispobj *)STATIC_SPACE_START;
1980     lispobj *end = (lispobj *)SymbolValue(STATIC_SPACE_FREE_POINTER,0);
1981     if ((pointer < (void *)start) || (pointer >= (void *)end))
1982         return NULL;
1983     return (gc_search_space(start,
1984                             (((lispobj *)pointer)+2)-start,
1985                             (lispobj *) pointer));
1986 }
1987
1988 /* a faster version for searching the dynamic space. This will work even
1989  * if the object is in a current allocation region. */
1990 lispobj *
1991 search_dynamic_space(void *pointer)
1992 {
1993     page_index_t page_index = find_page_index(pointer);
1994     lispobj *start;
1995
1996     /* The address may be invalid, so do some checks. */
1997     if ((page_index == -1) || page_free_p(page_index))
1998         return NULL;
1999     start = (lispobj *)page_region_start(page_index);
2000     return (gc_search_space(start,
2001                             (((lispobj *)pointer)+2)-start,
2002                             (lispobj *)pointer));
2003 }
2004
2005 #if defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
2006
2007 /* Is there any possibility that pointer is a valid Lisp object
2008  * reference, and/or something else (e.g. subroutine call return
2009  * address) which should prevent us from moving the referred-to thing?
2010  * This is called from preserve_pointers() */
2011 static int
2012 possibly_valid_dynamic_space_pointer(lispobj *pointer)
2013 {
2014     lispobj *start_addr;
2015
2016     /* Find the object start address. */
2017     if ((start_addr = search_dynamic_space(pointer)) == NULL) {
2018         return 0;
2019     }
2020
2021     return looks_like_valid_lisp_pointer_p(pointer, start_addr);
2022 }
2023
2024 #endif  // defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
2025
2026 /* Adjust large bignum and vector objects. This will adjust the
2027  * allocated region if the size has shrunk, and move unboxed objects
2028  * into unboxed pages. The pages are not promoted here, and the
2029  * promoted region is not added to the new_regions; this is really
2030  * only designed to be called from preserve_pointer(). Shouldn't fail
2031  * if this is missed, just may delay the moving of objects to unboxed
2032  * pages, and the freeing of pages. */
2033 static void
2034 maybe_adjust_large_object(lispobj *where)
2035 {
2036     page_index_t first_page;
2037     page_index_t next_page;
2038     long nwords;
2039
2040     unsigned long remaining_bytes;
2041     unsigned long bytes_freed;
2042     unsigned long old_bytes_used;
2043
2044     int boxed;
2045
2046     /* Check whether it's a vector or bignum object. */
2047     switch (widetag_of(where[0])) {
2048     case SIMPLE_VECTOR_WIDETAG:
2049         boxed = BOXED_PAGE_FLAG;
2050         break;
2051     case BIGNUM_WIDETAG:
2052     case SIMPLE_BASE_STRING_WIDETAG:
2053 #ifdef SIMPLE_CHARACTER_STRING_WIDETAG
2054     case SIMPLE_CHARACTER_STRING_WIDETAG:
2055 #endif
2056     case SIMPLE_BIT_VECTOR_WIDETAG:
2057     case SIMPLE_ARRAY_NIL_WIDETAG:
2058     case SIMPLE_ARRAY_UNSIGNED_BYTE_2_WIDETAG:
2059     case SIMPLE_ARRAY_UNSIGNED_BYTE_4_WIDETAG:
2060     case SIMPLE_ARRAY_UNSIGNED_BYTE_7_WIDETAG:
2061     case SIMPLE_ARRAY_UNSIGNED_BYTE_8_WIDETAG:
2062     case SIMPLE_ARRAY_UNSIGNED_BYTE_15_WIDETAG:
2063     case SIMPLE_ARRAY_UNSIGNED_BYTE_16_WIDETAG:
2064
2065     case SIMPLE_ARRAY_UNSIGNED_FIXNUM_WIDETAG:
2066
2067     case SIMPLE_ARRAY_UNSIGNED_BYTE_31_WIDETAG:
2068     case SIMPLE_ARRAY_UNSIGNED_BYTE_32_WIDETAG:
2069 #ifdef SIMPLE_ARRAY_UNSIGNED_BYTE_63_WIDETAG
2070     case SIMPLE_ARRAY_UNSIGNED_BYTE_63_WIDETAG:
2071 #endif
2072 #ifdef SIMPLE_ARRAY_UNSIGNED_BYTE_64_WIDETAG
2073     case SIMPLE_ARRAY_UNSIGNED_BYTE_64_WIDETAG:
2074 #endif
2075 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG
2076     case SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG:
2077 #endif
2078 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG
2079     case SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG:
2080 #endif
2081
2082     case SIMPLE_ARRAY_FIXNUM_WIDETAG:
2083
2084 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG
2085     case SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG:
2086 #endif
2087 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_64_WIDETAG
2088     case SIMPLE_ARRAY_SIGNED_BYTE_64_WIDETAG:
2089 #endif
2090     case SIMPLE_ARRAY_SINGLE_FLOAT_WIDETAG:
2091     case SIMPLE_ARRAY_DOUBLE_FLOAT_WIDETAG:
2092 #ifdef SIMPLE_ARRAY_LONG_FLOAT_WIDETAG
2093     case SIMPLE_ARRAY_LONG_FLOAT_WIDETAG:
2094 #endif
2095 #ifdef SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG
2096     case SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG:
2097 #endif
2098 #ifdef SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG
2099     case SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG:
2100 #endif
2101 #ifdef SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG
2102     case SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG:
2103 #endif
2104         boxed = UNBOXED_PAGE_FLAG;
2105         break;
2106     default:
2107         return;
2108     }
2109
2110     /* Find its current size. */
2111     nwords = (sizetab[widetag_of(where[0])])(where);
2112
2113     first_page = find_page_index((void *)where);
2114     gc_assert(first_page >= 0);
2115
2116     /* Note: Any page write-protection must be removed, else a later
2117      * scavenge_newspace may incorrectly not scavenge these pages.
2118      * This would not be necessary if they are added to the new areas,
2119      * but lets do it for them all (they'll probably be written
2120      * anyway?). */
2121
2122     gc_assert(page_table[first_page].region_start_offset == 0);
2123
2124     next_page = first_page;
2125     remaining_bytes = nwords*N_WORD_BYTES;
2126     while (remaining_bytes > GENCGC_CARD_BYTES) {
2127         gc_assert(page_table[next_page].gen == from_space);
2128         gc_assert(page_allocated_no_region_p(next_page));
2129         gc_assert(page_table[next_page].large_object);
2130         gc_assert(page_table[next_page].region_start_offset ==
2131                   npage_bytes(next_page-first_page));
2132         gc_assert(page_table[next_page].bytes_used == GENCGC_CARD_BYTES);
2133
2134         page_table[next_page].allocated = boxed;
2135
2136         /* Shouldn't be write-protected at this stage. Essential that the
2137          * pages aren't. */
2138         gc_assert(!page_table[next_page].write_protected);
2139         remaining_bytes -= GENCGC_CARD_BYTES;
2140         next_page++;
2141     }
2142
2143     /* Now only one page remains, but the object may have shrunk so
2144      * there may be more unused pages which will be freed. */
2145
2146     /* Object may have shrunk but shouldn't have grown - check. */
2147     gc_assert(page_table[next_page].bytes_used >= remaining_bytes);
2148
2149     page_table[next_page].allocated = boxed;
2150     gc_assert(page_table[next_page].allocated ==
2151               page_table[first_page].allocated);
2152
2153     /* Adjust the bytes_used. */
2154     old_bytes_used = page_table[next_page].bytes_used;
2155     page_table[next_page].bytes_used = remaining_bytes;
2156
2157     bytes_freed = old_bytes_used - remaining_bytes;
2158
2159     /* Free any remaining pages; needs care. */
2160     next_page++;
2161     while ((old_bytes_used == GENCGC_CARD_BYTES) &&
2162            (page_table[next_page].gen == from_space) &&
2163            page_allocated_no_region_p(next_page) &&
2164            page_table[next_page].large_object &&
2165            (page_table[next_page].region_start_offset ==
2166             npage_bytes(next_page - first_page))) {
2167         /* It checks out OK, free the page. We don't need to both zeroing
2168          * pages as this should have been done before shrinking the
2169          * object. These pages shouldn't be write protected as they
2170          * should be zero filled. */
2171         gc_assert(page_table[next_page].write_protected == 0);
2172
2173         old_bytes_used = page_table[next_page].bytes_used;
2174         page_table[next_page].allocated = FREE_PAGE_FLAG;
2175         page_table[next_page].bytes_used = 0;
2176         bytes_freed += old_bytes_used;
2177         next_page++;
2178     }
2179
2180     if ((bytes_freed > 0) && gencgc_verbose) {
2181         FSHOW((stderr,
2182                "/maybe_adjust_large_object() freed %d\n",
2183                bytes_freed));
2184     }
2185
2186     generations[from_space].bytes_allocated -= bytes_freed;
2187     bytes_allocated -= bytes_freed;
2188
2189     return;
2190 }
2191
2192 /* Take a possible pointer to a Lisp object and mark its page in the
2193  * page_table so that it will not be relocated during a GC.
2194  *
2195  * This involves locating the page it points to, then backing up to
2196  * the start of its region, then marking all pages dont_move from there
2197  * up to the first page that's not full or has a different generation
2198  *
2199  * It is assumed that all the page static flags have been cleared at
2200  * the start of a GC.
2201  *
2202  * It is also assumed that the current gc_alloc() region has been
2203  * flushed and the tables updated. */
2204
2205 static void
2206 preserve_pointer(void *addr)
2207 {
2208     page_index_t addr_page_index = find_page_index(addr);
2209     page_index_t first_page;
2210     page_index_t i;
2211     unsigned int region_allocation;
2212
2213     /* quick check 1: Address is quite likely to have been invalid. */
2214     if ((addr_page_index == -1)
2215         || page_free_p(addr_page_index)
2216         || (page_table[addr_page_index].bytes_used == 0)
2217         || (page_table[addr_page_index].gen != from_space)
2218         /* Skip if already marked dont_move. */
2219         || (page_table[addr_page_index].dont_move != 0))
2220         return;
2221     gc_assert(!(page_table[addr_page_index].allocated&OPEN_REGION_PAGE_FLAG));
2222     /* (Now that we know that addr_page_index is in range, it's
2223      * safe to index into page_table[] with it.) */
2224     region_allocation = page_table[addr_page_index].allocated;
2225
2226     /* quick check 2: Check the offset within the page.
2227      *
2228      */
2229     if (((unsigned long)addr & (GENCGC_CARD_BYTES - 1)) >
2230         page_table[addr_page_index].bytes_used)
2231         return;
2232
2233     /* Filter out anything which can't be a pointer to a Lisp object
2234      * (or, as a special case which also requires dont_move, a return
2235      * address referring to something in a CodeObject). This is
2236      * expensive but important, since it vastly reduces the
2237      * probability that random garbage will be bogusly interpreted as
2238      * a pointer which prevents a page from moving.
2239      *
2240      * This only needs to happen on x86oids, where this is used for
2241      * conservative roots.  Non-x86oid systems only ever call this
2242      * function on known-valid lisp objects. */
2243 #if defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
2244     if (!(code_page_p(addr_page_index)
2245           || (is_lisp_pointer((lispobj)addr) &&
2246               possibly_valid_dynamic_space_pointer(addr))))
2247         return;
2248 #endif
2249
2250     /* Find the beginning of the region.  Note that there may be
2251      * objects in the region preceding the one that we were passed a
2252      * pointer to: if this is the case, we will write-protect all the
2253      * previous objects' pages too.     */
2254
2255 #if 0
2256     /* I think this'd work just as well, but without the assertions.
2257      * -dan 2004.01.01 */
2258     first_page = find_page_index(page_region_start(addr_page_index))
2259 #else
2260     first_page = addr_page_index;
2261     while (page_table[first_page].region_start_offset != 0) {
2262         --first_page;
2263         /* Do some checks. */
2264         gc_assert(page_table[first_page].bytes_used == GENCGC_CARD_BYTES);
2265         gc_assert(page_table[first_page].gen == from_space);
2266         gc_assert(page_table[first_page].allocated == region_allocation);
2267     }
2268 #endif
2269
2270     /* Adjust any large objects before promotion as they won't be
2271      * copied after promotion. */
2272     if (page_table[first_page].large_object) {
2273         maybe_adjust_large_object(page_address(first_page));
2274         /* If a large object has shrunk then addr may now point to a
2275          * free area in which case it's ignored here. Note it gets
2276          * through the valid pointer test above because the tail looks
2277          * like conses. */
2278         if (page_free_p(addr_page_index)
2279             || (page_table[addr_page_index].bytes_used == 0)
2280             /* Check the offset within the page. */
2281             || (((unsigned long)addr & (GENCGC_CARD_BYTES - 1))
2282                 > page_table[addr_page_index].bytes_used)) {
2283             FSHOW((stderr,
2284                    "weird? ignore ptr 0x%x to freed area of large object\n",
2285                    addr));
2286             return;
2287         }
2288         /* It may have moved to unboxed pages. */
2289         region_allocation = page_table[first_page].allocated;
2290     }
2291
2292     /* Now work forward until the end of this contiguous area is found,
2293      * marking all pages as dont_move. */
2294     for (i = first_page; ;i++) {
2295         gc_assert(page_table[i].allocated == region_allocation);
2296
2297         /* Mark the page static. */
2298         page_table[i].dont_move = 1;
2299
2300         /* Move the page to the new_space. XX I'd rather not do this
2301          * but the GC logic is not quite able to copy with the static
2302          * pages remaining in the from space. This also requires the
2303          * generation bytes_allocated counters be updated. */
2304         page_table[i].gen = new_space;
2305         generations[new_space].bytes_allocated += page_table[i].bytes_used;
2306         generations[from_space].bytes_allocated -= page_table[i].bytes_used;
2307
2308         /* It is essential that the pages are not write protected as
2309          * they may have pointers into the old-space which need
2310          * scavenging. They shouldn't be write protected at this
2311          * stage. */
2312         gc_assert(!page_table[i].write_protected);
2313
2314         /* Check whether this is the last page in this contiguous block.. */
2315         if ((page_table[i].bytes_used < GENCGC_CARD_BYTES)
2316             /* ..or it is CARD_BYTES and is the last in the block */
2317             || page_free_p(i+1)
2318             || (page_table[i+1].bytes_used == 0) /* next page free */
2319             || (page_table[i+1].gen != from_space) /* diff. gen */
2320             || (page_table[i+1].region_start_offset == 0))
2321             break;
2322     }
2323
2324     /* Check that the page is now static. */
2325     gc_assert(page_table[addr_page_index].dont_move != 0);
2326 }
2327 \f
2328 /* If the given page is not write-protected, then scan it for pointers
2329  * to younger generations or the top temp. generation, if no
2330  * suspicious pointers are found then the page is write-protected.
2331  *
2332  * Care is taken to check for pointers to the current gc_alloc()
2333  * region if it is a younger generation or the temp. generation. This
2334  * frees the caller from doing a gc_alloc_update_page_tables(). Actually
2335  * the gc_alloc_generation does not need to be checked as this is only
2336  * called from scavenge_generation() when the gc_alloc generation is
2337  * younger, so it just checks if there is a pointer to the current
2338  * region.
2339  *
2340  * We return 1 if the page was write-protected, else 0. */
2341 static int
2342 update_page_write_prot(page_index_t page)
2343 {
2344     generation_index_t gen = page_table[page].gen;
2345     long j;
2346     int wp_it = 1;
2347     void **page_addr = (void **)page_address(page);
2348     long num_words = page_table[page].bytes_used / N_WORD_BYTES;
2349
2350     /* Shouldn't be a free page. */
2351     gc_assert(page_allocated_p(page));
2352     gc_assert(page_table[page].bytes_used != 0);
2353
2354     /* Skip if it's already write-protected, pinned, or unboxed */
2355     if (page_table[page].write_protected
2356         /* FIXME: What's the reason for not write-protecting pinned pages? */
2357         || page_table[page].dont_move
2358         || page_unboxed_p(page))
2359         return (0);
2360
2361     /* Scan the page for pointers to younger generations or the
2362      * top temp. generation. */
2363
2364     for (j = 0; j < num_words; j++) {
2365         void *ptr = *(page_addr+j);
2366         page_index_t index = find_page_index(ptr);
2367
2368         /* Check that it's in the dynamic space */
2369         if (index != -1)
2370             if (/* Does it point to a younger or the temp. generation? */
2371                 (page_allocated_p(index)
2372                  && (page_table[index].bytes_used != 0)
2373                  && ((page_table[index].gen < gen)
2374                      || (page_table[index].gen == SCRATCH_GENERATION)))
2375
2376                 /* Or does it point within a current gc_alloc() region? */
2377                 || ((boxed_region.start_addr <= ptr)
2378                     && (ptr <= boxed_region.free_pointer))
2379                 || ((unboxed_region.start_addr <= ptr)
2380                     && (ptr <= unboxed_region.free_pointer))) {
2381                 wp_it = 0;
2382                 break;
2383             }
2384     }
2385
2386     if (wp_it == 1) {
2387         /* Write-protect the page. */
2388         /*FSHOW((stderr, "/write-protecting page %d gen %d\n", page, gen));*/
2389
2390         os_protect((void *)page_addr,
2391                    GENCGC_CARD_BYTES,
2392                    OS_VM_PROT_READ|OS_VM_PROT_EXECUTE);
2393
2394         /* Note the page as protected in the page tables. */
2395         page_table[page].write_protected = 1;
2396     }
2397
2398     return (wp_it);
2399 }
2400
2401 /* Scavenge all generations from FROM to TO, inclusive, except for
2402  * new_space which needs special handling, as new objects may be
2403  * added which are not checked here - use scavenge_newspace generation.
2404  *
2405  * Write-protected pages should not have any pointers to the
2406  * from_space so do need scavenging; thus write-protected pages are
2407  * not always scavenged. There is some code to check that these pages
2408  * are not written; but to check fully the write-protected pages need
2409  * to be scavenged by disabling the code to skip them.
2410  *
2411  * Under the current scheme when a generation is GCed the younger
2412  * generations will be empty. So, when a generation is being GCed it
2413  * is only necessary to scavenge the older generations for pointers
2414  * not the younger. So a page that does not have pointers to younger
2415  * generations does not need to be scavenged.
2416  *
2417  * The write-protection can be used to note pages that don't have
2418  * pointers to younger pages. But pages can be written without having
2419  * pointers to younger generations. After the pages are scavenged here
2420  * they can be scanned for pointers to younger generations and if
2421  * there are none the page can be write-protected.
2422  *
2423  * One complication is when the newspace is the top temp. generation.
2424  *
2425  * Enabling SC_GEN_CK scavenges the write-protected pages and checks
2426  * that none were written, which they shouldn't be as they should have
2427  * no pointers to younger generations. This breaks down for weak
2428  * pointers as the objects contain a link to the next and are written
2429  * if a weak pointer is scavenged. Still it's a useful check. */
2430 static void
2431 scavenge_generations(generation_index_t from, generation_index_t to)
2432 {
2433     page_index_t i;
2434     page_index_t num_wp = 0;
2435
2436 #define SC_GEN_CK 0
2437 #if SC_GEN_CK
2438     /* Clear the write_protected_cleared flags on all pages. */
2439     for (i = 0; i < page_table_pages; i++)
2440         page_table[i].write_protected_cleared = 0;
2441 #endif
2442
2443     for (i = 0; i < last_free_page; i++) {
2444         generation_index_t generation = page_table[i].gen;
2445         if (page_boxed_p(i)
2446             && (page_table[i].bytes_used != 0)
2447             && (generation != new_space)
2448             && (generation >= from)
2449             && (generation <= to)) {
2450             page_index_t last_page,j;
2451             int write_protected=1;
2452
2453             /* This should be the start of a region */
2454             gc_assert(page_table[i].region_start_offset == 0);
2455
2456             /* Now work forward until the end of the region */
2457             for (last_page = i; ; last_page++) {
2458                 write_protected =
2459                     write_protected && page_table[last_page].write_protected;
2460                 if ((page_table[last_page].bytes_used < GENCGC_CARD_BYTES)
2461                     /* Or it is CARD_BYTES and is the last in the block */
2462                     || (!page_boxed_p(last_page+1))
2463                     || (page_table[last_page+1].bytes_used == 0)
2464                     || (page_table[last_page+1].gen != generation)
2465                     || (page_table[last_page+1].region_start_offset == 0))
2466                     break;
2467             }
2468             if (!write_protected) {
2469                 scavenge(page_address(i),
2470                          ((unsigned long)(page_table[last_page].bytes_used
2471                                           + npage_bytes(last_page-i)))
2472                          /N_WORD_BYTES);
2473
2474                 /* Now scan the pages and write protect those that
2475                  * don't have pointers to younger generations. */
2476                 if (enable_page_protection) {
2477                     for (j = i; j <= last_page; j++) {
2478                         num_wp += update_page_write_prot(j);
2479                     }
2480                 }
2481                 if ((gencgc_verbose > 1) && (num_wp != 0)) {
2482                     FSHOW((stderr,
2483                            "/write protected %d pages within generation %d\n",
2484                            num_wp, generation));
2485                 }
2486             }
2487             i = last_page;
2488         }
2489     }
2490
2491 #if SC_GEN_CK
2492     /* Check that none of the write_protected pages in this generation
2493      * have been written to. */
2494     for (i = 0; i < page_table_pages; i++) {
2495         if (page_allocated_p(i)
2496             && (page_table[i].bytes_used != 0)
2497             && (page_table[i].gen == generation)
2498             && (page_table[i].write_protected_cleared != 0)) {
2499             FSHOW((stderr, "/scavenge_generation() %d\n", generation));
2500             FSHOW((stderr,
2501                    "/page bytes_used=%d region_start_offset=%lu dont_move=%d\n",
2502                     page_table[i].bytes_used,
2503                     page_table[i].region_start_offset,
2504                     page_table[i].dont_move));
2505             lose("write to protected page %d in scavenge_generation()\n", i);
2506         }
2507     }
2508 #endif
2509 }
2510
2511 \f
2512 /* Scavenge a newspace generation. As it is scavenged new objects may
2513  * be allocated to it; these will also need to be scavenged. This
2514  * repeats until there are no more objects unscavenged in the
2515  * newspace generation.
2516  *
2517  * To help improve the efficiency, areas written are recorded by
2518  * gc_alloc() and only these scavenged. Sometimes a little more will be
2519  * scavenged, but this causes no harm. An easy check is done that the
2520  * scavenged bytes equals the number allocated in the previous
2521  * scavenge.
2522  *
2523  * Write-protected pages are not scanned except if they are marked
2524  * dont_move in which case they may have been promoted and still have
2525  * pointers to the from space.
2526  *
2527  * Write-protected pages could potentially be written by alloc however
2528  * to avoid having to handle re-scavenging of write-protected pages
2529  * gc_alloc() does not write to write-protected pages.
2530  *
2531  * New areas of objects allocated are recorded alternatively in the two
2532  * new_areas arrays below. */
2533 static struct new_area new_areas_1[NUM_NEW_AREAS];
2534 static struct new_area new_areas_2[NUM_NEW_AREAS];
2535
2536 /* Do one full scan of the new space generation. This is not enough to
2537  * complete the job as new objects may be added to the generation in
2538  * the process which are not scavenged. */
2539 static void
2540 scavenge_newspace_generation_one_scan(generation_index_t generation)
2541 {
2542     page_index_t i;
2543
2544     FSHOW((stderr,
2545            "/starting one full scan of newspace generation %d\n",
2546            generation));
2547     for (i = 0; i < last_free_page; i++) {
2548         /* Note that this skips over open regions when it encounters them. */
2549         if (page_boxed_p(i)
2550             && (page_table[i].bytes_used != 0)
2551             && (page_table[i].gen == generation)
2552             && ((page_table[i].write_protected == 0)
2553                 /* (This may be redundant as write_protected is now
2554                  * cleared before promotion.) */
2555                 || (page_table[i].dont_move == 1))) {
2556             page_index_t last_page;
2557             int all_wp=1;
2558
2559             /* The scavenge will start at the region_start_offset of
2560              * page i.
2561              *
2562              * We need to find the full extent of this contiguous
2563              * block in case objects span pages.
2564              *
2565              * Now work forward until the end of this contiguous area
2566              * is found. A small area is preferred as there is a
2567              * better chance of its pages being write-protected. */
2568             for (last_page = i; ;last_page++) {
2569                 /* If all pages are write-protected and movable,
2570                  * then no need to scavenge */
2571                 all_wp=all_wp && page_table[last_page].write_protected &&
2572                     !page_table[last_page].dont_move;
2573
2574                 /* Check whether this is the last page in this
2575                  * contiguous block */
2576                 if ((page_table[last_page].bytes_used < GENCGC_CARD_BYTES)
2577                     /* Or it is CARD_BYTES and is the last in the block */
2578                     || (!page_boxed_p(last_page+1))
2579                     || (page_table[last_page+1].bytes_used == 0)
2580                     || (page_table[last_page+1].gen != generation)
2581                     || (page_table[last_page+1].region_start_offset == 0))
2582                     break;
2583             }
2584
2585             /* Do a limited check for write-protected pages.  */
2586             if (!all_wp) {
2587                 long nwords = (((unsigned long)
2588                                (page_table[last_page].bytes_used
2589                                 + npage_bytes(last_page-i)
2590                                 + page_table[i].region_start_offset))
2591                                / N_WORD_BYTES);
2592                 new_areas_ignore_page = last_page;
2593
2594                 scavenge(page_region_start(i), nwords);
2595
2596             }
2597             i = last_page;
2598         }
2599     }
2600     FSHOW((stderr,
2601            "/done with one full scan of newspace generation %d\n",
2602            generation));
2603 }
2604
2605 /* Do a complete scavenge of the newspace generation. */
2606 static void
2607 scavenge_newspace_generation(generation_index_t generation)
2608 {
2609     size_t i;
2610
2611     /* the new_areas array currently being written to by gc_alloc() */
2612     struct new_area (*current_new_areas)[] = &new_areas_1;
2613     size_t current_new_areas_index;
2614
2615     /* the new_areas created by the previous scavenge cycle */
2616     struct new_area (*previous_new_areas)[] = NULL;
2617     size_t previous_new_areas_index;
2618
2619     /* Flush the current regions updating the tables. */
2620     gc_alloc_update_all_page_tables();
2621
2622     /* Turn on the recording of new areas by gc_alloc(). */
2623     new_areas = current_new_areas;
2624     new_areas_index = 0;
2625
2626     /* Don't need to record new areas that get scavenged anyway during
2627      * scavenge_newspace_generation_one_scan. */
2628     record_new_objects = 1;
2629
2630     /* Start with a full scavenge. */
2631     scavenge_newspace_generation_one_scan(generation);
2632
2633     /* Record all new areas now. */
2634     record_new_objects = 2;
2635
2636     /* Give a chance to weak hash tables to make other objects live.
2637      * FIXME: The algorithm implemented here for weak hash table gcing
2638      * is O(W^2+N) as Bruno Haible warns in
2639      * http://www.haible.de/bruno/papers/cs/weak/WeakDatastructures-writeup.html
2640      * see "Implementation 2". */
2641     scav_weak_hash_tables();
2642
2643     /* Flush the current regions updating the tables. */
2644     gc_alloc_update_all_page_tables();
2645
2646     /* Grab new_areas_index. */
2647     current_new_areas_index = new_areas_index;
2648
2649     /*FSHOW((stderr,
2650              "The first scan is finished; current_new_areas_index=%d.\n",
2651              current_new_areas_index));*/
2652
2653     while (current_new_areas_index > 0) {
2654         /* Move the current to the previous new areas */
2655         previous_new_areas = current_new_areas;
2656         previous_new_areas_index = current_new_areas_index;
2657
2658         /* Scavenge all the areas in previous new areas. Any new areas
2659          * allocated are saved in current_new_areas. */
2660
2661         /* Allocate an array for current_new_areas; alternating between
2662          * new_areas_1 and 2 */
2663         if (previous_new_areas == &new_areas_1)
2664             current_new_areas = &new_areas_2;
2665         else
2666             current_new_areas = &new_areas_1;
2667
2668         /* Set up for gc_alloc(). */
2669         new_areas = current_new_areas;
2670         new_areas_index = 0;
2671
2672         /* Check whether previous_new_areas had overflowed. */
2673         if (previous_new_areas_index >= NUM_NEW_AREAS) {
2674
2675             /* New areas of objects allocated have been lost so need to do a
2676              * full scan to be sure! If this becomes a problem try
2677              * increasing NUM_NEW_AREAS. */
2678             if (gencgc_verbose) {
2679                 SHOW("new_areas overflow, doing full scavenge");
2680             }
2681
2682             /* Don't need to record new areas that get scavenged
2683              * anyway during scavenge_newspace_generation_one_scan. */
2684             record_new_objects = 1;
2685
2686             scavenge_newspace_generation_one_scan(generation);
2687
2688             /* Record all new areas now. */
2689             record_new_objects = 2;
2690
2691             scav_weak_hash_tables();
2692
2693             /* Flush the current regions updating the tables. */
2694             gc_alloc_update_all_page_tables();
2695
2696         } else {
2697
2698             /* Work through previous_new_areas. */
2699             for (i = 0; i < previous_new_areas_index; i++) {
2700                 page_index_t page = (*previous_new_areas)[i].page;
2701                 size_t offset = (*previous_new_areas)[i].offset;
2702                 size_t size = (*previous_new_areas)[i].size / N_WORD_BYTES;
2703                 gc_assert((*previous_new_areas)[i].size % N_WORD_BYTES == 0);
2704                 scavenge(page_address(page)+offset, size);
2705             }
2706
2707             scav_weak_hash_tables();
2708
2709             /* Flush the current regions updating the tables. */
2710             gc_alloc_update_all_page_tables();
2711         }
2712
2713         current_new_areas_index = new_areas_index;
2714
2715         /*FSHOW((stderr,
2716                  "The re-scan has finished; current_new_areas_index=%d.\n",
2717                  current_new_areas_index));*/
2718     }
2719
2720     /* Turn off recording of areas allocated by gc_alloc(). */
2721     record_new_objects = 0;
2722
2723 #if SC_NS_GEN_CK
2724     {
2725         page_index_t i;
2726         /* Check that none of the write_protected pages in this generation
2727          * have been written to. */
2728         for (i = 0; i < page_table_pages; i++) {
2729             if (page_allocated_p(i)
2730                 && (page_table[i].bytes_used != 0)
2731                 && (page_table[i].gen == generation)
2732                 && (page_table[i].write_protected_cleared != 0)
2733                 && (page_table[i].dont_move == 0)) {
2734                 lose("write protected page %d written to in scavenge_newspace_generation\ngeneration=%d dont_move=%d\n",
2735                      i, generation, page_table[i].dont_move);
2736             }
2737         }
2738     }
2739 #endif
2740 }
2741 \f
2742 /* Un-write-protect all the pages in from_space. This is done at the
2743  * start of a GC else there may be many page faults while scavenging
2744  * the newspace (I've seen drive the system time to 99%). These pages
2745  * would need to be unprotected anyway before unmapping in
2746  * free_oldspace; not sure what effect this has on paging.. */
2747 static void
2748 unprotect_oldspace(void)
2749 {
2750     page_index_t i;
2751     void *region_addr = 0;
2752     void *page_addr = 0;
2753     unsigned long region_bytes = 0;
2754
2755     for (i = 0; i < last_free_page; i++) {
2756         if (page_allocated_p(i)
2757             && (page_table[i].bytes_used != 0)
2758             && (page_table[i].gen == from_space)) {
2759
2760             /* Remove any write-protection. We should be able to rely
2761              * on the write-protect flag to avoid redundant calls. */
2762             if (page_table[i].write_protected) {
2763                 page_table[i].write_protected = 0;
2764                 page_addr = page_address(i);
2765                 if (!region_addr) {
2766                     /* First region. */
2767                     region_addr = page_addr;
2768                     region_bytes = GENCGC_CARD_BYTES;
2769                 } else if (region_addr + region_bytes == page_addr) {
2770                     /* Region continue. */
2771                     region_bytes += GENCGC_CARD_BYTES;
2772                 } else {
2773                     /* Unprotect previous region. */
2774                     os_protect(region_addr, region_bytes, OS_VM_PROT_ALL);
2775                     /* First page in new region. */
2776                     region_addr = page_addr;
2777                     region_bytes = GENCGC_CARD_BYTES;
2778                 }
2779             }
2780         }
2781     }
2782     if (region_addr) {
2783         /* Unprotect last region. */
2784         os_protect(region_addr, region_bytes, OS_VM_PROT_ALL);
2785     }
2786 }
2787
2788 /* Work through all the pages and free any in from_space. This
2789  * assumes that all objects have been copied or promoted to an older
2790  * generation. Bytes_allocated and the generation bytes_allocated
2791  * counter are updated. The number of bytes freed is returned. */
2792 static unsigned long
2793 free_oldspace(void)
2794 {
2795     unsigned long bytes_freed = 0;
2796     page_index_t first_page, last_page;
2797
2798     first_page = 0;
2799
2800     do {
2801         /* Find a first page for the next region of pages. */
2802         while ((first_page < last_free_page)
2803                && (page_free_p(first_page)
2804                    || (page_table[first_page].bytes_used == 0)
2805                    || (page_table[first_page].gen != from_space)))
2806             first_page++;
2807
2808         if (first_page >= last_free_page)
2809             break;
2810
2811         /* Find the last page of this region. */
2812         last_page = first_page;
2813
2814         do {
2815             /* Free the page. */
2816             bytes_freed += page_table[last_page].bytes_used;
2817             generations[page_table[last_page].gen].bytes_allocated -=
2818                 page_table[last_page].bytes_used;
2819             page_table[last_page].allocated = FREE_PAGE_FLAG;
2820             page_table[last_page].bytes_used = 0;
2821             /* Should already be unprotected by unprotect_oldspace(). */
2822             gc_assert(!page_table[last_page].write_protected);
2823             last_page++;
2824         }
2825         while ((last_page < last_free_page)
2826                && page_allocated_p(last_page)
2827                && (page_table[last_page].bytes_used != 0)
2828                && (page_table[last_page].gen == from_space));
2829
2830 #ifdef READ_PROTECT_FREE_PAGES
2831         os_protect(page_address(first_page),
2832                    npage_bytes(last_page-first_page),
2833                    OS_VM_PROT_NONE);
2834 #endif
2835         first_page = last_page;
2836     } while (first_page < last_free_page);
2837
2838     bytes_allocated -= bytes_freed;
2839     return bytes_freed;
2840 }
2841 \f
2842 #if 0
2843 /* Print some information about a pointer at the given address. */
2844 static void
2845 print_ptr(lispobj *addr)
2846 {
2847     /* If addr is in the dynamic space then out the page information. */
2848     page_index_t pi1 = find_page_index((void*)addr);
2849
2850     if (pi1 != -1)
2851         fprintf(stderr,"  %p: page %d  alloc %d  gen %d  bytes_used %d  offset %lu  dont_move %d\n",
2852                 addr,
2853                 pi1,
2854                 page_table[pi1].allocated,
2855                 page_table[pi1].gen,
2856                 page_table[pi1].bytes_used,
2857                 page_table[pi1].region_start_offset,
2858                 page_table[pi1].dont_move);
2859     fprintf(stderr,"  %x %x %x %x (%x) %x %x %x %x\n",
2860             *(addr-4),
2861             *(addr-3),
2862             *(addr-2),
2863             *(addr-1),
2864             *(addr-0),
2865             *(addr+1),
2866             *(addr+2),
2867             *(addr+3),
2868             *(addr+4));
2869 }
2870 #endif
2871
2872 static int
2873 is_in_stack_space(lispobj ptr)
2874 {
2875     /* For space verification: Pointers can be valid if they point
2876      * to a thread stack space.  This would be faster if the thread
2877      * structures had page-table entries as if they were part of
2878      * the heap space. */
2879     struct thread *th;
2880     for_each_thread(th) {
2881         if ((th->control_stack_start <= (lispobj *)ptr) &&
2882             (th->control_stack_end >= (lispobj *)ptr)) {
2883             return 1;
2884         }
2885     }
2886     return 0;
2887 }
2888
2889 static void
2890 verify_space(lispobj *start, size_t words)
2891 {
2892     int is_in_dynamic_space = (find_page_index((void*)start) != -1);
2893     int is_in_readonly_space =
2894         (READ_ONLY_SPACE_START <= (unsigned long)start &&
2895          (unsigned long)start < SymbolValue(READ_ONLY_SPACE_FREE_POINTER,0));
2896
2897     while (words > 0) {
2898         size_t count = 1;
2899         lispobj thing = *(lispobj*)start;
2900
2901         if (is_lisp_pointer(thing)) {
2902             page_index_t page_index = find_page_index((void*)thing);
2903             long to_readonly_space =
2904                 (READ_ONLY_SPACE_START <= thing &&
2905                  thing < SymbolValue(READ_ONLY_SPACE_FREE_POINTER,0));
2906             long to_static_space =
2907                 (STATIC_SPACE_START <= thing &&
2908                  thing < SymbolValue(STATIC_SPACE_FREE_POINTER,0));
2909
2910             /* Does it point to the dynamic space? */
2911             if (page_index != -1) {
2912                 /* If it's within the dynamic space it should point to a used
2913                  * page. XX Could check the offset too. */
2914                 if (page_allocated_p(page_index)
2915                     && (page_table[page_index].bytes_used == 0))
2916                     lose ("Ptr %p @ %p sees free page.\n", thing, start);
2917                 /* Check that it doesn't point to a forwarding pointer! */
2918                 if (*((lispobj *)native_pointer(thing)) == 0x01) {
2919                     lose("Ptr %p @ %p sees forwarding ptr.\n", thing, start);
2920                 }
2921                 /* Check that its not in the RO space as it would then be a
2922                  * pointer from the RO to the dynamic space. */
2923                 if (is_in_readonly_space) {
2924                     lose("ptr to dynamic space %p from RO space %x\n",
2925                          thing, start);
2926                 }
2927                 /* Does it point to a plausible object? This check slows
2928                  * it down a lot (so it's commented out).
2929                  *
2930                  * "a lot" is serious: it ate 50 minutes cpu time on
2931                  * my duron 950 before I came back from lunch and
2932                  * killed it.
2933                  *
2934                  *   FIXME: Add a variable to enable this
2935                  * dynamically. */
2936                 /*
2937                 if (!possibly_valid_dynamic_space_pointer((lispobj *)thing)) {
2938                     lose("ptr %p to invalid object %p\n", thing, start);
2939                 }
2940                 */
2941             } else {
2942                 extern void funcallable_instance_tramp;
2943                 /* Verify that it points to another valid space. */
2944                 if (!to_readonly_space && !to_static_space
2945                     && (thing != (lispobj)&funcallable_instance_tramp)
2946                     && !is_in_stack_space(thing)) {
2947                     lose("Ptr %p @ %p sees junk.\n", thing, start);
2948                 }
2949             }
2950         } else {
2951             if (!(fixnump(thing))) {
2952                 /* skip fixnums */
2953                 switch(widetag_of(*start)) {
2954
2955                     /* boxed objects */
2956                 case SIMPLE_VECTOR_WIDETAG:
2957                 case RATIO_WIDETAG:
2958                 case COMPLEX_WIDETAG:
2959                 case SIMPLE_ARRAY_WIDETAG:
2960                 case COMPLEX_BASE_STRING_WIDETAG:
2961 #ifdef COMPLEX_CHARACTER_STRING_WIDETAG
2962                 case COMPLEX_CHARACTER_STRING_WIDETAG:
2963 #endif
2964                 case COMPLEX_VECTOR_NIL_WIDETAG:
2965                 case COMPLEX_BIT_VECTOR_WIDETAG:
2966                 case COMPLEX_VECTOR_WIDETAG:
2967                 case COMPLEX_ARRAY_WIDETAG:
2968                 case CLOSURE_HEADER_WIDETAG:
2969                 case FUNCALLABLE_INSTANCE_HEADER_WIDETAG:
2970                 case VALUE_CELL_HEADER_WIDETAG:
2971                 case SYMBOL_HEADER_WIDETAG:
2972                 case CHARACTER_WIDETAG:
2973 #if N_WORD_BITS == 64
2974                 case SINGLE_FLOAT_WIDETAG:
2975 #endif
2976                 case UNBOUND_MARKER_WIDETAG:
2977                 case FDEFN_WIDETAG:
2978                     count = 1;
2979                     break;
2980
2981                 case INSTANCE_HEADER_WIDETAG:
2982                     {
2983                         lispobj nuntagged;
2984                         long ntotal = HeaderValue(thing);
2985                         lispobj layout = ((struct instance *)start)->slots[0];
2986                         if (!layout) {
2987                             count = 1;
2988                             break;
2989                         }
2990                         nuntagged = ((struct layout *)
2991                                      native_pointer(layout))->n_untagged_slots;
2992                         verify_space(start + 1,
2993                                      ntotal - fixnum_value(nuntagged));
2994                         count = ntotal + 1;
2995                         break;
2996                     }
2997                 case CODE_HEADER_WIDETAG:
2998                     {
2999                         lispobj object = *start;
3000                         struct code *code;
3001                         long nheader_words, ncode_words, nwords;
3002                         lispobj fheaderl;
3003                         struct simple_fun *fheaderp;
3004
3005                         code = (struct code *) start;
3006
3007                         /* Check that it's not in the dynamic space.
3008                          * FIXME: Isn't is supposed to be OK for code
3009                          * objects to be in the dynamic space these days? */
3010                         if (is_in_dynamic_space
3011                             /* It's ok if it's byte compiled code. The trace
3012                              * table offset will be a fixnum if it's x86
3013                              * compiled code - check.
3014                              *
3015                              * FIXME: #^#@@! lack of abstraction here..
3016                              * This line can probably go away now that
3017                              * there's no byte compiler, but I've got
3018                              * too much to worry about right now to try
3019                              * to make sure. -- WHN 2001-10-06 */
3020                             && fixnump(code->trace_table_offset)
3021                             /* Only when enabled */
3022                             && verify_dynamic_code_check) {
3023                             FSHOW((stderr,
3024                                    "/code object at %p in the dynamic space\n",
3025                                    start));
3026                         }
3027
3028                         ncode_words = fixnum_value(code->code_size);
3029                         nheader_words = HeaderValue(object);
3030                         nwords = ncode_words + nheader_words;
3031                         nwords = CEILING(nwords, 2);
3032                         /* Scavenge the boxed section of the code data block */
3033                         verify_space(start + 1, nheader_words - 1);
3034
3035                         /* Scavenge the boxed section of each function
3036                          * object in the code data block. */
3037                         fheaderl = code->entry_points;
3038                         while (fheaderl != NIL) {
3039                             fheaderp =
3040                                 (struct simple_fun *) native_pointer(fheaderl);
3041                             gc_assert(widetag_of(fheaderp->header) ==
3042                                       SIMPLE_FUN_HEADER_WIDETAG);
3043                             verify_space(&fheaderp->name, 1);
3044                             verify_space(&fheaderp->arglist, 1);
3045                             verify_space(&fheaderp->type, 1);
3046                             fheaderl = fheaderp->next;
3047                         }
3048                         count = nwords;
3049                         break;
3050                     }
3051
3052                     /* unboxed objects */
3053                 case BIGNUM_WIDETAG:
3054 #if N_WORD_BITS != 64
3055                 case SINGLE_FLOAT_WIDETAG:
3056 #endif
3057                 case DOUBLE_FLOAT_WIDETAG:
3058 #ifdef COMPLEX_LONG_FLOAT_WIDETAG
3059                 case LONG_FLOAT_WIDETAG:
3060 #endif
3061 #ifdef COMPLEX_SINGLE_FLOAT_WIDETAG
3062                 case COMPLEX_SINGLE_FLOAT_WIDETAG:
3063 #endif
3064 #ifdef COMPLEX_DOUBLE_FLOAT_WIDETAG
3065                 case COMPLEX_DOUBLE_FLOAT_WIDETAG:
3066 #endif
3067 #ifdef COMPLEX_LONG_FLOAT_WIDETAG
3068                 case COMPLEX_LONG_FLOAT_WIDETAG:
3069 #endif
3070                 case SIMPLE_BASE_STRING_WIDETAG:
3071 #ifdef SIMPLE_CHARACTER_STRING_WIDETAG
3072                 case SIMPLE_CHARACTER_STRING_WIDETAG:
3073 #endif
3074                 case SIMPLE_BIT_VECTOR_WIDETAG:
3075                 case SIMPLE_ARRAY_NIL_WIDETAG:
3076                 case SIMPLE_ARRAY_UNSIGNED_BYTE_2_WIDETAG:
3077                 case SIMPLE_ARRAY_UNSIGNED_BYTE_4_WIDETAG:
3078                 case SIMPLE_ARRAY_UNSIGNED_BYTE_7_WIDETAG:
3079                 case SIMPLE_ARRAY_UNSIGNED_BYTE_8_WIDETAG:
3080                 case SIMPLE_ARRAY_UNSIGNED_BYTE_15_WIDETAG:
3081                 case SIMPLE_ARRAY_UNSIGNED_BYTE_16_WIDETAG:
3082
3083                 case SIMPLE_ARRAY_UNSIGNED_FIXNUM_WIDETAG:
3084
3085                 case SIMPLE_ARRAY_UNSIGNED_BYTE_31_WIDETAG:
3086                 case SIMPLE_ARRAY_UNSIGNED_BYTE_32_WIDETAG:
3087 #ifdef SIMPLE_ARRAY_UNSIGNED_BYTE_63_WIDETAG
3088                 case SIMPLE_ARRAY_UNSIGNED_BYTE_63_WIDETAG:
3089 #endif
3090 #ifdef SIMPLE_ARRAY_UNSIGNED_BYTE_64_WIDETAG
3091                 case SIMPLE_ARRAY_UNSIGNED_BYTE_64_WIDETAG:
3092 #endif
3093 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG
3094                 case SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG:
3095 #endif
3096 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG
3097                 case SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG:
3098 #endif
3099
3100                 case SIMPLE_ARRAY_FIXNUM_WIDETAG:
3101
3102 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG
3103                 case SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG:
3104 #endif
3105 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_64_WIDETAG
3106                 case SIMPLE_ARRAY_SIGNED_BYTE_64_WIDETAG:
3107 #endif
3108                 case SIMPLE_ARRAY_SINGLE_FLOAT_WIDETAG:
3109                 case SIMPLE_ARRAY_DOUBLE_FLOAT_WIDETAG:
3110 #ifdef SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG
3111                 case SIMPLE_ARRAY_LONG_FLOAT_WIDETAG:
3112 #endif
3113 #ifdef SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG
3114                 case SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG:
3115 #endif
3116 #ifdef SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG
3117                 case SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG:
3118 #endif
3119 #ifdef SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG
3120                 case SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG:
3121 #endif
3122                 case SAP_WIDETAG:
3123                 case WEAK_POINTER_WIDETAG:
3124 #ifdef NO_TLS_VALUE_MARKER_WIDETAG
3125                 case NO_TLS_VALUE_MARKER_WIDETAG:
3126 #endif
3127                     count = (sizetab[widetag_of(*start)])(start);
3128                     break;
3129
3130                 default:
3131                     lose("Unhandled widetag %p at %p\n",
3132                          widetag_of(*start), start);
3133                 }
3134             }
3135         }
3136         start += count;
3137         words -= count;
3138     }
3139 }
3140
3141 static void
3142 verify_gc(void)
3143 {
3144     /* FIXME: It would be nice to make names consistent so that
3145      * foo_size meant size *in* *bytes* instead of size in some
3146      * arbitrary units. (Yes, this caused a bug, how did you guess?:-)
3147      * Some counts of lispobjs are called foo_count; it might be good
3148      * to grep for all foo_size and rename the appropriate ones to
3149      * foo_count. */
3150     long read_only_space_size =
3151         (lispobj*)SymbolValue(READ_ONLY_SPACE_FREE_POINTER,0)
3152         - (lispobj*)READ_ONLY_SPACE_START;
3153     long static_space_size =
3154         (lispobj*)SymbolValue(STATIC_SPACE_FREE_POINTER,0)
3155         - (lispobj*)STATIC_SPACE_START;
3156     struct thread *th;
3157     for_each_thread(th) {
3158     long binding_stack_size =
3159         (lispobj*)get_binding_stack_pointer(th)
3160             - (lispobj*)th->binding_stack_start;
3161         verify_space(th->binding_stack_start, binding_stack_size);
3162     }
3163     verify_space((lispobj*)READ_ONLY_SPACE_START, read_only_space_size);
3164     verify_space((lispobj*)STATIC_SPACE_START   , static_space_size);
3165 }
3166
3167 static void
3168 verify_generation(generation_index_t generation)
3169 {
3170     page_index_t i;
3171
3172     for (i = 0; i < last_free_page; i++) {
3173         if (page_allocated_p(i)
3174             && (page_table[i].bytes_used != 0)
3175             && (page_table[i].gen == generation)) {
3176             page_index_t last_page;
3177             int region_allocation = page_table[i].allocated;
3178
3179             /* This should be the start of a contiguous block */
3180             gc_assert(page_table[i].region_start_offset == 0);
3181
3182             /* Need to find the full extent of this contiguous block in case
3183                objects span pages. */
3184
3185             /* Now work forward until the end of this contiguous area is
3186                found. */
3187             for (last_page = i; ;last_page++)
3188                 /* Check whether this is the last page in this contiguous
3189                  * block. */
3190                 if ((page_table[last_page].bytes_used < GENCGC_CARD_BYTES)
3191                     /* Or it is CARD_BYTES and is the last in the block */
3192                     || (page_table[last_page+1].allocated != region_allocation)
3193                     || (page_table[last_page+1].bytes_used == 0)
3194                     || (page_table[last_page+1].gen != generation)
3195                     || (page_table[last_page+1].region_start_offset == 0))
3196                     break;
3197
3198             verify_space(page_address(i),
3199                          ((unsigned long)
3200                           (page_table[last_page].bytes_used
3201                            + npage_bytes(last_page-i)))
3202                          / N_WORD_BYTES);
3203             i = last_page;
3204         }
3205     }
3206 }
3207
3208 /* Check that all the free space is zero filled. */
3209 static void
3210 verify_zero_fill(void)
3211 {
3212     page_index_t page;
3213
3214     for (page = 0; page < last_free_page; page++) {
3215         if (page_free_p(page)) {
3216             /* The whole page should be zero filled. */
3217             long *start_addr = (long *)page_address(page);
3218             long size = 1024;
3219             long i;
3220             for (i = 0; i < size; i++) {
3221                 if (start_addr[i] != 0) {
3222                     lose("free page not zero at %x\n", start_addr + i);
3223                 }
3224             }
3225         } else {
3226             long free_bytes = GENCGC_CARD_BYTES - page_table[page].bytes_used;
3227             if (free_bytes > 0) {
3228                 long *start_addr = (long *)((unsigned long)page_address(page)
3229                                           + page_table[page].bytes_used);
3230                 long size = free_bytes / N_WORD_BYTES;
3231                 long i;
3232                 for (i = 0; i < size; i++) {
3233                     if (start_addr[i] != 0) {
3234                         lose("free region not zero at %x\n", start_addr + i);
3235                     }
3236                 }
3237             }
3238         }
3239     }
3240 }
3241
3242 /* External entry point for verify_zero_fill */
3243 void
3244 gencgc_verify_zero_fill(void)
3245 {
3246     /* Flush the alloc regions updating the tables. */
3247     gc_alloc_update_all_page_tables();
3248     SHOW("verifying zero fill");
3249     verify_zero_fill();
3250 }
3251
3252 static void
3253 verify_dynamic_space(void)
3254 {
3255     generation_index_t i;
3256
3257     for (i = 0; i <= HIGHEST_NORMAL_GENERATION; i++)
3258         verify_generation(i);
3259
3260     if (gencgc_enable_verify_zero_fill)
3261         verify_zero_fill();
3262 }
3263 \f
3264 /* Write-protect all the dynamic boxed pages in the given generation. */
3265 static void
3266 write_protect_generation_pages(generation_index_t generation)
3267 {
3268     page_index_t start;
3269
3270     gc_assert(generation < SCRATCH_GENERATION);
3271
3272     for (start = 0; start < last_free_page; start++) {
3273         if (protect_page_p(start, generation)) {
3274             void *page_start;
3275             page_index_t last;
3276
3277             /* Note the page as protected in the page tables. */
3278             page_table[start].write_protected = 1;
3279
3280             for (last = start + 1; last < last_free_page; last++) {
3281                 if (!protect_page_p(last, generation))
3282                   break;
3283                 page_table[last].write_protected = 1;
3284             }
3285
3286             page_start = (void *)page_address(start);
3287
3288             os_protect(page_start,
3289                        npage_bytes(last - start),
3290                        OS_VM_PROT_READ | OS_VM_PROT_EXECUTE);
3291
3292             start = last;
3293         }
3294     }
3295
3296     if (gencgc_verbose > 1) {
3297         FSHOW((stderr,
3298                "/write protected %d of %d pages in generation %d\n",
3299                count_write_protect_generation_pages(generation),
3300                count_generation_pages(generation),
3301                generation));
3302     }
3303 }
3304
3305 #if defined(LISP_FEATURE_SB_THREAD) && (defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64))
3306 static void
3307 preserve_context_registers (os_context_t *c)
3308 {
3309     void **ptr;
3310     /* On Darwin the signal context isn't a contiguous block of memory,
3311      * so just preserve_pointering its contents won't be sufficient.
3312      */
3313 #if defined(LISP_FEATURE_DARWIN)
3314 #if defined LISP_FEATURE_X86
3315     preserve_pointer((void*)*os_context_register_addr(c,reg_EAX));
3316     preserve_pointer((void*)*os_context_register_addr(c,reg_ECX));
3317     preserve_pointer((void*)*os_context_register_addr(c,reg_EDX));
3318     preserve_pointer((void*)*os_context_register_addr(c,reg_EBX));
3319     preserve_pointer((void*)*os_context_register_addr(c,reg_ESI));
3320     preserve_pointer((void*)*os_context_register_addr(c,reg_EDI));
3321     preserve_pointer((void*)*os_context_pc_addr(c));
3322 #elif defined LISP_FEATURE_X86_64
3323     preserve_pointer((void*)*os_context_register_addr(c,reg_RAX));
3324     preserve_pointer((void*)*os_context_register_addr(c,reg_RCX));
3325     preserve_pointer((void*)*os_context_register_addr(c,reg_RDX));
3326     preserve_pointer((void*)*os_context_register_addr(c,reg_RBX));
3327     preserve_pointer((void*)*os_context_register_addr(c,reg_RSI));
3328     preserve_pointer((void*)*os_context_register_addr(c,reg_RDI));
3329     preserve_pointer((void*)*os_context_register_addr(c,reg_R8));
3330     preserve_pointer((void*)*os_context_register_addr(c,reg_R9));
3331     preserve_pointer((void*)*os_context_register_addr(c,reg_R10));
3332     preserve_pointer((void*)*os_context_register_addr(c,reg_R11));
3333     preserve_pointer((void*)*os_context_register_addr(c,reg_R12));
3334     preserve_pointer((void*)*os_context_register_addr(c,reg_R13));
3335     preserve_pointer((void*)*os_context_register_addr(c,reg_R14));
3336     preserve_pointer((void*)*os_context_register_addr(c,reg_R15));
3337     preserve_pointer((void*)*os_context_pc_addr(c));
3338 #else
3339     #error "preserve_context_registers needs to be tweaked for non-x86 Darwin"
3340 #endif
3341 #endif
3342     for(ptr = ((void **)(c+1))-1; ptr>=(void **)c; ptr--) {
3343         preserve_pointer(*ptr);
3344     }
3345 }
3346 #endif
3347
3348 /* Garbage collect a generation. If raise is 0 then the remains of the
3349  * generation are not raised to the next generation. */
3350 static void
3351 garbage_collect_generation(generation_index_t generation, int raise)
3352 {
3353     unsigned long bytes_freed;
3354     page_index_t i;
3355     unsigned long static_space_size;
3356     struct thread *th;
3357
3358     gc_assert(generation <= HIGHEST_NORMAL_GENERATION);
3359
3360     /* The oldest generation can't be raised. */
3361     gc_assert((generation != HIGHEST_NORMAL_GENERATION) || (raise == 0));
3362
3363     /* Check if weak hash tables were processed in the previous GC. */
3364     gc_assert(weak_hash_tables == NULL);
3365
3366     /* Initialize the weak pointer list. */
3367     weak_pointers = NULL;
3368
3369     /* When a generation is not being raised it is transported to a
3370      * temporary generation (NUM_GENERATIONS), and lowered when
3371      * done. Set up this new generation. There should be no pages
3372      * allocated to it yet. */
3373     if (!raise) {
3374          gc_assert(generations[SCRATCH_GENERATION].bytes_allocated == 0);
3375     }
3376
3377     /* Set the global src and dest. generations */
3378     from_space = generation;
3379     if (raise)
3380         new_space = generation+1;
3381     else
3382         new_space = SCRATCH_GENERATION;
3383
3384     /* Change to a new space for allocation, resetting the alloc_start_page */
3385     gc_alloc_generation = new_space;
3386     generations[new_space].alloc_start_page = 0;
3387     generations[new_space].alloc_unboxed_start_page = 0;
3388     generations[new_space].alloc_large_start_page = 0;
3389     generations[new_space].alloc_large_unboxed_start_page = 0;
3390
3391     /* Before any pointers are preserved, the dont_move flags on the
3392      * pages need to be cleared. */
3393     for (i = 0; i < last_free_page; i++)
3394         if(page_table[i].gen==from_space)
3395             page_table[i].dont_move = 0;
3396
3397     /* Un-write-protect the old-space pages. This is essential for the
3398      * promoted pages as they may contain pointers into the old-space
3399      * which need to be scavenged. It also helps avoid unnecessary page
3400      * faults as forwarding pointers are written into them. They need to
3401      * be un-protected anyway before unmapping later. */
3402     unprotect_oldspace();
3403
3404     /* Scavenge the stacks' conservative roots. */
3405
3406     /* there are potentially two stacks for each thread: the main
3407      * stack, which may contain Lisp pointers, and the alternate stack.
3408      * We don't ever run Lisp code on the altstack, but it may
3409      * host a sigcontext with lisp objects in it */
3410
3411     /* what we need to do: (1) find the stack pointer for the main
3412      * stack; scavenge it (2) find the interrupt context on the
3413      * alternate stack that might contain lisp values, and scavenge
3414      * that */
3415
3416     /* we assume that none of the preceding applies to the thread that
3417      * initiates GC.  If you ever call GC from inside an altstack
3418      * handler, you will lose. */
3419
3420 #if defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
3421     /* And if we're saving a core, there's no point in being conservative. */
3422     if (conservative_stack) {
3423         for_each_thread(th) {
3424             void **ptr;
3425             void **esp=(void **)-1;
3426             if (th->state == STATE_DEAD)
3427                 continue;
3428 # if defined(LISP_FEATURE_SB_SAFEPOINT)
3429             /* Conservative collect_garbage is always invoked with a
3430              * foreign C call or an interrupt handler on top of every
3431              * existing thread, so the stored SP in each thread
3432              * structure is valid, no matter which thread we are looking
3433              * at.  For threads that were running Lisp code, the pitstop
3434              * and edge functions maintain this value within the
3435              * interrupt or exception handler. */
3436             esp = os_get_csp(th);
3437             assert_on_stack(th, esp);
3438
3439             /* In addition to pointers on the stack, also preserve the
3440              * return PC, the only value from the context that we need
3441              * in addition to the SP.  The return PC gets saved by the
3442              * foreign call wrapper, and removed from the control stack
3443              * into a register. */
3444             preserve_pointer(th->pc_around_foreign_call);
3445
3446             /* And on platforms with interrupts: scavenge ctx registers. */
3447
3448             /* Disabled on Windows, because it does not have an explicit
3449              * stack of `interrupt_contexts'.  The reported CSP has been
3450              * chosen so that the current context on the stack is
3451              * covered by the stack scan.  See also set_csp_from_context(). */
3452 #  ifndef LISP_FEATURE_WIN32
3453             if (th != arch_os_get_current_thread()) {
3454                 long k = fixnum_value(
3455                     SymbolValue(FREE_INTERRUPT_CONTEXT_INDEX,th));
3456                 while (k > 0)
3457                     preserve_context_registers(th->interrupt_contexts[--k]);
3458             }
3459 #  endif
3460 # elif defined(LISP_FEATURE_SB_THREAD)
3461             long i,free;
3462             if(th==arch_os_get_current_thread()) {
3463                 /* Somebody is going to burn in hell for this, but casting
3464                  * it in two steps shuts gcc up about strict aliasing. */
3465                 esp = (void **)((void *)&raise);
3466             } else {
3467                 void **esp1;
3468                 free=fixnum_value(SymbolValue(FREE_INTERRUPT_CONTEXT_INDEX,th));
3469                 for(i=free-1;i>=0;i--) {
3470                     os_context_t *c=th->interrupt_contexts[i];
3471                     esp1 = (void **) *os_context_register_addr(c,reg_SP);
3472                     if (esp1>=(void **)th->control_stack_start &&
3473                         esp1<(void **)th->control_stack_end) {
3474                         if(esp1<esp) esp=esp1;
3475                         preserve_context_registers(c);
3476                     }
3477                 }
3478             }
3479 # else
3480             esp = (void **)((void *)&raise);
3481 # endif
3482             if (!esp || esp == (void*) -1)
3483                 lose("garbage_collect: no SP known for thread %x (OS %x)",
3484                      th, th->os_thread);
3485             for (ptr = ((void **)th->control_stack_end)-1; ptr >= esp;  ptr--) {
3486                 preserve_pointer(*ptr);
3487             }
3488         }
3489     }
3490 #else
3491     /* Non-x86oid systems don't have "conservative roots" as such, but
3492      * the same mechanism is used for objects pinned for use by alien
3493      * code. */
3494     for_each_thread(th) {
3495         lispobj pin_list = SymbolTlValue(PINNED_OBJECTS,th);
3496         while (pin_list != NIL) {
3497             struct cons *list_entry =
3498                 (struct cons *)native_pointer(pin_list);
3499             preserve_pointer(list_entry->car);
3500             pin_list = list_entry->cdr;
3501         }
3502     }
3503 #endif
3504
3505 #if QSHOW
3506     if (gencgc_verbose > 1) {
3507         long num_dont_move_pages = count_dont_move_pages();
3508         fprintf(stderr,
3509                 "/non-movable pages due to conservative pointers = %d (%d bytes)\n",
3510                 num_dont_move_pages,
3511                 npage_bytes(num_dont_move_pages));
3512     }
3513 #endif
3514
3515     /* Scavenge all the rest of the roots. */
3516
3517 #if !defined(LISP_FEATURE_X86) && !defined(LISP_FEATURE_X86_64)
3518     /*
3519      * If not x86, we need to scavenge the interrupt context(s) and the
3520      * control stack.
3521      */
3522     {
3523         struct thread *th;
3524         for_each_thread(th) {
3525             scavenge_interrupt_contexts(th);
3526             scavenge_control_stack(th);
3527         }
3528
3529         /* Scrub the unscavenged control stack space, so that we can't run
3530          * into any stale pointers in a later GC (this is done by the
3531          * stop-for-gc handler in the other threads). */
3532         scrub_control_stack();
3533     }
3534 #endif
3535
3536     /* Scavenge the Lisp functions of the interrupt handlers, taking
3537      * care to avoid SIG_DFL and SIG_IGN. */
3538     for (i = 0; i < NSIG; i++) {
3539         union interrupt_handler handler = interrupt_handlers[i];
3540         if (!ARE_SAME_HANDLER(handler.c, SIG_IGN) &&
3541             !ARE_SAME_HANDLER(handler.c, SIG_DFL)) {
3542             scavenge((lispobj *)(interrupt_handlers + i), 1);
3543         }
3544     }
3545     /* Scavenge the binding stacks. */
3546     {
3547         struct thread *th;
3548         for_each_thread(th) {
3549             long len= (lispobj *)get_binding_stack_pointer(th) -
3550                 th->binding_stack_start;
3551             scavenge((lispobj *) th->binding_stack_start,len);
3552 #ifdef LISP_FEATURE_SB_THREAD
3553             /* do the tls as well */
3554             len=(SymbolValue(FREE_TLS_INDEX,0) >> WORD_SHIFT) -
3555                 (sizeof (struct thread))/(sizeof (lispobj));
3556             scavenge((lispobj *) (th+1),len);
3557 #endif
3558         }
3559     }
3560
3561     /* The original CMU CL code had scavenge-read-only-space code
3562      * controlled by the Lisp-level variable
3563      * *SCAVENGE-READ-ONLY-SPACE*. It was disabled by default, and it
3564      * wasn't documented under what circumstances it was useful or
3565      * safe to turn it on, so it's been turned off in SBCL. If you
3566      * want/need this functionality, and can test and document it,
3567      * please submit a patch. */
3568 #if 0
3569     if (SymbolValue(SCAVENGE_READ_ONLY_SPACE) != NIL) {
3570         unsigned long read_only_space_size =
3571             (lispobj*)SymbolValue(READ_ONLY_SPACE_FREE_POINTER) -
3572             (lispobj*)READ_ONLY_SPACE_START;
3573         FSHOW((stderr,
3574                "/scavenge read only space: %d bytes\n",
3575                read_only_space_size * sizeof(lispobj)));
3576         scavenge( (lispobj *) READ_ONLY_SPACE_START, read_only_space_size);
3577     }
3578 #endif
3579
3580     /* Scavenge static space. */
3581     static_space_size =
3582         (lispobj *)SymbolValue(STATIC_SPACE_FREE_POINTER,0) -
3583         (lispobj *)STATIC_SPACE_START;
3584     if (gencgc_verbose > 1) {
3585         FSHOW((stderr,
3586                "/scavenge static space: %d bytes\n",
3587                static_space_size * sizeof(lispobj)));
3588     }
3589     scavenge( (lispobj *) STATIC_SPACE_START, static_space_size);
3590
3591     /* All generations but the generation being GCed need to be
3592      * scavenged. The new_space generation needs special handling as
3593      * objects may be moved in - it is handled separately below. */
3594     scavenge_generations(generation+1, PSEUDO_STATIC_GENERATION);
3595
3596     /* Finally scavenge the new_space generation. Keep going until no
3597      * more objects are moved into the new generation */
3598     scavenge_newspace_generation(new_space);
3599
3600     /* FIXME: I tried reenabling this check when debugging unrelated
3601      * GC weirdness ca. sbcl-0.6.12.45, and it failed immediately.
3602      * Since the current GC code seems to work well, I'm guessing that
3603      * this debugging code is just stale, but I haven't tried to
3604      * figure it out. It should be figured out and then either made to
3605      * work or just deleted. */
3606 #define RESCAN_CHECK 0
3607 #if RESCAN_CHECK
3608     /* As a check re-scavenge the newspace once; no new objects should
3609      * be found. */
3610     {
3611         os_vm_size_t old_bytes_allocated = bytes_allocated;
3612         os_vm_size_t bytes_allocated;
3613
3614         /* Start with a full scavenge. */
3615         scavenge_newspace_generation_one_scan(new_space);
3616
3617         /* Flush the current regions, updating the tables. */
3618         gc_alloc_update_all_page_tables();
3619
3620         bytes_allocated = bytes_allocated - old_bytes_allocated;
3621
3622         if (bytes_allocated != 0) {
3623             lose("Rescan of new_space allocated %d more bytes.\n",
3624                  bytes_allocated);
3625         }
3626     }
3627 #endif
3628
3629     scan_weak_hash_tables();
3630     scan_weak_pointers();
3631
3632     /* Flush the current regions, updating the tables. */
3633     gc_alloc_update_all_page_tables();
3634
3635     /* Free the pages in oldspace, but not those marked dont_move. */
3636     bytes_freed = free_oldspace();
3637
3638     /* If the GC is not raising the age then lower the generation back
3639      * to its normal generation number */
3640     if (!raise) {
3641         for (i = 0; i < last_free_page; i++)
3642             if ((page_table[i].bytes_used != 0)
3643                 && (page_table[i].gen == SCRATCH_GENERATION))
3644                 page_table[i].gen = generation;
3645         gc_assert(generations[generation].bytes_allocated == 0);
3646         generations[generation].bytes_allocated =
3647             generations[SCRATCH_GENERATION].bytes_allocated;
3648         generations[SCRATCH_GENERATION].bytes_allocated = 0;
3649     }
3650
3651     /* Reset the alloc_start_page for generation. */
3652     generations[generation].alloc_start_page = 0;
3653     generations[generation].alloc_unboxed_start_page = 0;
3654     generations[generation].alloc_large_start_page = 0;
3655     generations[generation].alloc_large_unboxed_start_page = 0;
3656
3657     if (generation >= verify_gens) {
3658         if (gencgc_verbose) {
3659             SHOW("verifying");
3660         }
3661         verify_gc();
3662         verify_dynamic_space();
3663     }
3664
3665     /* Set the new gc trigger for the GCed generation. */
3666     generations[generation].gc_trigger =
3667         generations[generation].bytes_allocated
3668         + generations[generation].bytes_consed_between_gc;
3669
3670     if (raise)
3671         generations[generation].num_gc = 0;
3672     else
3673         ++generations[generation].num_gc;
3674
3675 }
3676
3677 /* Update last_free_page, then SymbolValue(ALLOCATION_POINTER). */
3678 long
3679 update_dynamic_space_free_pointer(void)
3680 {
3681     page_index_t last_page = -1, i;
3682
3683     for (i = 0; i < last_free_page; i++)
3684         if (page_allocated_p(i) && (page_table[i].bytes_used != 0))
3685             last_page = i;
3686
3687     last_free_page = last_page+1;
3688
3689     set_alloc_pointer((lispobj)(page_address(last_free_page)));
3690     return 0; /* dummy value: return something ... */
3691 }
3692
3693 static void
3694 remap_page_range (page_index_t from, page_index_t to)
3695 {
3696     /* There's a mysterious Solaris/x86 problem with using mmap
3697      * tricks for memory zeroing. See sbcl-devel thread
3698      * "Re: patch: standalone executable redux".
3699      */
3700 #if defined(LISP_FEATURE_SUNOS)
3701     zero_and_mark_pages(from, to);
3702 #else
3703     const page_index_t
3704             release_granularity = gencgc_release_granularity/GENCGC_CARD_BYTES,
3705                    release_mask = release_granularity-1,
3706                             end = to+1,
3707                    aligned_from = (from+release_mask)&~release_mask,
3708                     aligned_end = (end&~release_mask);
3709
3710     if (aligned_from < aligned_end) {
3711         zero_pages_with_mmap(aligned_from, aligned_end-1);
3712         if (aligned_from != from)
3713             zero_and_mark_pages(from, aligned_from-1);
3714         if (aligned_end != end)
3715             zero_and_mark_pages(aligned_end, end-1);
3716     } else {
3717         zero_and_mark_pages(from, to);
3718     }
3719 #endif
3720 }
3721
3722 static void
3723 remap_free_pages (page_index_t from, page_index_t to, int forcibly)
3724 {
3725     page_index_t first_page, last_page;
3726
3727     if (forcibly)
3728         return remap_page_range(from, to);
3729
3730     for (first_page = from; first_page <= to; first_page++) {
3731         if (page_allocated_p(first_page) ||
3732             (page_table[first_page].need_to_zero == 0))
3733             continue;
3734
3735         last_page = first_page + 1;
3736         while (page_free_p(last_page) &&
3737                (last_page <= to) &&
3738                (page_table[last_page].need_to_zero == 1))
3739             last_page++;
3740
3741         remap_page_range(first_page, last_page-1);
3742
3743         first_page = last_page;
3744     }
3745 }
3746
3747 generation_index_t small_generation_limit = 1;
3748
3749 /* GC all generations newer than last_gen, raising the objects in each
3750  * to the next older generation - we finish when all generations below
3751  * last_gen are empty.  Then if last_gen is due for a GC, or if
3752  * last_gen==NUM_GENERATIONS (the scratch generation?  eh?) we GC that
3753  * too.  The valid range for last_gen is: 0,1,...,NUM_GENERATIONS.
3754  *
3755  * We stop collecting at gencgc_oldest_gen_to_gc, even if this is less than
3756  * last_gen (oh, and note that by default it is NUM_GENERATIONS-1) */
3757 void
3758 collect_garbage(generation_index_t last_gen)
3759 {
3760     generation_index_t gen = 0, i;
3761     int raise, more = 0;
3762     int gen_to_wp;
3763     /* The largest value of last_free_page seen since the time
3764      * remap_free_pages was called. */
3765     static page_index_t high_water_mark = 0;
3766
3767     FSHOW((stderr, "/entering collect_garbage(%d)\n", last_gen));
3768     log_generation_stats(gc_logfile, "=== GC Start ===");
3769
3770     gc_active_p = 1;
3771
3772     if (last_gen > HIGHEST_NORMAL_GENERATION+1) {
3773         FSHOW((stderr,
3774                "/collect_garbage: last_gen = %d, doing a level 0 GC\n",
3775                last_gen));
3776         last_gen = 0;
3777     }
3778
3779     /* Flush the alloc regions updating the tables. */
3780     gc_alloc_update_all_page_tables();
3781
3782     /* Verify the new objects created by Lisp code. */
3783     if (pre_verify_gen_0) {
3784         FSHOW((stderr, "pre-checking generation 0\n"));
3785         verify_generation(0);
3786     }
3787
3788     if (gencgc_verbose > 1)
3789         print_generation_stats();
3790
3791     do {
3792         /* Collect the generation. */
3793
3794         if (more || (gen >= gencgc_oldest_gen_to_gc)) {
3795             /* Never raise the oldest generation. Never raise the extra generation
3796              * collected due to more-flag. */
3797             raise = 0;
3798             more = 0;
3799         } else {
3800             raise =
3801                 (gen < last_gen)
3802                 || (generations[gen].num_gc >= generations[gen].number_of_gcs_before_promotion);
3803             /* If we would not normally raise this one, but we're
3804              * running low on space in comparison to the object-sizes
3805              * we've been seeing, raise it and collect the next one
3806              * too. */
3807             if (!raise && gen == last_gen) {
3808                 more = (2*large_allocation) >= (dynamic_space_size - bytes_allocated);
3809                 raise = more;
3810             }
3811         }
3812
3813         if (gencgc_verbose > 1) {
3814             FSHOW((stderr,
3815                    "starting GC of generation %d with raise=%d alloc=%d trig=%d GCs=%d\n",
3816                    gen,
3817                    raise,
3818                    generations[gen].bytes_allocated,
3819                    generations[gen].gc_trigger,
3820                    generations[gen].num_gc));
3821         }
3822
3823         /* If an older generation is being filled, then update its
3824          * memory age. */
3825         if (raise == 1) {
3826             generations[gen+1].cum_sum_bytes_allocated +=
3827                 generations[gen+1].bytes_allocated;
3828         }
3829
3830         garbage_collect_generation(gen, raise);
3831
3832         /* Reset the memory age cum_sum. */
3833         generations[gen].cum_sum_bytes_allocated = 0;
3834
3835         if (gencgc_verbose > 1) {
3836             FSHOW((stderr, "GC of generation %d finished:\n", gen));
3837             print_generation_stats();
3838         }
3839
3840         gen++;
3841     } while ((gen <= gencgc_oldest_gen_to_gc)
3842              && ((gen < last_gen)
3843                  || more
3844                  || (raise
3845                      && (generations[gen].bytes_allocated
3846                          > generations[gen].gc_trigger)
3847                      && (generation_average_age(gen)
3848                          > generations[gen].minimum_age_before_gc))));
3849
3850     /* Now if gen-1 was raised all generations before gen are empty.
3851      * If it wasn't raised then all generations before gen-1 are empty.
3852      *
3853      * Now objects within this gen's pages cannot point to younger
3854      * generations unless they are written to. This can be exploited
3855      * by write-protecting the pages of gen; then when younger
3856      * generations are GCed only the pages which have been written
3857      * need scanning. */
3858     if (raise)
3859         gen_to_wp = gen;
3860     else
3861         gen_to_wp = gen - 1;
3862
3863     /* There's not much point in WPing pages in generation 0 as it is
3864      * never scavenged (except promoted pages). */
3865     if ((gen_to_wp > 0) && enable_page_protection) {
3866         /* Check that they are all empty. */
3867         for (i = 0; i < gen_to_wp; i++) {
3868             if (generations[i].bytes_allocated)
3869                 lose("trying to write-protect gen. %d when gen. %d nonempty\n",
3870                      gen_to_wp, i);
3871         }
3872         write_protect_generation_pages(gen_to_wp);
3873     }
3874
3875     /* Set gc_alloc() back to generation 0. The current regions should
3876      * be flushed after the above GCs. */
3877     gc_assert((boxed_region.free_pointer - boxed_region.start_addr) == 0);
3878     gc_alloc_generation = 0;
3879
3880     /* Save the high-water mark before updating last_free_page */
3881     if (last_free_page > high_water_mark)
3882         high_water_mark = last_free_page;
3883
3884     update_dynamic_space_free_pointer();
3885
3886     /* Update auto_gc_trigger. Make sure we trigger the next GC before
3887      * running out of heap! */
3888     if (bytes_consed_between_gcs <= (dynamic_space_size - bytes_allocated))
3889         auto_gc_trigger = bytes_allocated + bytes_consed_between_gcs;
3890     else
3891         auto_gc_trigger = bytes_allocated + (dynamic_space_size - bytes_allocated)/2;
3892
3893     if(gencgc_verbose)
3894         fprintf(stderr,"Next gc when %"OS_VM_SIZE_FMT" bytes have been consed\n",
3895                 auto_gc_trigger);
3896
3897     /* If we did a big GC (arbitrarily defined as gen > 1), release memory
3898      * back to the OS.
3899      */
3900     if (gen > small_generation_limit) {
3901         if (last_free_page > high_water_mark)
3902             high_water_mark = last_free_page;
3903         remap_free_pages(0, high_water_mark, 0);
3904         high_water_mark = 0;
3905     }
3906
3907     gc_active_p = 0;
3908     large_allocation = 0;
3909
3910     log_generation_stats(gc_logfile, "=== GC End ===");
3911     SHOW("returning from collect_garbage");
3912 }
3913
3914 /* This is called by Lisp PURIFY when it is finished. All live objects
3915  * will have been moved to the RO and Static heaps. The dynamic space
3916  * will need a full re-initialization. We don't bother having Lisp
3917  * PURIFY flush the current gc_alloc() region, as the page_tables are
3918  * re-initialized, and every page is zeroed to be sure. */
3919 void
3920 gc_free_heap(void)
3921 {
3922     page_index_t page, last_page;
3923
3924     if (gencgc_verbose > 1) {
3925         SHOW("entering gc_free_heap");
3926     }
3927
3928     for (page = 0; page < page_table_pages; page++) {
3929         /* Skip free pages which should already be zero filled. */
3930         if (page_allocated_p(page)) {
3931             void *page_start;
3932             for (last_page = page;
3933                  (last_page < page_table_pages) && page_allocated_p(last_page);
3934                  last_page++) {
3935                 /* Mark the page free. The other slots are assumed invalid
3936                  * when it is a FREE_PAGE_FLAG and bytes_used is 0 and it
3937                  * should not be write-protected -- except that the
3938                  * generation is used for the current region but it sets
3939                  * that up. */
3940                 page_table[page].allocated = FREE_PAGE_FLAG;
3941                 page_table[page].bytes_used = 0;
3942                 page_table[page].write_protected = 0;
3943             }
3944
3945 #ifndef LISP_FEATURE_WIN32 /* Pages already zeroed on win32? Not sure
3946                             * about this change. */
3947             page_start = (void *)page_address(page);
3948             os_protect(page_start, npage_bytes(last_page-page), OS_VM_PROT_ALL);
3949             remap_free_pages(page, last_page-1, 1);
3950             page = last_page-1;
3951 #endif
3952         } else if (gencgc_zero_check_during_free_heap) {
3953             /* Double-check that the page is zero filled. */
3954             long *page_start;
3955             page_index_t i;
3956             gc_assert(page_free_p(page));
3957             gc_assert(page_table[page].bytes_used == 0);
3958             page_start = (long *)page_address(page);
3959             for (i=0; i<GENCGC_CARD_BYTES/sizeof(long); i++) {
3960                 if (page_start[i] != 0) {
3961                     lose("free region not zero at %x\n", page_start + i);
3962                 }
3963             }
3964         }
3965     }
3966
3967     bytes_allocated = 0;
3968
3969     /* Initialize the generations. */
3970     for (page = 0; page < NUM_GENERATIONS; page++) {
3971         generations[page].alloc_start_page = 0;
3972         generations[page].alloc_unboxed_start_page = 0;
3973         generations[page].alloc_large_start_page = 0;
3974         generations[page].alloc_large_unboxed_start_page = 0;
3975         generations[page].bytes_allocated = 0;
3976         generations[page].gc_trigger = 2000000;
3977         generations[page].num_gc = 0;
3978         generations[page].cum_sum_bytes_allocated = 0;
3979     }
3980
3981     if (gencgc_verbose > 1)
3982         print_generation_stats();
3983
3984     /* Initialize gc_alloc(). */
3985     gc_alloc_generation = 0;
3986
3987     gc_set_region_empty(&boxed_region);
3988     gc_set_region_empty(&unboxed_region);
3989
3990     last_free_page = 0;
3991     set_alloc_pointer((lispobj)((char *)heap_base));
3992
3993     if (verify_after_free_heap) {
3994         /* Check whether purify has left any bad pointers. */
3995         FSHOW((stderr, "checking after free_heap\n"));
3996         verify_gc();
3997     }
3998 }
3999 \f
4000 void
4001 gc_init(void)
4002 {
4003     page_index_t i;
4004
4005     /* Compute the number of pages needed for the dynamic space.
4006      * Dynamic space size should be aligned on page size. */
4007     page_table_pages = dynamic_space_size/GENCGC_CARD_BYTES;
4008     gc_assert(dynamic_space_size == npage_bytes(page_table_pages));
4009
4010     /* Default nursery size to 5% of the total dynamic space size,
4011      * min 1Mb. */
4012     bytes_consed_between_gcs = dynamic_space_size/(os_vm_size_t)20;
4013     if (bytes_consed_between_gcs < (1024*1024))
4014         bytes_consed_between_gcs = 1024*1024;
4015
4016     /* The page_table must be allocated using "calloc" to initialize
4017      * the page structures correctly. There used to be a separate
4018      * initialization loop (now commented out; see below) but that was
4019      * unnecessary and did hurt startup time. */
4020     page_table = calloc(page_table_pages, sizeof(struct page));
4021     gc_assert(page_table);
4022
4023     gc_init_tables();
4024     scavtab[WEAK_POINTER_WIDETAG] = scav_weak_pointer;
4025     transother[SIMPLE_ARRAY_WIDETAG] = trans_boxed_large;
4026
4027     heap_base = (void*)DYNAMIC_SPACE_START;
4028
4029     /* The page structures are initialized implicitly when page_table
4030      * is allocated with "calloc" above. Formerly we had the following
4031      * explicit initialization here (comments converted to C99 style
4032      * for readability as C's block comments don't nest):
4033      *
4034      * // Initialize each page structure.
4035      * for (i = 0; i < page_table_pages; i++) {
4036      *     // Initialize all pages as free.
4037      *     page_table[i].allocated = FREE_PAGE_FLAG;
4038      *     page_table[i].bytes_used = 0;
4039      *
4040      *     // Pages are not write-protected at startup.
4041      *     page_table[i].write_protected = 0;
4042      * }
4043      *
4044      * Without this loop the image starts up much faster when dynamic
4045      * space is large -- which it is on 64-bit platforms already by
4046      * default -- and when "calloc" for large arrays is implemented
4047      * using copy-on-write of a page of zeroes -- which it is at least
4048      * on Linux. In this case the pages that page_table_pages is stored
4049      * in are mapped and cleared not before the corresponding part of
4050      * dynamic space is used. For example, this saves clearing 16 MB of
4051      * memory at startup if the page size is 4 KB and the size of
4052      * dynamic space is 4 GB.
4053      * FREE_PAGE_FLAG must be 0 for this to work correctly which is
4054      * asserted below: */
4055     {
4056       /* Compile time assertion: If triggered, declares an array
4057        * of dimension -1 forcing a syntax error. The intent of the
4058        * assignment is to avoid an "unused variable" warning. */
4059       char assert_free_page_flag_0[(FREE_PAGE_FLAG) ? -1 : 1];
4060       assert_free_page_flag_0[0] = assert_free_page_flag_0[0];
4061     }
4062
4063     bytes_allocated = 0;
4064
4065     /* Initialize the generations.
4066      *
4067      * FIXME: very similar to code in gc_free_heap(), should be shared */
4068     for (i = 0; i < NUM_GENERATIONS; i++) {
4069         generations[i].alloc_start_page = 0;
4070         generations[i].alloc_unboxed_start_page = 0;
4071         generations[i].alloc_large_start_page = 0;
4072         generations[i].alloc_large_unboxed_start_page = 0;
4073         generations[i].bytes_allocated = 0;
4074         generations[i].gc_trigger = 2000000;
4075         generations[i].num_gc = 0;
4076         generations[i].cum_sum_bytes_allocated = 0;
4077         /* the tune-able parameters */
4078         generations[i].bytes_consed_between_gc
4079             = bytes_consed_between_gcs/(os_vm_size_t)HIGHEST_NORMAL_GENERATION;
4080         generations[i].number_of_gcs_before_promotion = 1;
4081         generations[i].minimum_age_before_gc = 0.75;
4082     }
4083
4084     /* Initialize gc_alloc. */
4085     gc_alloc_generation = 0;
4086     gc_set_region_empty(&boxed_region);
4087     gc_set_region_empty(&unboxed_region);
4088
4089     last_free_page = 0;
4090 }
4091
4092 /*  Pick up the dynamic space from after a core load.
4093  *
4094  *  The ALLOCATION_POINTER points to the end of the dynamic space.
4095  */
4096
4097 static void
4098 gencgc_pickup_dynamic(void)
4099 {
4100     page_index_t page = 0;
4101     void *alloc_ptr = (void *)get_alloc_pointer();
4102     lispobj *prev=(lispobj *)page_address(page);
4103     generation_index_t gen = PSEUDO_STATIC_GENERATION;
4104     do {
4105         lispobj *first,*ptr= (lispobj *)page_address(page);
4106
4107         if (!gencgc_partial_pickup || page_allocated_p(page)) {
4108           /* It is possible, though rare, for the saved page table
4109            * to contain free pages below alloc_ptr. */
4110           page_table[page].gen = gen;
4111           page_table[page].bytes_used = GENCGC_CARD_BYTES;
4112           page_table[page].large_object = 0;
4113           page_table[page].write_protected = 0;
4114           page_table[page].write_protected_cleared = 0;
4115           page_table[page].dont_move = 0;
4116           page_table[page].need_to_zero = 1;
4117         }
4118
4119         if (!gencgc_partial_pickup) {
4120             page_table[page].allocated = BOXED_PAGE_FLAG;
4121             first=gc_search_space(prev,(ptr+2)-prev,ptr);
4122             if(ptr == first)
4123                 prev=ptr;
4124             page_table[page].region_start_offset =
4125                 page_address(page) - (void *)prev;
4126         }
4127         page++;
4128     } while (page_address(page) < alloc_ptr);
4129
4130     last_free_page = page;
4131
4132     generations[gen].bytes_allocated = npage_bytes(page);
4133     bytes_allocated = npage_bytes(page);
4134
4135     gc_alloc_update_all_page_tables();
4136     write_protect_generation_pages(gen);
4137 }
4138
4139 void
4140 gc_initialize_pointers(void)
4141 {
4142     gencgc_pickup_dynamic();
4143 }
4144 \f
4145
4146 /* alloc(..) is the external interface for memory allocation. It
4147  * allocates to generation 0. It is not called from within the garbage
4148  * collector as it is only external uses that need the check for heap
4149  * size (GC trigger) and to disable the interrupts (interrupts are
4150  * always disabled during a GC).
4151  *
4152  * The vops that call alloc(..) assume that the returned space is zero-filled.
4153  * (E.g. the most significant word of a 2-word bignum in MOVE-FROM-UNSIGNED.)
4154  *
4155  * The check for a GC trigger is only performed when the current
4156  * region is full, so in most cases it's not needed. */
4157
4158 static inline lispobj *
4159 general_alloc_internal(long nbytes, int page_type_flag, struct alloc_region *region,
4160                        struct thread *thread)
4161 {
4162 #ifndef LISP_FEATURE_WIN32
4163     lispobj alloc_signal;
4164 #endif
4165     void *new_obj;
4166     void *new_free_pointer;
4167     os_vm_size_t trigger_bytes = 0;
4168
4169     gc_assert(nbytes>0);
4170
4171     /* Check for alignment allocation problems. */
4172     gc_assert((((unsigned long)region->free_pointer & LOWTAG_MASK) == 0)
4173               && ((nbytes & LOWTAG_MASK) == 0));
4174
4175     /* Must be inside a PA section. */
4176     gc_assert(get_pseudo_atomic_atomic(thread));
4177
4178     if (nbytes > large_allocation)
4179         large_allocation = nbytes;
4180
4181     /* maybe we can do this quickly ... */
4182     new_free_pointer = region->free_pointer + nbytes;
4183     if (new_free_pointer <= region->end_addr) {
4184         new_obj = (void*)(region->free_pointer);
4185         region->free_pointer = new_free_pointer;
4186         return(new_obj);        /* yup */
4187     }
4188
4189     /* We don't want to count nbytes against auto_gc_trigger unless we
4190      * have to: it speeds up the tenuring of objects and slows down
4191      * allocation. However, unless we do so when allocating _very_
4192      * large objects we are in danger of exhausting the heap without
4193      * running sufficient GCs.
4194      */
4195     if (nbytes >= bytes_consed_between_gcs)
4196         trigger_bytes = nbytes;
4197
4198     /* we have to go the long way around, it seems. Check whether we
4199      * should GC in the near future
4200      */
4201     if (auto_gc_trigger && (bytes_allocated+trigger_bytes > auto_gc_trigger)) {
4202         /* Don't flood the system with interrupts if the need to gc is
4203          * already noted. This can happen for example when SUB-GC
4204          * allocates or after a gc triggered in a WITHOUT-GCING. */
4205         if (SymbolValue(GC_PENDING,thread) == NIL) {
4206             /* set things up so that GC happens when we finish the PA
4207              * section */
4208             SetSymbolValue(GC_PENDING,T,thread);
4209             if (SymbolValue(GC_INHIBIT,thread) == NIL) {
4210 #ifdef LISP_FEATURE_SB_SAFEPOINT
4211                 thread_register_gc_trigger();
4212 #else
4213                 set_pseudo_atomic_interrupted(thread);
4214 #ifdef LISP_FEATURE_PPC
4215                 /* PPC calls alloc() from a trap or from pa_alloc(),
4216                  * look up the most context if it's from a trap. */
4217                 {
4218                     os_context_t *context =
4219                         thread->interrupt_data->allocation_trap_context;
4220                     maybe_save_gc_mask_and_block_deferrables
4221                         (context ? os_context_sigmask_addr(context) : NULL);
4222                 }
4223 #else
4224                 maybe_save_gc_mask_and_block_deferrables(NULL);
4225 #endif
4226 #endif
4227             }
4228         }
4229     }
4230     new_obj = gc_alloc_with_region(nbytes, page_type_flag, region, 0);
4231
4232 #ifndef LISP_FEATURE_WIN32
4233     /* for sb-prof, and not supported on Windows yet */
4234     alloc_signal = SymbolValue(ALLOC_SIGNAL,thread);
4235     if ((alloc_signal & FIXNUM_TAG_MASK) == 0) {
4236         if ((signed long) alloc_signal <= 0) {
4237             SetSymbolValue(ALLOC_SIGNAL, T, thread);
4238             raise(SIGPROF);
4239         } else {
4240             SetSymbolValue(ALLOC_SIGNAL,
4241                            alloc_signal - (1 << N_FIXNUM_TAG_BITS),
4242                            thread);
4243         }
4244     }
4245 #endif
4246
4247     return (new_obj);
4248 }
4249
4250 lispobj *
4251 general_alloc(long nbytes, int page_type_flag)
4252 {
4253     struct thread *thread = arch_os_get_current_thread();
4254     /* Select correct region, and call general_alloc_internal with it.
4255      * For other then boxed allocation we must lock first, since the
4256      * region is shared. */
4257     if (BOXED_PAGE_FLAG & page_type_flag) {
4258 #ifdef LISP_FEATURE_SB_THREAD
4259         struct alloc_region *region = (thread ? &(thread->alloc_region) : &boxed_region);
4260 #else
4261         struct alloc_region *region = &boxed_region;
4262 #endif
4263         return general_alloc_internal(nbytes, page_type_flag, region, thread);
4264     } else if (UNBOXED_PAGE_FLAG == page_type_flag) {
4265         lispobj * obj;
4266         gc_assert(0 == thread_mutex_lock(&allocation_lock));
4267         obj = general_alloc_internal(nbytes, page_type_flag, &unboxed_region, thread);
4268         gc_assert(0 == thread_mutex_unlock(&allocation_lock));
4269         return obj;
4270     } else {
4271         lose("bad page type flag: %d", page_type_flag);
4272     }
4273 }
4274
4275 lispobj *
4276 alloc(long nbytes)
4277 {
4278     gc_assert(get_pseudo_atomic_atomic(arch_os_get_current_thread()));
4279     return general_alloc(nbytes, BOXED_PAGE_FLAG);
4280 }
4281 \f
4282 /*
4283  * shared support for the OS-dependent signal handlers which
4284  * catch GENCGC-related write-protect violations
4285  */
4286 void unhandled_sigmemoryfault(void* addr);
4287
4288 /* Depending on which OS we're running under, different signals might
4289  * be raised for a violation of write protection in the heap. This
4290  * function factors out the common generational GC magic which needs
4291  * to invoked in this case, and should be called from whatever signal
4292  * handler is appropriate for the OS we're running under.
4293  *
4294  * Return true if this signal is a normal generational GC thing that
4295  * we were able to handle, or false if it was abnormal and control
4296  * should fall through to the general SIGSEGV/SIGBUS/whatever logic.
4297  *
4298  * We have two control flags for this: one causes us to ignore faults
4299  * on unprotected pages completely, and the second complains to stderr
4300  * but allows us to continue without losing.
4301  */
4302 extern boolean ignore_memoryfaults_on_unprotected_pages;
4303 boolean ignore_memoryfaults_on_unprotected_pages = 0;
4304
4305 extern boolean continue_after_memoryfault_on_unprotected_pages;
4306 boolean continue_after_memoryfault_on_unprotected_pages = 0;
4307
4308 int
4309 gencgc_handle_wp_violation(void* fault_addr)
4310 {
4311     page_index_t page_index = find_page_index(fault_addr);
4312
4313 #if QSHOW_SIGNALS
4314     FSHOW((stderr, "heap WP violation? fault_addr=%x, page_index=%d\n",
4315            fault_addr, page_index));
4316 #endif
4317
4318     /* Check whether the fault is within the dynamic space. */
4319     if (page_index == (-1)) {
4320
4321         /* It can be helpful to be able to put a breakpoint on this
4322          * case to help diagnose low-level problems. */
4323         unhandled_sigmemoryfault(fault_addr);
4324
4325         /* not within the dynamic space -- not our responsibility */
4326         return 0;
4327
4328     } else {
4329         int ret;
4330         ret = thread_mutex_lock(&free_pages_lock);
4331         gc_assert(ret == 0);
4332         if (page_table[page_index].write_protected) {
4333             /* Unprotect the page. */
4334             os_protect(page_address(page_index), GENCGC_CARD_BYTES, OS_VM_PROT_ALL);
4335             page_table[page_index].write_protected_cleared = 1;
4336             page_table[page_index].write_protected = 0;
4337         } else if (!ignore_memoryfaults_on_unprotected_pages) {
4338             /* The only acceptable reason for this signal on a heap
4339              * access is that GENCGC write-protected the page.
4340              * However, if two CPUs hit a wp page near-simultaneously,
4341              * we had better not have the second one lose here if it
4342              * does this test after the first one has already set wp=0
4343              */
4344             if(page_table[page_index].write_protected_cleared != 1) {
4345                 void lisp_backtrace(int frames);
4346                 lisp_backtrace(10);
4347                 fprintf(stderr,
4348                         "Fault @ %p, page %"PAGE_INDEX_FMT" not marked as write-protected:\n"
4349                         "  boxed_region.first_page: %"PAGE_INDEX_FMT","
4350                         "  boxed_region.last_page %"PAGE_INDEX_FMT"\n"
4351                         "  page.region_start_offset: %"OS_VM_SIZE_FMT"\n"
4352                         "  page.bytes_used: %"PAGE_BYTES_FMT"\n"
4353                         "  page.allocated: %d\n"
4354                         "  page.write_protected: %d\n"
4355                         "  page.write_protected_cleared: %d\n"
4356                         "  page.generation: %d\n",
4357                         fault_addr,
4358                         page_index,
4359                         boxed_region.first_page,
4360                         boxed_region.last_page,
4361                         page_table[page_index].region_start_offset,
4362                         page_table[page_index].bytes_used,
4363                         page_table[page_index].allocated,
4364                         page_table[page_index].write_protected,
4365                         page_table[page_index].write_protected_cleared,
4366                         page_table[page_index].gen);
4367                 if (!continue_after_memoryfault_on_unprotected_pages)
4368                     lose("Feh.\n");
4369             }
4370         }
4371         ret = thread_mutex_unlock(&free_pages_lock);
4372         gc_assert(ret == 0);
4373         /* Don't worry, we can handle it. */
4374         return 1;
4375     }
4376 }
4377 /* This is to be called when we catch a SIGSEGV/SIGBUS, determine that
4378  * it's not just a case of the program hitting the write barrier, and
4379  * are about to let Lisp deal with it. It's basically just a
4380  * convenient place to set a gdb breakpoint. */
4381 void
4382 unhandled_sigmemoryfault(void *addr)
4383 {}
4384
4385 void gc_alloc_update_all_page_tables(void)
4386 {
4387     /* Flush the alloc regions updating the tables. */
4388     struct thread *th;
4389     for_each_thread(th)
4390         gc_alloc_update_page_tables(BOXED_PAGE_FLAG, &th->alloc_region);
4391     gc_alloc_update_page_tables(UNBOXED_PAGE_FLAG, &unboxed_region);
4392     gc_alloc_update_page_tables(BOXED_PAGE_FLAG, &boxed_region);
4393 }
4394
4395 void
4396 gc_set_region_empty(struct alloc_region *region)
4397 {
4398     region->first_page = 0;
4399     region->last_page = -1;
4400     region->start_addr = page_address(0);
4401     region->free_pointer = page_address(0);
4402     region->end_addr = page_address(0);
4403 }
4404
4405 static void
4406 zero_all_free_pages()
4407 {
4408     page_index_t i;
4409
4410     for (i = 0; i < last_free_page; i++) {
4411         if (page_free_p(i)) {
4412 #ifdef READ_PROTECT_FREE_PAGES
4413             os_protect(page_address(i),
4414                        GENCGC_CARD_BYTES,
4415                        OS_VM_PROT_ALL);
4416 #endif
4417             zero_pages(i, i);
4418         }
4419     }
4420 }
4421
4422 /* Things to do before doing a final GC before saving a core (without
4423  * purify).
4424  *
4425  * + Pages in large_object pages aren't moved by the GC, so we need to
4426  *   unset that flag from all pages.
4427  * + The pseudo-static generation isn't normally collected, but it seems
4428  *   reasonable to collect it at least when saving a core. So move the
4429  *   pages to a normal generation.
4430  */
4431 static void
4432 prepare_for_final_gc ()
4433 {
4434     page_index_t i;
4435     for (i = 0; i < last_free_page; i++) {
4436         page_table[i].large_object = 0;
4437         if (page_table[i].gen == PSEUDO_STATIC_GENERATION) {
4438             int used = page_table[i].bytes_used;
4439             page_table[i].gen = HIGHEST_NORMAL_GENERATION;
4440             generations[PSEUDO_STATIC_GENERATION].bytes_allocated -= used;
4441             generations[HIGHEST_NORMAL_GENERATION].bytes_allocated += used;
4442         }
4443     }
4444 }
4445
4446
4447 /* Do a non-conservative GC, and then save a core with the initial
4448  * function being set to the value of the static symbol
4449  * SB!VM:RESTART-LISP-FUNCTION */
4450 void
4451 gc_and_save(char *filename, boolean prepend_runtime,
4452             boolean save_runtime_options,
4453             boolean compressed, int compression_level)
4454 {
4455     FILE *file;
4456     void *runtime_bytes = NULL;
4457     size_t runtime_size;
4458
4459     file = prepare_to_save(filename, prepend_runtime, &runtime_bytes,
4460                            &runtime_size);
4461     if (file == NULL)
4462        return;
4463
4464     conservative_stack = 0;
4465
4466     /* The filename might come from Lisp, and be moved by the now
4467      * non-conservative GC. */
4468     filename = strdup(filename);
4469
4470     /* Collect twice: once into relatively high memory, and then back
4471      * into low memory. This compacts the retained data into the lower
4472      * pages, minimizing the size of the core file.
4473      */
4474     prepare_for_final_gc();
4475     gencgc_alloc_start_page = last_free_page;
4476     collect_garbage(HIGHEST_NORMAL_GENERATION+1);
4477
4478     prepare_for_final_gc();
4479     gencgc_alloc_start_page = -1;
4480     collect_garbage(HIGHEST_NORMAL_GENERATION+1);
4481
4482     if (prepend_runtime)
4483         save_runtime_to_filehandle(file, runtime_bytes, runtime_size);
4484
4485     /* The dumper doesn't know that pages need to be zeroed before use. */
4486     zero_all_free_pages();
4487     save_to_filehandle(file, filename, SymbolValue(RESTART_LISP_FUNCTION,0),
4488                        prepend_runtime, save_runtime_options,
4489                        compressed ? compression_level : COMPRESSION_LEVEL_NONE);
4490     /* Oops. Save still managed to fail. Since we've mangled the stack
4491      * beyond hope, there's not much we can do.
4492      * (beyond FUNCALLing RESTART_LISP_FUNCTION, but I suspect that's
4493      * going to be rather unsatisfactory too... */
4494     lose("Attempt to save core after non-conservative GC failed.\n");
4495 }