mono/metadata/object.h

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