mono/metadata/gc-internal.h

   1 /*
   2  * metadata/gc-internal.h: Internal GC interface
   3  *
   4  * Author: Paolo Molaro <lupus@ximian.com>
   5  *
   6  * (C) 2002 Ximian, Inc.
   7  */
   8
   9 #ifndef __MONO_METADATA_GC_INTERNAL_H__
  10 #define __MONO_METADATA_GC_INTERNAL_H__
  11
  12 #include <glib.h>
  13 #include <mono/metadata/object-internals.h>
  14 #include <mono/metadata/threads-types.h>
  15 #include <mono/utils/gc_wrapper.h>
  16
  17 #define mono_domain_finalizers_lock(domain) EnterCriticalSection (&(domain)->finalizable_objects_hash_lock);
  18 #define mono_domain_finalizers_unlock(domain) LeaveCriticalSection (&(domain)->finalizable_objects_hash_lock);
  19
  20 #define MONO_GC_REGISTER_ROOT(x) mono_gc_register_root ((char*)&(x), sizeof(x), NULL)
  21
  22 #define MONO_GC_UNREGISTER_ROOT(x) mono_gc_deregister_root ((char*)&(x))
  23
  24 void   mono_object_register_finalizer               (MonoObject  *obj) MONO_INTERNAL;
  25 void   ves_icall_System_GC_InternalCollect          (int          generation) MONO_INTERNAL;
  26 gint64 ves_icall_System_GC_GetTotalMemory           (MonoBoolean  forceCollection) MONO_INTERNAL;
  27 void   ves_icall_System_GC_KeepAlive                (MonoObject  *obj) MONO_INTERNAL;
  28 void   ves_icall_System_GC_ReRegisterForFinalize    (MonoObject  *obj) MONO_INTERNAL;
  29 void   ves_icall_System_GC_SuppressFinalize         (MonoObject  *obj) MONO_INTERNAL;
  30 void   ves_icall_System_GC_WaitForPendingFinalizers (void) MONO_INTERNAL;
  31
  32 MonoObject *ves_icall_System_GCHandle_GetTarget (guint32 handle) MONO_INTERNAL;
  33 guint32     ves_icall_System_GCHandle_GetTargetHandle (MonoObject *obj, guint32 handle, gint32 type) MONO_INTERNAL;
  34 void        ves_icall_System_GCHandle_FreeHandle (guint32 handle) MONO_INTERNAL;
  35 gpointer    ves_icall_System_GCHandle_GetAddrOfPinnedObject (guint32 handle) MONO_INTERNAL;
  36 void        ves_icall_System_GC_register_ephemeron_array (MonoObject *array) MONO_INTERNAL;
  37 MonoObject  *ves_icall_System_GC_get_ephemeron_tombstone (void) MONO_INTERNAL;
  38
  39 extern void mono_gc_init (void) MONO_INTERNAL;
  40 extern void mono_gc_base_init (void) MONO_INTERNAL;
  41 extern void mono_gc_cleanup (void) MONO_INTERNAL;
  42 extern void mono_gc_enable (void) MONO_INTERNAL;
  43 extern void mono_gc_disable (void) MONO_INTERNAL;
  44
  45 /*
  46  * Return whenever the current thread is registered with the GC (i.e. started
  47  * by the GC pthread wrappers on unix.
  48  */
  49 extern gboolean mono_gc_is_gc_thread (void) MONO_INTERNAL;
  50
  51 /*
  52  * Try to register a foreign thread with the GC, if we fail or the backend
  53  * can't cope with this concept - we return FALSE.
  54  */
  55 extern gboolean mono_gc_register_thread (void *baseptr) MONO_INTERNAL;
  56
  57 extern gboolean mono_gc_is_finalizer_internal_thread (MonoInternalThread *thread) MONO_INTERNAL;
  58
  59 /* only valid after the RECLAIM_START GC event and before RECLAIM_END
  60  * Not exported in public headers, but can be linked to (unsupported).
  61  */
  62 extern gboolean mono_object_is_alive (MonoObject* obj);
  63 extern gboolean mono_gc_is_finalizer_thread (MonoThread *thread);
  64 extern gpointer mono_gc_out_of_memory (size_t size);
  65 extern void     mono_gc_enable_events (void);
  66
  67 /* disappearing link functionality */
  68 void        mono_gc_weak_link_add    (void **link_addr, MonoObject *obj, gboolean track) MONO_INTERNAL;
  69 void        mono_gc_weak_link_remove (void **link_addr) MONO_INTERNAL;
  70 MonoObject *mono_gc_weak_link_get    (void **link_addr) MONO_INTERNAL;
  71
  72 #ifndef HAVE_SGEN_GC
  73 void    mono_gc_add_weak_track_handle    (MonoObject *obj, guint32 gchandle) MONO_INTERNAL;
  74 void    mono_gc_change_weak_track_handle (MonoObject *old_obj, MonoObject *obj, guint32 gchandle) MONO_INTERNAL;
  75 void    mono_gc_remove_weak_track_handle (guint32 gchandle) MONO_INTERNAL;
  76 GSList* mono_gc_remove_weak_track_object (MonoDomain *domain, MonoObject *obj) MONO_INTERNAL;
  77 #endif
  78
  79 /*Ephemeron functionality. Sgen only*/
  80 gboolean    mono_gc_ephemeron_array_add (MonoObject *obj) MONO_INTERNAL;
  81
  82
  83 MonoBoolean
  84 GCHandle_CheckCurrentDomain (guint32 gchandle) MONO_INTERNAL;
  85
  86 /* simple interface for data structures needed in the runtime */
  87 void* mono_gc_make_descr_from_bitmap (gsize *bitmap, int numbits) MONO_INTERNAL;
  88
  89 /* User defined marking function */
  90 /* It should work like this:
  91  * foreach (ref in GC references in the are structure pointed to by ADDR)
  92  *    mark_func (ref)
  93  */
  94 typedef void (*MonoGCMarkFunc)     (void **addr);
  95 typedef void (*MonoGCRootMarkFunc) (void *addr, MonoGCMarkFunc mark_func);
  96
  97 /* Create a descriptor with a user defined marking function */
  98 void *mono_gc_make_root_descr_user (MonoGCRootMarkFunc marker);
  99
 100 /* desc is the result from mono_gc_make_descr*. A NULL value means
 101  * all the words might contain GC pointers.
 102  * The memory is non-moving and it will be explicitly deallocated.
 103  * size bytes will be available from the returned address (ie, descr
 104  * must not be stored in the returned memory)
 105  */
 106 void* mono_gc_alloc_fixed            (size_t size, void *descr) MONO_INTERNAL;
 107 void  mono_gc_free_fixed             (void* addr) MONO_INTERNAL;
 108
 109 /* make sure the gchandle was allocated for an object in domain */
 110 gboolean mono_gchandle_is_in_domain (guint32 gchandle, MonoDomain *domain) MONO_INTERNAL;
 111 void     mono_gchandle_free_domain  (MonoDomain *domain) MONO_INTERNAL;
 112
 113 typedef void (*FinalizerThreadCallback) (gpointer user_data);
 114
 115 /* if there are finalizers to run, run them. Returns the number of finalizers run */
 116 gboolean mono_gc_pending_finalizers (void) MONO_INTERNAL;
 117 void     mono_gc_finalize_notify    (void) MONO_INTERNAL;
 118
 119 void* mono_gc_alloc_pinned_obj (MonoVTable *vtable, size_t size) MONO_INTERNAL;
 120 void* mono_gc_alloc_obj (MonoVTable *vtable, size_t size) MONO_INTERNAL;
 121 void* mono_gc_alloc_vector (MonoVTable *vtable, size_t size, uintptr_t max_length) MONO_INTERNAL;
 122 void* mono_gc_alloc_array (MonoVTable *vtable, size_t size, uintptr_t max_length, uintptr_t bounds_size) MONO_INTERNAL;
 123 void* mono_gc_alloc_string (MonoVTable *vtable, size_t size, gint32 len) MONO_INTERNAL;
 124 void* mono_gc_make_descr_for_string (gsize *bitmap, int numbits) MONO_INTERNAL;
 125 void* mono_gc_make_descr_for_object (gsize *bitmap, int numbits, size_t obj_size) MONO_INTERNAL;
 126 void* mono_gc_make_descr_for_array (int vector, gsize *elem_bitmap, int numbits, size_t elem_size) MONO_INTERNAL;
 127
 128 void  mono_gc_register_for_finalization (MonoObject *obj, void *user_data) MONO_INTERNAL;
 129 void  mono_gc_add_memory_pressure (gint64 value) MONO_INTERNAL;
 130 int   mono_gc_register_root (char *start, size_t size, void *descr) MONO_INTERNAL;
 131 void  mono_gc_deregister_root (char* addr) MONO_INTERNAL;
 132 int   mono_gc_finalizers_for_domain (MonoDomain *domain, MonoObject **out_array, int out_size) MONO_INTERNAL;
 133 void  mono_gc_run_finalize (void *obj, void *data) MONO_INTERNAL;
 134 void  mono_gc_clear_domain (MonoDomain * domain) MONO_INTERNAL;
 135
 136 /*
 137  * Register a root which can only be written using a write barrier.
 138  * Writes to the root must be done using a write barrier (MONO_ROOT_SETREF).
 139  * If the root uses an user defined mark routine, the writes are not required to be
 140  * to the area between START and START+SIZE.
 141  * The write barrier allows the GC to avoid scanning this root at each collection, so it
 142  * is more efficient.
 143  * FIXME: Add an API for clearing remset entries if a root with a user defined
 144  * mark routine is deleted.
 145  */
 146 int mono_gc_register_root_wbarrier (char *start, size_t size, void *descr) MONO_INTERNAL;
 147
 148 void mono_gc_wbarrier_set_root (gpointer ptr, MonoObject *value) MONO_INTERNAL;
 149
 150 /* Set a field of a root registered using mono_gc_register_root_wbarrier () */
 151 #define MONO_ROOT_SETREF(s,fieldname,value) do {        \
 152         mono_gc_wbarrier_set_root (&((s)->fieldname), (MonoObject*)value); \
 153 } while (0)
 154
 155 void  mono_gc_finalize_threadpool_threads (void) MONO_INTERNAL;
 156
 157 /* fast allocation support */
 158
 159 /* Accessible using mono_marshal_wrapper_info_from_wrapper () */
 160 typedef struct {
 161         const char *gc_name;
 162         int alloc_type;
 163 } AllocatorWrapperInfo;
 164
 165 MonoMethod* mono_gc_get_managed_allocator (MonoVTable *vtable, gboolean for_box) MONO_INTERNAL;
 166 MonoMethod* mono_gc_get_managed_array_allocator (MonoVTable *vtable, int rank) MONO_INTERNAL;
 167 MonoMethod *mono_gc_get_managed_allocator_by_type (int atype) MONO_INTERNAL;
 168
 169 guint32 mono_gc_get_managed_allocator_types (void) MONO_INTERNAL;
 170
 171 /* Return a short string identifying the GC, indented to be saved in AOT images */
 172 const char *mono_gc_get_gc_name (void) MONO_INTERNAL;
 173
 174 /* Fast write barriers */
 175 MonoMethod* mono_gc_get_write_barrier (void) MONO_INTERNAL;
 176
 177 /* Fast valuetype copy */
 178 void mono_gc_wbarrier_value_copy_bitmap (gpointer dest, gpointer src, int size, unsigned bitmap) MONO_INTERNAL;
 179
 180 /* helper for the managed alloc support */
 181 MonoString *mono_string_alloc (int length) MONO_INTERNAL;
 182
 183 /*
 184  * Functions supplied by the runtime and called by the GC. Currently only used
 185  * by SGEN.
 186  */
 187 typedef struct {
 188         /*
 189          * Function called during thread startup/attach to allocate thread-local data
 190          * needed by the other functions.
 191          */
 192         gpointer (*thread_attach_func) (void);
 193         /* FIXME: Add a cleanup function too */
 194         /*
 195          * Function called from every thread when suspending for GC. It can save
 196          * data needed for marking from thread stacks. user_data is the data returned
 197          * by attach_func. This might called with GC locks held and the word stopped,
 198          * so it shouldn't do any synchronization etc.
 199          */
 200         void (*thread_suspend_func) (gpointer user_data, void *sigcontext);
 201         /*
 202          * Function called to mark from thread stacks. user_data is the data returned
 203          * by attach_func. This is called twice, with the word stopped:
 204          * - in the first pass, it should mark areas of the stack using
 205          *   conservative marking by calling mono_gc_conservatively_scan_area ().
 206          * - in the second pass, it should mark the remaining areas of the stack
 207          *   using precise marking by calling mono_gc_scan_object ().
 208          */
 209         void (*thread_mark_func) (gpointer user_data, guint8 *stack_start, guint8 *stack_end, gboolean precise);
 210 } MonoGCCallbacks;
 211
 212 /* Set the callback functions callable by the GC */
 213 void mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks) MONO_INTERNAL;
 214 MonoGCCallbacks *mono_gc_get_gc_callbacks (void) MONO_INTERNAL;
 215
 216 /* Functions callable from the thread mark func */
 217
 218 /* Scan the memory area between START and END conservatively */
 219 void mono_gc_conservatively_scan_area (void *start, void *end) MONO_INTERNAL;
 220
 221 /* Scan OBJ, returning its new address */
 222 void *mono_gc_scan_object (void *obj) MONO_INTERNAL;
 223
 224 /* Return the bitmap encoded by a descriptor */
 225 gsize* mono_gc_get_bitmap_for_descr (void *descr, int *numbits) MONO_INTERNAL;
 226
 227 /* Return the suspend signal number used by the GC to suspend threads,
 228    or -1 if not applicable. */
 229 int mono_gc_get_suspend_signal (void) MONO_INTERNAL;
 230
 231 /*
 232  * Return a human readable description of the GC in malloc-ed memory.
 233  */
 234 char* mono_gc_get_description (void) MONO_INTERNAL;
 235
 236 /*
 237  * Configure the GC to desktop mode
 238  */
 239 void mono_gc_set_desktop_mode (void) MONO_INTERNAL;
 240
 241 /*
 242  * Return whenever this GC can move objects
 243  */
 244 gboolean mono_gc_is_moving (void) MONO_INTERNAL;
 245
 246 typedef void* (*MonoGCLockedCallbackFunc) (void *data);
 247
 248 void* mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data) MONO_INTERNAL;
 249
 250 #ifdef HAVE_SGEN_GC
 251 int mono_gc_get_los_limit (void) MONO_INTERNAL;
 252 #endif
 253
 254 /*
 255  * Return whenever GC is disabled
 256  */
 257 gboolean mono_gc_is_disabled (void) MONO_INTERNAL;
 258
 259 #if defined(__MACH__)
 260 void mono_gc_register_mach_exception_thread (pthread_t thread) MONO_INTERNAL;
 261 pthread_t mono_gc_get_mach_exception_thread (void) MONO_INTERNAL;
 262 #endif
 263
 264 #endif /* __MONO_METADATA_GC_INTERNAL_H__ */
 265