src/runtime/gc-internal.h

   1 /*
   2  * garbage collection - shared definitions for modules "inside" the GC system
   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 #ifndef _GC_INTERNAL_H_
  17 #define _GC_INTERNAL_H_
  18
  19 #include <genesis/simple-fun.h>
  20 #include "thread.h"
  21 #include "interr.h"
  22
  23 #ifdef LISP_FEATURE_GENCGC
  24 #include "gencgc-internal.h"
  25 #else
  26 #include "cheneygc-internal.h"
  27 #endif
  28
  29 /* disabling gc assertions made no discernable difference to GC speed,
  30  * last I tried it - dan 2003.12.21
  31  *
  32  * And it's unsafe to do so while things like gc_assert(0 ==
  33  * thread_mutex_lock(&allocation_lock)) exist. - MG 2009-01-13
  34  */
  35 #if 1
  36 # define gc_assert(ex)                                                 \
  37 do {                                                                   \
  38     if (!(ex)) gc_abort();                                             \
  39 } while (0)
  40 # define gc_assert_verbose(ex, fmt, ...)                               \
  41 do {                                                                   \
  42     if (!(ex)) {                                                       \
  43         fprintf(stderr, fmt, ## __VA_ARGS__);                          \
  44         gc_abort();                                                    \
  45     }                                                                  \
  46 } while (0)
  47 #else
  48 # define gc_assert(ex)
  49 # define gc_assert_verbose(ex, fmt, ...)
  50 #endif
  51
  52 #define gc_abort()                                                     \
  53   lose("GC invariant lost, file \"%s\", line %d\n", __FILE__, __LINE__)
  54
  55 #define CEILING(x,y) (((x) + ((y) - 1)) & (~((y) - 1)))
  56
  57 static inline uword_t
  58 NWORDS(uword_t x, uword_t n_bits)
  59 {
  60     /* A good compiler should be able to constant-fold this whole thing,
  61        even with the conditional. */
  62     if(n_bits <= N_WORD_BITS) {
  63         uword_t elements_per_word = N_WORD_BITS/n_bits;
  64
  65         return CEILING(x, elements_per_word)/elements_per_word;
  66     }
  67     else {
  68         /* FIXME: should have some sort of assertion that N_WORD_BITS
  69            evenly divides n_bits */
  70         return x * (n_bits/N_WORD_BITS);
  71     }
  72 }
  73
  74 /* FIXME: Shouldn't this be defined in sbcl.h? */
  75
  76 #if defined(LISP_FEATURE_SPARC) || defined(LISP_FEATURE_ARM)
  77 #define FUN_RAW_ADDR_OFFSET 0
  78 #else
  79 #define FUN_RAW_ADDR_OFFSET (offsetof(struct simple_fun, code) - FUN_POINTER_LOWTAG)
  80 #endif
  81
  82 #define SIMPLE_FUN_SCAV_START(fun_ptr) &fun_ptr->name
  83 #define SIMPLE_FUN_SCAV_NWORDS(fun_ptr) ((lispobj*)fun_ptr->code - &fun_ptr->name)
  84
  85 /* values for the *_alloc_* parameters, also see the commentary for
  86  * struct page in gencgc-internal.h.  FIXME: Perhaps these constants
  87  * should be there, or at least defined on gencgc only? */
  88 #define FREE_PAGE_FLAG 0
  89 #define BOXED_PAGE_FLAG 1
  90 #define UNBOXED_PAGE_FLAG 2
  91 #define OPEN_REGION_PAGE_FLAG 4
  92 #define CODE_PAGE_FLAG        (BOXED_PAGE_FLAG|UNBOXED_PAGE_FLAG)
  93
  94 #define ALLOC_BOXED 0
  95 #define ALLOC_UNBOXED 1
  96 #define ALLOC_QUICK 1
  97
  98 #ifdef LISP_FEATURE_GENCGC
  99 #include "gencgc-alloc-region.h"
 100 void *
 101 gc_alloc_with_region(sword_t nbytes,int page_type_flag, struct alloc_region *my_region,
 102                      int quick_p);
 103 static inline void *
 104 gc_general_alloc(sword_t nbytes, int page_type_flag, int quick_p)
 105 {
 106     struct alloc_region *my_region;
 107     if (UNBOXED_PAGE_FLAG == page_type_flag) {
 108         my_region = &unboxed_region;
 109     } else if (BOXED_PAGE_FLAG & page_type_flag) {
 110         my_region = &boxed_region;
 111     } else {
 112         lose("bad page type flag: %d", page_type_flag);
 113     }
 114     return gc_alloc_with_region(nbytes, page_type_flag, my_region, quick_p);
 115 }
 116 #else
 117 extern void *gc_general_alloc(word_t nbytes,int page_type_flag,int quick_p);
 118 #endif
 119
 120 static inline lispobj
 121 gc_general_copy_object(lispobj object, long nwords, int page_type_flag)
 122 {
 123     lispobj *new;
 124
 125     gc_assert(is_lisp_pointer(object));
 126     gc_assert(from_space_p(object));
 127     gc_assert((nwords & 0x01) == 0);
 128
 129     /* Allocate space. */
 130     new = gc_general_alloc(nwords*N_WORD_BYTES, page_type_flag, ALLOC_QUICK);
 131
 132     /* Copy the object. */
 133     memcpy(new,native_pointer(object),nwords*N_WORD_BYTES);
 134
 135     return make_lispobj(new, lowtag_of(object));
 136 }
 137
 138 extern sword_t (*scavtab[256])(lispobj *where, lispobj object);
 139 extern lispobj (*transother[256])(lispobj object);
 140 extern sword_t (*sizetab[256])(lispobj *where);
 141
 142 extern struct weak_pointer *weak_pointers; /* in gc-common.c */
 143 extern struct hash_table *weak_hash_tables; /* in gc-common.c */
 144
 145 extern void scavenge(lispobj *start, sword_t n_words);
 146 extern void scavenge_interrupt_contexts(struct thread *thread);
 147 extern void scav_weak_hash_tables(void);
 148 extern void scan_weak_hash_tables(void);
 149 extern void scan_weak_pointers(void);
 150
 151 lispobj  copy_large_unboxed_object(lispobj object, sword_t nwords);
 152 lispobj  copy_unboxed_object(lispobj object, sword_t nwords);
 153 lispobj  copy_large_object(lispobj object, sword_t nwords);
 154 lispobj  copy_object(lispobj object, sword_t nwords);
 155 lispobj  copy_code_object(lispobj object, sword_t nwords);
 156
 157 lispobj *search_read_only_space(void *pointer);
 158 lispobj *search_static_space(void *pointer);
 159 lispobj *search_dynamic_space(void *pointer);
 160
 161 lispobj *gc_search_space(lispobj *start, size_t words, lispobj *pointer);
 162
 163 extern int looks_like_valid_lisp_pointer_p(lispobj pointer, lispobj *start_addr);
 164
 165 extern void scavenge_control_stack(struct thread *th);
 166 extern void scrub_control_stack(void);
 167 extern void scrub_thread_control_stack(struct thread *);
 168
 169 #include "fixnump.h"
 170
 171 #ifdef LISP_FEATURE_GENCGC
 172 #include "gencgc-internal.h"
 173 #else
 174 #include "cheneygc-internal.h"
 175 #endif
 176
 177 #if N_WORD_BITS == 32
 178 # define SIMPLE_ARRAY_WORD_WIDETAG SIMPLE_ARRAY_UNSIGNED_BYTE_32_WIDETAG
 179 #elif N_WORD_BITS == 64
 180 # define SIMPLE_ARRAY_WORD_WIDETAG SIMPLE_ARRAY_UNSIGNED_BYTE_64_WIDETAG
 181 #endif
 182
 183 extern void
 184 instance_scan_interleaved(void (*proc)(),
 185                           lispobj *instance_ptr,
 186                           sword_t n_words,
 187                           lispobj *layout_obj);
 188
 189 #endif /* _GC_INTERNAL_H_ */