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 /* Register a memory area as a conservatively scanned GC root */
  21 #define MONO_GC_REGISTER_ROOT(x) mono_gc_register_root ((char*)&(x), sizeof(x), NULL)
  22
  23 #define MONO_GC_UNREGISTER_ROOT(x) mono_gc_deregister_root ((char*)&(x))
  24
  25 /*
  26  * Register a memory location as a root pointing to memory allocated using
  27  * mono_gc_alloc_fixed (). This includes MonoGHashTable.
  28  */
  29 #ifdef HAVE_SGEN_GC
  30 /* The result of alloc_fixed () is not GC tracked memory */
  31 #define MONO_GC_REGISTER_ROOT_FIXED(x)
  32 #else
  33 #define MONO_GC_REGISTER_ROOT_FIXED(x) MONO_GC_REGISTER_ROOT ((x))
  34 #endif
  35
  36 /*
  37  * Return a GC descriptor for an array containing N pointers to memory allocated
  38  * by mono_gc_alloc_fixed ().
  39  */
  40 #ifdef HAVE_SGEN_GC
  41 /* The result of alloc_fixed () is not GC tracked memory */
  42 #define MONO_GC_ROOT_DESCR_FOR_FIXED(n) mono_gc_make_root_descr_all_refs (0)
  43 #else
  44 /* The result of alloc_fixed () is GC tracked memory */
  45 #define MONO_GC_ROOT_DESCR_FOR_FIXED(n) NULL
  46 #endif
  47
  48 /* Register a memory location holding a single object reference as a GC root */
  49 #define MONO_GC_REGISTER_ROOT_SINGLE(x) do { \
  50         g_assert (sizeof (x) == sizeof (MonoObject*)); \
  51         mono_gc_register_root ((char*)&(x), sizeof(MonoObject*), mono_gc_make_root_descr_all_refs (1)); \
  52         } while (0)
  53
  54 /*
  55  * This is used for fields which point to objects which are kept alive by other references
  56  * when using Boehm.
  57  */
  58 #ifdef HAVE_SGEN_GC
  59 #define MONO_GC_REGISTER_ROOT_IF_MOVING(x) do { \
  60                 MONO_GC_REGISTER_ROOT_SINGLE(x);                \
  61 } while (0)
  62
  63 #define MONO_GC_UNREGISTER_ROOT_IF_MOVING(x) do { \
  64         MONO_GC_UNREGISTER_ROOT (x); \
  65 } while (0)
  66 #else
  67 #define MONO_GC_REGISTER_ROOT_IF_MOVING(x)
  68 #define MONO_GC_UNREGISTER_ROOT_IF_MOVING(x)
  69 #endif
  70
  71 /* useful until we keep track of gc-references in corlib etc. */
  72 #ifdef HAVE_SGEN_GC
  73 #define IS_GC_REFERENCE(t) FALSE
  74 #else
  75 #define IS_GC_REFERENCE(t) ((t)->type == MONO_TYPE_U && class->image == mono_defaults.corlib)
  76 #endif
  77
  78 void   mono_object_register_finalizer               (MonoObject  *obj) MONO_INTERNAL;
  79 void   ves_icall_System_GC_InternalCollect          (int          generation) MONO_INTERNAL;
  80 gint64 ves_icall_System_GC_GetTotalMemory           (MonoBoolean  forceCollection) MONO_INTERNAL;
  81 void   ves_icall_System_GC_KeepAlive                (MonoObject  *obj) MONO_INTERNAL;
  82 void   ves_icall_System_GC_ReRegisterForFinalize    (MonoObject  *obj) MONO_INTERNAL;
  83 void   ves_icall_System_GC_SuppressFinalize         (MonoObject  *obj) MONO_INTERNAL;
  84 void   ves_icall_System_GC_WaitForPendingFinalizers (void) MONO_INTERNAL;
  85
  86 MonoObject *ves_icall_System_GCHandle_GetTarget (guint32 handle) MONO_INTERNAL;
  87 guint32     ves_icall_System_GCHandle_GetTargetHandle (MonoObject *obj, guint32 handle, gint32 type) MONO_INTERNAL;
  88 void        ves_icall_System_GCHandle_FreeHandle (guint32 handle) MONO_INTERNAL;
  89 gpointer    ves_icall_System_GCHandle_GetAddrOfPinnedObject (guint32 handle) MONO_INTERNAL;
  90 void        ves_icall_System_GC_register_ephemeron_array (MonoObject *array) MONO_INTERNAL;
  91 MonoObject  *ves_icall_System_GC_get_ephemeron_tombstone (void) MONO_INTERNAL;
  92
  93 extern void mono_gc_init (void) MONO_INTERNAL;
  94 extern void mono_gc_base_init (void) MONO_INTERNAL;
  95 extern void mono_gc_cleanup (void) MONO_INTERNAL;
  96 extern void mono_gc_enable (void) MONO_INTERNAL;
  97 extern void mono_gc_disable (void) MONO_INTERNAL;
  98
  99 /*
 100  * Return whenever the current thread is registered with the GC (i.e. started
 101  * by the GC pthread wrappers on unix.
 102  */
 103 extern gboolean mono_gc_is_gc_thread (void) MONO_INTERNAL;
 104
 105 /*
 106  * Try to register a foreign thread with the GC, if we fail or the backend
 107  * can't cope with this concept - we return FALSE.
 108  */
 109 extern gboolean mono_gc_register_thread (void *baseptr) MONO_INTERNAL;
 110
 111 extern gboolean mono_gc_is_finalizer_internal_thread (MonoInternalThread *thread) MONO_INTERNAL;
 112
 113 extern void mono_gc_set_stack_end (void *stack_end) MONO_INTERNAL;
 114
 115 /* only valid after the RECLAIM_START GC event and before RECLAIM_END
 116  * Not exported in public headers, but can be linked to (unsupported).
 117  */
 118 extern gboolean mono_object_is_alive (MonoObject* obj);
 119 extern gboolean mono_gc_is_finalizer_thread (MonoThread *thread);
 120 extern gpointer mono_gc_out_of_memory (size_t size);
 121 extern void     mono_gc_enable_events (void);
 122
 123 /* disappearing link functionality */
 124 void        mono_gc_weak_link_add    (void **link_addr, MonoObject *obj, gboolean track) MONO_INTERNAL;
 125 void        mono_gc_weak_link_remove (void **link_addr) MONO_INTERNAL;
 126 MonoObject *mono_gc_weak_link_get    (void **link_addr) MONO_INTERNAL;
 127
 128 #ifndef HAVE_SGEN_GC
 129 void    mono_gc_add_weak_track_handle    (MonoObject *obj, guint32 gchandle) MONO_INTERNAL;
 130 void    mono_gc_change_weak_track_handle (MonoObject *old_obj, MonoObject *obj, guint32 gchandle) MONO_INTERNAL;
 131 void    mono_gc_remove_weak_track_handle (guint32 gchandle) MONO_INTERNAL;
 132 GSList* mono_gc_remove_weak_track_object (MonoDomain *domain, MonoObject *obj) MONO_INTERNAL;
 133 #endif
 134
 135 /*Ephemeron functionality. Sgen only*/
 136 gboolean    mono_gc_ephemeron_array_add (MonoObject *obj) MONO_INTERNAL;
 137
 138
 139 MonoBoolean
 140 GCHandle_CheckCurrentDomain (guint32 gchandle) MONO_INTERNAL;
 141
 142 /* simple interface for data structures needed in the runtime */
 143 void* mono_gc_make_descr_from_bitmap (gsize *bitmap, int numbits) MONO_INTERNAL;
 144
 145 /* Return a root descriptor for a root with all refs */
 146 void* mono_gc_make_root_descr_all_refs (int numbits) MONO_INTERNAL;
 147
 148 /* User defined marking function */
 149 /* It should work like this:
 150  * foreach (ref in GC references in the are structure pointed to by ADDR)
 151  *    mark_func (ref)
 152  */
 153 typedef void (*MonoGCMarkFunc)     (void **addr);
 154 typedef void (*MonoGCRootMarkFunc) (void *addr, MonoGCMarkFunc mark_func);
 155
 156 /* Create a descriptor with a user defined marking function */
 157 void *mono_gc_make_root_descr_user (MonoGCRootMarkFunc marker);
 158
 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 ().
 166  */
 167 void* mono_gc_alloc_fixed            (size_t size, void *descr) MONO_INTERNAL;
 168 void  mono_gc_free_fixed             (void* addr) MONO_INTERNAL;
 169
 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;
 173
 174 typedef void (*FinalizerThreadCallback) (gpointer user_data);
 175
 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;
 179
 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;
 188
 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;
 197
 198 /*
 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
 204  * is more efficient.
 205  * FIXME: Add an API for clearing remset entries if a root with a user defined
 206  * mark routine is deleted.
 207  */
 208 int mono_gc_register_root_wbarrier (char *start, size_t size, void *descr) MONO_INTERNAL;
 209
 210 void mono_gc_wbarrier_set_root (gpointer ptr, MonoObject *value) MONO_INTERNAL;
 211
 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); \
 215 } while (0)
 216
 217 void  mono_gc_finalize_threadpool_threads (void) MONO_INTERNAL;
 218
 219 /* fast allocation support */
 220
 221 /* Accessible using mono_marshal_wrapper_info_from_wrapper () */
 222 typedef struct {
 223         const char *gc_name;
 224         int alloc_type;
 225 } AllocatorWrapperInfo;
 226
 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;
 230
 231 guint32 mono_gc_get_managed_allocator_types (void) MONO_INTERNAL;
 232
 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;
 235
 236 /* Fast write barriers */
 237 MonoMethod* mono_gc_get_write_barrier (void) MONO_INTERNAL;
 238
 239 /* Fast valuetype copy */
 240 void mono_gc_wbarrier_value_copy_bitmap (gpointer dest, gpointer src, int size, unsigned bitmap) MONO_INTERNAL;
 241
 242 /* helper for the managed alloc support */
 243 MonoString *mono_string_alloc (int length) MONO_INTERNAL;
 244
 245 /*
 246  * Functions supplied by the runtime and called by the GC. Currently only used
 247  * by SGEN.
 248  */
 249 typedef struct {
 250         /*
 251          * Function called during thread startup/attach to allocate thread-local data
 252          * needed by the other functions.
 253          */
 254         gpointer (*thread_attach_func) (void);
 255         /*
 256          * Function called during thread deatch to free the data allocated by
 257          * thread_attach_func.
 258          */
 259         void (*thread_detach_func) (gpointer user_data);
 260         /*
 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.
 265          */
 266         void (*thread_suspend_func) (gpointer user_data, void *sigcontext);
 267         /*
 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 ().
 274          */
 275         void (*thread_mark_func) (gpointer user_data, guint8 *stack_start, guint8 *stack_end, gboolean precise);
 276 } MonoGCCallbacks;
 277
 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;
 281
 282 /* Functions callable from the thread mark func */
 283
 284 /* Scan the memory area between START and END conservatively */
 285 void mono_gc_conservatively_scan_area (void *start, void *end) MONO_INTERNAL;
 286
 287 /* Scan OBJ, returning its new address */
 288 void *mono_gc_scan_object (void *obj) MONO_INTERNAL;
 289
 290 /* Return the bitmap encoded by a descriptor */
 291 gsize* mono_gc_get_bitmap_for_descr (void *descr, int *numbits) MONO_INTERNAL;
 292
 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;
 296
 297 /*
 298  * Return a human readable description of the GC in malloc-ed memory.
 299  */
 300 char* mono_gc_get_description (void) MONO_INTERNAL;
 301
 302 /*
 303  * Configure the GC to desktop mode
 304  */
 305 void mono_gc_set_desktop_mode (void) MONO_INTERNAL;
 306
 307 /*
 308  * Return whenever this GC can move objects
 309  */
 310 gboolean mono_gc_is_moving (void) MONO_INTERNAL;
 311
 312 typedef void* (*MonoGCLockedCallbackFunc) (void *data);
 313
 314 void* mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data) MONO_INTERNAL;
 315
 316 int mono_gc_get_los_limit (void) MONO_INTERNAL;
 317
 318 guint8* mono_gc_get_card_table (int *shift_bits, gpointer *card_mask) MONO_INTERNAL;
 319
 320 void* mono_gc_get_nursery (int *shift_bits, size_t *size) MONO_INTERNAL;
 321
 322 /*
 323  * Return whenever GC is disabled
 324  */
 325 gboolean mono_gc_is_disabled (void) MONO_INTERNAL;
 326
 327 #if defined(__MACH__)
 328 void mono_gc_register_mach_exception_thread (pthread_t thread) MONO_INTERNAL;
 329 pthread_t mono_gc_get_mach_exception_thread (void) MONO_INTERNAL;
 330 #endif
 331
 332 gboolean mono_gc_parse_environment_string_extract_number (const char *str, glong *out) MONO_INTERNAL;
 333
 334 gboolean mono_gc_precise_stack_mark_enabled (void) MONO_INTERNAL;
 335
 336 FILE *mono_gc_get_logfile (void) MONO_INTERNAL;
 337
 338 #endif /* __MONO_METADATA_GC_INTERNAL_H__ */
 339