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/utils/gc_wrapper.h>
  15
  16 #define mono_domain_finalizers_lock(domain) EnterCriticalSection (&(domain)->finalizable_objects_hash_lock);
  17 #define mono_domain_finalizers_unlock(domain) LeaveCriticalSection (&(domain)->finalizable_objects_hash_lock);
  18
  19 #define MONO_GC_REGISTER_ROOT(x) mono_gc_register_root ((char*)&(x), sizeof(x), NULL)
  20
  21 #define MONO_GC_UNREGISTER_ROOT(x) mono_gc_deregister_root ((char*)&(x))
  22
  23 void   mono_object_register_finalizer               (MonoObject  *obj) MONO_INTERNAL;
  24 void   ves_icall_System_GC_InternalCollect          (int          generation) MONO_INTERNAL;
  25 gint64 ves_icall_System_GC_GetTotalMemory           (MonoBoolean  forceCollection) MONO_INTERNAL;
  26 void   ves_icall_System_GC_KeepAlive                (MonoObject  *obj) MONO_INTERNAL;
  27 void   ves_icall_System_GC_ReRegisterForFinalize    (MonoObject  *obj) MONO_INTERNAL;
  28 void   ves_icall_System_GC_SuppressFinalize         (MonoObject  *obj) MONO_INTERNAL;
  29 void   ves_icall_System_GC_WaitForPendingFinalizers (void) MONO_INTERNAL;
  30
  31 MonoObject *ves_icall_System_GCHandle_GetTarget (guint32 handle) MONO_INTERNAL;
  32 guint32     ves_icall_System_GCHandle_GetTargetHandle (MonoObject *obj, guint32 handle, gint32 type) MONO_INTERNAL;
  33 void        ves_icall_System_GCHandle_FreeHandle (guint32 handle) MONO_INTERNAL;
  34 gpointer    ves_icall_System_GCHandle_GetAddrOfPinnedObject (guint32 handle) MONO_INTERNAL;
  35
  36 extern void mono_gc_init (void) MONO_INTERNAL;
  37 extern void mono_gc_base_init (void) MONO_INTERNAL;
  38 extern void mono_gc_cleanup (void) MONO_INTERNAL;
  39 extern void mono_gc_enable (void) MONO_INTERNAL;
  40 extern void mono_gc_disable (void) MONO_INTERNAL;
  41
  42 /*
  43  * Return whenever the current thread is registered with the GC (i.e. started
  44  * by the GC pthread wrappers on unix.
  45  */
  46 extern gboolean mono_gc_is_gc_thread (void) MONO_INTERNAL;
  47
  48 /*
  49  * Try to register a foreign thread with the GC, if we fail or the backend
  50  * can't cope with this concept - we return FALSE.
  51  */
  52 extern gboolean mono_gc_register_thread (void *baseptr) MONO_INTERNAL;
  53
  54 /* only valid after the RECLAIM_START GC event and before RECLAIM_END
  55  * Not exported in public headers, but can be linked to (unsupported).
  56  */
  57 extern gboolean mono_object_is_alive (MonoObject* obj);
  58 extern gboolean mono_gc_is_finalizer_thread (MonoThread *thread);
  59 extern gpointer mono_gc_out_of_memory (size_t size);
  60 extern void     mono_gc_enable_events (void);
  61
  62 /* disappearing link functionality */
  63 void        mono_gc_weak_link_add    (void **link_addr, MonoObject *obj, gboolean track) MONO_INTERNAL;
  64 void        mono_gc_weak_link_remove (void **link_addr) MONO_INTERNAL;
  65 MonoObject *mono_gc_weak_link_get    (void **link_addr) MONO_INTERNAL;
  66
  67 #ifndef HAVE_SGEN_GC
  68 void    mono_gc_add_weak_track_handle    (MonoObject *obj, guint32 gchandle) MONO_INTERNAL;
  69 void    mono_gc_change_weak_track_handle (MonoObject *old_obj, MonoObject *obj, guint32 gchandle) MONO_INTERNAL;
  70 void    mono_gc_remove_weak_track_handle (guint32 gchandle) MONO_INTERNAL;
  71 GSList* mono_gc_remove_weak_track_object (MonoDomain *domain, MonoObject *obj) MONO_INTERNAL;
  72 #endif
  73
  74 /* simple interface for data structures needed in the runtime */
  75 void* mono_gc_make_descr_from_bitmap (gsize *bitmap, int numbits) MONO_INTERNAL;
  76
  77 /* User defined marking function */
  78 /* It should work like this:
  79  * foreach (ref in GC references in the are structure pointed to by ADDR)
  80  *    *ref = mark_func (*ref)
  81  */
  82 typedef void *(*MonoGCCopyFunc) (void *addr);
  83 typedef void (*MonoGCMarkFunc) (void *addr, MonoGCCopyFunc mark_func);
  84
  85 /* Create a descriptor with a user defined marking function */
  86 void *mono_gc_make_root_descr_user (MonoGCMarkFunc marker);
  87
  88 /* desc is the result from mono_gc_make_descr*. A NULL value means
  89  * all the words might contain GC pointers.
  90  * The memory is non-moving and it will be explicitly deallocated.
  91  * size bytes will be available from the returned address (ie, descr
  92  * must not be stored in the returned memory)
  93  */
  94 void* mono_gc_alloc_fixed            (size_t size, void *descr) MONO_INTERNAL;
  95 void  mono_gc_free_fixed             (void* addr) MONO_INTERNAL;
  96
  97 /* make sure the gchandle was allocated for an object in domain */
  98 gboolean mono_gchandle_is_in_domain (guint32 gchandle, MonoDomain *domain) MONO_INTERNAL;
  99 void     mono_gchandle_free_domain  (MonoDomain *domain) MONO_INTERNAL;
 100
 101 typedef void (*FinalizerThreadCallback) (gpointer user_data);
 102
 103 /* if there are finalizers to run, run them. Returns the number of finalizers run */
 104 gboolean mono_gc_pending_finalizers (void) MONO_INTERNAL;
 105 void     mono_gc_finalize_notify    (void) MONO_INTERNAL;
 106
 107 void* mono_gc_alloc_pinned_obj (MonoVTable *vtable, size_t size) MONO_INTERNAL;
 108 void* mono_gc_alloc_obj (MonoVTable *vtable, size_t size) MONO_INTERNAL;
 109 void* mono_gc_make_descr_for_string (gsize *bitmap, int numbits) MONO_INTERNAL;
 110 void* mono_gc_make_descr_for_object (gsize *bitmap, int numbits, size_t obj_size) MONO_INTERNAL;
 111 void* mono_gc_make_descr_for_array (int vector, gsize *elem_bitmap, int numbits, size_t elem_size) MONO_INTERNAL;
 112
 113 void  mono_gc_register_for_finalization (MonoObject *obj, void *user_data) MONO_INTERNAL;
 114 void  mono_gc_add_memory_pressure (gint64 value) MONO_INTERNAL;
 115 int   mono_gc_register_root (char *start, size_t size, void *descr) MONO_INTERNAL;
 116 void  mono_gc_deregister_root (char* addr) MONO_INTERNAL;
 117 int   mono_gc_finalizers_for_domain (MonoDomain *domain, MonoObject **out_array, int out_size) MONO_INTERNAL;
 118 void  mono_gc_run_finalize (void *obj, void *data) MONO_INTERNAL;
 119 void  mono_gc_clear_domain (MonoDomain * domain) MONO_INTERNAL;
 120
 121 /*
 122  * Register a root which can only be written using a write barrier.
 123  * Writes to the root must be done using a write barrier (MONO_ROOT_SETREF).
 124  * If the root uses an user defined mark routine, the writes are not required to be
 125  * to the area between START and START+SIZE.
 126  * The write barrier allows the GC to avoid scanning this root at each collection, so it
 127  * is more efficient.
 128  * FIXME: Add an API for clearing remset entries if a root with a user defined
 129  * mark routine is deleted.
 130  */
 131 int mono_gc_register_root_wbarrier (char *start, size_t size, void *descr) MONO_INTERNAL;
 132
 133 void mono_gc_wbarrier_set_root (gpointer ptr, MonoObject *value) MONO_INTERNAL;
 134
 135 /* Set a field of a root registered using mono_gc_register_root_wbarrier () */
 136 #define MONO_ROOT_SETREF(s,fieldname,value) do {        \
 137         mono_gc_wbarrier_set_root (&((s)->fieldname), (MonoObject*)value); \
 138 } while (0)
 139
 140 void  mono_gc_finalize_threadpool_threads (void) MONO_INTERNAL;
 141
 142 /* fast allocation support */
 143 MonoMethod* mono_gc_get_managed_allocator (MonoVTable *vtable, gboolean for_box) MONO_INTERNAL;
 144 int mono_gc_get_managed_allocator_type (MonoMethod *managed_alloc) MONO_INTERNAL;
 145 MonoMethod *mono_gc_get_managed_allocator_by_type (int atype) MONO_INTERNAL;
 146
 147 guint32 mono_gc_get_managed_allocator_types (void) MONO_INTERNAL;
 148
 149 /* Fast write barriers */
 150 MonoMethod* mono_gc_get_write_barrier (void) MONO_INTERNAL;
 151
 152 /* helper for the managed alloc support */
 153 MonoString *mono_string_alloc (int length) MONO_INTERNAL;
 154
 155 /*
 156  * Functions supplied by the runtime and called by the GC. Currently only used
 157  * by SGEN.
 158  */
 159 typedef struct {
 160         /*
 161          * Function called during thread startup/attach to allocate thread-local data
 162          * needed by the other functions.
 163          */
 164         gpointer (*thread_attach_func) (void);
 165         /* FIXME: Add a cleanup function too */
 166         /*
 167          * Function called from every thread when suspending for GC. It can save
 168          * data needed for marking from thread stacks. user_data is the data returned
 169          * by attach_func. This might called with GC locks held and the word stopped,
 170          * so it shouldn't do any synchronization etc.
 171          */
 172         void (*thread_suspend_func) (gpointer user_data, void *sigcontext);
 173         /*
 174          * Function called to mark from thread stacks. user_data is the data returned
 175          * by attach_func. This is called twice, with the word stopped:
 176          * - in the first pass, it should mark areas of the stack using
 177          *   conservative marking by calling mono_gc_conservatively_scan_area ().
 178          * - in the second pass, it should mark the remaining areas of the stack
 179          *   using precise marking by calling mono_gc_scan_object ().
 180          */
 181         void (*thread_mark_func) (gpointer user_data, guint8 *stack_start, guint8 *stack_end, gboolean precise);
 182 } MonoGCCallbacks;
 183
 184 /* Set the callback functions callable by the GC */
 185 void mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks) MONO_INTERNAL;
 186
 187 /* Functions callable from the thread mark func */
 188
 189 /* Scan the memory area between START and END conservatively */
 190 void mono_gc_conservatively_scan_area (void *start, void *end) MONO_INTERNAL;
 191
 192 /* Scan OBJ, returning its new address */
 193 void *mono_gc_scan_object (void *obj) MONO_INTERNAL;
 194
 195 /* Return the bitmap encoded by a descriptor */
 196 gsize* mono_gc_get_bitmap_for_descr (void *descr, int *numbits) MONO_INTERNAL;
 197
 198 typedef gpointer (*MonoGetIPFromSigCtxFunc) (gpointer ctx);
 199
 200 void mono_install_get_ip_from_sigctx (MonoGetIPFromSigCtxFunc func) MONO_INTERNAL;
 201
 202 gpointer mono_gc_get_ip_from_sigctx (gpointer ctx) MONO_INTERNAL;
 203
 204 #endif /* __MONO_METADATA_GC_INTERNAL_H__ */
 205