mono/metadata/sgen-gc.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_SGENGC_H__
  26 #define __MONO_SGENGC_H__
  27
  28 /* pthread impl */
  29 #include "config.h"
  30
  31 #ifdef HAVE_SGEN_GC
  32
  33 typedef struct _SgenThreadInfo SgenThreadInfo;
  34 #define THREAD_INFO_TYPE SgenThreadInfo
  35
  36 #include <glib.h>
  37 #ifdef HAVE_PTHREAD_H
  38 #include <pthread.h>
  39 #endif
  40 #include <signal.h>
  41 #include <mono/utils/mono-compiler.h>
  42 #include <mono/utils/mono-threads.h>
  43 #include <mono/utils/dtrace.h>
  44 #include <mono/io-layer/mono-mutex.h>
  45 #include <mono/metadata/class-internals.h>
  46 #include <mono/metadata/object-internals.h>
  47 #include <mono/metadata/sgen-conf.h>
  48 #include <mono/metadata/sgen-archdep.h>
  49 #include <mono/metadata/sgen-descriptor.h>
  50 #include <mono/metadata/sgen-gray.h>
  51 #include <mono/metadata/sgen-hash-table.h>
  52
  53 /* The method used to clear the nursery */
  54 /* Clearing at nursery collections is the safest, but has bad interactions with caches.
  55  * Clearing at TLAB creation is much faster, but more complex and it might expose hard
  56  * to find bugs.
  57  */
  58 typedef enum {
  59         CLEAR_AT_GC,
  60         CLEAR_AT_TLAB_CREATION
  61 } NurseryClearPolicy;
  62
  63 NurseryClearPolicy sgen_get_nursery_clear_policy (void) MONO_INTERNAL;
  64
  65 #define SGEN_TV_DECLARE(name) gint64 name
  66 #define SGEN_TV_GETTIME(tv) tv = mono_100ns_ticks ()
  67 #define SGEN_TV_ELAPSED(start,end) (int)((end-start) / 10)
  68 #define SGEN_TV_ELAPSED_MS(start,end) ((SGEN_TV_ELAPSED((start),(end)) + 500) / 1000)
  69
  70 /* for use with write barriers */
  71 typedef struct _RememberedSet RememberedSet;
  72 struct _RememberedSet {
  73         mword *store_next;
  74         mword *end_set;
  75         RememberedSet *next;
  76         mword data [MONO_ZERO_LEN_ARRAY];
  77 };
  78
  79 /*
  80  * We're never actually using the first element.  It's always set to
  81  * NULL to simplify the elimination of consecutive duplicate
  82  * entries.
  83  */
  84 #define STORE_REMSET_BUFFER_SIZE        1023
  85
  86 typedef struct _GenericStoreRememberedSet GenericStoreRememberedSet;
  87 struct _GenericStoreRememberedSet {
  88         GenericStoreRememberedSet *next;
  89         /* We need one entry less because the first entry of store
  90            remset buffers is always a dummy and we don't copy it. */
  91         gpointer data [STORE_REMSET_BUFFER_SIZE - 1];
  92 };
  93
  94 /* we have 4 possible values in the low 2 bits */
  95 enum {
  96         REMSET_LOCATION, /* just a pointer to the exact location */
  97         REMSET_RANGE,    /* range of pointer fields */
  98         REMSET_OBJECT,   /* mark all the object for scanning */
  99         REMSET_VTYPE,    /* a valuetype array described by a gc descriptor, a count and a size */
 100         REMSET_TYPE_MASK = 0x3
 101 };
 102
 103 /* eventually share with MonoThread? */
 104 /*
 105  * This structure extends the MonoThreadInfo structure.
 106  */
 107 struct _SgenThreadInfo {
 108         MonoThreadInfo info;
 109         int skip;
 110         volatile int in_critical_region;
 111         gboolean joined_stw;
 112         gboolean doing_handshake;
 113         gboolean thread_is_dying;
 114         gboolean gc_disabled;
 115         void *stack_end;
 116         void *stack_start;
 117         void *stack_start_limit;
 118         char **tlab_next_addr;
 119         char **tlab_start_addr;
 120         char **tlab_temp_end_addr;
 121         char **tlab_real_end_addr;
 122         gpointer **store_remset_buffer_addr;
 123         long *store_remset_buffer_index_addr;
 124         RememberedSet *remset;
 125         gpointer runtime_data;
 126
 127         /* Only used on POSIX platforms */
 128         int signal;
 129         /* Ditto */
 130         unsigned int stop_count; /* to catch duplicate signals */
 131
 132         gpointer stopped_ip;    /* only valid if the thread is stopped */
 133         MonoDomain *stopped_domain; /* ditto */
 134
 135 #ifdef USE_MONO_CTX
 136         MonoContext ctx;                /* ditto */
 137 #else
 138         gpointer regs[ARCH_NUM_REGS];       /* ditto */
 139 #endif
 140
 141 #ifndef HAVE_KW_THREAD
 142         char *tlab_start;
 143         char *tlab_next;
 144         char *tlab_temp_end;
 145         char *tlab_real_end;
 146         gpointer *store_remset_buffer;
 147         long store_remset_buffer_index;
 148 #endif
 149 };
 150
 151 enum {
 152         MEMORY_ROLE_GEN0,
 153         MEMORY_ROLE_GEN1,
 154         MEMORY_ROLE_PINNED
 155 };
 156
 157 typedef struct _SgenBlock SgenBlock;
 158 struct _SgenBlock {
 159         void *next;
 160         unsigned char role;
 161 };
 162
 163 /*
 164  * The nursery section and the major copying collector's sections use
 165  * this struct.
 166  */
 167 typedef struct _GCMemSection GCMemSection;
 168 struct _GCMemSection {
 169         SgenBlock block;
 170         char *data;
 171         mword size;
 172         /* pointer where more data could be allocated if it fits */
 173         char *next_data;
 174         char *end_data;
 175         /*
 176          * scan starts is an array of pointers to objects equally spaced in the allocation area
 177          * They let use quickly find pinned objects from pinning pointers.
 178          */
 179         char **scan_starts;
 180         /* in major collections indexes in the pin_queue for objects that pin this section */
 181         void **pin_queue_start;
 182         int pin_queue_num_entries;
 183         unsigned short num_scan_start;
 184         gboolean is_to_space;
 185 };
 186
 187 #define SGEN_PINNED_CHUNK_FOR_PTR(o)    ((SgenBlock*)(((mword)(o)) & ~(SGEN_PINNED_CHUNK_SIZE - 1)))
 188
 189 typedef struct _SgenPinnedChunk SgenPinnedChunk;
 190
 191 /*
 192  * Recursion is not allowed for the thread lock.
 193  */
 194 #define LOCK_DECLARE(name) mono_mutex_t name
 195 /* if changing LOCK_INIT to something that isn't idempotent, look at
 196    its use in mono_gc_base_init in sgen-gc.c */
 197 #define LOCK_INIT(name) mono_mutex_init (&(name), NULL)
 198 #define LOCK_GC do {                                            \
 199                 mono_mutex_lock (&gc_mutex);                    \
 200                 MONO_GC_LOCKED ();                              \
 201         } while (0)
 202 #define TRYLOCK_GC (mono_mutex_trylock (&gc_mutex) == 0)
 203 #define UNLOCK_GC do {                                          \
 204                 mono_mutex_unlock (&gc_mutex);                  \
 205                 MONO_GC_UNLOCKED ();                            \
 206         } while (0)
 207
 208 extern LOCK_DECLARE (sgen_interruption_mutex);
 209
 210 #define LOCK_INTERRUPTION mono_mutex_lock (&sgen_interruption_mutex)
 211 #define UNLOCK_INTERRUPTION mono_mutex_unlock (&sgen_interruption_mutex)
 212
 213 /* FIXME: Use InterlockedAdd & InterlockedAdd64 to reduce the CAS cost. */
 214 #define SGEN_CAS_PTR    InterlockedCompareExchangePointer
 215 #define SGEN_ATOMIC_ADD(x,i)    do {                                    \
 216                 int __old_x;                                            \
 217                 do {                                                    \
 218                         __old_x = (x);                                  \
 219                 } while (InterlockedCompareExchange (&(x), __old_x + (i), __old_x) != __old_x); \
 220         } while (0)
 221 #define SGEN_ATOMIC_ADD_P(x,i) do { \
 222                 size_t __old_x;                                            \
 223                 do {                                                    \
 224                         __old_x = (x);                                  \
 225                 } while (InterlockedCompareExchangePointer ((void**)&(x), (void*)(__old_x + (i)), (void*)__old_x) != (void*)__old_x); \
 226         } while (0)
 227
 228
 229 #ifndef HOST_WIN32
 230 /* we intercept pthread_create calls to know which threads exist */
 231 #define USE_PTHREAD_INTERCEPT 1
 232 #endif
 233
 234 #ifdef HEAVY_STATISTICS
 235 #define HEAVY_STAT(x)   x
 236
 237 extern long long stat_objects_alloced_degraded;
 238 extern long long stat_bytes_alloced_degraded;
 239 extern long long stat_copy_object_called_major;
 240 extern long long stat_objects_copied_major;
 241 #else
 242 #define HEAVY_STAT(x)
 243 #endif
 244
 245 #define SGEN_ASSERT(level, a, ...) do { \
 246         if (G_UNLIKELY ((level) <= SGEN_MAX_ASSERT_LEVEL && !(a))) {    \
 247                 g_error (__VA_ARGS__);  \
 248 } } while (0)
 249
 250
 251 #define SGEN_LOG(level, format, ...) do {      \
 252         if (G_UNLIKELY ((level) <= SGEN_MAX_DEBUG_LEVEL && (level) <= gc_debug_level)) {        \
 253                 fprintf (gc_debug_file, format "\n", ##__VA_ARGS__); fflush (gc_debug_file);    \
 254 } } while (0)
 255
 256 #define SGEN_COND_LOG(level, cond, format, ...) do {    \
 257         if (G_UNLIKELY ((level) <= SGEN_MAX_DEBUG_LEVEL && (level) <= gc_debug_level)) {        \
 258                 if (cond)       \
 259                         fprintf (gc_debug_file, format "\n", ##__VA_ARGS__); fflush (gc_debug_file);    \
 260 } } while (0)
 261
 262 #define SGEN_LOG_DO(level, fun) do {    \
 263         if (G_UNLIKELY ((level) <= SGEN_MAX_DEBUG_LEVEL && (level) <= gc_debug_level)) {        \
 264                 fun;    \
 265 } } while (0)
 266
 267 extern int gc_debug_level;
 268 extern FILE* gc_debug_file;
 269
 270 extern int current_collection_generation;
 271
 272 extern unsigned int sgen_global_stop_count;
 273
 274 extern gboolean bridge_processing_in_progress;
 275
 276 extern int num_ready_finalizers;
 277
 278 #define SGEN_ALLOC_ALIGN                8
 279 #define SGEN_ALLOC_ALIGN_BITS   3
 280
 281 #define SGEN_ALIGN_UP(s)                (((s)+(SGEN_ALLOC_ALIGN-1)) & ~(SGEN_ALLOC_ALIGN-1))
 282
 283 /*
 284  * The link pointer is hidden by negating each bit.  We use the lowest
 285  * bit of the link (before negation) to store whether it needs
 286  * resurrection tracking.
 287  */
 288 #define HIDE_POINTER(p,t)       ((gpointer)(~((gulong)(p)|((t)?1:0))))
 289 #define REVEAL_POINTER(p)       ((gpointer)((~(gulong)(p))&~3L))
 290
 291 #ifdef SGEN_ALIGN_NURSERY
 292 #define SGEN_PTR_IN_NURSERY(p,bits,start,end)   (((mword)(p) & ~((1 << (bits)) - 1)) == (mword)(start))
 293 #else
 294 #define SGEN_PTR_IN_NURSERY(p,bits,start,end)   ((char*)(p) >= (start) && (char*)(p) < (end))
 295 #endif
 296
 297 #ifdef USER_CONFIG
 298
 299 /* good sizes are 512KB-1MB: larger ones increase a lot memzeroing time */
 300 #define DEFAULT_NURSERY_SIZE (sgen_nursery_size)
 301 extern int sgen_nursery_size MONO_INTERNAL;
 302 #ifdef SGEN_ALIGN_NURSERY
 303 /* The number of trailing 0 bits in DEFAULT_NURSERY_SIZE */
 304 #define DEFAULT_NURSERY_BITS (sgen_nursery_bits)
 305 extern int sgen_nursery_bits MONO_INTERNAL;
 306 #endif
 307
 308 #else
 309
 310 #define DEFAULT_NURSERY_SIZE (4*1024*1024)
 311 #ifdef SGEN_ALIGN_NURSERY
 312 #define DEFAULT_NURSERY_BITS 22
 313 #endif
 314
 315 #endif
 316
 317 #ifndef SGEN_ALIGN_NURSERY
 318 #define DEFAULT_NURSERY_BITS -1
 319 #endif
 320
 321 extern char *sgen_nursery_start MONO_INTERNAL;
 322 extern char *sgen_nursery_end MONO_INTERNAL;
 323
 324 static inline gboolean
 325 sgen_ptr_in_nursery (void *p)
 326 {
 327         return SGEN_PTR_IN_NURSERY ((p), DEFAULT_NURSERY_BITS, sgen_nursery_start, sgen_nursery_end);
 328 }
 329
 330 static inline char*
 331 sgen_get_nursery_start (void)
 332 {
 333         return sgen_nursery_start;
 334 }
 335
 336 static inline char*
 337 sgen_get_nursery_end (void)
 338 {
 339         return sgen_nursery_end;
 340 }
 341
 342 /* Structure that corresponds to a MonoVTable: desc is a mword so requires
 343  * no cast from a pointer to an integer
 344  */
 345 typedef struct {
 346         MonoClass *klass;
 347         mword desc;
 348 } GCVTable;
 349
 350 /* these bits are set in the object vtable: we could merge them since an object can be
 351  * either pinned or forwarded but not both.
 352  * We store them in the vtable slot because the bits are used in the sync block for
 353  * other purposes: if we merge them and alloc the sync blocks aligned to 8 bytes, we can change
 354  * this and use bit 3 in the syncblock (with the lower two bits both set for forwarded, that
 355  * would be an invalid combination for the monitor and hash code).
 356  * The values are already shifted.
 357  * The forwarding address is stored in the sync block.
 358  */
 359 #define SGEN_FORWARDED_BIT 1
 360 #define SGEN_PINNED_BIT 2
 361 #define SGEN_VTABLE_BITS_MASK 0x3
 362
 363 /* returns NULL if not forwarded, or the forwarded address */
 364 #define SGEN_OBJECT_IS_FORWARDED(obj) (((mword*)(obj))[0] & SGEN_FORWARDED_BIT ? (void*)(((mword*)(obj))[0] & ~SGEN_VTABLE_BITS_MASK) : NULL)
 365 #define SGEN_OBJECT_IS_PINNED(obj) (((mword*)(obj))[0] & SGEN_PINNED_BIT)
 366
 367 /* set the forwarded address fw_addr for object obj */
 368 #define SGEN_FORWARD_OBJECT(obj,fw_addr) do {                           \
 369                 ((mword*)(obj))[0] = (mword)(fw_addr) | SGEN_FORWARDED_BIT; \
 370         } while (0)
 371 #define SGEN_PIN_OBJECT(obj) do {       \
 372                 ((mword*)(obj))[0] |= SGEN_PINNED_BIT;  \
 373         } while (0)
 374 #define SGEN_UNPIN_OBJECT(obj) do {     \
 375                 ((mword*)(obj))[0] &= ~SGEN_PINNED_BIT; \
 376         } while (0)
 377
 378 /*
 379  * Since we set bits in the vtable, use the macro to load it from the pointer to
 380  * an object that is potentially pinned.
 381  */
 382 #define SGEN_LOAD_VTABLE(addr) ((*(mword*)(addr)) & ~SGEN_VTABLE_BITS_MASK)
 383
 384 #if SGEN_MAX_DEBUG_LEVEL >= 9
 385 #define GRAY_OBJECT_ENQUEUE sgen_gray_object_enqueue
 386 #define GRAY_OBJECT_DEQUEUE(queue,o) ((o) = sgen_gray_object_dequeue ((queue)))
 387 #else
 388 #define GRAY_OBJECT_ENQUEUE(queue,o) do {                               \
 389                 if (G_UNLIKELY (!(queue)->first || (queue)->first->end == SGEN_GRAY_QUEUE_SECTION_SIZE)) \
 390                         sgen_gray_object_enqueue ((queue), (o));        \
 391                 else                                                    \
 392                         (queue)->first->objects [(queue)->first->end++] = (o); \
 393                 PREFETCH ((o));                                         \
 394         } while (0)
 395 #define GRAY_OBJECT_DEQUEUE(queue,o) do {                               \
 396                 if (!(queue)->first)                                    \
 397                         (o) = NULL;                                     \
 398                 else if (G_UNLIKELY ((queue)->first->end == 1))         \
 399                         (o) = sgen_gray_object_dequeue ((queue));               \
 400                 else                                                    \
 401                         (o) = (queue)->first->objects [--(queue)->first->end]; \
 402         } while (0)
 403 #endif
 404
 405 /*
 406 List of what each bit on of the vtable gc bits means.
 407 */
 408 enum {
 409         SGEN_GC_BIT_BRIDGE_OBJECT = 1,
 410 };
 411
 412 /* the runtime can register areas of memory as roots: we keep two lists of roots,
 413  * a pinned root set for conservatively scanned roots and a normal one for
 414  * precisely scanned roots (currently implemented as a single list).
 415  */
 416 typedef struct _RootRecord RootRecord;
 417 struct _RootRecord {
 418         char *end_root;
 419         mword root_desc;
 420 };
 421
 422 enum {
 423         ROOT_TYPE_NORMAL = 0, /* "normal" roots */
 424         ROOT_TYPE_PINNED = 1, /* roots without a GC descriptor */
 425         ROOT_TYPE_WBARRIER = 2, /* roots with a write barrier */
 426         ROOT_TYPE_NUM
 427 };
 428
 429 extern SgenHashTable roots_hash [ROOT_TYPE_NUM];
 430
 431 typedef void (*IterateObjectCallbackFunc) (char*, size_t, void*);
 432
 433 int sgen_thread_handshake (BOOL suspend) MONO_INTERNAL;
 434 gboolean sgen_suspend_thread (SgenThreadInfo *info) MONO_INTERNAL;
 435 gboolean sgen_resume_thread (SgenThreadInfo *info) MONO_INTERNAL;
 436 void sgen_wait_for_suspend_ack (int count) MONO_INTERNAL;
 437 gboolean sgen_park_current_thread_if_doing_handshake (SgenThreadInfo *p) MONO_INTERNAL;
 438 void sgen_os_init (void) MONO_INTERNAL;
 439
 440 void sgen_fill_thread_info_for_suspend (SgenThreadInfo *info) MONO_INTERNAL;
 441
 442 gboolean sgen_is_worker_thread (MonoNativeThreadId thread) MONO_INTERNAL;
 443
 444 void sgen_update_heap_boundaries (mword low, mword high) MONO_INTERNAL;
 445
 446 void sgen_scan_area_with_callback (char *start, char *end, IterateObjectCallbackFunc callback, void *data, gboolean allow_flags) MONO_INTERNAL;
 447 void sgen_check_section_scan_starts (GCMemSection *section) MONO_INTERNAL;
 448
 449 /* Keep in sync with description_for_type() in sgen-internal.c! */
 450 enum {
 451         INTERNAL_MEM_PIN_QUEUE,
 452         INTERNAL_MEM_FRAGMENT,
 453         INTERNAL_MEM_SECTION,
 454         INTERNAL_MEM_SCAN_STARTS,
 455         INTERNAL_MEM_FIN_TABLE,
 456         INTERNAL_MEM_FINALIZE_ENTRY,
 457         INTERNAL_MEM_FINALIZE_READY_ENTRY,
 458         INTERNAL_MEM_DISLINK_TABLE,
 459         INTERNAL_MEM_DISLINK,
 460         INTERNAL_MEM_ROOTS_TABLE,
 461         INTERNAL_MEM_ROOT_RECORD,
 462         INTERNAL_MEM_STATISTICS,
 463         INTERNAL_MEM_STAT_PINNED_CLASS,
 464         INTERNAL_MEM_STAT_REMSET_CLASS,
 465         INTERNAL_MEM_REMSET,
 466         INTERNAL_MEM_GRAY_QUEUE,
 467         INTERNAL_MEM_STORE_REMSET,
 468         INTERNAL_MEM_MS_TABLES,
 469         INTERNAL_MEM_MS_BLOCK_INFO,
 470         INTERNAL_MEM_EPHEMERON_LINK,
 471         INTERNAL_MEM_WORKER_DATA,
 472         INTERNAL_MEM_BRIDGE_DATA,
 473         INTERNAL_MEM_BRIDGE_HASH_TABLE,
 474         INTERNAL_MEM_BRIDGE_HASH_TABLE_ENTRY,
 475         INTERNAL_MEM_BRIDGE_ALIVE_HASH_TABLE,
 476         INTERNAL_MEM_BRIDGE_ALIVE_HASH_TABLE_ENTRY,
 477         INTERNAL_MEM_JOB_QUEUE_ENTRY,
 478         INTERNAL_MEM_TOGGLEREF_DATA,
 479         INTERNAL_MEM_MAX
 480 };
 481
 482 #define SGEN_PINNED_FREELIST_NUM_SLOTS  30
 483
 484 typedef struct {
 485         SgenPinnedChunk *chunk_list;
 486         SgenPinnedChunk *free_lists [SGEN_PINNED_FREELIST_NUM_SLOTS];
 487         void *delayed_free_lists [SGEN_PINNED_FREELIST_NUM_SLOTS];
 488 } SgenPinnedAllocator;
 489
 490 enum {
 491         GENERATION_NURSERY,
 492         GENERATION_OLD,
 493         GENERATION_MAX
 494 };
 495
 496 void sgen_init_internal_allocator (void) MONO_INTERNAL;
 497 void sgen_init_pinned_allocator (void) MONO_INTERNAL;
 498
 499 typedef struct _ObjectList ObjectList;
 500 struct _ObjectList {
 501         MonoObject *obj;
 502         ObjectList *next;
 503 };
 504
 505 void sgen_report_internal_mem_usage (void) MONO_INTERNAL;
 506 void sgen_report_pinned_mem_usage (SgenPinnedAllocator *alc) MONO_INTERNAL;
 507 void sgen_dump_internal_mem_usage (FILE *heap_dump_file) MONO_INTERNAL;
 508 void sgen_dump_section (GCMemSection *section, const char *type) MONO_INTERNAL;
 509 void sgen_dump_occupied (char *start, char *end, char *section_start) MONO_INTERNAL;
 510
 511 void sgen_register_moved_object (void *obj, void *destination) MONO_INTERNAL;
 512
 513 void sgen_register_fixed_internal_mem_type (int type, size_t size) MONO_INTERNAL;
 514
 515 void* sgen_alloc_internal (int type) MONO_INTERNAL;
 516 void sgen_free_internal (void *addr, int type) MONO_INTERNAL;
 517
 518 void* sgen_alloc_internal_dynamic (size_t size, int type, gboolean assert_on_failure) MONO_INTERNAL;
 519 void sgen_free_internal_dynamic (void *addr, size_t size, int type) MONO_INTERNAL;
 520
 521 void* sgen_alloc_pinned (SgenPinnedAllocator *allocator, size_t size) MONO_INTERNAL;
 522 void sgen_free_pinned (SgenPinnedAllocator *allocator, void *addr, size_t size) MONO_INTERNAL;
 523
 524 gboolean sgen_parse_environment_string_extract_number (const char *str, glong *out) MONO_INTERNAL;
 525
 526 void sgen_pinned_scan_objects (SgenPinnedAllocator *alc, IterateObjectCallbackFunc callback, void *callback_data) MONO_INTERNAL;
 527 void sgen_pinned_scan_pinned_objects (SgenPinnedAllocator *alc, IterateObjectCallbackFunc callback, void *callback_data) MONO_INTERNAL;
 528
 529 void sgen_pinned_update_heap_boundaries (SgenPinnedAllocator *alc) MONO_INTERNAL;
 530
 531 void** sgen_find_optimized_pin_queue_area (void *start, void *end, int *num) MONO_INTERNAL;
 532 void sgen_find_section_pin_queue_start_end (GCMemSection *section) MONO_INTERNAL;
 533 void sgen_pin_objects_in_section (GCMemSection *section, SgenGrayQueue *queue) MONO_INTERNAL;
 534
 535 void sgen_pin_stats_register_object (char *obj, size_t size);
 536 void sgen_pin_stats_register_global_remset (char *obj);
 537 void sgen_pin_stats_print_class_stats (void);
 538
 539 void sgen_sort_addresses (void **array, int size) MONO_INTERNAL;
 540 void sgen_add_to_global_remset (gpointer ptr) MONO_INTERNAL;
 541
 542 typedef void (*CopyOrMarkObjectFunc) (void**, SgenGrayQueue*);
 543 typedef void (*ScanObjectFunc) (char*, SgenGrayQueue*);
 544 typedef void (*ScanVTypeFunc) (char*, mword desc, SgenGrayQueue*);
 545
 546 int sgen_get_current_collection_generation (void) MONO_INTERNAL;
 547 gboolean sgen_collection_is_parallel (void) MONO_INTERNAL;
 548
 549 typedef struct {
 550         CopyOrMarkObjectFunc copy_or_mark_object;
 551         ScanObjectFunc scan_object;
 552         ScanVTypeFunc scan_vtype;
 553         /*FIXME add allocation function? */
 554 } SgenObjectOperations;
 555
 556 SgenObjectOperations *sgen_get_current_object_ops (void) MONO_INTERNAL;
 557
 558 typedef struct _SgenFragment SgenFragment;
 559
 560 struct _SgenFragment {
 561         SgenFragment *next;
 562         char *fragment_start;
 563         char *fragment_next; /* the current soft limit for allocation */
 564         char *fragment_end;
 565         SgenFragment *next_in_order; /* We use a different entry for all active fragments so we can avoid SMR. */
 566 };
 567
 568 typedef struct {
 569         SgenFragment *alloc_head; /* List head to be used when allocating memory. Walk with fragment_next. */
 570         SgenFragment *region_head; /* List head of the region used by this allocator. Walk with next_in_order. */
 571 } SgenFragmentAllocator;
 572
 573 void sgen_fragment_allocator_add (SgenFragmentAllocator *allocator, char *start, char *end) MONO_INTERNAL;
 574 void sgen_fragment_allocator_release (SgenFragmentAllocator *allocator) MONO_INTERNAL;
 575 void* sgen_fragment_allocator_serial_alloc (SgenFragmentAllocator *allocator, size_t size) MONO_INTERNAL;
 576 void* sgen_fragment_allocator_par_alloc (SgenFragmentAllocator *allocator, size_t size) MONO_INTERNAL;
 577 void* sgen_fragment_allocator_serial_range_alloc (SgenFragmentAllocator *allocator, size_t desired_size, size_t minimum_size, size_t *out_alloc_size) MONO_INTERNAL;
 578 void* sgen_fragment_allocator_par_range_alloc (SgenFragmentAllocator *allocator, size_t desired_size, size_t minimum_size, size_t *out_alloc_size) MONO_INTERNAL;
 579 SgenFragment* sgen_fragment_allocator_alloc (void) MONO_INTERNAL;
 580 void sgen_clear_allocator_fragments (SgenFragmentAllocator *allocator) MONO_INTERNAL;
 581 void sgen_clear_range (char *start, char *end) MONO_INTERNAL;
 582
 583
 584 /*
 585 This is a space/speed compromise as we need to make sure the from/to space check is both O(1)
 586 and only hit cache hot memory. On a 4Mb nursery it requires 1024 bytes, or 3% of your average
 587 L1 cache. On small configs with a 512kb nursery, this goes to 0.4%.
 588
 589 Experimental results on how much space we waste with a 4Mb nursery:
 590
 591 Note that the wastage applies to the half nursery, or 2Mb:
 592
 593 Test 1 (compiling corlib):
 594 9: avg: 3.1k
 595 8: avg: 1.6k
 596
 597 */
 598 #define SGEN_TO_SPACE_GRANULE_BITS 9
 599 #define SGEN_TO_SPACE_GRANULE_IN_BYTES (1 << SGEN_TO_SPACE_GRANULE_BITS)
 600
 601 extern char *sgen_space_bitmap MONO_INTERNAL;
 602 extern int sgen_space_bitmap_size MONO_INTERNAL;
 603
 604 static inline gboolean
 605 sgen_nursery_is_to_space (char *object)
 606 {
 607         int idx = (object - sgen_nursery_start) >> SGEN_TO_SPACE_GRANULE_BITS;
 608         int byte = idx / 8;
 609         int bit = idx & 0x7;
 610
 611         SGEN_ASSERT (4, sgen_ptr_in_nursery (object), "object %p is not in nursery [%p - %p]", object, sgen_get_nursery_start (), sgen_get_nursery_end ());
 612         SGEN_ASSERT (4, byte < sgen_space_bitmap_size, "byte index %d out of range", byte, sgen_space_bitmap_size);
 613
 614         return (sgen_space_bitmap [byte] & (1 << bit)) != 0;
 615 }
 616
 617 static inline gboolean
 618 sgen_nursery_is_from_space (char *object)
 619 {
 620         return !sgen_nursery_is_to_space (object);
 621 }
 622
 623 static inline gboolean
 624 sgen_nursery_is_object_alive (char *obj)
 625 {
 626         /* FIXME put this asserts under a non default level */
 627         g_assert (sgen_ptr_in_nursery (obj));
 628
 629         if (sgen_nursery_is_to_space (obj))
 630                 return TRUE;
 631
 632         if (SGEN_OBJECT_IS_PINNED (obj) || SGEN_OBJECT_IS_FORWARDED (obj))
 633                 return TRUE;
 634
 635         return FALSE;
 636 }
 637
 638 typedef struct {
 639         char* (*alloc_for_promotion) (char *obj, size_t objsize, gboolean has_references);
 640         char* (*par_alloc_for_promotion) (char *obj, size_t objsize, gboolean has_references);
 641
 642         SgenObjectOperations serial_ops;
 643         SgenObjectOperations parallel_ops;
 644
 645         void (*prepare_to_space) (char *to_space_bitmap, int space_bitmap_size);
 646         void (*clear_fragments) (void);
 647         SgenFragment* (*build_fragments_get_exclude_head) (void);
 648         void (*build_fragments_release_exclude_head) (void);
 649         void (*build_fragments_finish) (SgenFragmentAllocator *allocator);
 650         void (*init_nursery) (SgenFragmentAllocator *allocator, char *start, char *end);
 651
 652         gboolean (*handle_gc_param) (const char *opt); /* Optional */
 653         void (*print_gc_param_usage) (void); /* Optional */
 654 } SgenMinorCollector;
 655
 656 extern SgenMinorCollector sgen_minor_collector;
 657
 658 void sgen_simple_nursery_init (SgenMinorCollector *collector) MONO_INTERNAL;
 659 void sgen_split_nursery_init (SgenMinorCollector *collector) MONO_INTERNAL;
 660
 661 typedef void (*sgen_cardtable_block_callback) (mword start, mword size);
 662 void sgen_major_collector_iterate_live_block_ranges (sgen_cardtable_block_callback callback) MONO_INTERNAL;
 663
 664 typedef struct _SgenMajorCollector SgenMajorCollector;
 665 struct _SgenMajorCollector {
 666         size_t section_size;
 667         gboolean is_parallel;
 668         gboolean supports_cardtable;
 669
 670         /*
 671          * This is set to TRUE if the sweep for the last major
 672          * collection has been completed.
 673          */
 674         gboolean *have_swept;
 675
 676         void* (*alloc_heap) (mword nursery_size, mword nursery_align, int nursery_bits);
 677         gboolean (*is_object_live) (char *obj);
 678         void* (*alloc_small_pinned_obj) (size_t size, gboolean has_references);
 679         void* (*alloc_degraded) (MonoVTable *vtable, size_t size);
 680
 681         SgenObjectOperations major_ops;
 682
 683         void* (*alloc_object) (int size, gboolean has_references);
 684         void* (*par_alloc_object) (int size, gboolean has_references);
 685         void (*free_pinned_object) (char *obj, size_t size);
 686         void (*iterate_objects) (gboolean non_pinned, gboolean pinned, IterateObjectCallbackFunc callback, void *data);
 687         void (*free_non_pinned_object) (char *obj, size_t size);
 688         void (*find_pin_queue_start_ends) (SgenGrayQueue *queue);
 689         void (*pin_objects) (SgenGrayQueue *queue);
 690         void (*pin_major_object) (char *obj, SgenGrayQueue *queue);
 691         void (*scan_card_table) (SgenGrayQueue *queue);
 692         void (*iterate_live_block_ranges) (sgen_cardtable_block_callback callback);
 693         void (*init_to_space) (void);
 694         void (*sweep) (void);
 695         void (*check_scan_starts) (void);
 696         void (*dump_heap) (FILE *heap_dump_file);
 697         gint64 (*get_used_size) (void);
 698         void (*start_nursery_collection) (void);
 699         void (*finish_nursery_collection) (void);
 700         void (*start_major_collection) (void);
 701         void (*finish_major_collection) (void);
 702         void (*have_computed_minor_collection_allowance) (void);
 703         gboolean (*ptr_is_in_non_pinned_space) (char *ptr);
 704         gboolean (*obj_is_from_pinned_alloc) (char *obj);
 705         void (*report_pinned_memory_usage) (void);
 706         int (*get_num_major_sections) (void);
 707         gboolean (*handle_gc_param) (const char *opt);
 708         void (*print_gc_param_usage) (void);
 709         gboolean (*is_worker_thread) (MonoNativeThreadId thread);
 710         void (*post_param_init) (void);
 711         void* (*alloc_worker_data) (void);
 712         void (*init_worker_thread) (void *data);
 713         void (*reset_worker_data) (void *data);
 714         gboolean (*is_valid_object) (char *object);
 715         gboolean (*describe_pointer) (char *pointer);
 716 };
 717
 718 extern SgenMajorCollector major_collector;
 719
 720 void sgen_marksweep_init (SgenMajorCollector *collector) MONO_INTERNAL;
 721 void sgen_marksweep_fixed_init (SgenMajorCollector *collector) MONO_INTERNAL;
 722 void sgen_marksweep_par_init (SgenMajorCollector *collector) MONO_INTERNAL;
 723 void sgen_marksweep_fixed_par_init (SgenMajorCollector *collector) MONO_INTERNAL;
 724 void sgen_copying_init (SgenMajorCollector *collector) MONO_INTERNAL;
 725 SgenMajorCollector* sgen_get_major_collector (void) MONO_INTERNAL;
 726
 727
 728 typedef struct {
 729         void (*wbarrier_set_field) (MonoObject *obj, gpointer field_ptr, MonoObject* value);
 730         void (*wbarrier_set_arrayref) (MonoArray *arr, gpointer slot_ptr, MonoObject* value);
 731         void (*wbarrier_arrayref_copy) (gpointer dest_ptr, gpointer src_ptr, int count);
 732         void (*wbarrier_value_copy) (gpointer dest, gpointer src, int count, MonoClass *klass);
 733         void (*wbarrier_object_copy) (MonoObject* obj, MonoObject *src);
 734         void (*wbarrier_generic_nostore) (gpointer ptr);
 735         void (*record_pointer) (gpointer ptr);
 736
 737         void (*begin_scan_remsets) (void *start_nursery, void *end_nursery, SgenGrayQueue *queue); /* OPTIONAL */
 738         void (*finish_scan_remsets) (void *start_nursery, void *end_nursery, SgenGrayQueue *queue);
 739
 740         void (*register_thread) (SgenThreadInfo *p); /* OPTIONAL */
 741         void (*cleanup_thread) (SgenThreadInfo *p); /* OPTIONAL */
 742         void (*fill_thread_info_for_suspend) (SgenThreadInfo *info); /* OPTIONAL */
 743         void (*prepare_for_minor_collection) (void); /* OPTIONAL */
 744         void (*prepare_for_major_collection) (void);
 745
 746         void (*finish_minor_collection) (void); /* OPTIONAL */
 747         gboolean (*find_address) (char *addr);
 748 } SgenRemeberedSet;
 749
 750 SgenRemeberedSet *sgen_get_remset (void) MONO_INTERNAL;
 751
 752 static guint /*__attribute__((noinline)) not sure if this hint is a good idea*/
 753 slow_object_get_size (MonoVTable *vtable, MonoObject* o)
 754 {
 755         MonoClass *klass = vtable->klass;
 756
 757         /*
 758          * We depend on mono_string_length_fast and
 759          * mono_array_length_fast not using the object's vtable.
 760          */
 761         if (klass == mono_defaults.string_class) {
 762                 return sizeof (MonoString) + 2 * mono_string_length_fast ((MonoString*) o) + 2;
 763         } else if (klass->rank) {
 764                 MonoArray *array = (MonoArray*)o;
 765                 size_t size = sizeof (MonoArray) + klass->sizes.element_size * mono_array_length_fast (array);
 766                 if (G_UNLIKELY (array->bounds)) {
 767                         size += sizeof (mono_array_size_t) - 1;
 768                         size &= ~(sizeof (mono_array_size_t) - 1);
 769                         size += sizeof (MonoArrayBounds) * klass->rank;
 770                 }
 771                 return size;
 772         } else {
 773                 /* from a created object: the class must be inited already */
 774                 return klass->instance_size;
 775         }
 776 }
 777
 778 /*
 779  * This function can be called on an object whose first word, the
 780  * vtable field, is not intact.  This is necessary for the parallel
 781  * collector.
 782  */
 783 static inline guint
 784 sgen_par_object_get_size (MonoVTable *vtable, MonoObject* o)
 785 {
 786         mword descr = (mword)vtable->gc_descr;
 787         mword type = descr & 0x7;
 788
 789         if (type == DESC_TYPE_RUN_LENGTH || type == DESC_TYPE_SMALL_BITMAP) {
 790                 mword size = descr & 0xfff8;
 791                 if (size == 0) /* This is used to encode a string */
 792                         return sizeof (MonoString) + 2 * mono_string_length_fast ((MonoString*) o) + 2;
 793                 return size;
 794         } else if (type == DESC_TYPE_VECTOR) {
 795                 int element_size = ((descr) >> VECTOR_ELSIZE_SHIFT) & MAX_ELEMENT_SIZE;
 796                 MonoArray *array = (MonoArray*)o;
 797                 size_t size = sizeof (MonoArray) + element_size * mono_array_length_fast (array);
 798
 799                 if (descr & VECTOR_KIND_ARRAY) {
 800                         size += sizeof (mono_array_size_t) - 1;
 801                         size &= ~(sizeof (mono_array_size_t) - 1);
 802                         size += sizeof (MonoArrayBounds) * vtable->klass->rank;
 803                 }
 804                 return size;
 805         }
 806
 807         return slow_object_get_size (vtable, o);
 808 }
 809
 810 static inline guint
 811 sgen_safe_object_get_size (MonoObject *obj)
 812 {
 813        char *forwarded;
 814
 815        if ((forwarded = SGEN_OBJECT_IS_FORWARDED (obj)))
 816                obj = (MonoObject*)forwarded;
 817
 818        return sgen_par_object_get_size ((MonoVTable*)SGEN_LOAD_VTABLE (obj), obj);
 819 }
 820
 821 const char* sgen_safe_name (void* obj) MONO_INTERNAL;
 822
 823 gboolean sgen_object_is_live (void *obj) MONO_INTERNAL;
 824
 825 gboolean sgen_need_bridge_processing (void) MONO_INTERNAL;
 826 void sgen_bridge_reset_data (void) MONO_INTERNAL;
 827 void sgen_bridge_processing_stw_step (void) MONO_INTERNAL;
 828 void sgen_bridge_processing_finish (int generation) MONO_INTERNAL;
 829 void sgen_register_test_bridge_callbacks (const char *bridge_class_name) MONO_INTERNAL;
 830 gboolean sgen_is_bridge_object (MonoObject *obj) MONO_INTERNAL;
 831 gboolean sgen_is_bridge_class (MonoClass *class) MONO_INTERNAL;
 832 void sgen_mark_bridge_object (MonoObject *obj) MONO_INTERNAL;
 833 void sgen_bridge_register_finalized_object (MonoObject *object) MONO_INTERNAL;
 834
 835 void sgen_scan_togglerefs (CopyOrMarkObjectFunc copy_func, char *start, char *end, SgenGrayQueue *queue) MONO_INTERNAL;
 836 void sgen_process_togglerefs (void) MONO_INTERNAL;
 837
 838 typedef mono_bool (*WeakLinkAlivePredicateFunc) (MonoObject*, void*);
 839
 840 void sgen_null_links_with_predicate (int generation, WeakLinkAlivePredicateFunc predicate, void *data) MONO_INTERNAL;
 841
 842 gboolean sgen_gc_is_object_ready_for_finalization (void *object) MONO_INTERNAL;
 843 void sgen_gc_lock (void) MONO_INTERNAL;
 844 void sgen_gc_unlock (void) MONO_INTERNAL;
 845 void sgen_gc_event_moves (void) MONO_INTERNAL;
 846
 847 void sgen_queue_finalization_entry (MonoObject *obj) MONO_INTERNAL;
 848 const char* sgen_generation_name (int generation) MONO_INTERNAL;
 849
 850 void sgen_collect_bridge_objects (CopyOrMarkObjectFunc copy_func, char *start, char *end, int generation, SgenGrayQueue *queue) MONO_INTERNAL;
 851 void sgen_finalize_in_range (CopyOrMarkObjectFunc copy_func, char *start, char *end, int generation, SgenGrayQueue *queue) MONO_INTERNAL;
 852 void sgen_null_link_in_range (CopyOrMarkObjectFunc copy_func, char *start, char *end, int generation, gboolean before_finalization, SgenGrayQueue *queue) MONO_INTERNAL;
 853 void sgen_null_links_for_domain (MonoDomain *domain, int generation) MONO_INTERNAL;
 854 void sgen_remove_finalizers_for_domain (MonoDomain *domain, int generation) MONO_INTERNAL;
 855 void sgen_process_fin_stage_entries (void) MONO_INTERNAL;
 856 void sgen_process_dislink_stage_entries (void) MONO_INTERNAL;
 857 void sgen_register_disappearing_link (MonoObject *obj, void **link, gboolean track, gboolean in_gc) MONO_INTERNAL;
 858
 859 enum {
 860         SPACE_NURSERY,
 861         SPACE_MAJOR,
 862         SPACE_LOS
 863 };
 864
 865 void sgen_pin_object (void *object, SgenGrayQueue *queue) MONO_INTERNAL;
 866 void sgen_parallel_pin_or_update (void **ptr, void *obj, MonoVTable *vt, SgenGrayQueue *queue) MONO_INTERNAL;
 867 void sgen_set_pinned_from_failed_allocation (mword objsize) MONO_INTERNAL;
 868
 869 void sgen_ensure_free_space (size_t size) MONO_INTERNAL;
 870 void sgen_perform_collection (size_t requested_size, int generation_to_collect, const char *reason) MONO_INTERNAL;
 871 gboolean sgen_has_critical_method (void) MONO_INTERNAL;
 872 gboolean sgen_is_critical_method (MonoMethod *method) MONO_INTERNAL;
 873
 874 /* STW */
 875
 876 typedef struct {
 877         int generation;
 878         const char *reason;
 879         gboolean is_overflow;
 880         SGEN_TV_DECLARE (total_time);
 881         SGEN_TV_DECLARE (stw_time);
 882         SGEN_TV_DECLARE (bridge_time);
 883 } GGTimingInfo;
 884
 885 int sgen_stop_world (int generation) MONO_INTERNAL;
 886 int sgen_restart_world (int generation, GGTimingInfo *timing) MONO_INTERNAL;
 887
 888 /* LOS */
 889
 890 typedef struct _LOSObject LOSObject;
 891 struct _LOSObject {
 892         LOSObject *next;
 893         mword size; /* this is the object size */
 894         guint16 huge_object;
 895         int dummy; /* to have a sizeof (LOSObject) a multiple of ALLOC_ALIGN  and data starting at same alignment */
 896         char data [MONO_ZERO_LEN_ARRAY];
 897 };
 898
 899 #define ARRAY_OBJ_INDEX(ptr,array,elem_size) (((char*)(ptr) - ((char*)(array) + G_STRUCT_OFFSET (MonoArray, vector))) / (elem_size))
 900
 901 extern LOSObject *los_object_list;
 902 extern mword los_memory_usage;
 903
 904 void sgen_los_free_object (LOSObject *obj) MONO_INTERNAL;
 905 void* sgen_los_alloc_large_inner (MonoVTable *vtable, size_t size) MONO_INTERNAL;
 906 void sgen_los_sweep (void) MONO_INTERNAL;
 907 gboolean sgen_ptr_is_in_los (char *ptr, char **start) MONO_INTERNAL;
 908 void sgen_los_iterate_objects (IterateObjectCallbackFunc cb, void *user_data) MONO_INTERNAL;
 909 void sgen_los_iterate_live_block_ranges (sgen_cardtable_block_callback callback) MONO_INTERNAL;
 910 void sgen_los_scan_card_table (SgenGrayQueue *queue) MONO_INTERNAL;
 911 void sgen_major_collector_scan_card_table (SgenGrayQueue *queue) MONO_INTERNAL;
 912 gboolean sgen_los_is_valid_object (char *object) MONO_INTERNAL;
 913 gboolean mono_sgen_los_describe_pointer (char *ptr) MONO_INTERNAL;
 914
 915 /* nursery allocator */
 916
 917 void sgen_clear_nursery_fragments (void) MONO_INTERNAL;
 918 void sgen_nursery_allocator_prepare_for_pinning (void) MONO_INTERNAL;
 919 void sgen_nursery_allocator_set_nursery_bounds (char *nursery_start, char *nursery_end) MONO_INTERNAL;
 920 mword sgen_build_nursery_fragments (GCMemSection *nursery_section, void **start, int num_entries) MONO_INTERNAL;
 921 void sgen_init_nursery_allocator (void) MONO_INTERNAL;
 922 void sgen_nursery_allocator_init_heavy_stats (void) MONO_INTERNAL;
 923 void sgen_alloc_init_heavy_stats (void) MONO_INTERNAL;
 924 char* sgen_nursery_alloc_get_upper_alloc_bound (void) MONO_INTERNAL;
 925 void* sgen_nursery_alloc (size_t size) MONO_INTERNAL;
 926 void* sgen_nursery_alloc_range (size_t size, size_t min_size, size_t *out_alloc_size) MONO_INTERNAL;
 927 MonoVTable* sgen_get_array_fill_vtable (void) MONO_INTERNAL;
 928 gboolean sgen_can_alloc_size (size_t size) MONO_INTERNAL;
 929 void sgen_nursery_retire_region (void *address, ptrdiff_t size) MONO_INTERNAL;
 930
 931 void sgen_nursery_alloc_prepare_for_minor (void) MONO_INTERNAL;
 932 void sgen_nursery_alloc_prepare_for_major (void) MONO_INTERNAL;
 933
 934 char* sgen_alloc_for_promotion (char *obj, size_t objsize, gboolean has_references) MONO_INTERNAL;
 935 char* sgen_par_alloc_for_promotion (char *obj, size_t objsize, gboolean has_references) MONO_INTERNAL;
 936
 937 /* TLS Data */
 938
 939 extern MonoNativeTlsKey thread_info_key;
 940
 941 #ifdef HAVE_KW_THREAD
 942 extern __thread SgenThreadInfo *thread_info;
 943 extern __thread gpointer *store_remset_buffer;
 944 extern __thread long store_remset_buffer_index;
 945 extern __thread char *stack_end;
 946 extern __thread long *store_remset_buffer_index_addr;
 947 #endif
 948
 949 #ifdef HAVE_KW_THREAD
 950 #define TLAB_ACCESS_INIT
 951 #define REMEMBERED_SET  remembered_set
 952 #define STORE_REMSET_BUFFER     store_remset_buffer
 953 #define STORE_REMSET_BUFFER_INDEX       store_remset_buffer_index
 954 #define IN_CRITICAL_REGION thread_info->in_critical_region
 955 #else
 956 #define TLAB_ACCESS_INIT        SgenThreadInfo *__thread_info__ = mono_native_tls_get_value (thread_info_key)
 957 #define REMEMBERED_SET  (__thread_info__->remset)
 958 #define STORE_REMSET_BUFFER     (__thread_info__->store_remset_buffer)
 959 #define STORE_REMSET_BUFFER_INDEX       (__thread_info__->store_remset_buffer_index)
 960 #define IN_CRITICAL_REGION (__thread_info__->in_critical_region)
 961 #endif
 962
 963 #ifndef DISABLE_CRITICAL_REGION
 964
 965 #ifdef HAVE_KW_THREAD
 966 #define IN_CRITICAL_REGION thread_info->in_critical_region
 967 #else
 968 #define IN_CRITICAL_REGION (__thread_info__->in_critical_region)
 969 #endif
 970
 971 /* Enter must be visible before anything is done in the critical region. */
 972 #define ENTER_CRITICAL_REGION do { mono_atomic_store_acquire (&IN_CRITICAL_REGION, 1); } while (0)
 973
 974 /* Exit must make sure all critical regions stores are visible before it signal the end of the region.
 975  * We don't need to emit a full barrier since we
 976  */
 977 #define EXIT_CRITICAL_REGION  do { mono_atomic_store_release (&IN_CRITICAL_REGION, 0); } while (0)
 978
 979 #endif
 980
 981 #ifdef HAVE_KW_THREAD
 982 #define EMIT_TLS_ACCESS(mb,dummy,offset)        do {    \
 983         mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX);   \
 984         mono_mb_emit_byte ((mb), CEE_MONO_TLS);         \
 985         mono_mb_emit_i4 ((mb), (offset));               \
 986         } while (0)
 987 #else
 988
 989 /*
 990  * CEE_MONO_TLS requires the tls offset, not the key, so the code below only works on darwin,
 991  * where the two are the same.
 992  */
 993 #if defined(__APPLE__) || defined (HOST_WIN32)
 994 #define EMIT_TLS_ACCESS(mb,member,dummy)        do {    \
 995         mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX);   \
 996         mono_mb_emit_byte ((mb), CEE_MONO_TLS);         \
 997         mono_mb_emit_i4 ((mb), thread_info_key);        \
 998         mono_mb_emit_icon ((mb), G_STRUCT_OFFSET (SgenThreadInfo, member));     \
 999         mono_mb_emit_byte ((mb), CEE_ADD);              \
