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