2 * Copyright 2001-2003 Ximian, Inc
3 * Copyright 2003-2010 Novell, Inc.
5 * Permission is hereby granted, free of charge, to any person obtaining
6 * a copy of this software and associated documentation files (the
7 * "Software"), to deal in the Software without restriction, including
8 * without limitation the rights to use, copy, modify, merge, publish,
9 * distribute, sublicense, and/or sell copies of the Software, and to
10 * permit persons to whom the Software is furnished to do so, subject to
11 * the following conditions:
13 * The above copyright notice and this permission notice shall be
14 * included in all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 #ifndef __MONO_SGENGC_H__
25 #define __MONO_SGENGC_H__
32 #include <mono/utils/mono-compiler.h>
33 #include <mono/metadata/class-internals.h>
34 #include <mono/metadata/object-internals.h>
37 * Turning on heavy statistics will turn off the managed allocator and
38 * the managed write barrier.
40 //#define HEAVY_STATISTICS
43 * If this is set, the nursery is aligned to an address aligned to its size, ie.
44 * a 1MB nursery will be aligned to an address divisible by 1MB. This allows us to
45 * speed up ptr_in_nursery () checks which are very frequent. This requires the
46 * nursery size to be a compile time constant.
48 #define SGEN_ALIGN_NURSERY 1
50 //#define SGEN_BINARY_PROTOCOL
52 #define SGEN_MAX_DEBUG_LEVEL 2
54 #define THREAD_HASH_SIZE 11
56 #define GC_BITS_PER_WORD (sizeof (mword) * 8)
58 #define ARCH_THREAD_TYPE pthread_t
59 #define ARCH_GET_THREAD pthread_self
60 #define ARCH_THREAD_EQUALS(a,b) pthread_equal (a, b)
62 #if SIZEOF_VOID_P == 4
63 typedef guint32 mword;
65 typedef guint64 mword;
68 #define SGEN_TV_DECLARE(name) gint64 name
69 #define SGEN_TV_GETTIME(tv) tv = mono_100ns_ticks ()
70 #define SGEN_TV_ELAPSED(start,end) (int)((end-start) / 10)
71 #define SGEN_TV_ELAPSED_MS(start,end) ((SGEN_TV_ELAPSED((start),(end)) + 500) / 1000)
73 /* for use with write barriers */
74 typedef struct _RememberedSet RememberedSet;
75 struct _RememberedSet {
79 mword data [MONO_ZERO_LEN_ARRAY];
82 /* eventually share with MonoThread? */
83 typedef struct _SgenThreadInfo SgenThreadInfo;
85 struct _SgenThreadInfo {
88 unsigned int stop_count; /* to catch duplicate signals */
91 volatile int in_critical_region;
94 void *stack_start_limit;
95 char **tlab_next_addr;
96 char **tlab_start_addr;
97 char **tlab_temp_end_addr;
98 char **tlab_real_end_addr;
99 gpointer **store_remset_buffer_addr;
100 long *store_remset_buffer_index_addr;
101 RememberedSet *remset;
102 gpointer runtime_data;
103 gpointer stopped_ip; /* only valid if the thread is stopped */
104 MonoDomain *stopped_domain; /* ditto */
105 gpointer *stopped_regs; /* ditto */
106 #ifndef HAVE_KW_THREAD
111 gpointer *store_remset_buffer;
112 long store_remset_buffer_index;
123 typedef struct _SgenBlock SgenBlock;
130 * The nursery section and the major copying collector's sections use
133 typedef struct _GCMemSection GCMemSection;
134 struct _GCMemSection {
138 /* pointer where more data could be allocated if it fits */
142 * scan starts is an array of pointers to objects equally spaced in the allocation area
143 * They let use quickly find pinned objects from pinning pointers.
146 /* in major collections indexes in the pin_queue for objects that pin this section */
147 void **pin_queue_start;
148 int pin_queue_num_entries;
149 unsigned short num_scan_start;
150 gboolean is_to_space;
153 #define SGEN_SIZEOF_GC_MEM_SECTION ((sizeof (GCMemSection) + 7) & ~7)
156 * to quickly find the head of an object pinned by a conservative
157 * address we keep track of the objects allocated for each
158 * SGEN_SCAN_START_SIZE memory chunk in the nursery or other memory
159 * sections. Larger values have less memory overhead and bigger
160 * runtime cost. 4-8 KB are reasonable values.
162 #define SGEN_SCAN_START_SIZE (4096*2)
165 * Objects bigger then this go into the large object space. This size
166 * has a few constraints. It must fit into the major heap, which in
167 * the case of the copying collector means that it must fit into a
168 * pinned chunk. It must also play well with the GC descriptors, some
169 * of which (DESC_TYPE_RUN_LENGTH, DESC_TYPE_SMALL_BITMAP) encode the
172 #define SGEN_MAX_SMALL_OBJ_SIZE 8000
174 /* This is also the MAJOR_SECTION_SIZE for the copying major
176 #define SGEN_PINNED_CHUNK_SIZE (128 * 1024)
178 #define SGEN_PINNED_CHUNK_FOR_PTR(o) ((SgenBlock*)(((mword)(o)) & ~(SGEN_PINNED_CHUNK_SIZE - 1)))
180 typedef struct _SgenPinnedChunk SgenPinnedChunk;
182 #if defined(__APPLE__) || defined(__OpenBSD__) || defined(__FreeBSD__)
183 const static int suspend_signal_num = SIGXFSZ;
185 const static int suspend_signal_num = SIGPWR;
187 const static int restart_signal_num = SIGXCPU;
190 * Recursion is not allowed for the thread lock.
192 #define LOCK_DECLARE(name) pthread_mutex_t name = PTHREAD_MUTEX_INITIALIZER
193 /* if changing LOCK_INIT to something that isn't idempotent, look at
194 its use in mono_gc_base_init in sgen-gc.c */
195 #define LOCK_INIT(name)
196 #define LOCK_GC pthread_mutex_lock (&gc_mutex)
197 #define UNLOCK_GC pthread_mutex_unlock (&gc_mutex)
198 #define LOCK_INTERRUPTION pthread_mutex_lock (&interruption_mutex)
199 #define UNLOCK_INTERRUPTION pthread_mutex_unlock (&interruption_mutex)
201 #define SGEN_CAS_PTR InterlockedCompareExchangePointer
202 #define SGEN_ATOMIC_ADD(x,i) do { \
206 } while (InterlockedCompareExchange (&(x), __old_x + (i), __old_x) != __old_x); \
209 /* non-pthread will need to provide their own version of start/stop */
210 #define USE_SIGNAL_BASED_START_STOP_WORLD 1
211 /* we intercept pthread_create calls to know which threads exist */
212 #define USE_PTHREAD_INTERCEPT 1
214 #ifdef HEAVY_STATISTICS
215 #define HEAVY_STAT(x) x
217 extern long long stat_objects_alloced_degraded;
218 extern long long stat_bytes_alloced_degraded;
219 extern long long stat_copy_object_called_major;
220 extern long long stat_objects_copied_major;
222 #define HEAVY_STAT(x)
225 #define DEBUG(level,a) do {if (G_UNLIKELY ((level) <= SGEN_MAX_DEBUG_LEVEL && (level) <= gc_debug_level)) a;} while (0)
227 extern int gc_debug_level;
228 extern FILE* gc_debug_file;
230 extern int current_collection_generation;
232 #define SGEN_ALLOC_ALIGN 8
233 #define SGEN_ALLOC_ALIGN_BITS 3
235 #define SGEN_ALIGN_UP(s) (((s)+(SGEN_ALLOC_ALIGN-1)) & ~(SGEN_ALLOC_ALIGN-1))
237 #ifdef SGEN_ALIGN_NURSERY
238 #define SGEN_PTR_IN_NURSERY(p,bits,start,end) (((mword)(p) & ~((1 << (bits)) - 1)) == (mword)(start))
240 #define SGEN_PTR_IN_NURSERY(p,bits,start,end) ((char*)(p) >= (start) && (char*)(p) < (end))
243 /* Structure that corresponds to a MonoVTable: desc is a mword so requires
244 * no cast from a pointer to an integer
251 /* these bits are set in the object vtable: we could merge them since an object can be
252 * either pinned or forwarded but not both.
253 * We store them in the vtable slot because the bits are used in the sync block for
254 * other purposes: if we merge them and alloc the sync blocks aligned to 8 bytes, we can change
255 * this and use bit 3 in the syncblock (with the lower two bits both set for forwarded, that
256 * would be an invalid combination for the monitor and hash code).
257 * The values are already shifted.
258 * The forwarding address is stored in the sync block.
260 #define SGEN_FORWARDED_BIT 1
261 #define SGEN_PINNED_BIT 2
262 #define SGEN_VTABLE_BITS_MASK 0x3
264 /* returns NULL if not forwarded, or the forwarded address */
265 #define SGEN_OBJECT_IS_FORWARDED(obj) (((mword*)(obj))[0] & SGEN_FORWARDED_BIT ? (void*)(((mword*)(obj))[0] & ~SGEN_VTABLE_BITS_MASK) : NULL)
266 #define SGEN_OBJECT_IS_PINNED(obj) (((mword*)(obj))[0] & SGEN_PINNED_BIT)
268 /* set the forwarded address fw_addr for object obj */
269 #define SGEN_FORWARD_OBJECT(obj,fw_addr) do { \
270 ((mword*)(obj))[0] = (mword)(fw_addr) | SGEN_FORWARDED_BIT; \
272 #define SGEN_PIN_OBJECT(obj) do { \
273 ((mword*)(obj))[0] |= SGEN_PINNED_BIT; \
275 #define SGEN_UNPIN_OBJECT(obj) do { \
276 ((mword*)(obj))[0] &= ~SGEN_PINNED_BIT; \
280 * Since we set bits in the vtable, use the macro to load it from the pointer to
281 * an object that is potentially pinned.
283 #define SGEN_LOAD_VTABLE(addr) ((*(mword*)(addr)) & ~SGEN_VTABLE_BITS_MASK)
286 * ######################################################################
287 * ######## GC descriptors
288 * ######################################################################
289 * Used to quickly get the info the GC needs about an object: size and
290 * where the references are held.
292 #define OBJECT_HEADER_WORDS (sizeof(MonoObject)/sizeof(gpointer))
293 #define LOW_TYPE_BITS 3
294 #define SMALL_BITMAP_SHIFT 16
295 #define SMALL_BITMAP_SIZE (GC_BITS_PER_WORD - SMALL_BITMAP_SHIFT)
296 #define VECTOR_INFO_SHIFT 14
297 #define VECTOR_ELSIZE_SHIFT 3
298 #define LARGE_BITMAP_SIZE (GC_BITS_PER_WORD - LOW_TYPE_BITS)
299 #define MAX_ELEMENT_SIZE 0x3ff
300 #define VECTOR_SUBTYPE_PTRFREE (DESC_TYPE_V_PTRFREE << VECTOR_INFO_SHIFT)
301 #define VECTOR_SUBTYPE_REFS (DESC_TYPE_V_REFS << VECTOR_INFO_SHIFT)
302 #define VECTOR_SUBTYPE_RUN_LEN (DESC_TYPE_V_RUN_LEN << VECTOR_INFO_SHIFT)
303 #define VECTOR_SUBTYPE_BITMAP (DESC_TYPE_V_BITMAP << VECTOR_INFO_SHIFT)
305 /* objects are aligned to 8 bytes boundaries
306 * A descriptor is a pointer in MonoVTable, so 32 or 64 bits of size.
307 * The low 3 bits define the type of the descriptor. The other bits
308 * depend on the type.
309 * As a general rule the 13 remaining low bits define the size, either
310 * of the whole object or of the elements in the arrays. While for objects
311 * the size is already in bytes, for arrays we need to shift, because
312 * array elements might be smaller than 8 bytes. In case of arrays, we
313 * use two bits to describe what the additional high bits represents,
314 * so the default behaviour can handle element sizes less than 2048 bytes.
315 * The high 16 bits, if 0 it means the object is pointer-free.
316 * This design should make it easy and fast to skip over ptr-free data.
317 * The first 4 types should cover >95% of the objects.
318 * Note that since the size of objects is limited to 64K, larger objects
319 * will be allocated in the large object heap.
320 * If we want 4-bytes alignment, we need to put vector and small bitmap
325 * We don't use 0 so that 0 isn't a valid GC descriptor. No
326 * deep reason for this other than to be able to identify a
327 * non-inited descriptor for debugging.
329 * If an object contains no references, its GC descriptor is
330 * always DESC_TYPE_RUN_LENGTH, without a size, no exceptions.
331 * This is so that we can quickly check for that in
332 * copy_object_no_checks(), without having to fetch the
335 DESC_TYPE_RUN_LENGTH = 1, /* 15 bits aligned byte size | 1-3 (offset, numptr) bytes tuples */
336 DESC_TYPE_SMALL_BITMAP, /* 15 bits aligned byte size | 16-48 bit bitmap */
337 DESC_TYPE_COMPLEX, /* index for bitmap into complex_descriptors */
338 DESC_TYPE_VECTOR, /* 10 bits element size | 1 bit array | 2 bits desc | element desc */
339 DESC_TYPE_ARRAY, /* 10 bits element size | 1 bit array | 2 bits desc | element desc */
340 DESC_TYPE_LARGE_BITMAP, /* | 29-61 bitmap bits */
341 DESC_TYPE_COMPLEX_ARR, /* index for bitmap into complex_descriptors */
342 /* subtypes for arrays and vectors */
343 DESC_TYPE_V_PTRFREE = 0,/* there are no refs: keep first so it has a zero value */
344 DESC_TYPE_V_REFS, /* all the array elements are refs */
345 DESC_TYPE_V_RUN_LEN, /* elements are run-length encoded as DESC_TYPE_RUN_LENGTH */
346 DESC_TYPE_V_BITMAP /* elements are as the bitmap in DESC_TYPE_SMALL_BITMAP */
349 #define SGEN_VTABLE_HAS_REFERENCES(vt) (((MonoVTable*)(vt))->gc_descr != (void*)DESC_TYPE_RUN_LENGTH)
351 /* helper macros to scan and traverse objects, macros because we resue them in many functions */
352 #define OBJ_RUN_LEN_SIZE(size,desc,obj) do { \
353 (size) = ((desc) & 0xfff8) >> 1; \
356 #define OBJ_BITMAP_SIZE(size,desc,obj) do { \
357 (size) = ((desc) & 0xfff8) >> 1; \
360 //#define PREFETCH(addr) __asm__ __volatile__ (" prefetchnta %0": : "m"(*(char *)(addr)))
361 #define PREFETCH(addr)
363 /* code using these macros must define a HANDLE_PTR(ptr) macro that does the work */
364 #define OBJ_RUN_LEN_FOREACH_PTR(desc,obj) do { \
365 if ((desc) & 0xffff0000) { \
366 /* there are pointers */ \
367 void **_objptr_end; \
368 void **_objptr = (void**)(obj); \
369 _objptr += ((desc) >> 16) & 0xff; \
370 _objptr_end = _objptr + (((desc) >> 24) & 0xff); \
371 while (_objptr < _objptr_end) { \
372 HANDLE_PTR (_objptr, (obj)); \
378 /* a bitmap desc means that there are pointer references or we'd have
379 * choosen run-length, instead: add an assert to check.
381 #define OBJ_BITMAP_FOREACH_PTR(desc,obj) do { \
382 /* there are pointers */ \
383 void **_objptr = (void**)(obj); \
384 gsize _bmap = (desc) >> 16; \
385 _objptr += OBJECT_HEADER_WORDS; \
388 HANDLE_PTR (_objptr, (obj)); \
395 #define OBJ_LARGE_BITMAP_FOREACH_PTR(vt,obj) do { \
396 /* there are pointers */ \
397 void **_objptr = (void**)(obj); \
398 gsize _bmap = (vt)->desc >> LOW_TYPE_BITS; \
399 _objptr += OBJECT_HEADER_WORDS; \
402 HANDLE_PTR (_objptr, (obj)); \
409 gsize* mono_sgen_get_complex_descriptor (GCVTable *vt) MONO_INTERNAL;
411 #define OBJ_COMPLEX_FOREACH_PTR(vt,obj) do { \
412 /* there are pointers */ \
413 void **_objptr = (void**)(obj); \
414 gsize *bitmap_data = mono_sgen_get_complex_descriptor ((vt)); \
415 int bwords = (*bitmap_data) - 1; \
416 void **start_run = _objptr; \
419 MonoObject *myobj = (MonoObject*)obj; \
420 g_print ("found %d at %p (0x%zx): %s.%s\n", bwords, (obj), (vt)->desc, myobj->vtable->klass->name_space, myobj->vtable->klass->name); \
422 while (bwords-- > 0) { \
423 gsize _bmap = *bitmap_data++; \
424 _objptr = start_run; \
425 /*g_print ("bitmap: 0x%x/%d at %p\n", _bmap, bwords, _objptr);*/ \
428 HANDLE_PTR (_objptr, (obj)); \
433 start_run += GC_BITS_PER_WORD; \
437 /* this one is untested */
438 #define OBJ_COMPLEX_ARR_FOREACH_PTR(vt,obj) do { \
439 /* there are pointers */ \
440 gsize *mbitmap_data = mono_sgen_get_complex_descriptor ((vt)); \
441 int mbwords = (*mbitmap_data++) - 1; \
442 int el_size = mono_array_element_size (vt->klass); \
443 char *e_start = (char*)(obj) + G_STRUCT_OFFSET (MonoArray, vector); \
444 char *e_end = e_start + el_size * mono_array_length_fast ((MonoArray*)(obj)); \
446 g_print ("found %d at %p (0x%zx): %s.%s\n", mbwords, (obj), (vt)->desc, vt->klass->name_space, vt->klass->name); \
447 while (e_start < e_end) { \
448 void **_objptr = (void**)e_start; \
449 gsize *bitmap_data = mbitmap_data; \
450 unsigned int bwords = mbwords; \
451 while (bwords-- > 0) { \
452 gsize _bmap = *bitmap_data++; \
453 void **start_run = _objptr; \
454 /*g_print ("bitmap: 0x%x\n", _bmap);*/ \
457 HANDLE_PTR (_objptr, (obj)); \
462 _objptr = start_run + GC_BITS_PER_WORD; \
464 e_start += el_size; \
468 #define OBJ_VECTOR_FOREACH_PTR(vt,obj) do { \
469 /* note: 0xffffc000 excludes DESC_TYPE_V_PTRFREE */ \
470 if ((vt)->desc & 0xffffc000) { \
471 int el_size = ((vt)->desc >> 3) & MAX_ELEMENT_SIZE; \
472 /* there are pointers */ \
473 int etype = (vt)->desc & 0xc000; \
474 if (etype == (DESC_TYPE_V_REFS << 14)) { \
475 void **p = (void**)((char*)(obj) + G_STRUCT_OFFSET (MonoArray, vector)); \
476 void **end_refs = (void**)((char*)p + el_size * mono_array_length_fast ((MonoArray*)(obj))); \
477 /* Note: this code can handle also arrays of struct with only references in them */ \
478 while (p < end_refs) { \
479 HANDLE_PTR (p, (obj)); \
482 } else if (etype == DESC_TYPE_V_RUN_LEN << 14) { \
483 int offset = ((vt)->desc >> 16) & 0xff; \
484 int num_refs = ((vt)->desc >> 24) & 0xff; \
485 char *e_start = (char*)(obj) + G_STRUCT_OFFSET (MonoArray, vector); \
486 char *e_end = e_start + el_size * mono_array_length_fast ((MonoArray*)(obj)); \
487 while (e_start < e_end) { \
488 void **p = (void**)e_start; \
491 for (i = 0; i < num_refs; ++i) { \
492 HANDLE_PTR (p + i, (obj)); \
494 e_start += el_size; \
496 } else if (etype == DESC_TYPE_V_BITMAP << 14) { \
497 char *e_start = (char*)(obj) + G_STRUCT_OFFSET (MonoArray, vector); \
498 char *e_end = e_start + el_size * mono_array_length_fast ((MonoArray*)(obj)); \
499 while (e_start < e_end) { \
500 void **p = (void**)e_start; \
501 gsize _bmap = (vt)->desc >> 16; \
502 /* Note: there is no object header here to skip */ \
505 HANDLE_PTR (p, (obj)); \
510 e_start += el_size; \
516 typedef struct _SgenInternalAllocator SgenInternalAllocator;
518 #define SGEN_GRAY_QUEUE_SECTION_SIZE (128 - 3)
521 * This is a stack now instead of a queue, so the most recently added items are removed
522 * first, improving cache locality, and keeping the stack size manageable.
524 typedef struct _GrayQueueSection GrayQueueSection;
525 struct _GrayQueueSection {
527 GrayQueueSection *next;
528 char *objects [SGEN_GRAY_QUEUE_SECTION_SIZE];
531 typedef struct _SgenGrayQueue SgenGrayQueue;
533 typedef void (*GrayQueueAllocPrepareFunc) (SgenGrayQueue*);
535 struct _SgenGrayQueue {
536 SgenInternalAllocator *allocator;
537 GrayQueueSection *first;
538 GrayQueueSection *free_list;
540 GrayQueueAllocPrepareFunc alloc_prepare_func;
541 void *alloc_prepare_data;
544 #if SGEN_MAX_DEBUG_LEVEL >= 9
545 #define GRAY_OBJECT_ENQUEUE gray_object_enqueue
546 #define GRAY_OBJECT_DEQUEUE(queue,o) ((o) = gray_object_dequeue ((queue)))
548 #define GRAY_OBJECT_ENQUEUE(queue,o) do { \
549 if (G_UNLIKELY (!(queue)->first || (queue)->first->end == SGEN_GRAY_QUEUE_SECTION_SIZE)) \
550 mono_sgen_gray_object_enqueue ((queue), (o)); \
552 (queue)->first->objects [(queue)->first->end++] = (o); \
554 #define GRAY_OBJECT_DEQUEUE(queue,o) do { \
555 if (!(queue)->first) \
557 else if (G_UNLIKELY ((queue)->first->end == 1)) \
558 (o) = mono_sgen_gray_object_dequeue ((queue)); \
560 (o) = (queue)->first->objects [--(queue)->first->end]; \
564 void mono_sgen_gray_object_enqueue (SgenGrayQueue *queue, char *obj) MONO_INTERNAL;
565 char* mono_sgen_gray_object_dequeue (SgenGrayQueue *queue) MONO_INTERNAL;
567 typedef void (*IterateObjectCallbackFunc) (char*, size_t, void*);
569 void* mono_sgen_alloc_os_memory (size_t size, int activate) MONO_INTERNAL;
570 void* mono_sgen_alloc_os_memory_aligned (mword size, mword alignment, gboolean activate) MONO_INTERNAL;
571 void mono_sgen_free_os_memory (void *addr, size_t size) MONO_INTERNAL;
573 int mono_sgen_thread_handshake (int signum) MONO_INTERNAL;
574 SgenThreadInfo* mono_sgen_thread_info_lookup (ARCH_THREAD_TYPE id) MONO_INTERNAL;
575 SgenThreadInfo** mono_sgen_get_thread_table (void) MONO_INTERNAL;
576 void mono_sgen_wait_for_suspend_ack (int count) MONO_INTERNAL;
578 gboolean mono_sgen_is_worker_thread (pthread_t thread) MONO_INTERNAL;
580 void mono_sgen_update_heap_boundaries (mword low, mword high) MONO_INTERNAL;
582 void mono_sgen_register_major_sections_alloced (int num_sections) MONO_INTERNAL;
583 mword mono_sgen_get_minor_collection_allowance (void) MONO_INTERNAL;
585 void mono_sgen_scan_area_with_callback (char *start, char *end, IterateObjectCallbackFunc callback, void *data, gboolean allow_flags) MONO_INTERNAL;
586 void mono_sgen_check_section_scan_starts (GCMemSection *section) MONO_INTERNAL;
588 /* Keep in sync with mono_sgen_dump_internal_mem_usage() in dump_heap()! */
590 INTERNAL_MEM_MANAGED,
591 INTERNAL_MEM_PIN_QUEUE,
592 INTERNAL_MEM_FRAGMENT,
593 INTERNAL_MEM_SECTION,
594 INTERNAL_MEM_SCAN_STARTS,
595 INTERNAL_MEM_FIN_TABLE,
596 INTERNAL_MEM_FINALIZE_ENTRY,
597 INTERNAL_MEM_DISLINK_TABLE,
598 INTERNAL_MEM_DISLINK,
599 INTERNAL_MEM_ROOTS_TABLE,
600 INTERNAL_MEM_ROOT_RECORD,
601 INTERNAL_MEM_STATISTICS,
603 INTERNAL_MEM_GRAY_QUEUE,
604 INTERNAL_MEM_STORE_REMSET,
605 INTERNAL_MEM_MS_TABLES,
606 INTERNAL_MEM_MS_BLOCK_INFO,
607 INTERNAL_MEM_EPHEMERON_LINK,
608 INTERNAL_MEM_WORKER_DATA,
612 #define SGEN_INTERNAL_FREELIST_NUM_SLOTS 30
614 struct _SgenInternalAllocator {
615 SgenPinnedChunk *chunk_list;
616 SgenPinnedChunk *free_lists [SGEN_INTERNAL_FREELIST_NUM_SLOTS];
617 void *delayed_free_lists [SGEN_INTERNAL_FREELIST_NUM_SLOTS];
618 long small_internal_mem_bytes [INTERNAL_MEM_MAX];
627 void mono_sgen_init_internal_allocator (void) MONO_INTERNAL;
629 SgenInternalAllocator* mono_sgen_get_unmanaged_allocator (void) MONO_INTERNAL;
631 const char* mono_sgen_internal_mem_type_name (int type) MONO_INTERNAL;
632 void mono_sgen_report_internal_mem_usage (void) MONO_INTERNAL;
633 void mono_sgen_report_internal_mem_usage_full (SgenInternalAllocator *alc) MONO_INTERNAL;
634 void mono_sgen_dump_internal_mem_usage (FILE *heap_dump_file) MONO_INTERNAL;
635 void mono_sgen_dump_section (GCMemSection *section, const char *type) MONO_INTERNAL;
636 void mono_sgen_dump_occupied (char *start, char *end, char *section_start) MONO_INTERNAL;
638 void mono_sgen_register_moved_object (void *obj, void *destination) MONO_INTERNAL;
640 void mono_sgen_register_fixed_internal_mem_type (int type, size_t size) MONO_INTERNAL;
642 void* mono_sgen_alloc_internal (int type) MONO_INTERNAL;
643 void mono_sgen_free_internal (void *addr, int type) MONO_INTERNAL;
645 void* mono_sgen_alloc_internal_dynamic (size_t size, int type) MONO_INTERNAL;
646 void mono_sgen_free_internal_dynamic (void *addr, size_t size, int type) MONO_INTERNAL;
648 void* mono_sgen_alloc_internal_fixed (SgenInternalAllocator *allocator, int type) MONO_INTERNAL;
649 void mono_sgen_free_internal_fixed (SgenInternalAllocator *allocator, void *addr, int type) MONO_INTERNAL;
651 void* mono_sgen_alloc_internal_full (SgenInternalAllocator *allocator, size_t size, int type) MONO_INTERNAL;
652 void mono_sgen_free_internal_full (SgenInternalAllocator *allocator, void *addr, size_t size, int type) MONO_INTERNAL;
654 void mono_sgen_free_internal_delayed (void *addr, int type, SgenInternalAllocator *thread_allocator) MONO_INTERNAL;
656 void mono_sgen_debug_printf (int level, const char *format, ...) MONO_INTERNAL;
658 gboolean mono_sgen_parse_environment_string_extract_number (const char *str, glong *out) MONO_INTERNAL;
660 void mono_sgen_internal_scan_objects (SgenInternalAllocator *alc, IterateObjectCallbackFunc callback, void *callback_data) MONO_INTERNAL;
661 void mono_sgen_internal_scan_pinned_objects (SgenInternalAllocator *alc, IterateObjectCallbackFunc callback, void *callback_data) MONO_INTERNAL;
663 void mono_sgen_internal_update_heap_boundaries (SgenInternalAllocator *alc) MONO_INTERNAL;
665 void** mono_sgen_find_optimized_pin_queue_area (void *start, void *end, int *num) MONO_INTERNAL;
666 void mono_sgen_find_section_pin_queue_start_end (GCMemSection *section) MONO_INTERNAL;
667 void mono_sgen_pin_objects_in_section (GCMemSection *section, SgenGrayQueue *queue) MONO_INTERNAL;
669 void mono_sgen_pin_stats_register_object (char *obj, size_t size);
671 void mono_sgen_add_to_global_remset (gpointer ptr) MONO_INTERNAL;
673 int mono_sgen_get_current_collection_generation (void) MONO_INTERNAL;
675 typedef void (*sgen_cardtable_block_callback) (mword start, mword size);
677 typedef struct _SgenMajorCollector SgenMajorCollector;
678 struct _SgenMajorCollector {
680 gboolean is_parallel;
681 gboolean supports_cardtable;
684 * This is set to TRUE if the sweep for the last major
685 * collection has been completed.
687 gboolean *have_swept;
689 void* (*alloc_heap) (mword nursery_size, mword nursery_align, int nursery_bits);
690 gboolean (*is_object_live) (char *obj);
691 void* (*alloc_small_pinned_obj) (size_t size, gboolean has_references);
692 void* (*alloc_degraded) (MonoVTable *vtable, size_t size);
693 void (*copy_or_mark_object) (void **obj_slot, SgenGrayQueue *queue);
694 void (*minor_scan_object) (char *start, SgenGrayQueue *queue);
695 char* (*minor_scan_vtype) (char *start, mword desc, char* from_start, char* from_end, SgenGrayQueue *queue);
696 void (*major_scan_object) (char *start, SgenGrayQueue *queue);
697 void (*copy_object) (void **obj_slot, SgenGrayQueue *queue);
698 void* (*alloc_object) (int size, gboolean has_references);
699 void (*free_pinned_object) (char *obj, size_t size);
700 void (*iterate_objects) (gboolean non_pinned, gboolean pinned, IterateObjectCallbackFunc callback, void *data);
701 void (*free_non_pinned_object) (char *obj, size_t size);
702 void (*find_pin_queue_start_ends) (SgenGrayQueue *queue);
703 void (*pin_objects) (SgenGrayQueue *queue);
704 void (*scan_card_table) (SgenGrayQueue *queue);
705 void (*iterate_live_block_ranges) (sgen_cardtable_block_callback callback);
706 void (*init_to_space) (void);
707 void (*sweep) (void);
708 void (*check_scan_starts) (void);
709 void (*dump_heap) (FILE *heap_dump_file);
710 gint64 (*get_used_size) (void);
711 void (*start_nursery_collection) (void);
712 void (*finish_nursery_collection) (void);
713 void (*start_major_collection) (void);
714 void (*finish_major_collection) (void);
715 void (*have_computed_minor_collection_allowance) (void);
716 gboolean (*ptr_is_in_non_pinned_space) (char *ptr);
717 gboolean (*obj_is_from_pinned_alloc) (char *obj);
718 void (*report_pinned_memory_usage) (void);
719 int (*get_num_major_sections) (void);
720 gboolean (*handle_gc_param) (const char *opt);
721 void (*print_gc_param_usage) (void);
722 gboolean (*is_worker_thread) (pthread_t thread);
725 void mono_sgen_marksweep_init (SgenMajorCollector *collector) MONO_INTERNAL;
726 void mono_sgen_marksweep_fixed_init (SgenMajorCollector *collector) MONO_INTERNAL;
727 void mono_sgen_marksweep_par_init (SgenMajorCollector *collector) MONO_INTERNAL;
728 void mono_sgen_marksweep_fixed_par_init (SgenMajorCollector *collector) MONO_INTERNAL;
729 void mono_sgen_copying_init (SgenMajorCollector *collector) MONO_INTERNAL;
732 * This function can be called on an object whose first word, the
733 * vtable field, is not intact. This is necessary for the parallel
737 mono_sgen_par_object_get_size (MonoVTable *vtable, MonoObject* o)
739 MonoClass *klass = vtable->klass;
741 * We depend on mono_string_length_fast and
742 * mono_array_length_fast not using the object's vtable.
744 if (klass == mono_defaults.string_class) {
745 return sizeof (MonoString) + 2 * mono_string_length_fast ((MonoString*) o) + 2;
746 } else if (klass->rank) {
747 MonoArray *array = (MonoArray*)o;
748 size_t size = sizeof (MonoArray) + klass->sizes.element_size * mono_array_length_fast (array);
749 if (G_UNLIKELY (array->bounds)) {
750 size += sizeof (mono_array_size_t) - 1;
751 size &= ~(sizeof (mono_array_size_t) - 1);
752 size += sizeof (MonoArrayBounds) * klass->rank;
756 /* from a created object: the class must be inited already */
757 return klass->instance_size;
761 #define mono_sgen_safe_object_get_size(o) mono_sgen_par_object_get_size ((MonoVTable*)SGEN_LOAD_VTABLE ((o)), (o))
763 const char* mono_sgen_safe_name (void* obj) MONO_INTERNAL;
770 gboolean mono_sgen_try_alloc_space (mword size, int space) MONO_INTERNAL;
771 void mono_sgen_release_space (mword size, int space) MONO_INTERNAL;
772 void mono_sgen_pin_object (void *object, SgenGrayQueue *queue) MONO_INTERNAL;
773 void sgen_collect_major_no_lock (const char *reason) MONO_INTERNAL;
774 gboolean mono_sgen_need_major_collection (mword space_needed) MONO_INTERNAL;
778 typedef struct _LOSObject LOSObject;
781 mword size; /* this is the object size */
783 int dummy; /* to have a sizeof (LOSObject) a multiple of ALLOC_ALIGN and data starting at same alignment */
784 char data [MONO_ZERO_LEN_ARRAY];
787 #define ARRAY_OBJ_INDEX(ptr,array,elem_size) (((char*)(ptr) - ((char*)(array) + G_STRUCT_OFFSET (MonoArray, vector))) / (elem_size))
789 extern LOSObject *los_object_list;
790 extern mword los_memory_usage;
791 extern mword last_los_memory_usage;
793 void mono_sgen_los_free_object (LOSObject *obj) MONO_INTERNAL;
794 void* mono_sgen_los_alloc_large_inner (MonoVTable *vtable, size_t size) MONO_INTERNAL;
795 void mono_sgen_los_sweep (void) MONO_INTERNAL;
796 gboolean mono_sgen_ptr_is_in_los (char *ptr, char **start) MONO_INTERNAL;
797 void mono_sgen_los_iterate_objects (IterateObjectCallbackFunc cb, void *user_data) MONO_INTERNAL;
798 void mono_sgen_los_iterate_live_block_ranges (sgen_cardtable_block_callback callback) MONO_INTERNAL;
799 void mono_sgen_los_scan_card_table (SgenGrayQueue *queue) MONO_INTERNAL;
800 FILE *mono_sgen_get_logfile (void) MONO_INTERNAL;
802 #endif /* __MONO_SGENGC_H__ */