mono/metadata/marshal.h

   1
   2 /*
   3  * marshal.h: Routines for marshaling complex types in P/Invoke methods.
   4  *
   5  * Author:
   6  *   Paolo Molaro (lupus@ximian.com)
   7  *
   8  * (C) 2002 Ximian, Inc.  http://www.ximian.com
   9  *
  10  */
  11
  12 #ifndef __MONO_MARSHAL_H__
  13 #define __MONO_MARSHAL_H__
  14
  15 #include <mono/metadata/class.h>
  16 #include <mono/metadata/object-internals.h>
  17 #include <mono/metadata/class-internals.h>
  18 #include <mono/metadata/opcodes.h>
  19 #include <mono/metadata/reflection.h>
  20
  21 #define mono_marshal_find_bitfield_offset(type, elem, byte_offset, bitmask) \
  22         do { \
  23                 type tmp; \
  24                 memset (&tmp, 0, sizeof (tmp)); \
  25                 tmp.elem = 1; \
  26                 mono_marshal_find_nonzero_bit_offset ((guint8*)&tmp, sizeof (tmp), (byte_offset), (bitmask)); \
  27         } while (0)
  28
  29 G_BEGIN_DECLS
  30
  31 /* marshaling helper functions */
  32
  33 void
  34 mono_marshal_init (void) MONO_INTERNAL;
  35
  36 void
  37 mono_marshal_cleanup (void) MONO_INTERNAL;
  38
  39 gint32
  40 mono_class_native_size (MonoClass *klass, guint32 *align) MONO_INTERNAL;
  41
  42 MonoMarshalType *
  43 mono_marshal_load_type_info (MonoClass* klass) MONO_INTERNAL;
  44
  45 gint32
  46 mono_marshal_type_size (MonoType *type, MonoMarshalSpec *mspec, guint32 *align,
  47                         gboolean as_field, gboolean unicode) MONO_INTERNAL;
  48
  49 int
  50 mono_type_native_stack_size (MonoType *type, guint32 *alignment) MONO_INTERNAL;
  51
  52 gpointer
  53 mono_array_to_savearray (MonoArray *array) MONO_INTERNAL;
  54
  55 gpointer
  56 mono_array_to_lparray (MonoArray *array) MONO_INTERNAL;
  57
  58 void
  59 mono_string_utf8_to_builder (MonoStringBuilder *sb, char *text) MONO_INTERNAL;
  60
  61 void
  62 mono_string_utf16_to_builder (MonoStringBuilder *sb, gunichar2 *text) MONO_INTERNAL;
  63
  64 gpointer
  65 mono_string_builder_to_utf8 (MonoStringBuilder *sb) MONO_INTERNAL;
  66
  67 gpointer
  68 mono_string_builder_to_utf16 (MonoStringBuilder *sb) MONO_INTERNAL;
  69
  70 gpointer
  71 mono_string_to_ansibstr (MonoString *string_obj) MONO_INTERNAL;
  72
  73 gpointer
  74 mono_string_to_bstr (MonoString *string_obj) MONO_INTERNAL;
  75
  76 void
  77 mono_string_to_byvalstr (gpointer dst, MonoString *src, int size) MONO_INTERNAL;
  78
  79 void
  80 mono_string_to_byvalwstr (gpointer dst, MonoString *src, int size) MONO_INTERNAL;
  81
  82 gpointer
  83 mono_delegate_to_ftnptr (MonoDelegate *delegate) MONO_INTERNAL;
  84
  85 MonoDelegate*
  86 mono_ftnptr_to_delegate (MonoClass *klass, gpointer ftn) MONO_INTERNAL;
  87
  88 void mono_delegate_free_ftnptr (MonoDelegate *delegate) MONO_INTERNAL;
  89
  90 void
  91 mono_marshal_set_last_error (void) MONO_INTERNAL;
  92
  93 gpointer
  94 mono_marshal_asany (MonoObject *obj, MonoMarshalNative string_encoding, int param_attrs) MONO_INTERNAL;
  95
  96 void
  97 mono_marshal_free_asany (MonoObject *o, gpointer ptr, MonoMarshalNative string_encoding, int param_attrs) MONO_INTERNAL;
  98
  99 MonoMethod*
 100 mono_marshal_get_write_barrier (void) MONO_INTERNAL;
 101
 102 guint
 103 mono_type_to_ldind (MonoType *type) MONO_INTERNAL;
 104
 105 guint
 106 mono_type_to_stind (MonoType *type) MONO_INTERNAL;
 107
 108 /* functions to create various architecture independent helper functions */
 109
 110 MonoMethod *
 111 mono_marshal_method_from_wrapper (MonoMethod *wrapper) MONO_INTERNAL;
 112
 113 MonoMethod *
 114 mono_marshal_get_remoting_invoke (MonoMethod *method) MONO_INTERNAL;
 115
 116 MonoMethod *
 117 mono_marshal_get_xappdomain_invoke (MonoMethod *method) MONO_INTERNAL;
 118
 119 MonoMethod *
 120 mono_marshal_get_remoting_invoke_for_target (MonoMethod *method, MonoRemotingTarget target_type) MONO_INTERNAL;
 121
 122 MonoMethod *
 123 mono_marshal_get_remoting_invoke_with_check (MonoMethod *method) MONO_INTERNAL;
 124
 125 MonoMethod *
 126 mono_marshal_get_delegate_begin_invoke (MonoMethod *method) MONO_INTERNAL;
 127
 128 MonoMethod *
 129 mono_marshal_get_delegate_end_invoke (MonoMethod *method) MONO_INTERNAL;
 130
 131 MonoMethod *
 132 mono_marshal_get_delegate_invoke (MonoMethod *method, MonoDelegate *del) MONO_INTERNAL;
 133
 134 MonoMethod *
 135 mono_marshal_get_runtime_invoke (MonoMethod *method) MONO_INTERNAL;
 136
 137 MonoMethod *
 138 mono_marshal_get_static_rgctx_invoke (MonoMethod *method) MONO_INTERNAL;
 139
 140 MonoMethod *
 141 mono_marshal_get_managed_wrapper (MonoMethod *method, MonoClass *delegate_klass, MonoObject *this) MONO_INTERNAL;
 142
 143 gpointer
 144 mono_marshal_get_vtfixup_ftnptr (MonoImage *image, guint32 token, guint16 type) MONO_INTERNAL;
 145
 146 MonoMethod *
 147 mono_marshal_get_icall_wrapper (MonoMethodSignature *sig, const char *name, gconstpointer func, gboolean check_exceptions) MONO_INTERNAL;
 148
 149 MonoMethod *
 150 mono_marshal_get_native_wrapper (MonoMethod *method, gboolean check_exceptions, gboolean aot) MONO_INTERNAL;
 151
 152 MonoMethod *
 153 mono_marshal_get_native_func_wrapper (MonoImage *image, MonoMethodSignature *sig, MonoMethodPInvoke *piinfo, MonoMarshalSpec **mspecs, gpointer func) MONO_INTERNAL;
 154
 155 MonoMethod *
 156 mono_marshal_get_struct_to_ptr (MonoClass *klass) MONO_INTERNAL;
 157
 158 MonoMethod *
 159 mono_marshal_get_ptr_to_struct (MonoClass *klass) MONO_INTERNAL;
 160
 161 MonoMethod *
 162 mono_marshal_get_stfld_wrapper (MonoType *type) MONO_INTERNAL;
 163
 164 MonoMethod *
 165 mono_marshal_get_ldfld_wrapper (MonoType *type) MONO_INTERNAL;
 166
 167 MonoMethod *
 168 mono_marshal_get_ldflda_wrapper (MonoType *type) MONO_INTERNAL;
 169
 170 MonoMethod *
 171 mono_marshal_get_ldfld_remote_wrapper (MonoClass *klass) MONO_INTERNAL;
 172
 173 MonoMethod *
 174 mono_marshal_get_stfld_remote_wrapper (MonoClass *klass) MONO_INTERNAL;
 175
 176 MonoMethod *
 177 mono_marshal_get_synchronized_wrapper (MonoMethod *method) MONO_INTERNAL;
 178
 179 MonoMethod *
 180 mono_marshal_get_unbox_wrapper (MonoMethod *method) MONO_INTERNAL;
 181
 182 MonoMethod *
 183 mono_marshal_get_isinst (MonoClass *klass) MONO_INTERNAL;
 184
 185 MonoMethod *
 186 mono_marshal_get_castclass (MonoClass *klass) MONO_INTERNAL;
 187
 188 MonoMethod *
 189 mono_marshal_get_proxy_cancast (MonoClass *klass) MONO_INTERNAL;
 190
 191 MonoMethod *
 192 mono_marshal_get_stelemref (void) MONO_INTERNAL;
 193
 194 MonoMethod*
 195 mono_marshal_get_array_address (int rank, int elem_size) MONO_INTERNAL;
 196
 197 MonoMethod *
 198 mono_marshal_get_generic_array_helper (MonoClass *class, MonoClass *iface,
 199                                        gchar *name, MonoMethod *method) MONO_INTERNAL;
 200
 201 MonoMethod *
 202 mono_marshal_get_thunk_invoke_wrapper (MonoMethod *method) MONO_INTERNAL;
 203
 204 /* marshaling internal calls */
 205
 206 void *
 207 mono_marshal_alloc (gulong size) MONO_INTERNAL;
 208
 209 void
 210 mono_marshal_free (gpointer ptr) MONO_INTERNAL;
 211
 212 void
 213 mono_marshal_free_array (gpointer *ptr, int size) MONO_INTERNAL;
 214
 215 gboolean
 216 mono_marshal_free_ccw (MonoObject* obj) MONO_INTERNAL;
 217
 218 void
 219 ves_icall_System_Runtime_InteropServices_Marshal_copy_to_unmanaged (MonoArray *src, gint32 start_index,
 220                                                                     gpointer dest, gint32 length) MONO_INTERNAL;
 221
 222 void
 223 ves_icall_System_Runtime_InteropServices_Marshal_copy_from_unmanaged (gpointer src, gint32 start_index,
 224                                                                       MonoArray *dest, gint32 length) MONO_INTERNAL;
 225
 226 gpointer
 227 ves_icall_System_Runtime_InteropServices_Marshal_ReadIntPtr (gpointer ptr, gint32 offset) MONO_INTERNAL;
 228
 229 unsigned char
 230 ves_icall_System_Runtime_InteropServices_Marshal_ReadByte (gpointer ptr, gint32 offset) MONO_INTERNAL;
 231
 232 gint16
 233 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt16 (gpointer ptr, gint32 offset) MONO_INTERNAL;
 234
 235 gint32
 236 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt32 (gpointer ptr, gint32 offset) MONO_INTERNAL;
 237
 238 gint64
 239 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt64 (gpointer ptr, gint32 offset) MONO_INTERNAL;
 240
 241 void
 242 ves_icall_System_Runtime_InteropServices_Marshal_WriteByte (gpointer ptr, gint32 offset, unsigned char val) MONO_INTERNAL;
 243
 244 void
 245 ves_icall_System_Runtime_InteropServices_Marshal_WriteIntPtr (gpointer ptr, gint32 offset, gpointer val) MONO_INTERNAL;
 246
 247 void
 248 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt16 (gpointer ptr, gint32 offset, gint16 val) MONO_INTERNAL;
 249
 250 void
 251 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt32 (gpointer ptr, gint32 offset, gint32 val) MONO_INTERNAL;
 252
 253 void
 254 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt64 (gpointer ptr, gint32 offset, gint64 val) MONO_INTERNAL;
 255
 256 MonoString *
 257 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi (char *ptr) MONO_INTERNAL;
 258
 259 MonoString *
 260 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi_len (char *ptr, gint32 len) MONO_INTERNAL;
 261
 262 MonoString *
 263 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni (guint16 *ptr) MONO_INTERNAL;
 264
 265 MonoString *
 266 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni_len (guint16 *ptr, gint32 len) MONO_INTERNAL;
 267
 268 MonoString *
 269 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringBSTR (gpointer ptr) MONO_INTERNAL;
 270
 271 guint32
 272 ves_icall_System_Runtime_InteropServices_Marshal_GetComSlotForMethodInfoInternal (MonoReflectionMethod *m) MONO_INTERNAL;
 273
 274 guint32
 275 ves_icall_System_Runtime_InteropServices_Marshal_GetLastWin32Error (void) MONO_INTERNAL;
 276
 277 guint32
 278 ves_icall_System_Runtime_InteropServices_Marshal_SizeOf (MonoReflectionType *rtype) MONO_INTERNAL;
 279
 280 void
 281 ves_icall_System_Runtime_InteropServices_Marshal_StructureToPtr (MonoObject *obj, gpointer dst, MonoBoolean delete_old) MONO_INTERNAL;
 282
 283 void
 284 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure (gpointer src, MonoObject *dst) MONO_INTERNAL;
 285
 286 MonoObject *
 287 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure_type (gpointer src, MonoReflectionType *type) MONO_INTERNAL;
 288
 289 int
 290 ves_icall_System_Runtime_InteropServices_Marshal_OffsetOf (MonoReflectionType *type, MonoString *field_name) MONO_INTERNAL;
 291
 292 gpointer
 293 ves_icall_System_Runtime_InteropServices_Marshal_StringToBSTR (MonoString *string) MONO_INTERNAL;
 294
 295 gpointer
 296 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalAnsi (MonoString *string) MONO_INTERNAL;
 297
 298 gpointer
 299 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalUni (MonoString *string) MONO_INTERNAL;
 300
 301 void
 302 ves_icall_System_Runtime_InteropServices_Marshal_DestroyStructure (gpointer src, MonoReflectionType *type) MONO_INTERNAL;
 303
 304 void*
 305 ves_icall_System_Runtime_InteropServices_Marshal_AllocCoTaskMem (int size) MONO_INTERNAL;
 306
 307 void
 308 ves_icall_System_Runtime_InteropServices_Marshal_FreeCoTaskMem (void *ptr) MONO_INTERNAL;
 309
 310 gpointer
 311 ves_icall_System_Runtime_InteropServices_Marshal_ReAllocCoTaskMem (gpointer ptr, int size) MONO_INTERNAL;
 312
 313 void*
 314 ves_icall_System_Runtime_InteropServices_Marshal_AllocHGlobal (int size) MONO_INTERNAL;
 315
 316 gpointer
 317 ves_icall_System_Runtime_InteropServices_Marshal_ReAllocHGlobal (gpointer ptr, int size) MONO_INTERNAL;
 318
 319 void
 320 ves_icall_System_Runtime_InteropServices_Marshal_FreeHGlobal (void *ptr) MONO_INTERNAL;
 321
 322 void
 323 ves_icall_System_Runtime_InteropServices_Marshal_FreeBSTR (void *ptr) MONO_INTERNAL;
 324
 325 void*
 326 ves_icall_System_Runtime_InteropServices_Marshal_UnsafeAddrOfPinnedArrayElement (MonoArray *arrayobj, int index) MONO_INTERNAL;
 327
 328 MonoDelegate*
 329 ves_icall_System_Runtime_InteropServices_Marshal_GetDelegateForFunctionPointerInternal (void *ftn, MonoReflectionType *type) MONO_INTERNAL;
 330
 331 int
 332 ves_icall_System_Runtime_InteropServices_Marshal_AddRefInternal (gpointer pUnk) MONO_INTERNAL;
 333
 334 int
 335 ves_icall_System_Runtime_InteropServices_Marshal_QueryInterfaceInternal (gpointer pUnk, gpointer riid, gpointer* ppv) MONO_INTERNAL;
 336
 337 int
 338 ves_icall_System_Runtime_InteropServices_Marshal_ReleaseInternal (gpointer pUnk) MONO_INTERNAL;
 339
 340 void*
 341 ves_icall_System_Runtime_InteropServices_Marshal_GetIUnknownForObjectInternal (MonoObject* object) MONO_INTERNAL;
 342
 343 MonoObject*
 344 ves_icall_System_Runtime_InteropServices_Marshal_GetObjectForCCW (void* pUnk) MONO_INTERNAL;
 345
 346 void*
 347 ves_icall_System_Runtime_InteropServices_Marshal_GetIDispatchForObjectInternal (MonoObject* object) MONO_INTERNAL;
 348
 349 void*
 350 ves_icall_System_Runtime_InteropServices_Marshal_GetCCW (MonoObject* object, MonoReflectionType* type) MONO_INTERNAL;
 351
 352 MonoBoolean
 353 ves_icall_System_Runtime_InteropServices_Marshal_IsComObject (MonoObject* object) MONO_INTERNAL;
 354
 355 gint32
 356 ves_icall_System_Runtime_InteropServices_Marshal_ReleaseComObjectInternal (MonoObject* object) MONO_INTERNAL;
 357
 358 MonoObject *
 359 ves_icall_System_ComObject_CreateRCW (MonoReflectionType *type) MONO_INTERNAL;
 360
 361 void
 362 ves_icall_System_ComObject_ReleaseInterfaces(MonoComObject* obj) MONO_INTERNAL;
 363
 364 gpointer
 365 ves_icall_System_ComObject_GetInterfaceInternal (MonoComObject* obj, MonoReflectionType* type, MonoBoolean throw_exception) MONO_INTERNAL;
 366
 367 void
 368 ves_icall_Mono_Interop_ComInteropProxy_AddProxy (gpointer pUnk, MonoComInteropProxy* proxy) MONO_INTERNAL;
 369
 370 MonoComInteropProxy*
 371 ves_icall_Mono_Interop_ComInteropProxy_FindProxy (gpointer pUnk) MONO_INTERNAL;
 372
 373 void
 374 mono_win32_compat_CopyMemory (gpointer dest, gconstpointer source, gsize length);
 375
 376 void
 377 mono_win32_compat_FillMemory (gpointer dest, gsize length, guchar fill);
 378
 379 void
 380 mono_win32_compat_MoveMemory (gpointer dest, gconstpointer source, gsize length);
 381
 382 void
 383 mono_win32_compat_ZeroMemory (gpointer dest, gsize length);
 384
 385 void
 386 mono_marshal_find_nonzero_bit_offset (guint8 *buf, int len, int *byte_offset, guint8 *bitmask) MONO_INTERNAL;
 387
 388 G_END_DECLS
 389
 390 #endif /* __MONO_MARSHAL_H__ */
 391