mono/metadata/handle.h

   1 /*
   2  * handle.h: Handle to object in native code
   3  *
   4  * Authors:
   5  *  - Ludovic Henry <ludovic@xamarin.com>
   6  *  - Aleksey Klieger <aleksey.klieger@xamarin.com>
   7  *  - Rodrigo Kumpera <kumpera@xamarin.com>
   8  *
   9  * Copyright 2016 Dot net foundation.
  10  * Licensed under the MIT license. See LICENSE file in the project root for full license information.
  11  */
  12
  13 #ifndef __MONO_HANDLE_H__
  14 #define __MONO_HANDLE_H__
  15
  16 #include <config.h>
  17 #include <glib.h>
  18
  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>
  24
  25 G_BEGIN_DECLS
  26
  27
  28 /*
  29 Handle stack.
  30
  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.
  33
  34 To do bulk operations you use a stack mark.
  35
  36 */
  37
  38 /*
  39 3 is the number of fields besides the data in the struct;
  40 128 words makes each chunk 512 or 1024 bytes each
  41 */
  42 #define OBJECTS_PER_HANDLES_CHUNK (128 - 3)
  43
  44 /*
  45 Whether this config needs stack watermark recording to know where to start scanning from.
  46 */
  47 #ifdef HOST_WATCHOS
  48 #define MONO_NEEDS_STACK_WATERMARK 1
  49 #endif
  50
  51 typedef struct _HandleChunk HandleChunk;
  52
  53 struct _HandleChunk {
  54         int size; //number of bytes
  55         HandleChunk *prev, *next;
  56         MonoObject *objects [OBJECTS_PER_HANDLES_CHUNK];
  57 };
  58
  59 typedef struct {
  60         HandleChunk *top; //alloc from here
  61         HandleChunk *bottom; //scan from here
  62 } HandleStack;
  63
  64 typedef struct {
  65         int size;
  66         HandleChunk *chunk;
  67 } HandleStackMark;
  68
  69 typedef void *MonoRawHandle;
  70
  71 typedef void (*GcScanFunc) (gpointer*, gpointer);
  72
  73
  74 MonoRawHandle mono_handle_new (MonoObject *object);
  75
  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);
  81
  82 static inline void
  83 mono_stack_mark_init (MonoThreadInfo *info, HandleStackMark *stackmark)
  84 {
  85         HandleStack *handles = (HandleStack *)info->handle_stack;
  86         stackmark->size = handles->top->size;
  87         stackmark->chunk = handles->top;
  88 }
  89
  90 static inline void
  91 mono_stack_mark_pop (MonoThreadInfo *info, HandleStackMark *stackmark)
  92 {
  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;
  98 }
  99
 100 /*
 101 Icall macros
 102 */
 103 #define SETUP_ICALL_COMMON      \
 104         do { \
 105                 MonoError error;        \
 106                 MonoThreadInfo *__info = mono_thread_info_current ();   \
 107                 error_init (&error);    \
 108
 109 #define CLEAR_ICALL_COMMON      \
 110         mono_error_set_pending_exception (&error);
 111
 112 #define SETUP_ICALL_FRAME       \
 113         HandleStackMark __mark; \
 114         mono_stack_mark_init (__info, &__mark);
 115
 116 #define CLEAR_ICALL_FRAME       \
 117         mono_stack_mark_record_size (__info, &__mark, __FUNCTION__);    \
 118         mono_stack_mark_pop (__info, &__mark);
 119
 120 #define HANDLE_FUNCTION_ENTER() do {                            \
 121         MonoThreadInfo *__info = mono_thread_info_current ();   \
 122         SETUP_ICALL_FRAME                                       \
 123
 124 #define HANDLE_FUNCTION_RETURN()                \
 125         CLEAR_ICALL_FRAME;                      \
 126         } while (0)
 127
 128 #define HANDLE_FUNCTION_RETURN_VAL(VAL)         \
 129         CLEAR_ICALL_FRAME;                      \
 130         return (VAL);                           \
 131         } while (0)
 132
 133 #define HANDLE_FUNCTION_RETURN_OBJ(HANDLE)                      \
 134         do {                                                    \
 135                 void* __result = (MONO_HANDLE_RAW (HANDLE));    \
 136                 CLEAR_ICALL_FRAME;                              \
 137                 return __result;                                \
 138         } while (0); } while (0);
 139
 140 #ifdef MONO_NEEDS_STACK_WATERMARK
 141
 142 static void
 143 mono_thread_info_pop_stack_mark (MonoThreadInfo *info, void *old_mark)
 144 {
 145         info->stack_mark = old_mark;
 146 }
 147
 148 static void*
 149 mono_thread_info_push_stack_mark (MonoThreadInfo *info, void *mark)
 150 {
 151         void *old = info->stack_mark;
 152         info->stack_mark = mark;
 153         return old;
 154 }
 155
 156 #define SETUP_STACK_WATERMARK   \
 157         int __dummy;    \
 158         __builtin_unwind_init ();       \
 159         void *__old_stack_mark = mono_thread_info_push_stack_mark (__info, &__dummy);
 160
 161 #define CLEAR_STACK_WATERMARK   \
 162         mono_thread_info_pop_stack_mark (__info, __old_stack_mark);
 163
 164 #else
 165 #define SETUP_STACK_WATERMARK
 166 #define CLEAR_STACK_WATERMARK
 167 #endif
 168
 169 #define ICALL_ENTRY()   \
 170         SETUP_ICALL_COMMON      \
 171         SETUP_ICALL_FRAME       \
 172         SETUP_STACK_WATERMARK
 173
 174 #define ICALL_RETURN()  \
 175         do {    \
 176                 CLEAR_STACK_WATERMARK   \
 177                 CLEAR_ICALL_COMMON      \
 178                 CLEAR_ICALL_FRAME       \
 179                 return; \
 180         } while (0); } while (0)
 181
 182 #define ICALL_RETURN_VAL(VAL)   \
 183         do {    \
 184                 CLEAR_STACK_WATERMARK   \
 185                 CLEAR_ICALL_COMMON      \
 186                 CLEAR_ICALL_FRAME       \
 187                 return VAL;     \
 188         } while (0); } while (0)
 189
 190 #define ICALL_RETURN_OBJ(HANDLE)        \
 191         do {    \
 192                 CLEAR_STACK_WATERMARK   \
 193                 CLEAR_ICALL_COMMON      \
 194                 void* __ret = MONO_HANDLE_RAW (HANDLE); \
 195                 CLEAR_ICALL_FRAME       \
 196                 return __ret;   \
 197         } while (0); } while (0)
 198
 199 /*
 200 Handle macros/functions
 201 */
 202
 203 #ifdef ENABLE_CHECKED_BUILD
 204 void mono_handle_verify (MonoRawHandle handle);
 205 #define HANDLE_INVARIANTS(H) mono_handle_verify((void*)(H))
 206 #else
 207 #define HANDLE_INVARIANTS(H) (0)
 208 #endif
 209
 210 #define TYPED_HANDLE_PAYLOAD_NAME(TYPE) TYPE ## HandlePayload
 211 #define TYPED_HANDLE_NAME(TYPE) TYPE ## Handle
 212 #define TYPED_OUT_HANDLE_NAME(TYPE) TYPE ## HandleOut
 213
 214
 215 /*
 216  * TYPED_HANDLE_DECL(SomeType):
 217  *   Expands to a decl for handles to SomeType and to an internal payload struct.
 218  *
 219  * For example, TYPED_HANDLE_DECL(MonoObject) (see below) expands to:
 220  *
 221  * typedef struct {
 222  *   MonoObject *__obj;
 223  * } MonoObjectHandlePayload;
 224  *
 225  * typedef MonoObjectHandlePayload* MonoObjectHandle;
 226  * typedef MonoObjectHandlePayload* MonoObjectHandleOut;
 227  */
 228 #define TYPED_HANDLE_DECL(TYPE)                                         \
 229         typedef struct { TYPE *__obj; } TYPED_HANDLE_PAYLOAD_NAME (TYPE) ; \
 230         typedef TYPED_HANDLE_PAYLOAD_NAME (TYPE) * TYPED_HANDLE_NAME (TYPE); \
 231         typedef TYPED_HANDLE_PAYLOAD_NAME (TYPE) * TYPED_OUT_HANDLE_NAME (TYPE)
 232 /* Have to double expand because MONO_STRUCT_OFFSET is doing token pasting on cross-compilers. */
 233 #define MONO_HANDLE_PAYLOAD_OFFSET_(PayloadType) MONO_STRUCT_OFFSET(PayloadType, __obj)
 234 #define MONO_HANDLE_PAYLOAD_OFFSET(TYPE) MONO_HANDLE_PAYLOAD_OFFSET_(TYPED_HANDLE_PAYLOAD_NAME (TYPE))
 235
 236 #define MONO_HANDLE_INIT ((void*) mono_null_value_handle)
 237 #define NULL_HANDLE mono_null_value_handle
 238
 239 //XXX add functions to get/set raw, set field, set field to null, set array, set array to null
 240 #define MONO_HANDLE_RAW(HANDLE) (HANDLE_INVARIANTS (HANDLE), ((HANDLE)->__obj))
 241 #define MONO_HANDLE_DCL(TYPE, NAME) TYPED_HANDLE_NAME(TYPE) NAME = (TYPED_HANDLE_NAME(TYPE))(mono_handle_new ((MonoObject*)(NAME ## _raw)))
 242 #define MONO_HANDLE_NEW(TYPE, VALUE) (TYPED_HANDLE_NAME(TYPE))( mono_handle_new ((MonoObject*)(VALUE)) )
 243 #define MONO_HANDLE_CAST(TYPE, VALUE) (TYPED_HANDLE_NAME(TYPE))( VALUE )
 244
 245 #define MONO_HANDLE_IS_NULL(HANDLE) (MONO_HANDLE_RAW(HANDLE) == NULL)
 246
 247
 248 /*
 249 WARNING WARNING WARNING
 250
 251 The following functions require a particular evaluation ordering to ensure correctness.
 252 We must not have exposed handles while any sort of evaluation is happening as that very evaluation might trigger
 253 a safepoint and break us.
 254
 255 This is why we evaluate index and value before any call to MONO_HANDLE_RAW or other functions that deal with naked objects.
 256 */
 257 #define MONO_HANDLE_SETRAW(HANDLE, FIELD, VALUE) do {   \
 258                 MonoObject *__val = (MonoObject*)(VALUE);       \
 259                 MONO_OBJECT_SETREF (MONO_HANDLE_RAW (HANDLE), FIELD, __val);    \
 260         } while (0)
 261
 262 #define MONO_HANDLE_SET(HANDLE, FIELD, VALUE) do {      \
 263                 MonoObjectHandle __val = MONO_HANDLE_CAST (MonoObject, VALUE);  \
 264                 MONO_OBJECT_SETREF (MONO_HANDLE_RAW (HANDLE), FIELD, MONO_HANDLE_RAW (__val));  \
 265         } while (0)
 266
 267 /* N.B. RESULT is evaluated before HANDLE */
 268 #define MONO_HANDLE_GET(RESULT, HANDLE, FIELD) do {                     \
 269                 MonoObjectHandle __dest = MONO_HANDLE_CAST(MonoObject, RESULT); \
 270                 mono_gc_wbarrier_generic_store (&__dest->__obj,  (MonoObject*)(MONO_HANDLE_RAW(HANDLE)->FIELD)); \
 271         } while (0)
 272
 273 #define MONO_HANDLE_GETVAL(HANDLE, FIELD) (MONO_HANDLE_RAW(HANDLE)->FIELD)
 274
 275 /* VS doesn't support typeof :( :( :( */
 276 #define MONO_HANDLE_SETVAL(HANDLE, FIELD, TYPE, VALUE) do {     \
 277                 TYPE __val = (VALUE);   \
 278                 MONO_HANDLE_RAW (HANDLE)->FIELD = __val;        \
 279          } while (0)
 280
 281 #define MONO_HANDLE_ARRAY_SETREF(HANDLE, IDX, VALUE) do {       \
 282                 int __idx = (IDX);      \
 283                 MonoObjectHandle __val = MONO_HANDLE_CAST (MonoObject, VALUE);          \
 284                 mono_array_setref_fast (MONO_HANDLE_RAW (HANDLE), __idx, MONO_HANDLE_RAW (__val));      \
 285         } while (0)
 286
 287 #define MONO_HANDLE_ARRAY_SETVAL(HANDLE, TYPE, IDX, VALUE) do {         \
 288                 int __idx = (IDX);                                      \
 289                 TYPE __val = (VALUE);                   \
 290                 mono_array_set (MONO_HANDLE_RAW (HANDLE), TYPE, __idx, __val); \
 291         } while (0)
 292
 293 #define MONO_HANDLE_ARRAY_SETRAW(HANDLE, IDX, VALUE) do {       \
 294                 int __idx = (IDX);      \
 295                 MonoObject *__val = (MonoObject*)(VALUE);       \
 296                 mono_array_setref_fast (MONO_HANDLE_RAW (HANDLE), __idx, __val); \
 297         } while (0)
 298
 299 /* N.B. DEST is evaluated AFTER all the other arguments */
 300 #define MONO_HANDLE_ARRAY_GETVAL(DEST, HANDLE, TYPE, IDX) do {          \
 301                 MonoArrayHandle __arr = (HANDLE);                       \
 302                 int __idx = (IDX);                                      \
 303                 TYPE __result = mono_array_get (MONO_HANDLE_RAW(__arr), TYPE, __idx); \
 304                 (DEST) =  __result;                                     \
 305         } while (0)
 306
 307 #define MONO_HANDLE_ARRAY_GETREF(DEST, HANDLE, IDX) do {                \
 308                 mono_handle_array_getref (MONO_HANDLE_CAST(MonoObject, (DEST)), (HANDLE), (IDX)); \
 309         } while (0)
 310
 311 #define MONO_HANDLE_ASSIGN(DESTH, SRCH)                         \
 312         mono_handle_assign (MONO_HANDLE_CAST (MonoObject, (DESTH)), MONO_HANDLE_CAST(MonoObject, (SRCH)))
 313
 314 #define MONO_HANDLE_DOMAIN(HANDLE) (mono_object_domain (MONO_HANDLE_RAW (MONO_HANDLE_CAST (MonoObject, HANDLE))))
 315
 316 /* Baked typed handles we all want */
 317 TYPED_HANDLE_DECL (MonoString);
 318 TYPED_HANDLE_DECL (MonoArray);
 319 TYPED_HANDLE_DECL (MonoObject);
 320 TYPED_HANDLE_DECL (MonoException);
 321
 322 #define NULL_HANDLE_STRING MONO_HANDLE_CAST(MonoString, NULL_HANDLE)
 323
 324 /*
 325 This is the constant for a handle that points nowhere.
 326 Init values to it.
 327 */
 328 extern const MonoObjectHandle mono_null_value_handle;
 329
 330 static inline void
 331 mono_handle_assign (MonoObjectHandleOut dest, MonoObjectHandle src)
 332 {
 333         mono_gc_wbarrier_generic_store (&dest->__obj, MONO_HANDLE_RAW(src));
 334 }
 335
 336 //FIXME this should go somewhere else
 337 MonoStringHandle mono_string_new_handle (MonoDomain *domain, const char *data, MonoError *error);
 338 MonoArrayHandle mono_array_new_handle (MonoDomain *domain, MonoClass *eclass, uintptr_t n, MonoError *error);
 339
 340 uintptr_t mono_array_handle_length (MonoArrayHandle arr);
 341
 342 static inline void
 343 mono_handle_array_getref (MonoObjectHandleOut dest, MonoArrayHandle array, uintptr_t index)
 344 {
 345         mono_gc_wbarrier_generic_store (&dest->__obj, mono_array_get (MONO_HANDLE_RAW (array),gpointer, index));
 346 }
 347
 348 #define mono_handle_class(o) mono_object_class (MONO_HANDLE_RAW (o))
 349
 350 /* Local handles to global GC handles and back */
 351
 352 uint32_t
 353 mono_gchandle_from_handle (MonoObjectHandle handle, mono_bool pinned);
 354
 355 MonoObjectHandle
 356 mono_gchandle_get_target_handle (uint32_t gchandle);
 357
 358 void
 359 mono_array_handle_memcpy_refs (MonoArrayHandle dest, uintptr_t dest_idx, MonoArrayHandle src, uintptr_t src_idx, uintptr_t len);
 360
 361 /* Pins the MonoArray using a gchandle and returns a pointer to the
 362  * element with the given index (where each element is of the given
 363  * size.  Call mono_gchandle_free to unpin.
 364  */
 365 gpointer
 366 mono_array_handle_pin_with_size (MonoArrayHandle handle, int size, uintptr_t index, uint32_t *gchandle);
 367
 368 #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))
 369
 370 void
 371 mono_error_set_exception_handle (MonoError *error, MonoExceptionHandle exc);
 372
 373 G_END_DECLS
 374
 375 #endif /* __MONO_HANDLE_H__ */