mono/metadata/sgen-gc.h

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