mono/metadata/gc-internals.h

   1 /*
   2  * metadata/gc-internals.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  * Licensed under the MIT license. See LICENSE file in the project root for full license information.
   9  */
  10
  11 #ifndef __MONO_METADATA_GC_INTERNAL_H__
  12 #define __MONO_METADATA_GC_INTERNAL_H__
  13
  14 #include <glib.h>
  15 #include <mono/utils/gc_wrapper.h>
  16 #include <mono/metadata/object-internals.h>
  17 #include <mono/metadata/threads-types.h>
  18 #include <mono/sgen/gc-internal-agnostic.h>
  19
  20 #define mono_domain_finalizers_lock(domain) mono_os_mutex_lock (&(domain)->finalizable_objects_hash_lock);
  21 #define mono_domain_finalizers_unlock(domain) mono_os_mutex_unlock (&(domain)->finalizable_objects_hash_lock);
  22
  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))
  25
  26 #define MONO_GC_UNREGISTER_ROOT(x) mono_gc_deregister_root ((char*)&(x))
  27
  28 /*
  29  * Register a memory location as a root pointing to memory allocated using
  30  * mono_gc_alloc_fixed (). This includes MonoGHashTable.
  31  */
  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)); \
  36         } while (0)
  37
  38 /*
  39  * Return a GC descriptor for an array containing N pointers to memory allocated
  40  * by mono_gc_alloc_fixed ().
  41  */
  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)
  44
  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)); \
  49         } while (0)
  50
  51 /*
  52  * This is used for fields which point to objects which are kept alive by other references
  53  * when using Boehm.
  54  */
  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);                \
  58 } while (0)
  59
  60 #define MONO_GC_UNREGISTER_ROOT_IF_MOVING(x) do { \
  61         if (mono_gc_is_moving ()) \
  62                 MONO_GC_UNREGISTER_ROOT (x);                    \
  63 } while (0)
  64
  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))
  67
  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);
  75
  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);
  82
  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
 106 void mono_gchandle_set_target (guint32 gchandle, MonoObject *obj);
 107
 108 /*Ephemeron functionality. Sgen only*/
 109 gboolean    mono_gc_ephemeron_array_add (MonoObject *obj);
 110
 111 MonoBoolean
 112 mono_gc_GCHandle_CheckCurrentDomain (guint32 gchandle);
 113
 114 /* User defined marking function */
 115 /* It should work like this:
 116  * foreach (ref in GC references in the are structure pointed to by ADDR)
 117  *    mark_func (ref)
 118  */
 119 typedef void (*MonoGCMarkFunc)     (MonoObject **addr, void *gc_data);
 120 typedef void (*MonoGCRootMarkFunc) (void *addr, MonoGCMarkFunc mark_func, void *gc_data);
 121
 122 /* Create a descriptor with a user defined marking function */
 123 MonoGCDescriptor mono_gc_make_root_descr_user (MonoGCRootMarkFunc marker);
 124
 125 /* Return whenever user defined marking functions are supported */
 126 gboolean mono_gc_user_markers_supported (void);
 127
 128 /* desc is the result from mono_gc_make_descr*. A NULL value means
 129  * all the words might contain GC pointers.
 130  * The memory is non-moving and it will be explicitly deallocated.
 131  * size bytes will be available from the returned address (ie, descr
 132  * must not be stored in the returned memory)
 133  * NOTE: Under Boehm, this returns memory allocated using GC_malloc, so the result should
 134  * be stored into a location registered using MONO_GC_REGISTER_ROOT_FIXED ().
 135  */
 136 void* mono_gc_alloc_fixed            (size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg);
 137 void  mono_gc_free_fixed             (void* addr);
 138
 139 /* make sure the gchandle was allocated for an object in domain */
 140 gboolean mono_gchandle_is_in_domain (guint32 gchandle, MonoDomain *domain);
 141 void     mono_gchandle_free_domain  (MonoDomain *domain);
 142
 143 typedef void (*FinalizerThreadCallback) (gpointer user_data);
 144
 145 void* mono_gc_alloc_pinned_obj (MonoVTable *vtable, size_t size);
 146 void* mono_gc_alloc_obj (MonoVTable *vtable, size_t size);
 147 void* mono_gc_alloc_vector (MonoVTable *vtable, size_t size, uintptr_t max_length);
 148 void* mono_gc_alloc_array (MonoVTable *vtable, size_t size, uintptr_t max_length, uintptr_t bounds_size);
 149 void* mono_gc_alloc_string (MonoVTable *vtable, size_t size, gint32 len);
 150 void* mono_gc_alloc_mature (MonoVTable *vtable, size_t size);
 151 MonoGCDescriptor mono_gc_make_descr_for_string (gsize *bitmap, int numbits);
 152
 153 void  mono_gc_register_for_finalization (MonoObject *obj, void *user_data);
 154 void  mono_gc_add_memory_pressure (gint64 value);
 155 MONO_API int   mono_gc_register_root (char *start, size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg);
 156 void  mono_gc_deregister_root (char* addr);
 157 void  mono_gc_finalize_domain (MonoDomain *domain);
 158 void  mono_gc_run_finalize (void *obj, void *data);
 159 void  mono_gc_clear_domain (MonoDomain * domain);
 160 /* Signal early termination of finalizer processing inside the gc */
 161 void  mono_gc_suspend_finalizers (void);
 162
 163
 164 /*
 165  * Register a root which can only be written using a write barrier.
 166  * Writes to the root must be done using a write barrier (MONO_ROOT_SETREF).
 167  * If the root uses an user defined mark routine, the writes are not required to be
 168  * to the area between START and START+SIZE.
 169  * The write barrier allows the GC to avoid scanning this root at each collection, so it
 170  * is more efficient.
 171  * FIXME: Add an API for clearing remset entries if a root with a user defined
 172  * mark routine is deleted.
 173  */
 174 int mono_gc_register_root_wbarrier (char *start, size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg);
 175
 176 void mono_gc_wbarrier_set_root (gpointer ptr, MonoObject *value);
 177
 178 /* Set a field of a root registered using mono_gc_register_root_wbarrier () */
 179 #define MONO_ROOT_SETREF(s,fieldname,value) do {        \
 180         mono_gc_wbarrier_set_root (&((s)->fieldname), (MonoObject*)value); \
 181 } while (0)
 182
 183 void  mono_gc_finalize_threadpool_threads (void);
 184
 185 /* fast allocation support */
 186
 187 typedef enum {
 188         // Regular fast path allocator.
 189         MANAGED_ALLOCATOR_REGULAR,
 190         // Managed allocator that just calls into the runtime. Used when allocation profiling w/ AOT.
 191         MANAGED_ALLOCATOR_SLOW_PATH,
 192 } ManagedAllocatorVariant;
 193
 194 int mono_gc_get_aligned_size_for_allocator (int size);
 195 MonoMethod* mono_gc_get_managed_allocator (MonoClass *klass, gboolean for_box, gboolean known_instance_size);
 196 MonoMethod* mono_gc_get_managed_array_allocator (MonoClass *klass);
 197 MonoMethod *mono_gc_get_managed_allocator_by_type (int atype, ManagedAllocatorVariant variant);
 198
 199 guint32 mono_gc_get_managed_allocator_types (void);
 200
 201 /* Return a short string identifying the GC, indented to be saved in AOT images */
 202 const char *mono_gc_get_gc_name (void);
 203
 204 /* Fast write barriers */
 205 MonoMethod* mono_gc_get_specific_write_barrier (gboolean is_concurrent);
 206 MonoMethod* mono_gc_get_write_barrier (void);
 207
 208 /* Fast valuetype copy */
 209 void mono_gc_wbarrier_value_copy_bitmap (gpointer dest, gpointer src, int size, unsigned bitmap);
 210
 211 /* helper for the managed alloc support */
 212 MonoString *
 213 ves_icall_string_alloc (int length);
 214
 215 /*
 216  * Functions supplied by the runtime and called by the GC. Currently only used
 217  * by SGEN.
 218  */
 219 typedef struct {
 220         /*
 221          * Function called during thread startup/attach to allocate thread-local data
 222          * needed by the other functions.
 223          */
 224         gpointer (*thread_attach_func) (void);
 225         /*
 226          * Function called during thread deatch to free the data allocated by
 227          * thread_attach_func.
 228          */
 229         void (*thread_detach_func) (gpointer user_data);
 230         /*
 231          * Function called from every thread when suspending for GC. It can save
 232          * data needed for marking from thread stacks. user_data is the data returned
 233          * by attach_func. This might called with GC locks held and the word stopped,
 234          * so it shouldn't do any synchronization etc.
 235          */
 236         void (*thread_suspend_func) (gpointer user_data, void *sigcontext, MonoContext *ctx);
 237         /*
 238          * Function called to mark from thread stacks. user_data is the data returned
 239          * by attach_func. This is called twice, with the word stopped:
 240          * - in the first pass, it should mark areas of the stack using
 241          *   conservative marking by calling mono_gc_conservatively_scan_area ().
 242          * - in the second pass, it should mark the remaining areas of the stack
 243          *   using precise marking by calling mono_gc_scan_object ().
 244          */
 245         void (*thread_mark_func) (gpointer user_data, guint8 *stack_start, guint8 *stack_end, gboolean precise, void *gc_data);
 246         /*
 247          * Function called for debugging to get the current managed method for
 248          * tracking the provenances of objects.
 249          */
 250         gpointer (*get_provenance_func) (void);
 251 } MonoGCCallbacks;
 252
 253 /* Set the callback functions callable by the GC */
 254 void mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks);
 255 MonoGCCallbacks *mono_gc_get_gc_callbacks (void);
 256
 257 /* Functions callable from the thread mark func */
 258
 259 /* Scan the memory area between START and END conservatively */
 260 void mono_gc_conservatively_scan_area (void *start, void *end);
 261
 262 /* Scan OBJ, returning its new address */
 263 void *mono_gc_scan_object (void *obj, void *gc_data);
 264
 265 /* Return the suspend signal number used by the GC to suspend threads,
 266    or -1 if not applicable. */
 267 int mono_gc_get_suspend_signal (void);
 268
 269 /* Return the suspend signal number used by the GC to suspend threads,
 270    or -1 if not applicable. */
 271 int mono_gc_get_restart_signal (void);
 272
 273 /*
 274  * Return a human readable description of the GC in malloc-ed memory.
 275  */
 276 char* mono_gc_get_description (void);
 277
 278 /*
 279  * Configure the GC to desktop mode
 280  */
 281 void mono_gc_set_desktop_mode (void);
 282
 283 /*
 284  * Return whenever this GC can move objects
 285  */
 286 gboolean mono_gc_is_moving (void);
 287
 288 typedef void* (*MonoGCLockedCallbackFunc) (void *data);
 289
 290 void* mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data);
 291
 292 int mono_gc_get_los_limit (void);
 293
 294 guint8* mono_gc_get_card_table (int *shift_bits, gpointer *card_mask);
 295 gboolean mono_gc_card_table_nursery_check (void);
 296
 297 void* mono_gc_get_nursery (int *shift_bits, size_t *size);
 298
 299 void mono_gc_set_skip_thread (gboolean skip);
 300
 301 #ifndef HOST_WIN32
 302 int mono_gc_pthread_create (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg);
 303 #endif
 304
 305 /*
 306  * Return whenever GC is disabled
 307  */
 308 gboolean mono_gc_is_disabled (void);
 309
 310 /*
 311  * Return whenever this is the null GC
 312  */
 313 gboolean mono_gc_is_null (void);
 314
 315 void mono_gc_set_string_length (MonoString *str, gint32 new_length);
 316
 317 #if defined(__MACH__)
 318 void mono_gc_register_mach_exception_thread (pthread_t thread);
 319 pthread_t mono_gc_get_mach_exception_thread (void);
 320 #endif
 321
 322 gboolean mono_gc_precise_stack_mark_enabled (void);
 323
 324 typedef struct _RefQueueEntry RefQueueEntry;
 325
 326 struct _RefQueueEntry {
 327         void *dis_link;
 328         guint32 gchandle;
 329         MonoDomain *domain;
 330         void *user_data;
 331         RefQueueEntry *next;
 332 };
 333
 334 struct _MonoReferenceQueue {
 335         RefQueueEntry *queue;
 336         mono_reference_queue_callback callback;
 337         MonoReferenceQueue *next;
 338         gboolean should_be_deleted;
 339 };
 340
 341 enum {
 342         MONO_GC_FINALIZER_EXTENSION_VERSION = 1,
 343 };
 344
 345 typedef struct {
 346         int version;
 347         gboolean (*is_class_finalization_aware) (MonoClass *klass);
 348         void (*object_queued_for_finalization) (MonoObject *object);
 349 } MonoGCFinalizerCallbacks;
 350
 351 MONO_API void mono_gc_register_finalizer_callbacks (MonoGCFinalizerCallbacks *callbacks);
 352
 353
 354 #ifdef HOST_WIN32
 355 BOOL APIENTRY mono_gc_dllmain (HMODULE module_handle, DWORD reason, LPVOID reserved);
 356 #endif
 357
 358 guint mono_gc_get_vtable_bits (MonoClass *klass);
 359
 360 void mono_gc_register_altstack (gpointer stack, gint32 stack_size, gpointer altstack, gint32 altstack_size);
 361
 362 gboolean mono_gc_is_critical_method (MonoMethod *method);
 363
 364 /* If set, print debugging messages around finalizers. */
 365 extern gboolean log_finalizers;
 366
 367 /* If set, do not run finalizers. */
 368 extern gboolean mono_do_not_finalize;
 369 /* List of names of classes not to finalize. */
 370 extern gchar **mono_do_not_finalize_class_names;
 371
 372 #endif /* __MONO_METADATA_GC_INTERNAL_H__ */
 373