2 * handle.h: Handle to object in native code
5 * - Ludovic Henry <ludovic@xamarin.com>
6 * - Aleksey Klieger <aleksey.klieger@xamarin.com>
7 * - Rodrigo Kumpera <kumpera@xamarin.com>
9 * Copyright 2016 Dot net foundation.
10 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
13 #ifndef __MONO_HANDLE_H__
14 #define __MONO_HANDLE_H__
19 #include <mono/metadata/object.h>
20 #include <mono/metadata/class.h>
21 #include <mono/utils/mono-error-internals.h>
22 #include <mono/utils/mono-threads.h>
23 #include <mono/utils/checked-build.h>
31 The handle stack is designed so it's efficient to pop a large amount of entries at once.
32 The stack is made out of a series of fixed size segments.
34 To do bulk operations you use a stack mark.
39 3 is the number of fields besides the data in the struct;
40 128 words makes each chunk 512 or 1024 bytes each
42 #define OBJECTS_PER_HANDLES_CHUNK (128 - 3)
45 Whether this config needs stack watermark recording to know where to start scanning from.
48 #define MONO_NEEDS_STACK_WATERMARK 1
51 typedef struct _HandleChunk HandleChunk;
54 int size; //number of bytes
55 HandleChunk *prev, *next;
56 MonoObject *objects [OBJECTS_PER_HANDLES_CHUNK];
60 HandleChunk *top; //alloc from here
61 HandleChunk *bottom; //scan from here
69 typedef void *MonoRawHandle;
71 typedef void (*GcScanFunc) (gpointer*, gpointer);
74 MonoRawHandle mono_handle_new (MonoObject *object);
76 void mono_handle_stack_scan (HandleStack *stack, GcScanFunc func, gpointer gc_data);
77 HandleStack* mono_handle_stack_alloc (void);
78 void mono_handle_stack_free (HandleStack *handlestack);
79 MonoRawHandle mono_stack_mark_pop_value (MonoThreadInfo *info, HandleStackMark *stackmark, MonoRawHandle value);
80 void mono_stack_mark_record_size (MonoThreadInfo *info, HandleStackMark *stackmark, const char *func_name);
83 mono_stack_mark_init (MonoThreadInfo *info, HandleStackMark *stackmark)
85 HandleStack *handles = (HandleStack *)info->handle_stack;
86 stackmark->size = handles->top->size;
87 stackmark->chunk = handles->top;
91 mono_stack_mark_pop (MonoThreadInfo *info, HandleStackMark *stackmark)
93 HandleStack *handles = (HandleStack *)info->handle_stack;
94 handles->top = stackmark->chunk;
95 handles->top->size = stackmark->size;
101 #define SETUP_ICALL_COMMON \
104 MonoThreadInfo *__info = mono_thread_info_current (); \
105 error_init (&error); \
107 #define CLEAR_ICALL_COMMON \
108 mono_error_set_pending_exception (&error);
110 #define SETUP_ICALL_FRAME \
111 HandleStackMark __mark; \
112 mono_stack_mark_init (__info, &__mark);
114 #define CLEAR_ICALL_FRAME \
115 mono_stack_mark_record_size (__info, &__mark, __FUNCTION__); \
116 mono_stack_mark_pop (__info, &__mark);
118 #ifdef MONO_NEEDS_STACK_WATERMARK
121 mono_thread_info_pop_stack_mark (MonoThreadInfo *info, void *old_mark)
123 info->stack_mark = old_mark;
127 mono_thread_info_push_stack_mark (MonoThreadInfo *info, void *mark)
129 void *old = info->stack_mark;
130 info->stack_mark = mark;
134 #define SETUP_STACK_WATERMARK \
136 __builtin_unwind_init (); \
137 void *__old_stack_mark = mono_thread_info_push_stack_mark (__info, &__dummy);
139 #define CLEAR_STACK_WATERMARK \
140 mono_thread_info_pop_stack_mark (__info, __old_stack_mark);
143 #define SETUP_STACK_WATERMARK
144 #define CLEAR_STACK_WATERMARK
147 #define ICALL_ENTRY() \
150 SETUP_STACK_WATERMARK
152 #define ICALL_RETURN() \
154 CLEAR_STACK_WATERMARK \
158 } while (0); } while (0)
160 #define ICALL_RETURN_VAL(VAL) \
162 CLEAR_STACK_WATERMARK \
166 } while (0); } while (0)
168 #define ICALL_RETURN_OBJ(HANDLE) \
170 CLEAR_STACK_WATERMARK \
172 void* __ret = MONO_HANDLE_RAW (HANDLE); \
175 } while (0); } while (0)
178 Handle macros/functions
181 #ifdef ENABLE_CHECKED_BUILD
182 void mono_handle_verify (MonoRawHandle handle);
183 #define HANDLE_INVARIANTS(H) mono_handle_verify((void*)(H))
185 #define HANDLE_INVARIANTS(H) (0)
188 #define TYPED_HANDLE_PAYLOAD_NAME(TYPE) TYPE ## HandlePayload
189 #define TYPED_HANDLE_NAME(TYPE) TYPE ## Handle
192 * TYPED_HANDLE_DECL(SomeType):
193 * Expands to a decl for handles to SomeType and to an internal payload struct.
195 * For example, TYPED_HANDLE_DECL(MonoObject) (see below) expands to:
199 * } MonoObjectHandlePayload;
201 * typedef MonoObjectHandlePayload* MonoObjectHandle;
203 #define TYPED_HANDLE_DECL(TYPE) typedef struct { TYPE *__obj; } TYPED_HANDLE_PAYLOAD_NAME (TYPE) ; typedef TYPED_HANDLE_PAYLOAD_NAME (TYPE) * TYPED_HANDLE_NAME (TYPE)
204 /* Have to double expand because MONO_STRUCT_OFFSET is doing token pasting on cross-compilers. */
205 #define MONO_HANDLE_PAYLOAD_OFFSET_(PayloadType) MONO_STRUCT_OFFSET(PayloadType, __obj)
206 #define MONO_HANDLE_PAYLOAD_OFFSET(TYPE) MONO_HANDLE_PAYLOAD_OFFSET_(TYPED_HANDLE_PAYLOAD_NAME (TYPE))
208 #define MONO_HANDLE_INIT ((void*) mono_null_value_handle)
209 #define NULL_HANDLE mono_null_value_handle
211 //XXX add functions to get/set raw, set field, set field to null, set array, set array to null
212 #define MONO_HANDLE_RAW(HANDLE) (HANDLE_INVARIANTS (HANDLE), ((HANDLE)->__obj))
213 #define MONO_HANDLE_DCL(TYPE, NAME) TYPED_HANDLE_NAME(TYPE) NAME = (TYPED_HANDLE_NAME(TYPE))(mono_handle_new ((MonoObject*)(NAME ## _raw)))
214 #define MONO_HANDLE_NEW(TYPE, VALUE) (TYPED_HANDLE_NAME(TYPE))( mono_handle_new ((MonoObject*)(VALUE)) )
215 #define MONO_HANDLE_CAST(TYPE, VALUE) (TYPED_HANDLE_NAME(TYPE))( VALUE )
218 WARNING WARNING WARNING
220 The following functions require a particular evaluation ordering to ensure correctness.
221 We must not have exposed handles while any sort of evaluation is happening as that very evaluation might trigger
222 a safepoint and break us.
224 This is why we evaluate index and value before any call to MONO_HANDLE_RAW or other functions that deal with naked objects.
226 #define MONO_HANDLE_SETRAW(HANDLE, FIELD, VALUE) do { \
227 MonoObject *__val = (MonoObject*)(VALUE); \
228 MONO_OBJECT_SETREF (MONO_HANDLE_RAW (HANDLE), FIELD, __val); \
231 #define MONO_HANDLE_SET(HANDLE, FIELD, VALUE) do { \
232 MonoObjectHandle __val = MONO_HANDLE_CAST (MonoObject, VALUE); \
233 MONO_OBJECT_SETREF (MONO_HANDLE_RAW (HANDLE), FIELD, MONO_HANDLE_RAW (__val)); \
236 /* VS doesn't support typeof :( :( :( */
237 #define MONO_HANDLE_SETVAL(HANDLE, FIELD, TYPE, VALUE) do { \
238 TYPE __val = (VALUE); \
239 MONO_HANDLE_RAW (HANDLE)->FIELD = __val; \
242 #define MONO_HANDLE_ARRAY_SETREF(HANDLE, IDX, VALUE) do { \
244 MonoObjectHandle __val = MONO_HANDLE_CAST (MonoObject, VALUE); \
245 mono_array_setref_fast (MONO_HANDLE_RAW (HANDLE), __idx, MONO_HANDLE_RAW (__val)); \
248 #define MONO_HANDLE_ARRAY_SETRAW(HANDLE, IDX, VALUE) do { \
250 MonoObject *__val = (MonoObject*)(VALUE); \
251 mono_array_setref_fast (MONO_HANDLE_RAW (HANDLE), __idx, __val); \
255 /* Baked typed handles we all want */
256 TYPED_HANDLE_DECL (MonoString);
257 TYPED_HANDLE_DECL (MonoArray);
258 TYPED_HANDLE_DECL (MonoObject);
260 #define NULL_HANDLE_STRING MONO_HANDLE_CAST(MonoString, NULL_HANDLE)
263 This is the constant for a handle that points nowhere.
266 extern const MonoObjectHandle mono_null_value_handle;
269 //FIXME this should go somewhere else
270 MonoStringHandle mono_string_new_handle (MonoDomain *domain, const char *data);
271 MonoArrayHandle mono_array_new_handle (MonoDomain *domain, MonoClass *eclass, uintptr_t n, MonoError *error);
275 #endif /* __MONO_HANDLE_H__ */