mono/metadata/object.h

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