mono/metadata/object.h

   1 /**
   2  * \file
   3  */
   4
   5 #ifndef _MONO_CLI_OBJECT_H_
   6 #define _MONO_CLI_OBJECT_H_
   7
   8 #include <mono/utils/mono-forward.h>
   9 #include <mono/metadata/object-forward.h>
  10 #include <mono/metadata/class.h>
  11 #include <mono/utils/mono-error.h>
  12
  13 MONO_BEGIN_DECLS
  14
  15 typedef struct _MonoString MONO_RT_MANAGED_ATTR MonoString;
  16 typedef struct _MonoArray MONO_RT_MANAGED_ATTR MonoArray;
  17 typedef struct _MonoReflectionMethod MONO_RT_MANAGED_ATTR MonoReflectionMethod;
  18 typedef struct _MonoReflectionModule MONO_RT_MANAGED_ATTR MonoReflectionModule;
  19 typedef struct _MonoReflectionField MONO_RT_MANAGED_ATTR MonoReflectionField;
  20 typedef struct _MonoReflectionProperty MONO_RT_MANAGED_ATTR MonoReflectionProperty;
  21 typedef struct _MonoReflectionEvent MONO_RT_MANAGED_ATTR MonoReflectionEvent;
  22 typedef struct _MonoReflectionType MONO_RT_MANAGED_ATTR MonoReflectionType;
  23 typedef struct _MonoDelegate MONO_RT_MANAGED_ATTR MonoDelegate;
  24 typedef struct _MonoThreadsSync MonoThreadsSync;
  25 typedef struct _MonoThread MONO_RT_MANAGED_ATTR MonoThread;
  26 typedef struct _MonoDynamicAssembly MonoDynamicAssembly;
  27 typedef struct _MonoDynamicImage MonoDynamicImage;
  28 typedef struct _MonoReflectionMethodBody MONO_RT_MANAGED_ATTR MonoReflectionMethodBody;
  29 typedef struct _MonoAppContext MONO_RT_MANAGED_ATTR MonoAppContext;
  30
  31 struct _MonoObject {
  32         MonoVTable *vtable;
  33         MonoThreadsSync *synchronisation;
  34 };
  35
  36 typedef MonoObject* (*MonoInvokeFunc)        (MonoMethod *method, void *obj, void **params, MonoObject **exc, MonoError *error);
  37 typedef void*    (*MonoCompileFunc)          (MonoMethod *method);
  38 typedef void        (*MonoMainThreadFunc)    (void* user_data);
  39
  40 #define MONO_OBJECT_SETREF(obj,fieldname,value) do {    \
  41                 mono_gc_wbarrier_set_field ((MonoObject*)(obj), &((obj)->fieldname), (MonoObject*)value);       \
  42                 /*(obj)->fieldname = (value);*/ \
  43         } while (0)
  44
  45 /* This should be used if 's' can reside on the heap */
  46 #define MONO_STRUCT_SETREF(s,field,value) do { \
  47         mono_gc_wbarrier_generic_store (&((s)->field), (MonoObject*)(value)); \
  48     } while (0)
  49
  50 #define mono_array_addr(array,type,index) ((type*)mono_array_addr_with_size ((array), sizeof (type), (index)))
  51 #define mono_array_get(array,type,index) ( *(type*)mono_array_addr ((array), type, (index)) )
  52 #define mono_array_set(array,type,index,value)  \
  53         do {    \
  54                 type *__p = (type *) mono_array_addr ((array), type, (index));  \
  55                 *__p = (value); \
  56         } while (0)
  57 #define mono_array_setref(array,index,value)    \
  58         do {    \
  59                 void **__p = (void **) mono_array_addr ((array), void*, (index));       \
  60                 mono_gc_wbarrier_set_arrayref ((array), __p, (MonoObject*)(value));     \
  61                 /* *__p = (value);*/    \
  62         } while (0)
  63 #define mono_array_memcpy_refs(dest,destidx,src,srcidx,count)   \
  64         do {    \
  65                 void **__p = (void **) mono_array_addr ((dest), void*, (destidx));      \
  66                 void **__s = mono_array_addr ((src), void*, (srcidx));  \
  67                 mono_gc_wbarrier_arrayref_copy (__p, __s, (count));     \
  68         } while (0)
  69
  70 MONO_API MONO_RT_EXTERNAL_ONLY mono_unichar2 *mono_string_chars  (MonoString *s);
  71 MONO_API MONO_RT_EXTERNAL_ONLY int            mono_string_length (MonoString *s);
  72
  73 MONO_API MONO_RT_EXTERNAL_ONLY MonoObject *
  74 mono_object_new             (MonoDomain *domain, MonoClass *klass);
  75
  76 MONO_API MONO_RT_EXTERNAL_ONLY
  77 MonoObject *
  78 mono_object_new_specific    (MonoVTable *vtable);
  79
  80 /* can be used for classes without finalizer in non-profiling mode */
  81 MONO_API MONO_RT_EXTERNAL_ONLY
  82 MonoObject *
  83 mono_object_new_fast        (MonoVTable *vtable);
  84
  85 MONO_API MONO_RT_EXTERNAL_ONLY
  86 MonoObject *
  87 mono_object_new_alloc_specific (MonoVTable *vtable);
  88
  89 MONO_API MONO_RT_EXTERNAL_ONLY
  90 MonoObject *
  91 mono_object_new_from_token  (MonoDomain *domain, MonoImage *image, uint32_t token);
  92
  93 MONO_API MONO_RT_EXTERNAL_ONLY
  94 MonoArray*
  95 mono_array_new              (MonoDomain *domain, MonoClass *eclass, uintptr_t n);
  96
  97 MONO_API MONO_RT_EXTERNAL_ONLY
  98 MonoArray*
  99 mono_array_new_full         (MonoDomain *domain, MonoClass *array_class,
 100                              uintptr_t *lengths, intptr_t *lower_bounds);
 101
 102 MONO_API MONO_RT_EXTERNAL_ONLY
 103 MonoArray *
 104 mono_array_new_specific     (MonoVTable *vtable, uintptr_t n);
 105
 106 MONO_API MONO_RT_EXTERNAL_ONLY
 107 MonoArray*
 108 mono_array_clone            (MonoArray *array);
 109
 110 MONO_API MONO_RT_EXTERNAL_ONLY char*
 111 mono_array_addr_with_size   (MonoArray *array, int size, uintptr_t idx);
 112
 113 MONO_API MONO_RT_EXTERNAL_ONLY uintptr_t
 114 mono_array_length           (MonoArray *array);
 115
 116 MONO_API MONO_RT_EXTERNAL_ONLY MonoString*
 117 mono_string_empty             (MonoDomain *domain);
 118
 119 MONO_API MONO_RT_EXTERNAL_ONLY
 120 MonoString*
 121 mono_string_empty_wrapper   (void);
 122
 123 MONO_API MONO_RT_EXTERNAL_ONLY
 124 MonoString*
 125 mono_string_new_utf16       (MonoDomain *domain, const mono_unichar2 *text, int32_t len);
 126
 127 MONO_API MONO_RT_EXTERNAL_ONLY
 128 MonoString*
 129 mono_string_new_size        (MonoDomain *domain, int32_t len);
 130
 131 MONO_API MONO_RT_EXTERNAL_ONLY
 132 MonoString*
 133 mono_ldstr                  (MonoDomain *domain, MonoImage *image, uint32_t str_index);
 134
 135 MONO_API MONO_RT_EXTERNAL_ONLY MonoString*
 136 mono_string_is_interned     (MonoString *str);
 137
 138 MONO_API MONO_RT_EXTERNAL_ONLY
 139 MonoString*
 140 mono_string_intern          (MonoString *str);
 141
 142 MONO_API MONO_RT_EXTERNAL_ONLY
 143 MonoString*
 144 mono_string_new             (MonoDomain *domain, const char *text);
 145
 146 MONO_API MONO_RT_EXTERNAL_ONLY MonoString*
 147 mono_string_new_wrapper     (const char *text);
 148
 149 MONO_API MONO_RT_EXTERNAL_ONLY
 150 MonoString*
 151 mono_string_new_len         (MonoDomain *domain, const char *text, unsigned int length);
 152
 153 MONO_API MONO_RT_EXTERNAL_ONLY
 154 MonoString*
 155 mono_string_new_utf32       (MonoDomain *domain, const mono_unichar4 *text, int32_t len);
 156
 157 MONO_API MONO_RT_EXTERNAL_ONLY
 158 char *
 159 mono_string_to_utf8         (MonoString *string_obj);
 160
 161 MONO_API MONO_RT_EXTERNAL_ONLY char *
 162 mono_string_to_utf8_checked (MonoString *string_obj, MonoError *error);
 163
 164 MONO_API MONO_RT_EXTERNAL_ONLY mono_unichar2 *
 165 mono_string_to_utf16        (MonoString *string_obj);
 166
 167 MONO_API MONO_RT_EXTERNAL_ONLY mono_unichar4 *
 168 mono_string_to_utf32        (MonoString *string_obj);
 169
 170 MONO_API MONO_RT_EXTERNAL_ONLY MonoString *
 171 mono_string_from_utf16      (/*const*/ mono_unichar2 *data);
 172
 173 MONO_API MONO_RT_EXTERNAL_ONLY MonoString *
 174 mono_string_from_utf32      (/*const*/ mono_unichar4 *data);
 175
 176 MONO_API MONO_RT_EXTERNAL_ONLY mono_bool
 177 mono_string_equal           (MonoString *s1, MonoString *s2);
 178
 179 MONO_API MONO_RT_EXTERNAL_ONLY unsigned int
 180 mono_string_hash            (MonoString *s);
 181
 182 MONO_API MONO_RT_EXTERNAL_ONLY int
 183 mono_object_hash            (MonoObject* obj);
 184
 185 MONO_API MONO_RT_EXTERNAL_ONLY
 186 MonoString *
 187 mono_object_to_string (MonoObject *obj, MonoObject **exc);
 188
 189 MONO_API MONO_RT_EXTERNAL_ONLY MonoObject *
 190 mono_value_box              (MonoDomain *domain, MonoClass *klass, void* val);
 191
 192 MONO_API MONO_RT_EXTERNAL_ONLY void
 193 mono_value_copy             (void* dest, /*const*/ void* src, MonoClass *klass);
 194
 195 MONO_API MONO_RT_EXTERNAL_ONLY void
 196 mono_value_copy_array       (MonoArray *dest, int dest_idx, void* src, int count);
 197
 198 MONO_API MONO_RT_EXTERNAL_ONLY MonoVTable*
 199 mono_object_get_vtable      (MonoObject *obj);
 200
 201 MONO_API MONO_RT_EXTERNAL_ONLY MonoDomain*
 202 mono_object_get_domain      (MonoObject *obj);
 203
 204 MONO_API MONO_RT_EXTERNAL_ONLY MonoClass*
 205 mono_object_get_class       (MonoObject *obj);
 206
 207 MONO_API MONO_RT_EXTERNAL_ONLY void*
 208 mono_object_unbox           (MonoObject *obj);
 209
 210 MONO_API MONO_RT_EXTERNAL_ONLY MonoObject *
 211 mono_object_clone           (MonoObject *obj);
 212
 213 MONO_API MONO_RT_EXTERNAL_ONLY MonoObject *
 214 mono_object_isinst          (MonoObject *obj, MonoClass *klass);
 215
 216 MONO_API MONO_RT_EXTERNAL_ONLY MonoObject *
 217 mono_object_isinst_mbyref   (MonoObject *obj, MonoClass *klass);
 218
 219 MONO_API MONO_RT_EXTERNAL_ONLY MonoObject *
 220 mono_object_castclass_mbyref (MonoObject *obj, MonoClass *klass);
 221
 222 MONO_API MONO_RT_EXTERNAL_ONLY mono_bool
 223 mono_monitor_try_enter       (MonoObject *obj, uint32_t ms);
 224
 225 MONO_API MONO_RT_EXTERNAL_ONLY mono_bool
 226 mono_monitor_enter           (MonoObject *obj);
 227
 228 MONO_API MONO_RT_EXTERNAL_ONLY void
 229 mono_monitor_enter_v4        (MonoObject *obj, char *lock_taken);
 230
 231 MONO_API MONO_RT_EXTERNAL_ONLY unsigned int
 232 mono_object_get_size         (MonoObject *o);
 233
 234 MONO_API MONO_RT_EXTERNAL_ONLY void
 235 mono_monitor_exit            (MonoObject *obj);
 236
 237 MONO_API MONO_RT_EXTERNAL_ONLY void
 238 mono_raise_exception        (MonoException *ex);
 239
 240 MONO_API MONO_RT_EXTERNAL_ONLY mono_bool
 241 mono_runtime_set_pending_exception (MonoException *exc, mono_bool overwrite);
 242
 243 MONO_API MONO_RT_EXTERNAL_ONLY void
 244 mono_reraise_exception      (MonoException *ex);
 245
 246 MONO_API MONO_RT_EXTERNAL_ONLY void
 247 mono_runtime_object_init    (MonoObject *this_obj);
 248
 249 MONO_API MONO_RT_EXTERNAL_ONLY void
 250 mono_runtime_class_init     (MonoVTable *vtable);
 251
 252 MONO_API MONO_RT_EXTERNAL_ONLY MonoDomain*
 253 mono_vtable_domain          (MonoVTable *vtable);
 254
 255 MONO_API MONO_RT_EXTERNAL_ONLY MonoClass*
 256 mono_vtable_class           (MonoVTable *vtable);
 257
 258 MONO_API MONO_RT_EXTERNAL_ONLY MonoMethod*
 259 mono_object_get_virtual_method (MonoObject *obj, MonoMethod *method);
 260
 261 MONO_API MONO_RT_EXTERNAL_ONLY MonoObject*
 262 mono_runtime_invoke         (MonoMethod *method, void *obj, void **params,
 263                              MonoObject **exc);
 264
 265 MONO_API MONO_RT_EXTERNAL_ONLY MonoMethod*
 266 mono_get_delegate_invoke    (MonoClass *klass);
 267
 268 MONO_API MONO_RT_EXTERNAL_ONLY MonoMethod*
 269 mono_get_delegate_begin_invoke (MonoClass *klass);
 270
 271 MONO_API MONO_RT_EXTERNAL_ONLY MonoMethod*
 272 mono_get_delegate_end_invoke (MonoClass *klass);
 273
 274 MONO_API MONO_RT_EXTERNAL_ONLY MonoObject*
 275 mono_runtime_delegate_invoke (MonoObject *delegate, void **params,
 276                               MonoObject **exc);
 277
 278 MONO_API MONO_RT_EXTERNAL_ONLY MonoObject*
 279 mono_runtime_invoke_array   (MonoMethod *method, void *obj, MonoArray *params,
 280                              MonoObject **exc);
 281
 282 MONO_API MONO_RT_EXTERNAL_ONLY void*
 283 mono_method_get_unmanaged_thunk (MonoMethod *method);
 284
 285 MONO_API MONO_RT_EXTERNAL_ONLY MonoArray*
 286 mono_runtime_get_main_args  (void);
 287
 288 MONO_API MONO_RT_EXTERNAL_ONLY void
 289 mono_runtime_exec_managed_code (MonoDomain *domain,
 290                                 MonoMainThreadFunc main_func,
 291                                 void* main_args);
 292
 293 MONO_API MONO_RT_EXTERNAL_ONLY int
 294 mono_runtime_run_main       (MonoMethod *method, int argc, char* argv[],
 295                              MonoObject **exc);
 296
 297 MONO_API MONO_RT_EXTERNAL_ONLY int
 298 mono_runtime_exec_main      (MonoMethod *method, MonoArray *args,
 299                              MonoObject **exc);
 300
 301 MONO_API MONO_RT_EXTERNAL_ONLY int
 302 mono_runtime_set_main_args  (int argc, char* argv[]);
 303
 304 /* The following functions won't be available with mono was configured with remoting disabled. */
 305 /*#ifndef DISABLE_REMOTING */
 306 MONO_API MONO_RT_EXTERNAL_ONLY void*
 307 mono_load_remote_field (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, void **res);
 308
 309 MONO_API MONO_RT_EXTERNAL_ONLY MonoObject *
 310 mono_load_remote_field_new (MonoObject *this_obj, MonoClass *klass, MonoClassField *field);
 311
 312 MONO_API MONO_RT_EXTERNAL_ONLY void
 313 mono_store_remote_field (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, void* val);
 314
 315 MONO_API MONO_RT_EXTERNAL_ONLY void
 316 mono_store_remote_field_new (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, MonoObject *arg);
 317
 318 /* #endif */
 319
 320 MONO_API MONO_RT_EXTERNAL_ONLY void
 321 mono_unhandled_exception    (MonoObject *exc);
 322
 323 MONO_API MONO_RT_EXTERNAL_ONLY void
 324 mono_print_unhandled_exception (MonoObject *exc);
 325
 326 MONO_API MONO_RT_EXTERNAL_ONLY
 327 void*
 328 mono_compile_method        (MonoMethod *method);
 329
 330 /* accessors for fields and properties */
 331 MONO_API MONO_RT_EXTERNAL_ONLY void
 332 mono_field_set_value (MonoObject *obj, MonoClassField *field, void *value);
 333
 334 MONO_API MONO_RT_EXTERNAL_ONLY void
 335 mono_field_static_set_value (MonoVTable *vt, MonoClassField *field, void *value);
 336
 337 MONO_API MONO_RT_EXTERNAL_ONLY void
 338 mono_field_get_value (MonoObject *obj, MonoClassField *field, void *value);
 339
 340 MONO_API MONO_RT_EXTERNAL_ONLY void
 341 mono_field_static_get_value (MonoVTable *vt, MonoClassField *field, void *value);
 342
 343 MONO_API MONO_RT_EXTERNAL_ONLY MonoObject *
 344 mono_field_get_value_object (MonoDomain *domain, MonoClassField *field, MonoObject *obj);
 345
 346 MONO_API MONO_RT_EXTERNAL_ONLY void
 347 mono_property_set_value (MonoProperty *prop, void *obj, void **params, MonoObject **exc);
 348
 349 MONO_API MONO_RT_EXTERNAL_ONLY MonoObject*
 350 mono_property_get_value (MonoProperty *prop, void *obj, void **params, MonoObject **exc);
 351
 352 /* GC handles support
 353  *
 354  * A handle can be created to refer to a managed object and either prevent it
 355  * from being garbage collected or moved or to be able to know if it has been
 356  * collected or not (weak references).
 357  * mono_gchandle_new () is used to prevent an object from being garbage collected
 358  * until mono_gchandle_free() is called. Use a TRUE value for the pinned argument to
 359  * prevent the object from being moved (this should be avoided as much as possible
 360  * and this should be used only for shorts periods of time or performance will suffer).
 361  * To create a weakref use mono_gchandle_new_weakref (): track_resurrection should
 362  * usually be false (see the GC docs for more details).
 363  * mono_gchandle_get_target () can be used to get the object referenced by both kinds
 364  * of handle: for a weakref handle, if an object has been collected, it will return NULL.
 365  */
 366 MONO_API MONO_RT_EXTERNAL_ONLY uint32_t     mono_gchandle_new         (MonoObject *obj, mono_bool pinned);
 367 MONO_API MONO_RT_EXTERNAL_ONLY uint32_t     mono_gchandle_new_weakref (MonoObject *obj, mono_bool track_resurrection);
 368 MONO_API MONO_RT_EXTERNAL_ONLY MonoObject*  mono_gchandle_get_target  (uint32_t gchandle);
 369 MONO_API MONO_RT_EXTERNAL_ONLY void         mono_gchandle_free        (uint32_t gchandle);
 370
 371 /* Reference queue support
 372  *
 373  * A reference queue is used to get notifications of when objects are collected.
 374  * Call mono_gc_reference_queue_new to create a new queue and pass the callback that
 375  * will be invoked when registered objects are collected.
 376  * Call mono_gc_reference_queue_add to register a pair of objects and data within a queue.
 377  * The callback will be triggered once an object is both unreachable and finalized.
 378  */
 379
 380 typedef void (*mono_reference_queue_callback) (void *user_data);
 381 typedef struct _MonoReferenceQueue MonoReferenceQueue;
 382
 383 MONO_API MONO_RT_EXTERNAL_ONLY MonoReferenceQueue* mono_gc_reference_queue_new (mono_reference_queue_callback callback);
 384 MONO_API MONO_RT_EXTERNAL_ONLY void mono_gc_reference_queue_free (MonoReferenceQueue *queue);
 385 MONO_API MONO_RT_EXTERNAL_ONLY mono_bool mono_gc_reference_queue_add (MonoReferenceQueue *queue, MonoObject *obj, void *user_data);
 386
 387 /* GC write barriers support */
 388 MONO_API MONO_RT_EXTERNAL_ONLY void mono_gc_wbarrier_set_field     (MonoObject *obj, void* field_ptr, MonoObject* value);
 389 MONO_API MONO_RT_EXTERNAL_ONLY void mono_gc_wbarrier_set_arrayref  (MonoArray *arr, void* slot_ptr, MonoObject* value);
 390 MONO_API MONO_RT_EXTERNAL_ONLY void mono_gc_wbarrier_arrayref_copy (void* dest_ptr, /*const*/ void* src_ptr, int count);
 391 MONO_API MONO_RT_EXTERNAL_ONLY void mono_gc_wbarrier_generic_store (void* ptr, MonoObject* value);
 392 MONO_API MONO_RT_EXTERNAL_ONLY void mono_gc_wbarrier_generic_store_atomic (void *ptr, MonoObject *value);
 393 MONO_API MONO_RT_EXTERNAL_ONLY void mono_gc_wbarrier_generic_nostore (void* ptr);
 394 MONO_API MONO_RT_EXTERNAL_ONLY void mono_gc_wbarrier_value_copy    (void* dest, /*const*/ void* src, int count, MonoClass *klass);
 395 MONO_API MONO_RT_EXTERNAL_ONLY void mono_gc_wbarrier_object_copy   (MonoObject* obj, MonoObject *src);
 396
 397 MONO_END_DECLS
 398
 399 #endif