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 G_BEGIN_DECLS
  22
  23 typedef struct _MonoMethodBuilder MonoMethodBuilder;
  24
  25 /* marshaling helper functions */
  26
  27 void
  28 mono_marshal_init (void) MONO_INTERNAL;
  29
  30 void
  31 mono_marshal_cleanup (void) MONO_INTERNAL;
  32
  33 gint32
  34 mono_class_native_size (MonoClass *klass, guint32 *align) MONO_INTERNAL;
  35
  36 MonoMarshalType *
  37 mono_marshal_load_type_info (MonoClass* klass) MONO_INTERNAL;
  38
  39 gint32
  40 mono_marshal_type_size (MonoType *type, MonoMarshalSpec *mspec, guint32 *align,
  41                         gboolean as_field, gboolean unicode) MONO_INTERNAL;
  42
  43 int
  44 mono_type_native_stack_size (MonoType *type, guint32 *alignment) MONO_INTERNAL;
  45
  46 gpointer
  47 mono_array_to_savearray (MonoArray *array) MONO_INTERNAL;
  48
  49 gpointer
  50 mono_array_to_lparray (MonoArray *array) MONO_INTERNAL;
  51
  52 void
  53 mono_string_utf8_to_builder (MonoStringBuilder *sb, char *text) MONO_INTERNAL;
  54
  55 void
  56 mono_string_utf16_to_builder (MonoStringBuilder *sb, gunichar2 *text) MONO_INTERNAL;
  57
  58 gpointer
  59 mono_string_builder_to_utf8 (MonoStringBuilder *sb) MONO_INTERNAL;
  60
  61 gpointer
  62 mono_string_builder_to_utf16 (MonoStringBuilder *sb) MONO_INTERNAL;
  63
  64 gpointer
  65 mono_string_to_ansibstr (MonoString *string_obj) MONO_INTERNAL;
  66
  67 gpointer
  68 mono_string_to_bstr (MonoString *string_obj) MONO_INTERNAL;
  69
  70 void
  71 mono_string_to_byvalstr (gpointer dst, MonoString *src, int size) MONO_INTERNAL;
  72
  73 void
  74 mono_string_to_byvalwstr (gpointer dst, MonoString *src, int size) MONO_INTERNAL;
  75
  76 gpointer
  77 mono_delegate_to_ftnptr (MonoDelegate *delegate) MONO_INTERNAL;
  78
  79 MonoDelegate*
  80 mono_ftnptr_to_delegate (MonoClass *klass, gpointer ftn) MONO_INTERNAL;
  81
  82 void mono_delegate_free_ftnptr (MonoDelegate *delegate) MONO_INTERNAL;
  83
  84 void
  85 mono_marshal_set_last_error (void) MONO_INTERNAL;
  86
  87 gpointer
  88 mono_marshal_asany (MonoObject *obj, MonoMarshalNative string_encoding, int param_attrs) MONO_INTERNAL;
  89
  90 void
  91 mono_marshal_free_asany (MonoObject *o, gpointer ptr, MonoMarshalNative string_encoding, int param_attrs) MONO_INTERNAL;
  92
  93 MonoMethod*
  94 mono_marshal_get_write_barrier (void) MONO_INTERNAL;
  95
  96 /* method builder functions */
  97
  98 void
  99 mono_mb_free (MonoMethodBuilder *mb) MONO_INTERNAL;
 100
 101 MonoMethodBuilder *
 102 mono_mb_new (MonoClass *klass, const char *name, MonoWrapperType type) MONO_INTERNAL;
 103
 104 void
 105 mono_mb_patch_addr (MonoMethodBuilder *mb, int pos, int value) MONO_INTERNAL;
 106
 107 void
 108 mono_mb_patch_addr_s (MonoMethodBuilder *mb, int pos, gint8 value) MONO_INTERNAL;
 109
 110 guint32
 111 mono_mb_add_data (MonoMethodBuilder *mb, gpointer data) MONO_INTERNAL;
 112
 113 void
 114 mono_mb_emit_native_call (MonoMethodBuilder *mb, MonoMethodSignature *sig, gpointer func) MONO_INTERNAL;
 115
 116 void
 117 mono_mb_emit_managed_call (MonoMethodBuilder *mb, MonoMethod *method, MonoMethodSignature *opt_sig) MONO_INTERNAL;
 118
 119 int
 120 mono_mb_add_local (MonoMethodBuilder *mb, MonoType *type) MONO_INTERNAL;
 121
 122 MonoMethod *
 123 mono_mb_create_method (MonoMethodBuilder *mb, MonoMethodSignature *signature, int max_stack) MONO_INTERNAL;
 124
 125 void
 126 mono_mb_emit_ldarg (MonoMethodBuilder *mb, guint argnum) MONO_INTERNAL;
 127
 128 void
 129 mono_mb_emit_ldarg_addr (MonoMethodBuilder *mb, guint argnum) MONO_INTERNAL;
 130
 131 void
 132 mono_mb_emit_ldloc (MonoMethodBuilder *mb, guint num) MONO_INTERNAL;
 133
 134 void
 135 mono_mb_emit_ldloc_addr (MonoMethodBuilder *mb, guint locnum) MONO_INTERNAL;
 136
 137 void
 138 mono_mb_emit_stloc (MonoMethodBuilder *mb, guint num) MONO_INTERNAL;
 139
 140 void
 141 mono_mb_emit_exception (MonoMethodBuilder *mb, const char *exc_name, const char *msg) MONO_INTERNAL;
 142
 143 void
 144 mono_mb_emit_icon (MonoMethodBuilder *mb, gint32 value) MONO_INTERNAL;
 145
 146 guint32
 147 mono_mb_emit_branch (MonoMethodBuilder *mb, guint8 op) MONO_INTERNAL;
 148
 149 guint32
 150 mono_mb_emit_short_branch (MonoMethodBuilder *mb, guint8 op) MONO_INTERNAL;
 151
 152 void
 153 mono_mb_emit_add_to_local (MonoMethodBuilder *mb, guint16 local, gint32 incr) MONO_INTERNAL;
 154
 155 void
 156 mono_mb_emit_ldflda (MonoMethodBuilder *mb, gint32 offset) MONO_INTERNAL;
 157
 158 void
 159 mono_mb_emit_byte (MonoMethodBuilder *mb, guint8 op) MONO_INTERNAL;
 160
 161 void
 162 mono_mb_emit_i2 (MonoMethodBuilder *mb, gint16 data) MONO_INTERNAL;
 163
 164 void
 165 mono_mb_emit_i4 (MonoMethodBuilder *mb, gint32 data) MONO_INTERNAL;
 166
 167 void
 168 mono_mb_emit_ldstr (MonoMethodBuilder *mb, char *str) MONO_INTERNAL;
 169
 170 guint
 171 mono_type_to_ldind (MonoType *type) MONO_INTERNAL;
 172
 173 guint
 174 mono_type_to_stind (MonoType *type) MONO_INTERNAL;
 175
 176 /* functions to create various architecture independent helper functions */
 177
 178 MonoMethod *
 179 mono_marshal_method_from_wrapper (MonoMethod *wrapper) MONO_INTERNAL;
 180
 181 MonoMethod *
 182 mono_marshal_get_remoting_invoke (MonoMethod *method) MONO_INTERNAL;
 183
 184 MonoMethod *
 185 mono_marshal_get_xappdomain_invoke (MonoMethod *method) MONO_INTERNAL;
 186
 187 MonoMethod *
 188 mono_marshal_get_remoting_invoke_for_target (MonoMethod *method, MonoRemotingTarget target_type) MONO_INTERNAL;
 189
 190 MonoMethod *
 191 mono_marshal_get_remoting_invoke_with_check (MonoMethod *method) MONO_INTERNAL;
 192
 193 MonoMethod *
 194 mono_marshal_get_delegate_begin_invoke (MonoMethod *method) MONO_INTERNAL;
 195
 196 MonoMethod *
 197 mono_marshal_get_delegate_end_invoke (MonoMethod *method) MONO_INTERNAL;
 198
 199 MonoMethod *
 200 mono_marshal_get_delegate_invoke (MonoMethod *method) MONO_INTERNAL;
 201
 202 MonoMethod *
 203 mono_marshal_get_runtime_invoke (MonoMethod *method) MONO_INTERNAL;
 204
 205 MonoMethod *
 206 mono_marshal_get_managed_wrapper (MonoMethod *method, MonoClass *delegate_klass, MonoObject *this) MONO_INTERNAL;
 207
 208 MonoMethod *
 209 mono_marshal_get_icall_wrapper (MonoMethodSignature *sig, const char *name, gconstpointer func) MONO_INTERNAL;
 210
 211 MonoMethod *
 212 mono_marshal_get_native_wrapper (MonoMethod *method) MONO_INTERNAL;
 213
 214 MonoMethod *
 215 mono_marshal_get_native_func_wrapper (MonoImage *image, MonoMethodSignature *sig, MonoMethodPInvoke *piinfo, MonoMarshalSpec **mspecs, gpointer func) MONO_INTERNAL;
 216
 217 MonoMethod *
 218 mono_marshal_get_struct_to_ptr (MonoClass *klass) MONO_INTERNAL;
 219
 220 MonoMethod *
 221 mono_marshal_get_ptr_to_struct (MonoClass *klass) MONO_INTERNAL;
 222
 223 MonoMethod *
 224 mono_marshal_get_stfld_wrapper (MonoType *type) MONO_INTERNAL;
 225
 226 MonoMethod *
 227 mono_marshal_get_ldfld_wrapper (MonoType *type) MONO_INTERNAL;
 228
 229 MonoMethod *
 230 mono_marshal_get_ldflda_wrapper (MonoType *type) MONO_INTERNAL;
 231
 232 MonoMethod *
 233 mono_marshal_get_ldfld_remote_wrapper (MonoClass *klass) MONO_INTERNAL;
 234
 235 MonoMethod *
 236 mono_marshal_get_stfld_remote_wrapper (MonoClass *klass) MONO_INTERNAL;
 237
 238 MonoMethod *
 239 mono_marshal_get_synchronized_wrapper (MonoMethod *method) MONO_INTERNAL;
 240
 241 MonoMethod *
 242 mono_marshal_get_unbox_wrapper (MonoMethod *method) MONO_INTERNAL;
 243
 244 MonoMethod *
 245 mono_marshal_get_isinst (MonoClass *klass) MONO_INTERNAL;
 246
 247 MonoMethod *
 248 mono_marshal_get_castclass (MonoClass *klass) MONO_INTERNAL;
 249
 250 MonoMethod *
 251 mono_marshal_get_proxy_cancast (MonoClass *klass) MONO_INTERNAL;
 252
 253 MonoMethod *
 254 mono_marshal_get_stelemref (void) MONO_INTERNAL;
 255
 256 MonoMethod*
 257 mono_marshal_get_array_address (int rank, int elem_size) MONO_INTERNAL;
 258
 259 MonoMethod *
 260 mono_marshal_get_generic_array_helper (MonoClass *class, MonoClass *iface,
 261                                        gchar *name, MonoMethod *method) MONO_INTERNAL;
 262
 263 /* marshaling internal calls */
 264
 265 void *
 266 mono_marshal_alloc (gulong size) MONO_INTERNAL;
 267
 268 void
 269 mono_marshal_free (gpointer ptr) MONO_INTERNAL;
 270
 271 void
 272 mono_marshal_free_array (gpointer *ptr, int size) MONO_INTERNAL;
 273
 274 gboolean
 275 mono_marshal_free_ccw (MonoObject* obj) MONO_INTERNAL;
 276
 277 void
 278 ves_icall_System_Runtime_InteropServices_Marshal_copy_to_unmanaged (MonoArray *src, gint32 start_index,
 279                                                                     gpointer dest, gint32 length) MONO_INTERNAL;
 280
 281 void
 282 ves_icall_System_Runtime_InteropServices_Marshal_copy_from_unmanaged (gpointer src, gint32 start_index,
 283                                                                       MonoArray *dest, gint32 length) MONO_INTERNAL;
 284
 285 gpointer
 286 ves_icall_System_Runtime_InteropServices_Marshal_ReadIntPtr (gpointer ptr, gint32 offset) MONO_INTERNAL;
 287
 288 unsigned char
 289 ves_icall_System_Runtime_InteropServices_Marshal_ReadByte (gpointer ptr, gint32 offset) MONO_INTERNAL;
 290
 291 gint16
 292 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt16 (gpointer ptr, gint32 offset) MONO_INTERNAL;
 293
 294 gint32
 295 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt32 (gpointer ptr, gint32 offset) MONO_INTERNAL;
 296
 297 gint64
 298 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt64 (gpointer ptr, gint32 offset) MONO_INTERNAL;
 299
 300 void
 301 ves_icall_System_Runtime_InteropServices_Marshal_WriteByte (gpointer ptr, gint32 offset, unsigned char val) MONO_INTERNAL;
 302
 303 void
 304 ves_icall_System_Runtime_InteropServices_Marshal_WriteIntPtr (gpointer ptr, gint32 offset, gpointer val) MONO_INTERNAL;
 305
 306 void
 307 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt16 (gpointer ptr, gint32 offset, gint16 val) MONO_INTERNAL;
 308
 309 void
 310 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt32 (gpointer ptr, gint32 offset, gint32 val) MONO_INTERNAL;
 311
 312 void
 313 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt64 (gpointer ptr, gint32 offset, gint64 val) MONO_INTERNAL;
 314
 315 MonoString *
 316 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi (char *ptr) MONO_INTERNAL;
 317
 318 MonoString *
 319 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi_len (char *ptr, gint32 len) MONO_INTERNAL;
 320
 321 MonoString *
 322 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni (guint16 *ptr) MONO_INTERNAL;
 323
 324 MonoString *
 325 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni_len (guint16 *ptr, gint32 len) MONO_INTERNAL;
 326
 327 MonoString *
 328 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringBSTR (gpointer ptr) MONO_INTERNAL;
 329
 330 guint32
 331 ves_icall_System_Runtime_InteropServices_Marshal_GetComSlotForMethodInfoInternal (MonoReflectionMethod *m) MONO_INTERNAL;
 332
 333 guint32
 334 ves_icall_System_Runtime_InteropServices_Marshal_GetLastWin32Error (void) MONO_INTERNAL;
 335
 336 guint32
 337 ves_icall_System_Runtime_InteropServices_Marshal_SizeOf (MonoReflectionType *rtype) MONO_INTERNAL;
 338
 339 void
 340 ves_icall_System_Runtime_InteropServices_Marshal_StructureToPtr (MonoObject *obj, gpointer dst, MonoBoolean delete_old) MONO_INTERNAL;
 341
 342 void
 343 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure (gpointer src, MonoObject *dst) MONO_INTERNAL;
 344
 345 MonoObject *
 346 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure_type (gpointer src, MonoReflectionType *type) MONO_INTERNAL;
 347
 348 int
 349 ves_icall_System_Runtime_InteropServices_Marshal_OffsetOf (MonoReflectionType *type, MonoString *field_name) MONO_INTERNAL;
 350
 351 gpointer
 352 ves_icall_System_Runtime_InteropServices_Marshal_StringToBSTR (MonoString *string) MONO_INTERNAL;
 353
 354 gpointer
 355 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalAnsi (MonoString *string) MONO_INTERNAL;
 356
 357 gpointer
 358 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalUni (MonoString *string) MONO_INTERNAL;
 359
 360 void
 361 ves_icall_System_Runtime_InteropServices_Marshal_DestroyStructure (gpointer src, MonoReflectionType *type) MONO_INTERNAL;
 362
 363 void*
 364 ves_icall_System_Runtime_InteropServices_Marshal_AllocCoTaskMem (int size) MONO_INTERNAL;
 365
 366 void
 367 ves_icall_System_Runtime_InteropServices_Marshal_FreeCoTaskMem (void *ptr) MONO_INTERNAL;
 368
 369 gpointer
 370 ves_icall_System_Runtime_InteropServices_Marshal_ReAllocCoTaskMem (gpointer ptr, int size) MONO_INTERNAL;
 371
 372 void*
 373 ves_icall_System_Runtime_InteropServices_Marshal_AllocHGlobal (int size) MONO_INTERNAL;
 374
 375 gpointer
 376 ves_icall_System_Runtime_InteropServices_Marshal_ReAllocHGlobal (gpointer ptr, int size) MONO_INTERNAL;
 377
 378 void
 379 ves_icall_System_Runtime_InteropServices_Marshal_FreeHGlobal (void *ptr) MONO_INTERNAL;
 380
 381 void
 382 ves_icall_System_Runtime_InteropServices_Marshal_FreeBSTR (void *ptr) MONO_INTERNAL;
 383
 384 void*
 385 ves_icall_System_Runtime_InteropServices_Marshal_UnsafeAddrOfPinnedArrayElement (MonoArray *arrayobj, int index) MONO_INTERNAL;
 386
 387 MonoDelegate*
 388 ves_icall_System_Runtime_InteropServices_Marshal_GetDelegateForFunctionPointerInternal (void *ftn, MonoReflectionType *type) MONO_INTERNAL;
 389
 390 int
 391 ves_icall_System_Runtime_InteropServices_Marshal_AddRefInternal (gpointer pUnk) MONO_INTERNAL;
 392
 393 int
 394 ves_icall_System_Runtime_InteropServices_Marshal_QueryInterfaceInternal (gpointer pUnk, gpointer riid, gpointer* ppv) MONO_INTERNAL;
 395
 396 int
 397 ves_icall_System_Runtime_InteropServices_Marshal_ReleaseInternal (gpointer pUnk) MONO_INTERNAL;
 398
 399 void*
 400 ves_icall_System_Runtime_InteropServices_Marshal_GetIUnknownForObjectInternal (MonoObject* object) MONO_INTERNAL;
 401
 402 MonoObject*
 403 ves_icall_System_Runtime_InteropServices_Marshal_GetObjectForCCW (void* pUnk) MONO_INTERNAL;
 404
 405 void*
 406 ves_icall_System_Runtime_InteropServices_Marshal_GetIDispatchForObjectInternal (MonoObject* object) MONO_INTERNAL;
 407
 408 void*
 409 ves_icall_System_Runtime_InteropServices_Marshal_GetCCW (MonoObject* object, MonoReflectionType* type) MONO_INTERNAL;
 410
 411 MonoBoolean
 412 ves_icall_System_Runtime_InteropServices_Marshal_IsComObject (MonoObject* object) MONO_INTERNAL;
 413
 414 gint32
 415 ves_icall_System_Runtime_InteropServices_Marshal_ReleaseComObjectInternal (MonoObject* object) MONO_INTERNAL;
 416
 417 MonoObject *
 418 ves_icall_System_ComObject_CreateRCW (MonoReflectionType *type) MONO_INTERNAL;
 419
 420 void
 421 ves_icall_System_ComObject_ReleaseInterfaces(MonoComObject* obj) MONO_INTERNAL;
 422
 423 gpointer
 424 ves_icall_System_ComObject_GetInterfaceInternal (MonoComObject* obj, MonoReflectionType* type, MonoBoolean throw_exception) MONO_INTERNAL;
 425
 426 void
 427 ves_icall_Mono_Interop_ComInteropProxy_AddProxy (gpointer pUnk, MonoComInteropProxy* proxy) MONO_INTERNAL;
 428
 429 MonoComInteropProxy*
 430 ves_icall_Mono_Interop_ComInteropProxy_FindProxy (gpointer pUnk) MONO_INTERNAL;
 431
 432 void
 433 mono_win32_compat_CopyMemory (gpointer dest, gconstpointer source, gsize length);
 434
 435 void
 436 mono_win32_compat_FillMemory (gpointer dest, gsize length, guchar fill);
 437
 438 void
 439 mono_win32_compat_MoveMemory (gpointer dest, gconstpointer source, gsize length);
 440
 441 void
 442 mono_win32_compat_ZeroMemory (gpointer dest, gsize length);
 443
 444 G_END_DECLS
 445
 446 #endif /* __MONO_MARSHAL_H__ */
 447