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 HandleChunk *old_top = stackmark->chunk;
95 old_top->size = stackmark->size;
96 mono_memory_write_barrier ();
97 handles->top = old_top;
103 #define SETUP_ICALL_COMMON \
106 MonoThreadInfo *__info = mono_thread_info_current (); \
107 error_init (&error); \
109 #define CLEAR_ICALL_COMMON \
110 mono_error_set_pending_exception (&error);
112 #define SETUP_ICALL_FRAME \
113 HandleStackMark __mark; \
114 mono_stack_mark_init (__info, &__mark);
116 #define CLEAR_ICALL_FRAME \
117 mono_stack_mark_record_size (__info, &__mark, __FUNCTION__); \
118 mono_stack_mark_pop (__info, &__mark);
120 #define CLEAR_ICALL_FRAME_VALUE(RESULT, HANDLE) \
121 mono_stack_mark_record_size (__info, &__mark, __FUNCTION__); \
122 (RESULT) = mono_stack_mark_pop_value (__info, &__mark, (HANDLE));
125 #define HANDLE_FUNCTION_ENTER() do { \
126 MonoThreadInfo *__info = mono_thread_info_current (); \
129 #define HANDLE_FUNCTION_RETURN() \
133 #define HANDLE_FUNCTION_RETURN_VAL(VAL) \
138 #define HANDLE_FUNCTION_RETURN_OBJ(HANDLE) \
140 void* __result = (MONO_HANDLE_RAW (HANDLE)); \
143 } while (0); } while (0);
145 #define HANDLE_FUNCTION_RETURN_REF(TYPE, HANDLE) \
147 MonoRawHandle __result; \
148 CLEAR_ICALL_FRAME_VALUE (__result, ((MonoRawHandle) (HANDLE))); \
149 return MONO_HANDLE_CAST (TYPE, __result); \
150 } while (0); } while (0);
152 #ifdef MONO_NEEDS_STACK_WATERMARK
155 mono_thread_info_pop_stack_mark (MonoThreadInfo *info, void *old_mark)
157 info->stack_mark = old_mark;
161 mono_thread_info_push_stack_mark (MonoThreadInfo *info, void *mark)
163 void *old = info->stack_mark;
164 info->stack_mark = mark;
168 #define SETUP_STACK_WATERMARK \
170 __builtin_unwind_init (); \
171 void *__old_stack_mark = mono_thread_info_push_stack_mark (__info, &__dummy);
173 #define CLEAR_STACK_WATERMARK \
174 mono_thread_info_pop_stack_mark (__info, __old_stack_mark);
177 #define SETUP_STACK_WATERMARK
178 #define CLEAR_STACK_WATERMARK
181 #define ICALL_ENTRY() \
184 SETUP_STACK_WATERMARK
186 #define ICALL_RETURN() \
188 CLEAR_STACK_WATERMARK \
192 } while (0); } while (0)
194 #define ICALL_RETURN_VAL(VAL) \
196 CLEAR_STACK_WATERMARK \
200 } while (0); } while (0)
202 #define ICALL_RETURN_OBJ(HANDLE) \
204 CLEAR_STACK_WATERMARK \
206 void* __ret = MONO_HANDLE_RAW (HANDLE); \
209 } while (0); } while (0)
212 Handle macros/functions
215 #ifdef ENABLE_CHECKED_BUILD
216 void mono_handle_verify (MonoRawHandle handle);
217 #define HANDLE_INVARIANTS(H) mono_handle_verify((void*)(H))
219 #define HANDLE_INVARIANTS(H) (0)
222 #define TYPED_HANDLE_PAYLOAD_NAME(TYPE) TYPE ## HandlePayload
223 #define TYPED_HANDLE_NAME(TYPE) TYPE ## Handle
224 #define TYPED_OUT_HANDLE_NAME(TYPE) TYPE ## HandleOut
228 * TYPED_HANDLE_DECL(SomeType):
229 * Expands to a decl for handles to SomeType and to an internal payload struct.
231 * For example, TYPED_HANDLE_DECL(MonoObject) (see below) expands to:
235 * } MonoObjectHandlePayload;
237 * typedef MonoObjectHandlePayload* MonoObjectHandle;
238 * typedef MonoObjectHandlePayload* MonoObjectHandleOut;
240 #define TYPED_HANDLE_DECL(TYPE) \
241 typedef struct { TYPE *__obj; } TYPED_HANDLE_PAYLOAD_NAME (TYPE) ; \
242 typedef TYPED_HANDLE_PAYLOAD_NAME (TYPE) * TYPED_HANDLE_NAME (TYPE); \
243 typedef TYPED_HANDLE_PAYLOAD_NAME (TYPE) * TYPED_OUT_HANDLE_NAME (TYPE)
244 /* Have to double expand because MONO_STRUCT_OFFSET is doing token pasting on cross-compilers. */
245 #define MONO_HANDLE_PAYLOAD_OFFSET_(PayloadType) MONO_STRUCT_OFFSET(PayloadType, __obj)
246 #define MONO_HANDLE_PAYLOAD_OFFSET(TYPE) MONO_HANDLE_PAYLOAD_OFFSET_(TYPED_HANDLE_PAYLOAD_NAME (TYPE))
248 #define MONO_HANDLE_INIT ((void*) mono_null_value_handle)
249 #define NULL_HANDLE mono_null_value_handle
251 //XXX add functions to get/set raw, set field, set field to null, set array, set array to null
252 #define MONO_HANDLE_RAW(HANDLE) (HANDLE_INVARIANTS (HANDLE), ((HANDLE)->__obj))
253 #define MONO_HANDLE_DCL(TYPE, NAME) TYPED_HANDLE_NAME(TYPE) NAME = (TYPED_HANDLE_NAME(TYPE))(mono_handle_new ((MonoObject*)(NAME ## _raw)))
254 #define MONO_HANDLE_NEW(TYPE, VALUE) (TYPED_HANDLE_NAME(TYPE))( mono_handle_new ((MonoObject*)(VALUE)) )
255 #define MONO_HANDLE_CAST(TYPE, VALUE) (TYPED_HANDLE_NAME(TYPE))( VALUE )
257 #define MONO_HANDLE_IS_NULL(HANDLE) (MONO_HANDLE_RAW(HANDLE) == NULL)
261 WARNING WARNING WARNING
263 The following functions require a particular evaluation ordering to ensure correctness.
264 We must not have exposed handles while any sort of evaluation is happening as that very evaluation might trigger
265 a safepoint and break us.
267 This is why we evaluate index and value before any call to MONO_HANDLE_RAW or other functions that deal with naked objects.
269 #define MONO_HANDLE_SETRAW(HANDLE, FIELD, VALUE) do { \
270 MonoObject *__val = (MonoObject*)(VALUE); \
271 MONO_OBJECT_SETREF (MONO_HANDLE_RAW (HANDLE), FIELD, __val); \
274 #define MONO_HANDLE_SET(HANDLE, FIELD, VALUE) do { \
275 MonoObjectHandle __val = MONO_HANDLE_CAST (MonoObject, VALUE); \
276 MONO_OBJECT_SETREF (MONO_HANDLE_RAW (HANDLE), FIELD, MONO_HANDLE_RAW (__val)); \
279 /* N.B. RESULT is evaluated before HANDLE */
280 #define MONO_HANDLE_GET(RESULT, HANDLE, FIELD) do { \
281 MonoObjectHandle __dest = MONO_HANDLE_CAST(MonoObject, RESULT); \
282 mono_gc_wbarrier_generic_store (&__dest->__obj, (MonoObject*)(MONO_HANDLE_RAW(HANDLE)->FIELD)); \
285 #define MONO_HANDLE_GETVAL(HANDLE, FIELD) (MONO_HANDLE_RAW(HANDLE)->FIELD)
287 /* VS doesn't support typeof :( :( :( */
288 #define MONO_HANDLE_SETVAL(HANDLE, FIELD, TYPE, VALUE) do { \
289 TYPE __val = (VALUE); \
290 MONO_HANDLE_RAW (HANDLE)->FIELD = __val; \
293 #define MONO_HANDLE_ARRAY_SETREF(HANDLE, IDX, VALUE) do { \
295 MonoObjectHandle __val = MONO_HANDLE_CAST (MonoObject, VALUE); \
296 mono_array_setref_fast (MONO_HANDLE_RAW (HANDLE), __idx, MONO_HANDLE_RAW (__val)); \
299 #define MONO_HANDLE_ARRAY_SETVAL(HANDLE, TYPE, IDX, VALUE) do { \
301 TYPE __val = (VALUE); \
302 mono_array_set (MONO_HANDLE_RAW (HANDLE), TYPE, __idx, __val); \
305 #define MONO_HANDLE_ARRAY_SETRAW(HANDLE, IDX, VALUE) do { \
307 MonoObject *__val = (MonoObject*)(VALUE); \
308 mono_array_setref_fast (MONO_HANDLE_RAW (HANDLE), __idx, __val); \
311 /* N.B. DEST is evaluated AFTER all the other arguments */
312 #define MONO_HANDLE_ARRAY_GETVAL(DEST, HANDLE, TYPE, IDX) do { \
313 MonoArrayHandle __arr = (HANDLE); \
315 TYPE __result = mono_array_get (MONO_HANDLE_RAW(__arr), TYPE, __idx); \
319 #define MONO_HANDLE_ARRAY_GETREF(DEST, HANDLE, IDX) do { \
320 mono_handle_array_getref (MONO_HANDLE_CAST(MonoObject, (DEST)), (HANDLE), (IDX)); \
323 #define MONO_HANDLE_ASSIGN(DESTH, SRCH) \
324 mono_handle_assign (MONO_HANDLE_CAST (MonoObject, (DESTH)), MONO_HANDLE_CAST(MonoObject, (SRCH)))
326 #define MONO_HANDLE_DOMAIN(HANDLE) (mono_object_domain (MONO_HANDLE_RAW (MONO_HANDLE_CAST (MonoObject, HANDLE))))
328 /* Baked typed handles we all want */
329 TYPED_HANDLE_DECL (MonoString);
330 TYPED_HANDLE_DECL (MonoArray);
331 TYPED_HANDLE_DECL (MonoObject);
332 TYPED_HANDLE_DECL (MonoException);
334 #define NULL_HANDLE_STRING MONO_HANDLE_CAST(MonoString, NULL_HANDLE)
337 This is the constant for a handle that points nowhere.
340 extern const MonoObjectHandle mono_null_value_handle;
343 mono_handle_assign (MonoObjectHandleOut dest, MonoObjectHandle src)
345 mono_gc_wbarrier_generic_store (&dest->__obj, src ? MONO_HANDLE_RAW(src) : NULL);
348 //FIXME this should go somewhere else
349 MonoStringHandle mono_string_new_handle (MonoDomain *domain, const char *data, MonoError *error);
350 MonoArrayHandle mono_array_new_handle (MonoDomain *domain, MonoClass *eclass, uintptr_t n, MonoError *error);
352 uintptr_t mono_array_handle_length (MonoArrayHandle arr);
355 mono_handle_array_getref (MonoObjectHandleOut dest, MonoArrayHandle array, uintptr_t index)
357 mono_gc_wbarrier_generic_store (&dest->__obj, mono_array_get (MONO_HANDLE_RAW (array),gpointer, index));
360 #define mono_handle_class(o) mono_object_class (MONO_HANDLE_RAW (o))
362 /* Local handles to global GC handles and back */
365 mono_gchandle_from_handle (MonoObjectHandle handle, mono_bool pinned);
368 mono_gchandle_get_target_handle (uint32_t gchandle);
371 mono_array_handle_memcpy_refs (MonoArrayHandle dest, uintptr_t dest_idx, MonoArrayHandle src, uintptr_t src_idx, uintptr_t len);
373 /* Pins the MonoArray using a gchandle and returns a pointer to the
374 * element with the given index (where each element is of the given
375 * size. Call mono_gchandle_free to unpin.
378 mono_array_handle_pin_with_size (MonoArrayHandle handle, int size, uintptr_t index, uint32_t *gchandle);
380 #define MONO_ARRAY_HANDLE_PIN(handle,type,index,gchandle_out) mono_array_handle_pin_with_size (MONO_HANDLE_CAST(MonoArray,(handle)), sizeof (type), (index), (gchandle_out))
383 mono_error_set_exception_handle (MonoError *error, MonoExceptionHandle exc);
387 #endif /* __MONO_HANDLE_H__ */