object.h 15 KB

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