2006-02-01 Zoltan Varga <vargaz@gmail.com>
[mono.git] / mono / metadata / gc-internal.h
1 /*
2  * metadata/gc-internal.h: GC icalls.
3  *
4  * Author: Paolo Molaro <lupus@ximian.com>
5  *
6  * (C) 2002 Ximian, Inc.
7  */
8
9 #ifndef __MONO_METADATA_GC_H__
10 #define __MONO_METADATA_GC_H__
11
12 #include <glib.h>
13 #include <mono/metadata/object-internals.h>
14
15 void   mono_object_register_finalizer               (MonoObject  *obj);
16 void   ves_icall_System_GC_InternalCollect          (int          generation);
17 gint64 ves_icall_System_GC_GetTotalMemory           (MonoBoolean  forceCollection);
18 void   ves_icall_System_GC_KeepAlive                (MonoObject  *obj);
19 void   ves_icall_System_GC_ReRegisterForFinalize    (MonoObject  *obj);
20 void   ves_icall_System_GC_SuppressFinalize         (MonoObject  *obj);
21 void   ves_icall_System_GC_WaitForPendingFinalizers (void);
22
23 MonoObject *ves_icall_System_GCHandle_GetTarget (guint32 handle);
24 guint32     ves_icall_System_GCHandle_GetTargetHandle (MonoObject *obj, guint32 handle, gint32 type);
25 void        ves_icall_System_GCHandle_FreeHandle (guint32 handle);
26 gpointer    ves_icall_System_GCHandle_GetAddrOfPinnedObject (guint32 handle);
27
28 extern void mono_gc_init (void);
29 extern void mono_gc_cleanup (void);
30 extern void mono_gc_enable (void);
31 extern void mono_gc_disable (void);
32
33 /*
34  * Return whenever the current thread is registered with the GC (i.e. started
35  * by the GC pthread wrappers on unix.
36  */
37 extern gboolean mono_gc_is_gc_thread (void);
38
39 /*
40  * Try to register a foreign thread with the GC, if we fail or the backend
41  * can't cope with this concept - we return FALSE.
42  */
43 extern gboolean mono_gc_register_thread (void *baseptr);
44
45 /*
46  * Unregister a foreign thread from the GC.
47  */
48 extern void mono_gc_unregister_thread (void);
49
50 /* only valid after the RECLAIM_START GC event and before RECLAIM_END
51  * Not exported in public headers, but can be linked to (unsupported).
52  */
53 extern gboolean mono_object_is_alive (MonoObject* obj);
54 extern gboolean mono_gc_is_finalizer_thread (MonoThread *thread);
55 extern gpointer mono_gc_out_of_memory (size_t size);
56 extern void     mono_gc_enable_events (void);
57
58 /* disappearing link functionality */
59 void        mono_gc_weak_link_add    (void **link_addr, MonoObject *obj);
60 void        mono_gc_weak_link_remove (void **link_addr);
61 MonoObject *mono_gc_weak_link_get    (void **link_addr);
62
63 /* simple interface for data structures needed in the runtime */
64 void* mono_gc_make_descr_from_bitmap (unsigned int *bitmap, int numbits);
65 /* desc is the result from mono_gc_make_descr*. A NULL value means
66  * all the words contain GC pointers.
67  * The memory is non-moving and it will be explicitly deallocated.
68  * size bytes will be available from the returned address (ie, descr
69  * must not be stored in the returned memory)
70  */
71 void* mono_gc_alloc_fixed            (size_t size, void *descr);
72 void  mono_gc_free_fixed             (void* addr);
73
74 /* make sure the gchandle was allocated for an object in domain */
75 gboolean mono_gchandle_is_in_domain (guint32 gchandle, MonoDomain *domain);
76
77 #endif /* __MONO_METADATA_GC_H__ */
78