1000         mono_mb_emit_byte ((mb), CEE_LDIND_I);          \
1001         } while (0)
1002 #else
1003 #define EMIT_TLS_ACCESS(mb,member,dummy)        do { g_error ("sgen is not supported when using --with-tls=pthread.\n"); } while (0)
1004 #endif
1005
1006 #endif
1007
1008 /* Other globals */
1009
1010 extern GCMemSection *nursery_section;
1011 extern int stat_major_gcs;
1012 extern guint32 collect_before_allocs;
1013 extern guint32 verify_before_allocs;
1014 extern gboolean has_per_allocation_action;
1015 extern int degraded_mode;
1016 extern int default_nursery_size;
1017 extern guint32 tlab_size;
1018 extern NurseryClearPolicy nursery_clear_policy;
1019
1020 extern LOCK_DECLARE (gc_mutex);
1021
1022 extern int do_pin_stats;
1023
1024 /* Nursery helpers. */
1025
1026 static inline void
1027 sgen_set_nursery_scan_start (char *p)
1028 {
1029         int idx = (p - (char*)nursery_section->data) / SGEN_SCAN_START_SIZE;
1030         char *old = nursery_section->scan_starts [idx];
1031         if (!old || old > p)
1032                 nursery_section->scan_starts [idx] = p;
1033 }
1034
1035
1036 /* Object Allocation */
1037
1038 typedef enum {
1039         ATYPE_NORMAL,
1040         ATYPE_VECTOR,
1041         ATYPE_SMALL,
1042         ATYPE_NUM
1043 } SgenAllocatorType;
1044
1045 void sgen_init_tlab_info (SgenThreadInfo* info);
1046 void sgen_clear_tlabs (void);
1047 void sgen_set_use_managed_allocator (gboolean flag);
1048 gboolean sgen_is_managed_allocator (MonoMethod *method);
1049 gboolean sgen_has_managed_allocator (void);
1050
1051 /* Debug support */
1052
1053 void sgen_check_consistency (void);
1054 void sgen_check_major_refs (void);
1055 void sgen_check_whole_heap (void);
1056 void sgen_check_whole_heap_stw (void) MONO_INTERNAL;
1057 void sgen_check_objref (char *obj);
1058
1059 /* Write barrier support */
1060
1061 /*
1062  * This causes the compile to extend the liveness of 'v' till the call to dummy_use
1063  */
1064 static inline void
1065 sgen_dummy_use (gpointer v) {
1066 #if defined(__GNUC__)
1067         __asm__ volatile ("" : "=r"(v) : "r"(v));
1068 #elif defined(_MSC_VER)
1069         __asm {
1070                 mov eax, v;
1071                 and eax, eax;
1072         };
1073 #else
1074 #error "Implement sgen_dummy_use for your compiler"
1075 #endif
1076 }
1077
1078 #endif /* HAVE_SGEN_GC */
1079
1080 #endif /* __MONO_SGENGC_H__ */