2 * gc-internal-agnostic.h: Mono-agnostic GC interface.
4 * Copyright (C) 2015 Xamarin Inc
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License 2.0 as published by the Free Software Foundation;
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License 2.0 along with this library; if not, write to the Free
17 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __MONO_METADATA_GCINTERNALAGNOSTIC_H__
21 #define __MONO_METADATA_GCINTERNALAGNOSTIC_H__
27 #include "mono/utils/mono-compiler.h"
28 #include "mono/utils/parse.h"
29 #include "mono/utils/memfuncs.h"
31 #include "mono/sgen/sgen-conf.h"
34 /* h indicates whether to hide or just tag.
35 * (-!!h ^ p) is used instead of (h ? ~p : p) to avoid multiple mentions of p.
37 #define MONO_GC_HIDE_POINTER(p,t,h) ((gpointer)(((-(size_t)!!(h) ^ (size_t)(p)) & ~(size_t)3) | ((t) & (size_t)3)))
38 #define MONO_GC_REVEAL_POINTER(p,h) ((gpointer)((-(size_t)!!(h) ^ (size_t)(p)) & ~(size_t)3))
40 #define MONO_GC_POINTER_TAG(p) ((size_t)(p) & (size_t)3)
42 #define MONO_GC_HANDLE_OCCUPIED_MASK (1)
43 #define MONO_GC_HANDLE_VALID_MASK (2)
44 #define MONO_GC_HANDLE_TAG_MASK (MONO_GC_HANDLE_OCCUPIED_MASK | MONO_GC_HANDLE_VALID_MASK)
46 #define MONO_GC_HANDLE_METADATA_POINTER(p,h) (MONO_GC_HIDE_POINTER ((p), MONO_GC_HANDLE_OCCUPIED_MASK, (h)))
47 #define MONO_GC_HANDLE_OBJECT_POINTER(p,h) (MONO_GC_HIDE_POINTER ((p), MONO_GC_HANDLE_OCCUPIED_MASK | MONO_GC_HANDLE_VALID_MASK, (h)))
49 #define MONO_GC_HANDLE_OCCUPIED(slot) ((size_t)(slot) & MONO_GC_HANDLE_OCCUPIED_MASK)
50 #define MONO_GC_HANDLE_VALID(slot) ((size_t)(slot) & MONO_GC_HANDLE_VALID_MASK)
52 #define MONO_GC_HANDLE_TAG(slot) ((size_t)(slot) & MONO_GC_HANDLE_TAG_MASK)
54 #define MONO_GC_HANDLE_IS_OBJECT_POINTER(slot) (MONO_GC_HANDLE_TAG (slot) == (MONO_GC_HANDLE_OCCUPIED_MASK | MONO_GC_HANDLE_VALID_MASK))
55 #define MONO_GC_HANDLE_IS_METADATA_POINTER(slot) (MONO_GC_HANDLE_TAG (slot) == MONO_GC_HANDLE_OCCUPIED_MASK)
59 HANDLE_WEAK = HANDLE_TYPE_MIN,
66 #define GC_HANDLE_TYPE_IS_WEAK(x) ((x) <= HANDLE_WEAK_TRACK)
68 #define MONO_GC_HANDLE_TYPE_SHIFT (3)
69 #define MONO_GC_HANDLE_TYPE_MASK ((1 << MONO_GC_HANDLE_TYPE_SHIFT) - 1)
70 #define MONO_GC_HANDLE_TYPE(x) ((GCHandleType)(((x) & MONO_GC_HANDLE_TYPE_MASK) - 1))
71 #define MONO_GC_HANDLE_SLOT(x) ((x) >> MONO_GC_HANDLE_TYPE_SHIFT)
72 #define MONO_GC_HANDLE_TYPE_IS_WEAK(x) ((x) <= HANDLE_WEAK_TRACK)
73 #define MONO_GC_HANDLE(slot, type) (((slot) << MONO_GC_HANDLE_TYPE_SHIFT) | (((type) & MONO_GC_HANDLE_TYPE_MASK) + 1))
78 guint64 minor_gc_time;
79 guint64 major_gc_time;
80 guint64 major_gc_time_concurrent;
83 extern GCStats gc_stats;
86 typedef SgenDescriptor MonoGCDescriptor;
87 #define MONO_GC_DESCRIPTOR_NULL SGEN_DESCRIPTOR_NULL
89 typedef void* MonoGCDescriptor;
90 #define MONO_GC_DESCRIPTOR_NULL NULL
94 * Try to register a foreign thread with the GC, if we fail or the backend
95 * can't cope with this concept - we return FALSE.
97 extern gboolean mono_gc_register_thread (void *baseptr);
99 gboolean mono_gc_parse_environment_string_extract_number (const char *str, size_t *out);
101 MonoGCDescriptor mono_gc_make_descr_for_object (gsize *bitmap, int numbits, size_t obj_size);
102 MonoGCDescriptor mono_gc_make_descr_for_array (int vector, gsize *elem_bitmap, int numbits, size_t elem_size);
104 /* simple interface for data structures needed in the runtime */
105 MonoGCDescriptor mono_gc_make_descr_from_bitmap (gsize *bitmap, int numbits);
107 /* Return a root descriptor for a root with all refs */
108 MonoGCDescriptor mono_gc_make_root_descr_all_refs (int numbits);
110 /* Return the bitmap encoded by a descriptor */
111 gsize* mono_gc_get_bitmap_for_descr (MonoGCDescriptor descr, int *numbits);
114 These functions must be used when it's possible that either destination is not
115 word aligned or size is not a multiple of word size.
117 void mono_gc_bzero_atomic (void *dest, size_t size);
118 void mono_gc_bzero_aligned (void *dest, size_t size);
119 void mono_gc_memmove_atomic (void *dest, const void *src, size_t size);
120 void mono_gc_memmove_aligned (void *dest, const void *src, size_t size);
122 FILE *mono_gc_get_logfile (void);