mono/metadata/sgen-descriptor.h

   1 /*
   2  * Copyright 2001-2003 Ximian, Inc
   3  * Copyright 2003-2010 Novell, Inc.
   4  * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining
   7  * a copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sublicense, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be
  15  * included in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  20  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  21  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  22  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  23  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25 #ifndef __MONO_SGEN_DESCRIPTOR_H__
  26 #define __MONO_SGEN_DESCRIPTOR_H__
  27
  28 #include <mono/metadata/gc-internal.h>
  29 #include <mono/metadata/sgen-conf.h>
  30
  31
  32 /*
  33  * ######################################################################
  34  * ########  GC descriptors
  35  * ######################################################################
  36  * Used to quickly get the info the GC needs about an object: size and
  37  * where the references are held.
  38  */
  39 #define OBJECT_HEADER_WORDS (sizeof(MonoObject)/sizeof(gpointer))
  40 #define LOW_TYPE_BITS 3
  41 #define MAX_RUNLEN_OBJECT_SIZE 0xFFFF
  42 #define SMALL_BITMAP_SHIFT 16
  43 #define SMALL_BITMAP_SIZE (GC_BITS_PER_WORD - SMALL_BITMAP_SHIFT)
  44 #define VECTOR_INFO_SHIFT 14
  45 #define VECTOR_KIND_SHIFT 13
  46 #define VECTOR_ELSIZE_SHIFT 3
  47 #define LARGE_BITMAP_SIZE (GC_BITS_PER_WORD - LOW_TYPE_BITS)
  48 #define MAX_ELEMENT_SIZE 0x3ff
  49 #define VECTOR_SUBTYPE_PTRFREE (DESC_TYPE_V_PTRFREE << VECTOR_INFO_SHIFT)
  50 #define VECTOR_SUBTYPE_REFS    (DESC_TYPE_V_REFS << VECTOR_INFO_SHIFT)
  51 #define VECTOR_SUBTYPE_RUN_LEN (DESC_TYPE_V_RUN_LEN << VECTOR_INFO_SHIFT)
  52 #define VECTOR_SUBTYPE_BITMAP  (DESC_TYPE_V_BITMAP << VECTOR_INFO_SHIFT)
  53
  54 #define VECTOR_KIND_SZARRAY  (DESC_TYPE_V_SZARRAY << VECTOR_KIND_SHIFT)
  55 #define VECTOR_KIND_ARRAY  (DESC_TYPE_V_ARRAY << VECTOR_KIND_SHIFT)
  56
  57 /* objects are aligned to 8 bytes boundaries
  58  * A descriptor is a pointer in MonoVTable, so 32 or 64 bits of size.
  59  * The low 3 bits define the type of the descriptor. The other bits
  60  * depend on the type.
  61  * As a general rule the 13 remaining low bits define the size, either
  62  * of the whole object or of the elements in the arrays. While for objects
  63  * the size is already in bytes, for arrays we need to shift, because
  64  * array elements might be smaller than 8 bytes. In case of arrays, we
  65  * use two bits to describe what the additional high bits represents,
  66  * so the default behaviour can handle element sizes less than 2048 bytes.
  67  * The high 16 bits, if 0 it means the object is pointer-free.
  68  * This design should make it easy and fast to skip over ptr-free data.
  69  * The first 4 types should cover >95% of the objects.
  70  * Note that since the size of objects is limited to 64K, larger objects
  71  * will be allocated in the large object heap.
  72  * If we want 4-bytes alignment, we need to put vector and small bitmap
  73  * inside complex.
  74  */
  75 enum {
  76         /*
  77          * We don't use 0 so that 0 isn't a valid GC descriptor.  No
  78          * deep reason for this other than to be able to identify a
  79          * non-inited descriptor for debugging.
  80          *
  81          * If an object contains no references, its GC descriptor is
  82          * always DESC_TYPE_RUN_LENGTH, without a size, no exceptions.
  83          * This is so that we can quickly check for that in
  84          * copy_object_no_checks(), without having to fetch the
  85          * object's class.
  86          */
  87         DESC_TYPE_RUN_LENGTH = 1, /* 16 bits aligned byte size | 1-3 (offset, numptr) bytes tuples */
  88         DESC_TYPE_SMALL_BITMAP,   /* 16 bits aligned byte size | 16-48 bit bitmap */
  89         DESC_TYPE_COMPLEX,      /* index for bitmap into complex_descriptors */
  90         DESC_TYPE_VECTOR,       /* 10 bits element size | 1 bit kind | 2 bits desc | element desc */
  91         DESC_TYPE_LARGE_BITMAP, /* | 29-61 bitmap bits */
  92         DESC_TYPE_COMPLEX_ARR,  /* index for bitmap into complex_descriptors */
  93         DESC_TYPE_COMPLEX_PTRFREE, /*Nothing, used to encode large ptr objects. */
  94         /* values for array kind */
  95         DESC_TYPE_V_SZARRAY = 0, /*vector with no bounds data */
  96         DESC_TYPE_V_ARRAY = 1, /* array with bounds data */
  97         /* subtypes for arrays and vectors */
  98         DESC_TYPE_V_PTRFREE = 0,/* there are no refs: keep first so it has a zero value  */
  99         DESC_TYPE_V_REFS,       /* all the array elements are refs */
 100         DESC_TYPE_V_RUN_LEN,    /* elements are run-length encoded as DESC_TYPE_RUN_LENGTH */
 101         DESC_TYPE_V_BITMAP      /* elements are as the bitmap in DESC_TYPE_SMALL_BITMAP */
 102 };
 103
 104 /* Root bitmap descriptors are simpler: the lower three bits describe the type
 105  * and we either have 30/62 bitmap bits or nibble-based run-length,
 106  * or a complex descriptor, or a user defined marker function.
 107  */
 108 enum {
 109         ROOT_DESC_CONSERVATIVE, /* 0, so matches NULL value */
 110         ROOT_DESC_BITMAP,
 111         ROOT_DESC_RUN_LEN,
 112         ROOT_DESC_COMPLEX,
 113         ROOT_DESC_USER,
 114         ROOT_DESC_TYPE_MASK = 0x7,
 115         ROOT_DESC_TYPE_SHIFT = 3,
 116 };
 117
 118 gsize* sgen_get_complex_descriptor (mword desc) MONO_INTERNAL;
 119 void* sgen_get_complex_descriptor_bitmap (mword desc) MONO_INTERNAL;
 120 MonoGCRootMarkFunc sgen_get_user_descriptor_func (mword desc) MONO_INTERNAL;
 121
 122
 123 static inline gboolean
 124 sgen_gc_descr_has_references (mword desc)
 125 {
 126         /*Both string and fixed size objects are encoded using a zero run RUN_LEN*/
 127         if ((desc & 0xffff0007) == DESC_TYPE_RUN_LENGTH)
 128                 return FALSE;
 129
 130         /*The array is ptr-free*/
 131         if ((desc & 0xC007) == (DESC_TYPE_VECTOR | VECTOR_SUBTYPE_PTRFREE))
 132                 return FALSE;
 133
 134         if ((desc & 0x7) == DESC_TYPE_COMPLEX_PTRFREE)
 135                 return FALSE;
 136
 137         return TRUE;
 138 }
 139
 140 #define SGEN_VTABLE_HAS_REFERENCES(vt)  (sgen_gc_descr_has_references ((mword)((MonoVTable*)(vt))->gc_descr))
 141 #define SGEN_CLASS_HAS_REFERENCES(c)    (sgen_gc_descr_has_references ((mword)(c)->gc_descr))
 142
 143 /* helper macros to scan and traverse objects, macros because we resue them in many functions */
 144 #define OBJ_RUN_LEN_SIZE(size,desc,obj) do { \
 145                 (size) = ((desc) & 0xfff8);     \
 146     } while (0)
 147
 148 #define OBJ_BITMAP_SIZE(size,desc,obj) do { \
 149                 (size) = ((desc) & 0xfff8);     \
 150     } while (0)
 151
 152 #ifdef __GNUC__
 153 #define PREFETCH(addr)  __builtin_prefetch ((addr))
 154 #else
 155 #define PREFETCH(addr)
 156 #endif
 157
 158 /* code using these macros must define a HANDLE_PTR(ptr) macro that does the work */
 159 #define OBJ_RUN_LEN_FOREACH_PTR(desc,obj)       do {    \
 160                 if ((desc) & 0xffff0000) {      \
 161                         /* there are pointers */        \
 162                         void **_objptr_end;     \
 163                         void **_objptr = (void**)(obj); \
 164                         _objptr += ((desc) >> 16) & 0xff;       \
 165                         _objptr_end = _objptr + (((desc) >> 24) & 0xff);        \
 166                         HANDLE_PTR (_objptr, (obj)); \
 167                         _objptr ++; \
 168                         while (_objptr < _objptr_end) { \
 169                                 HANDLE_PTR (_objptr, (obj));    \
 170                                 _objptr++;      \
 171                         }       \
 172                 }       \
 173         } while (0)
 174
 175 #ifdef __GNUC__
 176 #define OBJ_BITMAP_FOREACH_PTR(desc,obj)       do {    \
 177                 /* there are pointers */        \
 178                 void **_objptr = (void**)(obj); \
 179                 gsize _bmap = (desc) >> 16;     \
 180                 _objptr += OBJECT_HEADER_WORDS; \
 181                 { \
 182                         int _index = __builtin_ctz (_bmap); \
 183                         _objptr += _index; \
 184                         _bmap >>= (_index + 1);                         \
 185                         HANDLE_PTR (_objptr, (obj));            \
 186                         _objptr ++;                                                     \
 187                         } \
 188                 while (_bmap) { \
 189                         int _index = __builtin_ctz (_bmap); \
 190                         _objptr += _index; \
 191                         _bmap >>= (_index + 1);                         \
 192                         HANDLE_PTR (_objptr, (obj));            \
 193                         _objptr ++;                                                     \
 194                 }                                                                               \
 195         } while (0)
 196 #else
 197 #define OBJ_BITMAP_FOREACH_PTR(desc,obj)       do {    \
 198                 /* there are pointers */        \
 199                 void **_objptr = (void**)(obj); \
 200                 gsize _bmap = (desc) >> 16;     \
 201                 _objptr += OBJECT_HEADER_WORDS; \
 202                 while (_bmap) {                                            \
 203                         if ((_bmap & 1)) {                                                                 \
 204                                 HANDLE_PTR (_objptr, (obj));                               \
 205                         }                                                                                                  \
 206                         _bmap >>= 1;                                                                       \
 207                         ++_objptr;                                                                                 \
 208                 }                                                                                                          \
 209         } while (0)
 210 #endif
 211
 212 /* a bitmap desc means that there are pointer references or we'd have
 213  * choosen run-length, instead: add an assert to check.
 214  */
 215 #define OBJ_LARGE_BITMAP_FOREACH_PTR(desc,obj)  do {    \
 216                 /* there are pointers */        \
 217                 void **_objptr = (void**)(obj); \
 218                 gsize _bmap = (desc) >> LOW_TYPE_BITS;  \
 219                 _objptr += OBJECT_HEADER_WORDS; \
 220                 while (_bmap) { \
 221                         if ((_bmap & 1)) {      \
 222                                 HANDLE_PTR (_objptr, (obj));    \
 223                         }       \
 224                         _bmap >>= 1;    \
 225                         ++_objptr;      \
 226                 }       \
 227         } while (0)
 228
 229 #define OBJ_COMPLEX_FOREACH_PTR(vt,obj) do {    \
 230                 /* there are pointers */        \
 231                 void **_objptr = (void**)(obj); \
 232                 gsize *bitmap_data = sgen_get_complex_descriptor ((desc)); \
 233                 int bwords = (*bitmap_data) - 1;        \
 234                 void **start_run = _objptr;     \
 235                 bitmap_data++;  \
 236                 if (0) {        \
 237                         MonoObject *myobj = (MonoObject*)obj;   \
 238                         g_print ("found %d at %p (0x%zx): %s.%s\n", bwords, (obj), (desc), myobj->vtable->klass->name_space, myobj->vtable->klass->name); \
 239                 }       \
 240                 while (bwords-- > 0) {  \
 241                         gsize _bmap = *bitmap_data++;   \
 242                         _objptr = start_run;    \
 243                         /*g_print ("bitmap: 0x%x/%d at %p\n", _bmap, bwords, _objptr);*/        \
 244                         while (_bmap) { \
 245                                 if ((_bmap & 1)) {      \
 246                                         HANDLE_PTR (_objptr, (obj));    \
 247                                 }       \
 248                                 _bmap >>= 1;    \
 249                                 ++_objptr;      \
 250                         }       \
 251                         start_run += GC_BITS_PER_WORD;  \
 252                 }       \
 253         } while (0)
 254
 255 /* this one is untested */
 256 #define OBJ_COMPLEX_ARR_FOREACH_PTR(vt,obj)     do {    \
 257                 /* there are pointers */        \
 258                 gsize *mbitmap_data = sgen_get_complex_descriptor ((vt)->desc); \
 259                 int mbwords = (*mbitmap_data++) - 1;    \
 260                 int el_size = mono_array_element_size (vt->klass);      \
 261                 char *e_start = (char*)(obj) +  G_STRUCT_OFFSET (MonoArray, vector);    \
 262                 char *e_end = e_start + el_size * mono_array_length_fast ((MonoArray*)(obj));   \
 263                 if (0)                                                  \
 264                         g_print ("found %d at %p (0x%zx): %s.%s\n", mbwords, (obj), (vt)->desc, vt->klass->name_space, vt->klass->name); \
 265                 while (e_start < e_end) {       \
 266                         void **_objptr = (void**)e_start;       \
 267                         gsize *bitmap_data = mbitmap_data;      \
 268                         unsigned int bwords = mbwords;  \
 269                         while (bwords-- > 0) {  \
 270                                 gsize _bmap = *bitmap_data++;   \
 271                                 void **start_run = _objptr;     \
 272                                 /*g_print ("bitmap: 0x%x\n", _bmap);*/  \
 273                                 while (_bmap) { \
 274                                         if ((_bmap & 1)) {      \
 275                                                 HANDLE_PTR (_objptr, (obj));    \
 276                                         }       \
 277                                         _bmap >>= 1;    \
 278                                         ++_objptr;      \
 279                                 }       \
 280                                 _objptr = start_run + GC_BITS_PER_WORD; \
 281                         }       \
 282                         e_start += el_size;     \
 283                 }       \
 284         } while (0)
 285
 286 #define OBJ_VECTOR_FOREACH_PTR(desc,obj)        do {    \
 287                 /* note: 0xffffc000 excludes DESC_TYPE_V_PTRFREE */     \
 288                 if ((desc) & 0xffffc000) {                              \
 289                         int el_size = ((desc) >> 3) & MAX_ELEMENT_SIZE; \
 290                         /* there are pointers */        \
 291                         int etype = (desc) & 0xc000;                    \
 292                         if (etype == (DESC_TYPE_V_REFS << 14)) {        \
 293                                 void **p = (void**)((char*)(obj) + G_STRUCT_OFFSET (MonoArray, vector));        \
 294                                 void **end_refs = (void**)((char*)p + el_size * mono_array_length_fast ((MonoArray*)(obj)));    \
 295                                 /* Note: this code can handle also arrays of struct with only references in them */     \
 296                                 while (p < end_refs) {  \
 297                                         HANDLE_PTR (p, (obj));  \
 298                                         ++p;    \
 299                                 }       \
 300                         } else if (etype == DESC_TYPE_V_RUN_LEN << 14) {        \
 301                                 int offset = ((desc) >> 16) & 0xff;     \
 302                                 int num_refs = ((desc) >> 24) & 0xff;   \
 303                                 char *e_start = (char*)(obj) + G_STRUCT_OFFSET (MonoArray, vector);     \
 304                                 char *e_end = e_start + el_size * mono_array_length_fast ((MonoArray*)(obj));   \
 305                                 while (e_start < e_end) {       \
 306                                         void **p = (void**)e_start;     \
 307                                         int i;  \
 308                                         p += offset;    \
 309                                         for (i = 0; i < num_refs; ++i) {        \
 310                                                 HANDLE_PTR (p + i, (obj));      \
 311                                         }       \
 312                                         e_start += el_size;     \
 313                                 }       \
 314                         } else if (etype == DESC_TYPE_V_BITMAP << 14) { \
 315                                 char *e_start = (char*)(obj) +  G_STRUCT_OFFSET (MonoArray, vector);    \
 316                                 char *e_end = e_start + el_size * mono_array_length_fast ((MonoArray*)(obj));   \
 317                                 while (e_start < e_end) {       \
 318                                         void **p = (void**)e_start;     \
 319                                         gsize _bmap = (desc) >> 16;     \
 320                                         /* Note: there is no object header here to skip */      \
 321                                         while (_bmap) { \
 322                                                 if ((_bmap & 1)) {      \
 323                                                         HANDLE_PTR (p, (obj));  \
 324                                                 }       \
 325                                                 _bmap >>= 1;    \
 326                                                 ++p;    \
 327                                         }       \
 328                                         e_start += el_size;     \
 329                                 }       \
 330                         }       \
 331                 }       \
 332         } while (0)
 333
 334
 335 #endif