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