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 {
  30         MonoVTable *vtable;
  31         MonoThreadsSync *synchronisation;
  32 } MonoObject;
  33
  34 typedef MonoObject* (*MonoInvokeFunc)        (MonoMethod *method, void *obj, void **params, MonoObject **exc);
  35 typedef void*    (*MonoCompileFunc)          (MonoMethod *method);
  36 typedef void        (*MonoMainThreadFunc)    (void* user_data);
  37
  38 #define MONO_OBJECT_SETREF(obj,fieldname,value) do {    \
  39                 mono_gc_wbarrier_set_field ((MonoObject*)(obj), &((obj)->fieldname), (MonoObject*)value);       \
  40                 /*(obj)->fieldname = (value);*/ \
  41         } while (0)
  42
  43 /* This should be used if 's' can reside on the heap */
  44 #define MONO_STRUCT_SETREF(s,field,value) do { \
  45         mono_gc_wbarrier_generic_store (&((s)->field), (MonoObject*)(value)); \
  46     } while (0)
  47
  48 #define mono_array_addr(array,type,index) ((type*)(void*) mono_array_addr_with_size (array, sizeof (type), index))
  49 #define mono_array_get(array,type,index) ( *(type*)mono_array_addr ((array), type, (index)) )
  50 #define mono_array_set(array,type,index,value)  \
  51         do {    \
  52                 type *__p = (type *) mono_array_addr ((array), type, (index));  \
  53                 *__p = (value); \
  54         } while (0)
  55 #define mono_array_setref(array,index,value)    \
  56         do {    \
  57                 void **__p = (void **) mono_array_addr ((array), void*, (index));       \
  58                 mono_gc_wbarrier_set_arrayref ((array), __p, (MonoObject*)(value));     \
  59                 /* *__p = (value);*/    \
  60         } while (0)
  61 #define mono_array_memcpy_refs(dest,destidx,src,srcidx,count)   \
  62         do {    \
  63                 void **__p = (void **) mono_array_addr ((dest), void*, (destidx));      \
  64                 void **__s = mono_array_addr ((src), void*, (srcidx));  \
  65                 mono_gc_wbarrier_arrayref_copy (__p, __s, (count));     \
  66         } while (0)
  67
  68 mono_unichar2 *mono_string_chars  (MonoString *s);
  69 int            mono_string_length (MonoString *s);
  70
  71 MonoObject *
  72 mono_object_new             (MonoDomain *domain, MonoClass *klass);
  73
  74 MonoObject *
  75 mono_object_new_specific    (MonoVTable *vtable);
  76
  77 /* can be used for classes without finalizer in non-profiling mode */
  78 MonoObject *
  79 mono_object_new_fast        (MonoVTable *vtable);
  80
  81 MonoObject *
  82 mono_object_new_alloc_specific (MonoVTable *vtable);
  83
  84 MonoObject *
  85 mono_object_new_from_token  (MonoDomain *domain, MonoImage *image, uint32_t token);
  86
  87 MonoArray*
  88 mono_array_new              (MonoDomain *domain, MonoClass *eclass, uintptr_t n);
  89
  90 MonoArray*
  91 mono_array_new_full         (MonoDomain *domain, MonoClass *array_class,
  92                              uintptr_t *lengths, intptr_t *lower_bounds);
  93
  94 MonoArray *
  95 mono_array_new_specific     (MonoVTable *vtable, uintptr_t n);
  96
  97 MonoArray*
  98 mono_array_clone            (MonoArray *array);
  99
 100 char*
 101 mono_array_addr_with_size   (MonoArray *array, int size, uintptr_t idx);
 102
 103 uintptr_t
 104 mono_array_length           (MonoArray *array);
 105
 106 MonoString*
 107 mono_string_new_utf16       (MonoDomain *domain, const mono_unichar2 *text, int32_t len);
 108
 109 MonoString*
 110 mono_string_new_size        (MonoDomain *domain, int32_t len);
 111
 112 MonoString*
 113 mono_ldstr                  (MonoDomain *domain, MonoImage *image, uint32_t str_index);
 114
 115 MonoString*
 116 mono_string_is_interned     (MonoString *str);
 117
 118 MonoString*
 119 mono_string_intern          (MonoString *str);
 120
 121 MonoString*
 122 mono_string_new             (MonoDomain *domain, const char *text);
 123
 124 MonoString*
 125 mono_string_new_wrapper     (const char *text);
 126
 127 MonoString*
 128 mono_string_new_len         (MonoDomain *domain, const char *text, unsigned int length);
 129
 130 char *
 131 mono_string_to_utf8         (MonoString *string_obj);
 132
 133 char *
 134 mono_string_to_utf8_checked (MonoString *string_obj, MonoError *error);
 135
 136 mono_unichar2 *
 137 mono_string_to_utf16        (MonoString *string_obj);
 138
 139 MonoString *
 140 mono_string_from_utf16      (mono_unichar2 *data);
 141
 142 mono_bool
 143 mono_string_equal           (MonoString *s1, MonoString *s2);
 144
 145 unsigned int
 146 mono_string_hash            (MonoString *s);
 147
 148 int
 149 mono_object_hash            (MonoObject* obj);
 150
 151 MonoString *
 152 mono_object_to_string (MonoObject *obj, MonoObject **exc);
 153
 154 MonoObject *
 155 mono_value_box              (MonoDomain *domain, MonoClass *klass, void* val);
 156
 157 void
 158 mono_value_copy             (void* dest, void* src, MonoClass *klass);
 159
 160 void
 161 mono_value_copy_array       (MonoArray *dest, int dest_idx, void* src, int count);
 162
 163 MonoDomain*
 164 mono_object_get_domain      (MonoObject *obj);
 165
 166 MonoClass*
 167 mono_object_get_class       (MonoObject *obj);
 168
 169 void*
 170 mono_object_unbox           (MonoObject *obj);
 171
 172 MonoObject *
 173 mono_object_clone           (MonoObject *obj);
 174
 175 MonoObject *
 176 mono_object_isinst          (MonoObject *obj, MonoClass *klass);
 177
 178 MonoObject *
 179 mono_object_isinst_mbyref   (MonoObject *obj, MonoClass *klass);
 180
 181 MonoObject *
 182 mono_object_castclass_mbyref (MonoObject *obj, MonoClass *klass);
 183
 184 mono_bool
 185 mono_monitor_try_enter       (MonoObject *obj, uint32_t ms);
 186
 187 mono_bool
 188 mono_monitor_enter           (MonoObject *obj);
 189
 190 unsigned int
 191 mono_object_get_size         (MonoObject *o);
 192
 193 void
 194 mono_monitor_exit            (MonoObject *obj);
 195
 196 void
 197 mono_raise_exception        (MonoException *ex);
 198
 199 void
 200 mono_runtime_object_init    (MonoObject *this_obj);
 201
 202 void
 203 mono_runtime_class_init     (MonoVTable *vtable);
 204
 205 MonoMethod*
 206 mono_object_get_virtual_method (MonoObject *obj, MonoMethod *method);
 207
 208 MonoObject*
 209 mono_runtime_invoke         (MonoMethod *method, void *obj, void **params,
 210                              MonoObject **exc);
 211
 212 MonoMethod *
 213 mono_get_delegate_invoke    (MonoClass *klass);
 214
 215 MonoObject*
 216 mono_runtime_delegate_invoke (MonoObject *delegate, void **params,
 217                               MonoObject **exc);
 218
 219 MonoObject*
 220 mono_runtime_invoke_array   (MonoMethod *method, void *obj, MonoArray *params,
 221                              MonoObject **exc);
 222
 223 void*
 224 mono_method_get_unmanaged_thunk (MonoMethod *method);
 225
 226 MonoArray*
 227 mono_runtime_get_main_args  (void);
 228
 229 void
 230 mono_runtime_exec_managed_code (MonoDomain *domain,
 231                                 MonoMainThreadFunc main_func,
 232                                 void* main_args);
 233
 234 int
 235 mono_runtime_run_main       (MonoMethod *method, int argc, char* argv[],
 236                              MonoObject **exc);
 237
 238 int
 239 mono_runtime_exec_main      (MonoMethod *method, MonoArray *args,
 240                              MonoObject **exc);
 241
 242 void*
 243 mono_load_remote_field (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, void **res);
 244
 245 MonoObject *
 246 mono_load_remote_field_new (MonoObject *this_obj, MonoClass *klass, MonoClassField *field);
 247
 248 void
 249 mono_store_remote_field (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, void* val);
 250
 251 void
 252 mono_store_remote_field_new (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, MonoObject *arg);
 253
 254 void
 255 mono_unhandled_exception    (MonoObject *exc);
 256
 257 void
 258 mono_print_unhandled_exception (MonoObject *exc);
 259
 260 void*
 261 mono_compile_method        (MonoMethod *method);
 262
 263 /* accessors for fields and properties */
 264 void
 265 mono_field_set_value (MonoObject *obj, MonoClassField *field, void *value);
 266
 267 void
 268 mono_field_static_set_value (MonoVTable *vt, MonoClassField *field, void *value);
 269
 270 void
 271 mono_field_get_value (MonoObject *obj, MonoClassField *field, void *value);
 272
 273 void
 274 mono_field_static_get_value (MonoVTable *vt, MonoClassField *field, void *value);
 275
 276 MonoObject *
 277 mono_field_get_value_object (MonoDomain *domain, MonoClassField *field, MonoObject *obj);
 278
 279 void
 280 mono_property_set_value (MonoProperty *prop, void *obj, void **params, MonoObject **exc);
 281
 282 MonoObject*
 283 mono_property_get_value (MonoProperty *prop, void *obj, void **params, MonoObject **exc);
 284
 285 /* GC handles support
 286  *
 287  * A handle can be created to refer to a managed object and either prevent it
 288  * from being garbage collected or moved or to be able to know if it has been
 289  * collected or not (weak references).
 290  * mono_gchandle_new () is used to prevent an object from being garbage collected
 291  * until mono_gchandle_free() is called. Use a TRUE value for the pinned argument to
 292  * prevent the object from being moved (this should be avoided as much as possible
 293  * and this should be used only for shorts periods of time or performance will suffer).
 294  * To create a weakref use mono_gchandle_new_weakref (): track_resurrection should
 295  * usually be false (see the GC docs for more details).
 296  * mono_gchandle_get_target () can be used to get the object referenced by both kinds
 297  * of handle: for a weakref handle, if an object has been collected, it will return NULL.
 298  */
 299 uint32_t      mono_gchandle_new         (MonoObject *obj, mono_bool pinned);
 300 uint32_t      mono_gchandle_new_weakref (MonoObject *obj, mono_bool track_resurrection);
 301 MonoObject*  mono_gchandle_get_target  (uint32_t gchandle);
 302 void         mono_gchandle_free        (uint32_t gchandle);
 303
 304 /* GC write barriers support */
 305 void mono_gc_wbarrier_set_field     (MonoObject *obj, void* field_ptr, MonoObject* value);
 306 void mono_gc_wbarrier_set_arrayref  (MonoArray *arr, void* slot_ptr, MonoObject* value);
 307 void mono_gc_wbarrier_arrayref_copy (void* dest_ptr, void* src_ptr, int count);
 308 void mono_gc_wbarrier_generic_store (void* ptr, MonoObject* value);
 309 void mono_gc_wbarrier_generic_nostore (void* ptr);
 310 void mono_gc_wbarrier_value_copy    (void* dest, void* src, int count, MonoClass *klass);
 311 void mono_gc_wbarrier_object_copy   (MonoObject* obj, MonoObject *src);
 312
 313 MONO_END_DECLS
 314
 315 #endif
 316