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