mono/metadata/mono-gc.h

   1 /**
   2  * \file
   3  * GC related public interface
   4  *
   5  */
   6 #ifndef __METADATA_MONO_GC_H__
   7 #define __METADATA_MONO_GC_H__
   8
   9 #include <mono/metadata/object.h>
  10
  11 MONO_BEGIN_DECLS
  12
  13 typedef int (*MonoGCReferences) (MonoObject *obj, MonoClass *klass, uintptr_t size, uintptr_t num, MonoObject **refs, uintptr_t *offsets, void *data);
  14
  15 /**
  16  * This enum is used by the profiler API when reporting root registration.
  17  */
  18 typedef enum {
  19         /**
  20          * Roots external to Mono. Embedders may only use this value.
  21          */
  22         MONO_ROOT_SOURCE_EXTERNAL = 0,
  23         /**
  24          * Thread call stack.
  25          *
  26          * The \c key parameter is a thread ID as a \c uintptr_t.
  27          */
  28         MONO_ROOT_SOURCE_STACK = 1,
  29         /**
  30          * Roots in the finalizer queue. This is a pseudo-root.
  31          */
  32         MONO_ROOT_SOURCE_FINALIZER_QUEUE = 2,
  33         /**
  34          * Managed \c static variables.
  35          *
  36          * The \c key parameter is a \c MonoVTable pointer.
  37          */
  38         MONO_ROOT_SOURCE_STATIC = 3,
  39         /**
  40          * Managed \c static variables with \c ThreadStaticAttribute.
  41          *
  42          * The \c key parameter is a thread ID as a \c uintptr_t.
  43          */
  44         MONO_ROOT_SOURCE_THREAD_STATIC = 4,
  45         /**
  46          * Managed \c static variables with \c ContextStaticAttribute.
  47          *
  48          * The \c key parameter is a \c MonoAppContext pointer.
  49          */
  50         MONO_ROOT_SOURCE_CONTEXT_STATIC = 5,
  51         /**
  52          * \c GCHandle structures.
  53          */
  54         MONO_ROOT_SOURCE_GC_HANDLE = 6,
  55         /**
  56          * Roots in the just-in-time compiler.
  57          */
  58         MONO_ROOT_SOURCE_JIT = 7,
  59         /**
  60          * Roots in the threading subsystem.
  61          *
  62          * The \c key parameter, if not \c NULL, is a thread ID as a \c uintptr_t.
  63          */
  64         MONO_ROOT_SOURCE_THREADING = 8,
  65         /**
  66          * Roots in application domains.
  67          *
  68          * The \c key parameter, if not \c NULL, is a \c MonoDomain pointer.
  69          */
  70         MONO_ROOT_SOURCE_DOMAIN = 9,
  71         /**
  72          * Roots in reflection code.
  73          *
  74          * The \c key parameter, if not \c NULL, is a \c MonoVTable pointer.
  75          */
  76         MONO_ROOT_SOURCE_REFLECTION = 10,
  77         /**
  78          * Roots from P/Invoke or other marshaling infrastructure.
  79          */
  80         MONO_ROOT_SOURCE_MARSHAL = 11,
  81         /**
  82          * Roots in the thread pool data structures.
  83          */
  84         MONO_ROOT_SOURCE_THREAD_POOL = 12,
  85         /**
  86          * Roots in the debugger agent.
  87          */
  88         MONO_ROOT_SOURCE_DEBUGGER = 13,
  89         /**
  90          * Roots in the runtime handle stack. This is a pseudo-root.
  91          *
  92          * The \c key parameter is a thread ID as a \c uintptr_t.
  93          */
  94         MONO_ROOT_SOURCE_HANDLE = 14,
  95         /**
  96          * Roots in the ephemeron arrays. This is a pseudo-root.
  97          */
  98         MONO_ROOT_SOURCE_EPHEMERON = 15,
  99         /**
 100          * Roots in the toggleref arrays. This is a pseudo-root.
 101          */
 102         MONO_ROOT_SOURCE_TOGGLEREF = 16,
 103 } MonoGCRootSource;
 104
 105 typedef enum {
 106         MONO_GC_HANDLE_TYPE_MIN = 0,
 107         MONO_GC_HANDLE_WEAK = MONO_GC_HANDLE_TYPE_MIN,
 108         MONO_GC_HANDLE_WEAK_TRACK_RESURRECTION,
 109         MONO_GC_HANDLE_NORMAL,
 110         MONO_GC_HANDLE_PINNED,
 111         MONO_GC_HANDLE_TYPE_MAX,
 112 } MonoGCHandleType;
 113
 114 MONO_API void   mono_gc_collect         (int generation);
 115 MONO_API int    mono_gc_max_generation  (void);
 116 MONO_API int    mono_gc_get_generation  (MonoObject *object);
 117 MONO_API int    mono_gc_collection_count (int generation);
 118 MONO_API int64_t mono_gc_get_used_size   (void);
 119 MONO_API int64_t mono_gc_get_heap_size   (void);
 120 MONO_API MonoBoolean mono_gc_pending_finalizers (void);
 121 MONO_API void     mono_gc_finalize_notify    (void);
 122 MONO_API int    mono_gc_invoke_finalizers (void);
 123 /* heap walking is only valid in the pre-stop-world event callback */
 124 MONO_API int    mono_gc_walk_heap        (int flags, MonoGCReferences callback, void *data);
 125
 126 MONO_API MONO_RT_EXTERNAL_ONLY void
 127 mono_gc_init_finalizer_thread (void);
 128
 129 /*
 130  * Only supported under SGen. These two with Sgen will take and release the LOCK_GC
 131  */
 132 void mono_gc_stop_world (void);
 133 void mono_gc_restart_world (void);
 134
 135 MONO_END_DECLS
 136
 137 #endif /* __METADATA_MONO_GC_H__ */
 138