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