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/utils/gc_wrapper.h>
15 #include <mono/metadata/object-internals.h>
16 #include <mono/metadata/threads-types.h>
17 #include <mono/sgen/gc-internal-agnostic.h>
18 #include <mono/utils/gc_wrapper.h>
20 #define mono_domain_finalizers_lock(domain) mono_mutex_lock (&(domain)->finalizable_objects_hash_lock);
21 #define mono_domain_finalizers_unlock(domain) mono_mutex_unlock (&(domain)->finalizable_objects_hash_lock);
23 /* Register a memory area as a conservatively scanned GC root */
24 #define MONO_GC_REGISTER_ROOT_PINNING(x,src,msg) mono_gc_register_root ((char*)&(x), sizeof(x), MONO_GC_DESCRIPTOR_NULL, (src), (msg))
26 #define MONO_GC_UNREGISTER_ROOT(x) mono_gc_deregister_root ((char*)&(x))
29 * Register a memory location as a root pointing to memory allocated using
30 * mono_gc_alloc_fixed (). This includes MonoGHashTable.
32 /* The result of alloc_fixed () is not GC tracked memory */
33 #define MONO_GC_REGISTER_ROOT_FIXED(x,src,msg) do { \
34 if (!mono_gc_is_moving ()) \
35 MONO_GC_REGISTER_ROOT_PINNING ((x),(src),(msg)); \
39 * Return a GC descriptor for an array containing N pointers to memory allocated
40 * by mono_gc_alloc_fixed ().
42 /* For SGEN, the result of alloc_fixed () is not GC tracked memory */
43 #define MONO_GC_ROOT_DESCR_FOR_FIXED(n) (mono_gc_is_moving () ? mono_gc_make_root_descr_all_refs (0) : MONO_GC_DESCRIPTOR_NULL)
45 /* Register a memory location holding a single object reference as a GC root */
46 #define MONO_GC_REGISTER_ROOT_SINGLE(x,src,msg) do { \
47 g_assert (sizeof (x) == sizeof (MonoObject*)); \
48 mono_gc_register_root ((char*)&(x), sizeof(MonoObject*), mono_gc_make_root_descr_all_refs (1), (src), (msg)); \
52 * This is used for fields which point to objects which are kept alive by other references
55 #define MONO_GC_REGISTER_ROOT_IF_MOVING(x,src,msg) do { \
56 if (mono_gc_is_moving ()) \
57 MONO_GC_REGISTER_ROOT_SINGLE(x,src,msg); \
60 #define MONO_GC_UNREGISTER_ROOT_IF_MOVING(x) do { \
61 if (mono_gc_is_moving ()) \
62 MONO_GC_UNREGISTER_ROOT (x); \
65 /* useful until we keep track of gc-references in corlib etc. */
66 #define IS_GC_REFERENCE(class,t) (mono_gc_is_moving () ? FALSE : ((t)->type == MONO_TYPE_U && (class)->image == mono_defaults.corlib))
68 void mono_object_register_finalizer (MonoObject *obj);
69 void ves_icall_System_GC_InternalCollect (int generation);
70 gint64 ves_icall_System_GC_GetTotalMemory (MonoBoolean forceCollection);
71 void ves_icall_System_GC_KeepAlive (MonoObject *obj);
72 void ves_icall_System_GC_ReRegisterForFinalize (MonoObject *obj);
73 void ves_icall_System_GC_SuppressFinalize (MonoObject *obj);
74 void ves_icall_System_GC_WaitForPendingFinalizers (void);
76 MonoObject *ves_icall_System_GCHandle_GetTarget (guint32 handle);
77 guint32 ves_icall_System_GCHandle_GetTargetHandle (MonoObject *obj, guint32 handle, gint32 type);
78 void ves_icall_System_GCHandle_FreeHandle (guint32 handle);
79 gpointer ves_icall_System_GCHandle_GetAddrOfPinnedObject (guint32 handle);
80 void ves_icall_System_GC_register_ephemeron_array (MonoObject *array);
81 MonoObject *ves_icall_System_GC_get_ephemeron_tombstone (void);
83 MonoBoolean ves_icall_Mono_Runtime_SetGCAllowSynchronousMajor (MonoBoolean flag);
85 extern void mono_gc_init (void);
86 extern void mono_gc_base_init (void);
87 extern void mono_gc_cleanup (void);
88 extern void mono_gc_mutex_cleanup (void);
89 extern void mono_gc_base_cleanup (void);
92 * Return whenever the current thread is registered with the GC (i.e. started
93 * by the GC pthread wrappers on unix.
95 extern gboolean mono_gc_is_gc_thread (void);
97 extern gboolean mono_gc_is_finalizer_internal_thread (MonoInternalThread *thread);
99 extern void mono_gc_set_stack_end (void *stack_end);
101 /* only valid after the RECLAIM_START GC event and before RECLAIM_END
102 * Not exported in public headers, but can be linked to (unsupported).
104 gboolean mono_object_is_alive (MonoObject* obj);
105 gboolean mono_gc_is_finalizer_thread (MonoThread *thread);
106 gpointer mono_gc_out_of_memory (size_t size);
107 void mono_gc_enable_events (void);
108 void mono_gc_enable_alloc_events (void);
110 /* disappearing link functionality */
111 void mono_gc_weak_link_add (void **link_addr, MonoObject *obj, gboolean track);
112 void mono_gc_weak_link_remove (void **link_addr, gboolean track);
113 MonoObject *mono_gc_weak_link_get (void **link_addr);
115 /*Ephemeron functionality. Sgen only*/
116 gboolean mono_gc_ephemeron_array_add (MonoObject *obj);
118 /* To disable synchronous, evacuating collections - concurrent SGen only */
119 gboolean mono_gc_set_allow_synchronous_major (gboolean flag);
122 mono_gc_GCHandle_CheckCurrentDomain (guint32 gchandle);
124 /* User defined marking function */
125 /* It should work like this:
126 * foreach (ref in GC references in the are structure pointed to by ADDR)
129 typedef void (*MonoGCMarkFunc) (MonoObject **addr, void *gc_data);
130 typedef void (*MonoGCRootMarkFunc) (void *addr, MonoGCMarkFunc mark_func, void *gc_data);
132 /* Create a descriptor with a user defined marking function */
133 MonoGCDescriptor mono_gc_make_root_descr_user (MonoGCRootMarkFunc marker);
135 /* Return whenever user defined marking functions are supported */
136 gboolean mono_gc_user_markers_supported (void);
138 /* desc is the result from mono_gc_make_descr*. A NULL value means
139 * all the words might contain GC pointers.
140 * The memory is non-moving and it will be explicitly deallocated.
141 * size bytes will be available from the returned address (ie, descr
142 * must not be stored in the returned memory)
143 * NOTE: Under Boehm, this returns memory allocated using GC_malloc, so the result should
144 * be stored into a location registered using MONO_GC_REGISTER_ROOT_FIXED ().
146 void* mono_gc_alloc_fixed (size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg);
147 void mono_gc_free_fixed (void* addr);
149 /* make sure the gchandle was allocated for an object in domain */
150 gboolean mono_gchandle_is_in_domain (guint32 gchandle, MonoDomain *domain);
151 void mono_gchandle_free_domain (MonoDomain *domain);
153 typedef void (*FinalizerThreadCallback) (gpointer user_data);
155 /* if there are finalizers to run, run them. Returns the number of finalizers run */
156 gboolean mono_gc_pending_finalizers (void);
157 void mono_gc_finalize_notify (void);
159 void* mono_gc_alloc_pinned_obj (MonoVTable *vtable, size_t size);
160 void* mono_gc_alloc_obj (MonoVTable *vtable, size_t size);
161 void* mono_gc_alloc_vector (MonoVTable *vtable, size_t size, uintptr_t max_length);
162 void* mono_gc_alloc_array (MonoVTable *vtable, size_t size, uintptr_t max_length, uintptr_t bounds_size);
163 void* mono_gc_alloc_string (MonoVTable *vtable, size_t size, gint32 len);
164 MonoGCDescriptor mono_gc_make_descr_for_string (gsize *bitmap, int numbits);
166 void mono_gc_register_for_finalization (MonoObject *obj, void *user_data);
167 void mono_gc_add_memory_pressure (gint64 value);
168 MONO_API int mono_gc_register_root (char *start, size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg);
169 void mono_gc_deregister_root (char* addr);
170 int mono_gc_finalizers_for_domain (MonoDomain *domain, MonoObject **out_array, int out_size);
171 void mono_gc_run_finalize (void *obj, void *data);
172 void mono_gc_clear_domain (MonoDomain * domain);
173 void* mono_gc_alloc_mature (MonoVTable *vtable);
176 * Register a root which can only be written using a write barrier.
177 * Writes to the root must be done using a write barrier (MONO_ROOT_SETREF).
178 * If the root uses an user defined mark routine, the writes are not required to be
179 * to the area between START and START+SIZE.
180 * The write barrier allows the GC to avoid scanning this root at each collection, so it
182 * FIXME: Add an API for clearing remset entries if a root with a user defined
183 * mark routine is deleted.
185 int mono_gc_register_root_wbarrier (char *start, size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg);
187 void mono_gc_wbarrier_set_root (gpointer ptr, MonoObject *value);
189 /* Set a field of a root registered using mono_gc_register_root_wbarrier () */
190 #define MONO_ROOT_SETREF(s,fieldname,value) do { \
191 mono_gc_wbarrier_set_root (&((s)->fieldname), (MonoObject*)value); \
194 void mono_gc_finalize_threadpool_threads (void);
196 /* fast allocation support */
198 /* Accessible using mono_marshal_wrapper_info_from_wrapper () */
202 } AllocatorWrapperInfo;
204 int mono_gc_get_aligned_size_for_allocator (int size);
205 MonoMethod* mono_gc_get_managed_allocator (MonoClass *klass, gboolean for_box, gboolean known_instance_size);
206 MonoMethod* mono_gc_get_managed_array_allocator (MonoClass *klass);
207 MonoMethod *mono_gc_get_managed_allocator_by_type (int atype, gboolean slowpath);
209 guint32 mono_gc_get_managed_allocator_types (void);
211 /* Return a short string identifying the GC, indented to be saved in AOT images */
212 const char *mono_gc_get_gc_name (void);
214 /* Fast write barriers */
215 MonoMethod* mono_gc_get_specific_write_barrier (gboolean is_concurrent);
216 MonoMethod* mono_gc_get_write_barrier (void);
218 /* Fast valuetype copy */
219 void mono_gc_wbarrier_value_copy_bitmap (gpointer dest, gpointer src, int size, unsigned bitmap);
221 /* helper for the managed alloc support */
222 MonoString *mono_string_alloc (int length);
225 * Functions supplied by the runtime and called by the GC. Currently only used
230 * Function called during thread startup/attach to allocate thread-local data
231 * needed by the other functions.
233 gpointer (*thread_attach_func) (void);
235 * Function called during thread deatch to free the data allocated by
236 * thread_attach_func.
238 void (*thread_detach_func) (gpointer user_data);
240 * Function called from every thread when suspending for GC. It can save
241 * data needed for marking from thread stacks. user_data is the data returned
242 * by attach_func. This might called with GC locks held and the word stopped,
243 * so it shouldn't do any synchronization etc.
245 void (*thread_suspend_func) (gpointer user_data, void *sigcontext, MonoContext *ctx);
247 * Function called to mark from thread stacks. user_data is the data returned
248 * by attach_func. This is called twice, with the word stopped:
249 * - in the first pass, it should mark areas of the stack using
250 * conservative marking by calling mono_gc_conservatively_scan_area ().
251 * - in the second pass, it should mark the remaining areas of the stack
252 * using precise marking by calling mono_gc_scan_object ().
254 void (*thread_mark_func) (gpointer user_data, guint8 *stack_start, guint8 *stack_end, gboolean precise, void *gc_data);
256 * Function called for debugging to get the current managed method for
257 * tracking the provenances of objects.
259 gpointer (*get_provenance_func) (void);
262 /* Set the callback functions callable by the GC */
263 void mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks);
264 MonoGCCallbacks *mono_gc_get_gc_callbacks (void);
266 /* Functions callable from the thread mark func */
268 /* Scan the memory area between START and END conservatively */
269 void mono_gc_conservatively_scan_area (void *start, void *end);
271 /* Scan OBJ, returning its new address */
272 void *mono_gc_scan_object (void *obj, void *gc_data);
274 /* Return the suspend signal number used by the GC to suspend threads,
275 or -1 if not applicable. */
276 int mono_gc_get_suspend_signal (void);
278 /* Return the suspend signal number used by the GC to suspend threads,
279 or -1 if not applicable. */
280 int mono_gc_get_restart_signal (void);
283 * Return a human readable description of the GC in malloc-ed memory.
285 char* mono_gc_get_description (void);
288 * Configure the GC to desktop mode
290 void mono_gc_set_desktop_mode (void);
293 * Return whenever this GC can move objects
295 gboolean mono_gc_is_moving (void);
297 typedef void* (*MonoGCLockedCallbackFunc) (void *data);
299 void* mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data);
301 int mono_gc_get_los_limit (void);
303 guint8* mono_gc_get_card_table (int *shift_bits, gpointer *card_mask);
304 gboolean mono_gc_card_table_nursery_check (void);
306 void* mono_gc_get_nursery (int *shift_bits, size_t *size);
308 void mono_gc_set_current_thread_appdomain (MonoDomain *domain);
310 void mono_gc_set_skip_thread (gboolean skip);
313 int mono_gc_pthread_create (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg);
317 * Return whenever GC is disabled
319 gboolean mono_gc_is_disabled (void);
322 * Return whenever this is the null GC
324 gboolean mono_gc_is_null (void);
326 void mono_gc_set_string_length (MonoString *str, gint32 new_length);
328 #if defined(__MACH__)
329 void mono_gc_register_mach_exception_thread (pthread_t thread);
330 pthread_t mono_gc_get_mach_exception_thread (void);
333 gboolean mono_gc_precise_stack_mark_enabled (void);
335 typedef struct _RefQueueEntry RefQueueEntry;
337 struct _RefQueueEntry {
345 struct _MonoReferenceQueue {
346 RefQueueEntry *queue;
347 mono_reference_queue_callback callback;
348 MonoReferenceQueue *next;
349 gboolean should_be_deleted;
353 MONO_GC_FINALIZER_EXTENSION_VERSION = 1,
358 gboolean (*is_class_finalization_aware) (MonoClass *klass);
359 void (*object_queued_for_finalization) (MonoObject *object);
360 } MonoGCFinalizerCallbacks;
362 MONO_API void mono_gc_register_finalizer_callbacks (MonoGCFinalizerCallbacks *callbacks);
366 BOOL APIENTRY mono_gc_dllmain (HMODULE module_handle, DWORD reason, LPVOID reserved);
369 guint mono_gc_get_vtable_bits (MonoClass *klass);
371 void mono_gc_register_altstack (gpointer stack, gint32 stack_size, gpointer altstack, gint32 altstack_size);
373 /* If set, print debugging messages around finalizers. */
374 extern gboolean log_finalizers;
376 /* If set, do not run finalizers. */
377 extern gboolean do_not_finalize;
379 gboolean mono_gc_object_older_than (MonoObject *object, int generation);
381 #endif /* __MONO_METADATA_GC_INTERNAL_H__ */