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