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