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