2 * metadata/gc-internal.h: Internal GC interface
4 * Author: Paolo Molaro <lupus@ximian.com>
6 * (C) 2002 Ximian, Inc.
7 * Copyright 2012 Xamarin Inc (http://www.xamarin.com)
10 #ifndef __MONO_METADATA_GC_INTERNAL_H__
11 #define __MONO_METADATA_GC_INTERNAL_H__
14 #include <mono/metadata/object-internals.h>
15 #include <mono/metadata/threads-types.h>
16 #include <mono/utils/gc_wrapper.h>
21 long long minor_gc_time_usecs;
22 long long major_gc_time_usecs;
25 #define mono_domain_finalizers_lock(domain) EnterCriticalSection (&(domain)->finalizable_objects_hash_lock);
26 #define mono_domain_finalizers_unlock(domain) LeaveCriticalSection (&(domain)->finalizable_objects_hash_lock);
28 /* Register a memory area as a conservatively scanned GC root */
29 #define MONO_GC_REGISTER_ROOT_PINNING(x) mono_gc_register_root ((char*)&(x), sizeof(x), NULL)
31 #define MONO_GC_UNREGISTER_ROOT(x) mono_gc_deregister_root ((char*)&(x))
34 * Register a memory location as a root pointing to memory allocated using
35 * mono_gc_alloc_fixed (). This includes MonoGHashTable.
37 /* The result of alloc_fixed () is not GC tracked memory */
38 #define MONO_GC_REGISTER_ROOT_FIXED(x) do { \
39 if (!mono_gc_is_moving ()) \
40 MONO_GC_REGISTER_ROOT_PINNING ((x)); \
44 * Return a GC descriptor for an array containing N pointers to memory allocated
45 * by mono_gc_alloc_fixed ().
47 /* For SGEN, the result of alloc_fixed () is not GC tracked memory */
48 #define MONO_GC_ROOT_DESCR_FOR_FIXED(n) (mono_gc_is_moving () ? mono_gc_make_root_descr_all_refs (0) : NULL)
50 /* Register a memory location holding a single object reference as a GC root */
51 #define MONO_GC_REGISTER_ROOT_SINGLE(x) do { \
52 g_assert (sizeof (x) == sizeof (MonoObject*)); \
53 mono_gc_register_root ((char*)&(x), sizeof(MonoObject*), mono_gc_make_root_descr_all_refs (1)); \
57 * This is used for fields which point to objects which are kept alive by other references
60 #define MONO_GC_REGISTER_ROOT_IF_MOVING(x) do { \
61 if (mono_gc_is_moving ()) \
62 MONO_GC_REGISTER_ROOT_SINGLE(x); \
65 #define MONO_GC_UNREGISTER_ROOT_IF_MOVING(x) do { \
66 if (mono_gc_is_moving ()) \
67 MONO_GC_UNREGISTER_ROOT (x); \
70 /* useful until we keep track of gc-references in corlib etc. */
71 #define IS_GC_REFERENCE(t) (mono_gc_is_moving () ? FALSE : ((t)->type == MONO_TYPE_U && class->image == mono_defaults.corlib))
73 extern GCStats gc_stats MONO_INTERNAL;
75 void mono_object_register_finalizer (MonoObject *obj) MONO_INTERNAL;
76 void ves_icall_System_GC_InternalCollect (int generation) MONO_INTERNAL;
77 gint64 ves_icall_System_GC_GetTotalMemory (MonoBoolean forceCollection) MONO_INTERNAL;
78 void ves_icall_System_GC_KeepAlive (MonoObject *obj) MONO_INTERNAL;
79 void ves_icall_System_GC_ReRegisterForFinalize (MonoObject *obj) MONO_INTERNAL;
80 void ves_icall_System_GC_SuppressFinalize (MonoObject *obj) MONO_INTERNAL;
81 void ves_icall_System_GC_WaitForPendingFinalizers (void) MONO_INTERNAL;
83 MonoObject *ves_icall_System_GCHandle_GetTarget (guint32 handle) MONO_INTERNAL;
84 guint32 ves_icall_System_GCHandle_GetTargetHandle (MonoObject *obj, guint32 handle, gint32 type) MONO_INTERNAL;
85 void ves_icall_System_GCHandle_FreeHandle (guint32 handle) MONO_INTERNAL;
86 gpointer ves_icall_System_GCHandle_GetAddrOfPinnedObject (guint32 handle) MONO_INTERNAL;
87 void ves_icall_System_GC_register_ephemeron_array (MonoObject *array) MONO_INTERNAL;
88 MonoObject *ves_icall_System_GC_get_ephemeron_tombstone (void) MONO_INTERNAL;
90 extern void mono_gc_init (void) MONO_INTERNAL;
91 extern void mono_gc_base_init (void) MONO_INTERNAL;
92 extern void mono_gc_cleanup (void) MONO_INTERNAL;
93 extern void mono_gc_enable (void) MONO_INTERNAL;
94 extern void mono_gc_disable (void) MONO_INTERNAL;
97 * Return whenever the current thread is registered with the GC (i.e. started
98 * by the GC pthread wrappers on unix.
100 extern gboolean mono_gc_is_gc_thread (void) MONO_INTERNAL;
103 * Try to register a foreign thread with the GC, if we fail or the backend
104 * can't cope with this concept - we return FALSE.
106 extern gboolean mono_gc_register_thread (void *baseptr) MONO_INTERNAL;
108 extern gboolean mono_gc_is_finalizer_internal_thread (MonoInternalThread *thread) MONO_INTERNAL;
110 extern void mono_gc_set_stack_end (void *stack_end) MONO_INTERNAL;
112 /* only valid after the RECLAIM_START GC event and before RECLAIM_END
113 * Not exported in public headers, but can be linked to (unsupported).
115 extern gboolean mono_object_is_alive (MonoObject* obj);
116 extern gboolean mono_gc_is_finalizer_thread (MonoThread *thread);
117 extern gpointer mono_gc_out_of_memory (size_t size);
118 extern void mono_gc_enable_events (void);
120 /* disappearing link functionality */
121 void mono_gc_weak_link_add (void **link_addr, MonoObject *obj, gboolean track) MONO_INTERNAL;
122 void mono_gc_weak_link_remove (void **link_addr) MONO_INTERNAL;
123 MonoObject *mono_gc_weak_link_get (void **link_addr) MONO_INTERNAL;
126 void mono_gc_add_weak_track_handle (MonoObject *obj, guint32 gchandle) MONO_INTERNAL;
127 void mono_gc_change_weak_track_handle (MonoObject *old_obj, MonoObject *obj, guint32 gchandle) MONO_INTERNAL;
128 void mono_gc_remove_weak_track_handle (guint32 gchandle) MONO_INTERNAL;
129 GSList* mono_gc_remove_weak_track_object (MonoDomain *domain, MonoObject *obj) MONO_INTERNAL;
132 /*Ephemeron functionality. Sgen only*/
133 gboolean mono_gc_ephemeron_array_add (MonoObject *obj) MONO_INTERNAL;
137 GCHandle_CheckCurrentDomain (guint32 gchandle) MONO_INTERNAL;
139 /* simple interface for data structures needed in the runtime */
140 void* mono_gc_make_descr_from_bitmap (gsize *bitmap, int numbits) MONO_INTERNAL;
142 /* Return a root descriptor for a root with all refs */
143 void* mono_gc_make_root_descr_all_refs (int numbits) MONO_INTERNAL;
145 /* User defined marking function */
146 /* It should work like this:
147 * foreach (ref in GC references in the are structure pointed to by ADDR)
150 typedef void (*MonoGCMarkFunc) (void **addr);
151 typedef void (*MonoGCRootMarkFunc) (void *addr, MonoGCMarkFunc mark_func);
153 /* Create a descriptor with a user defined marking function */
154 void *mono_gc_make_root_descr_user (MonoGCRootMarkFunc marker);
156 /* Return whenever user defined marking functions are supported */
157 gboolean mono_gc_user_markers_supported (void) MONO_INTERNAL;
159 /* desc is the result from mono_gc_make_descr*. A NULL value means
160 * all the words might contain GC pointers.
161 * The memory is non-moving and it will be explicitly deallocated.
162 * size bytes will be available from the returned address (ie, descr
163 * must not be stored in the returned memory)
164 * NOTE: Under Boehm, this returns memory allocated using GC_malloc, so the result should
165 * be stored into a location registered using MONO_GC_REGISTER_ROOT_FIXED ().
167 void* mono_gc_alloc_fixed (size_t size, void *descr) MONO_INTERNAL;
168 void mono_gc_free_fixed (void* addr) MONO_INTERNAL;
170 /* make sure the gchandle was allocated for an object in domain */
171 gboolean mono_gchandle_is_in_domain (guint32 gchandle, MonoDomain *domain) MONO_INTERNAL;
172 void mono_gchandle_free_domain (MonoDomain *domain) MONO_INTERNAL;
174 typedef void (*FinalizerThreadCallback) (gpointer user_data);
176 /* if there are finalizers to run, run them. Returns the number of finalizers run */
177 gboolean mono_gc_pending_finalizers (void) MONO_INTERNAL;
178 void mono_gc_finalize_notify (void) MONO_INTERNAL;
180 void* mono_gc_alloc_pinned_obj (MonoVTable *vtable, size_t size) MONO_INTERNAL;
181 void* mono_gc_alloc_obj (MonoVTable *vtable, size_t size) MONO_INTERNAL;
182 void* mono_gc_alloc_vector (MonoVTable *vtable, size_t size, uintptr_t max_length) MONO_INTERNAL;
183 void* mono_gc_alloc_array (MonoVTable *vtable, size_t size, uintptr_t max_length, uintptr_t bounds_size) MONO_INTERNAL;
184 void* mono_gc_alloc_string (MonoVTable *vtable, size_t size, gint32 len) MONO_INTERNAL;
185 void* mono_gc_make_descr_for_string (gsize *bitmap, int numbits) MONO_INTERNAL;
186 void* mono_gc_make_descr_for_object (gsize *bitmap, int numbits, size_t obj_size) MONO_INTERNAL;
187 void* mono_gc_make_descr_for_array (int vector, gsize *elem_bitmap, int numbits, size_t elem_size) MONO_INTERNAL;
189 void mono_gc_register_for_finalization (MonoObject *obj, void *user_data) MONO_INTERNAL;
190 void mono_gc_add_memory_pressure (gint64 value) MONO_INTERNAL;
191 int mono_gc_register_root (char *start, size_t size, void *descr) MONO_INTERNAL;
192 void mono_gc_deregister_root (char* addr) MONO_INTERNAL;
193 int mono_gc_finalizers_for_domain (MonoDomain *domain, MonoObject **out_array, int out_size) MONO_INTERNAL;
194 void mono_gc_run_finalize (void *obj, void *data) MONO_INTERNAL;
195 void mono_gc_clear_domain (MonoDomain * domain) MONO_INTERNAL;
196 void* mono_gc_alloc_mature (MonoVTable *vtable) MONO_INTERNAL;
199 * Register a root which can only be written using a write barrier.
200 * Writes to the root must be done using a write barrier (MONO_ROOT_SETREF).
201 * If the root uses an user defined mark routine, the writes are not required to be
202 * to the area between START and START+SIZE.
203 * The write barrier allows the GC to avoid scanning this root at each collection, so it
205 * FIXME: Add an API for clearing remset entries if a root with a user defined
206 * mark routine is deleted.
208 int mono_gc_register_root_wbarrier (char *start, size_t size, void *descr) MONO_INTERNAL;
210 void mono_gc_wbarrier_set_root (gpointer ptr, MonoObject *value) MONO_INTERNAL;
212 /* Set a field of a root registered using mono_gc_register_root_wbarrier () */
213 #define MONO_ROOT_SETREF(s,fieldname,value) do { \
214 mono_gc_wbarrier_set_root (&((s)->fieldname), (MonoObject*)value); \
217 void mono_gc_finalize_threadpool_threads (void) MONO_INTERNAL;
219 /* fast allocation support */
221 /* Accessible using mono_marshal_wrapper_info_from_wrapper () */
225 } AllocatorWrapperInfo;
227 MonoMethod* mono_gc_get_managed_allocator (MonoVTable *vtable, gboolean for_box) MONO_INTERNAL;
228 MonoMethod* mono_gc_get_managed_array_allocator (MonoVTable *vtable, int rank) MONO_INTERNAL;
229 MonoMethod *mono_gc_get_managed_allocator_by_type (int atype) MONO_INTERNAL;
231 guint32 mono_gc_get_managed_allocator_types (void) MONO_INTERNAL;
233 /* Return a short string identifying the GC, indented to be saved in AOT images */
234 const char *mono_gc_get_gc_name (void) MONO_INTERNAL;
236 /* Fast write barriers */
237 MonoMethod* mono_gc_get_write_barrier (void) MONO_INTERNAL;
239 /* Fast valuetype copy */
240 void mono_gc_wbarrier_value_copy_bitmap (gpointer dest, gpointer src, int size, unsigned bitmap) MONO_INTERNAL;
242 /* helper for the managed alloc support */
243 MonoString *mono_string_alloc (int length) MONO_INTERNAL;
246 * Functions supplied by the runtime and called by the GC. Currently only used
251 * Function called during thread startup/attach to allocate thread-local data
252 * needed by the other functions.
254 gpointer (*thread_attach_func) (void);
256 * Function called during thread deatch to free the data allocated by
257 * thread_attach_func.
259 void (*thread_detach_func) (gpointer user_data);
261 * Function called from every thread when suspending for GC. It can save
262 * data needed for marking from thread stacks. user_data is the data returned
263 * by attach_func. This might called with GC locks held and the word stopped,
264 * so it shouldn't do any synchronization etc.
266 void (*thread_suspend_func) (gpointer user_data, void *sigcontext, MonoContext *ctx);
268 * Function called to mark from thread stacks. user_data is the data returned
269 * by attach_func. This is called twice, with the word stopped:
270 * - in the first pass, it should mark areas of the stack using
271 * conservative marking by calling mono_gc_conservatively_scan_area ().
272 * - in the second pass, it should mark the remaining areas of the stack
273 * using precise marking by calling mono_gc_scan_object ().
275 void (*thread_mark_func) (gpointer user_data, guint8 *stack_start, guint8 *stack_end, gboolean precise);
278 /* Set the callback functions callable by the GC */
279 void mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks) MONO_INTERNAL;
280 MonoGCCallbacks *mono_gc_get_gc_callbacks (void) MONO_INTERNAL;
282 /* Functions callable from the thread mark func */
284 /* Scan the memory area between START and END conservatively */
285 void mono_gc_conservatively_scan_area (void *start, void *end) MONO_INTERNAL;
287 /* Scan OBJ, returning its new address */
288 void *mono_gc_scan_object (void *obj) MONO_INTERNAL;
290 /* Return the bitmap encoded by a descriptor */
291 gsize* mono_gc_get_bitmap_for_descr (void *descr, int *numbits) MONO_INTERNAL;
293 /* Return the suspend signal number used by the GC to suspend threads,
294 or -1 if not applicable. */
295 int mono_gc_get_suspend_signal (void) MONO_INTERNAL;
298 * Return a human readable description of the GC in malloc-ed memory.
300 char* mono_gc_get_description (void) MONO_INTERNAL;
303 * Configure the GC to desktop mode
305 void mono_gc_set_desktop_mode (void) MONO_INTERNAL;
308 * Return whenever this GC can move objects
310 gboolean mono_gc_is_moving (void) MONO_INTERNAL;
312 typedef void* (*MonoGCLockedCallbackFunc) (void *data);
314 void* mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data) MONO_INTERNAL;
316 int mono_gc_get_los_limit (void) MONO_INTERNAL;
318 guint8* mono_gc_get_card_table (int *shift_bits, gpointer *card_mask) MONO_INTERNAL;
320 void* mono_gc_get_nursery (int *shift_bits, size_t *size) MONO_INTERNAL;
322 void mono_gc_set_current_thread_appdomain (MonoDomain *domain) MONO_INTERNAL;
324 void mono_gc_set_skip_thread (gboolean skip) MONO_INTERNAL;
327 * Return whenever GC is disabled
329 gboolean mono_gc_is_disabled (void) MONO_INTERNAL;
331 #if defined(__MACH__)
332 void mono_gc_register_mach_exception_thread (pthread_t thread) MONO_INTERNAL;
333 pthread_t mono_gc_get_mach_exception_thread (void) MONO_INTERNAL;
336 gboolean mono_gc_parse_environment_string_extract_number (const char *str, glong *out) MONO_INTERNAL;
338 gboolean mono_gc_precise_stack_mark_enabled (void) MONO_INTERNAL;
340 FILE *mono_gc_get_logfile (void) MONO_INTERNAL;
342 typedef void (*mono_reference_queue_callback) (void *user_data);
344 typedef struct _MonoReferenceQueue MonoReferenceQueue;
345 typedef struct _RefQueueEntry RefQueueEntry;
347 struct _RefQueueEntry {
357 struct _MonoReferenceQueue {
358 RefQueueEntry *queue;
359 mono_reference_queue_callback callback;
360 MonoReferenceQueue *next;
361 gboolean should_be_deleted;
364 MonoReferenceQueue* mono_gc_reference_queue_new (mono_reference_queue_callback callback) MONO_INTERNAL;
365 void mono_gc_reference_queue_free (MonoReferenceQueue *queue) MONO_INTERNAL;
366 gboolean mono_gc_reference_queue_add (MonoReferenceQueue *queue, MonoObject *obj, void *user_data) MONO_INTERNAL;
369 BOOL APIENTRY mono_gc_dllmain (HMODULE module_handle, DWORD reason, LPVOID reserved) MONO_INTERNAL;
372 void mono_gc_bzero (void *dest, size_t size) MONO_INTERNAL;
373 void mono_gc_memmove (void *dest, const void *src, size_t size) MONO_INTERNAL;
375 guint mono_gc_get_vtable_bits (MonoClass *class) MONO_INTERNAL;
377 void mono_gc_register_altstack (gpointer stack, gint32 stack_size, gpointer altstack, gint32 altstack_size) MONO_INTERNAL;
379 #endif /* __MONO_METADATA_GC_INTERNAL_H__ */