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 #include <mono/metadata/method-builder.h>
  21
  22 #define mono_marshal_find_bitfield_offset(type, elem, byte_offset, bitmask) \
  23         do { \
  24                 type tmp; \
  25                 memset (&tmp, 0, sizeof (tmp)); \
  26                 tmp.elem = 1; \
  27                 mono_marshal_find_nonzero_bit_offset ((guint8*)&tmp, sizeof (tmp), (byte_offset), (bitmask)); \
  28         } while (0)
  29
  30 /*
  31  * This structure holds the state kept by the emit_ marshalling functions.
  32  * This is exported so it can be used by cominterop.c.
  33  */
  34 typedef struct {
  35         MonoMethodBuilder *mb;
  36         MonoMethodSignature *sig;
  37         MonoMethodPInvoke *piinfo;
  38         int *orig_conv_args; /* Locals containing the original values of byref args */
  39         int retobj_var;
  40         MonoClass *retobj_class;
  41         MonoMethodSignature *csig; /* Might need to be changed due to MarshalAs directives */
  42         MonoImage *image; /* The image to use for looking up custom marshallers */
  43 } EmitMarshalContext;
  44
  45 typedef enum {
  46         /*
  47          * This is invoked to convert arguments from the current types to
  48          * the underlying types expected by the platform routine.  If required,
  49          * the methods create a temporary variable with the proper type, and return
  50          * the location for it (either the passed argument, or the newly allocated
  51          * local slot).
  52          */
  53         MARSHAL_ACTION_CONV_IN,
  54
  55         /*
  56          * This operation is called to push the actual value that was optionally
  57          * converted on the first stage
  58          */
  59         MARSHAL_ACTION_PUSH,
  60
  61         /*
  62          * Convert byref arguments back or free resources allocated during the
  63          * CONV_IN stage
  64          */
  65         MARSHAL_ACTION_CONV_OUT,
  66
  67         /*
  68          * The result from the unmanaged call is at the top of the stack when
  69          * this action is invoked.    The result should be stored in the
  70          * third local variable slot.
  71          */
  72         MARSHAL_ACTION_CONV_RESULT,
  73
  74         MARSHAL_ACTION_MANAGED_CONV_IN,
  75         MARSHAL_ACTION_MANAGED_CONV_OUT,
  76         MARSHAL_ACTION_MANAGED_CONV_RESULT
  77 } MarshalAction;
  78
  79 typedef struct {
  80         guint32 rank, elem_size;
  81 } ElementAddrWrapperInfo;
  82
  83 G_BEGIN_DECLS
  84
  85 /*type of the function pointer of methods returned by mono_marshal_get_runtime_invoke*/
  86 typedef MonoObject *(*RuntimeInvokeFunction) (MonoObject *this, void **params, MonoObject **exc, void* compiled_method);
  87
  88 typedef void (*RuntimeInvokeDynamicFunction) (void *args, MonoObject **exc, void* compiled_method);
  89
  90 /* marshaling helper functions */
  91
  92 void
  93 mono_marshal_init (void) MONO_INTERNAL;
  94
  95 void
  96 mono_marshal_cleanup (void) MONO_INTERNAL;
  97
  98 gint32
  99 mono_class_native_size (MonoClass *klass, guint32 *align) MONO_INTERNAL;
 100
 101 MonoMarshalType *
 102 mono_marshal_load_type_info (MonoClass* klass) MONO_INTERNAL;
 103
 104 gint32
 105 mono_marshal_type_size (MonoType *type, MonoMarshalSpec *mspec, guint32 *align,
 106                         gboolean as_field, gboolean unicode) MONO_INTERNAL;
 107
 108 int
 109 mono_type_native_stack_size (MonoType *type, guint32 *alignment) MONO_INTERNAL;
 110
 111 gpointer
 112 mono_array_to_savearray (MonoArray *array) MONO_INTERNAL;
 113
 114 gpointer
 115 mono_array_to_lparray (MonoArray *array) MONO_INTERNAL;
 116
 117 void
 118 mono_free_lparray (MonoArray *array, gpointer* nativeArray) MONO_INTERNAL;
 119
 120 void
 121 mono_string_utf8_to_builder (MonoStringBuilder *sb, char *text) MONO_INTERNAL;
 122
 123 void
 124 mono_string_utf16_to_builder (MonoStringBuilder *sb, gunichar2 *text) MONO_INTERNAL;
 125
 126 gpointer
 127 mono_string_builder_to_utf8 (MonoStringBuilder *sb) MONO_INTERNAL;
 128
 129 gpointer
 130 mono_string_builder_to_utf16 (MonoStringBuilder *sb) MONO_INTERNAL;
 131
 132 gpointer
 133 mono_string_to_ansibstr (MonoString *string_obj) MONO_INTERNAL;
 134
 135 gpointer
 136 mono_string_to_bstr (MonoString *string_obj) MONO_INTERNAL;
 137
 138 void
 139 mono_string_to_byvalstr (gpointer dst, MonoString *src, int size) MONO_INTERNAL;
 140
 141 void
 142 mono_string_to_byvalwstr (gpointer dst, MonoString *src, int size) MONO_INTERNAL;
 143
 144 gpointer
 145 mono_delegate_to_ftnptr (MonoDelegate *delegate) MONO_INTERNAL;
 146
 147 MonoDelegate*
 148 mono_ftnptr_to_delegate (MonoClass *klass, gpointer ftn) MONO_INTERNAL;
 149
 150 void mono_delegate_free_ftnptr (MonoDelegate *delegate) MONO_INTERNAL;
 151
 152 void
 153 mono_marshal_set_last_error (void) MONO_INTERNAL;
 154
 155 gpointer
 156 mono_marshal_asany (MonoObject *obj, MonoMarshalNative string_encoding, int param_attrs) MONO_INTERNAL;
 157
 158 void
 159 mono_marshal_free_asany (MonoObject *o, gpointer ptr, MonoMarshalNative string_encoding, int param_attrs) MONO_INTERNAL;
 160
 161 guint
 162 mono_type_to_ldind (MonoType *type) MONO_INTERNAL;
 163
 164 guint
 165 mono_type_to_stind (MonoType *type) MONO_INTERNAL;
 166
 167 /* functions to create various architecture independent helper functions */
 168
 169 MonoMethod *
 170 mono_marshal_method_from_wrapper (MonoMethod *wrapper) MONO_INTERNAL;
 171
 172 void
 173 mono_marshal_set_wrapper_info (MonoMethod *method, gpointer data) MONO_INTERNAL;
 174
 175 gpointer
 176 mono_marshal_get_wrapper_info (MonoMethod *wrapper) MONO_INTERNAL;
 177
 178 MonoMethod *
 179 mono_marshal_get_remoting_invoke (MonoMethod *method) MONO_INTERNAL;
 180
 181 MonoMethod *
 182 mono_marshal_get_xappdomain_invoke (MonoMethod *method) MONO_INTERNAL;
 183
 184 MonoMethod *
 185 mono_marshal_get_remoting_invoke_for_target (MonoMethod *method, MonoRemotingTarget target_type) MONO_INTERNAL;
 186
 187 MonoMethod *
 188 mono_marshal_get_remoting_invoke_with_check (MonoMethod *method) MONO_INTERNAL;
 189
 190 MonoMethod *
 191 mono_marshal_get_delegate_begin_invoke (MonoMethod *method) MONO_INTERNAL;
 192
 193 MonoMethod *
 194 mono_marshal_get_delegate_end_invoke (MonoMethod *method) MONO_INTERNAL;
 195
 196 MonoMethod *
 197 mono_marshal_get_delegate_invoke (MonoMethod *method, MonoDelegate *del) MONO_INTERNAL;
 198
 199 MonoMethod *
 200 mono_marshal_get_runtime_invoke (MonoMethod *method, gboolean virtual) MONO_INTERNAL;
 201
 202 MonoMethod*
 203 mono_marshal_get_runtime_invoke_dynamic (void) MONO_INTERNAL;
 204
 205 MonoMethodSignature*
 206 mono_marshal_get_string_ctor_signature (MonoMethod *method) MONO_INTERNAL;
 207
 208 MonoMethod *
 209 mono_marshal_get_managed_wrapper (MonoMethod *method, MonoClass *delegate_klass, uint32_t this_loc) MONO_INTERNAL;
 210
 211 gpointer
 212 mono_marshal_get_vtfixup_ftnptr (MonoImage *image, guint32 token, guint16 type) MONO_INTERNAL;
 213
 214 MonoMethod *
 215 mono_marshal_get_icall_wrapper (MonoMethodSignature *sig, const char *name, gconstpointer func, gboolean check_exceptions) MONO_INTERNAL;
 216
 217 MonoMethod *
 218 mono_marshal_get_native_wrapper (MonoMethod *method, gboolean check_exceptions, gboolean aot) MONO_INTERNAL;
 219
 220 MonoMethod *
 221 mono_marshal_get_native_func_wrapper (MonoImage *image, MonoMethodSignature *sig, MonoMethodPInvoke *piinfo, MonoMarshalSpec **mspecs, gpointer func) MONO_INTERNAL;
 222
 223 MonoMethod *
 224 mono_marshal_get_struct_to_ptr (MonoClass *klass) MONO_INTERNAL;
 225
 226 MonoMethod *
 227 mono_marshal_get_ptr_to_struct (MonoClass *klass) MONO_INTERNAL;
 228
 229 MonoMethod *
 230 mono_marshal_get_stfld_wrapper (MonoType *type) MONO_INTERNAL;
 231
 232 MonoMethod *
 233 mono_marshal_get_ldfld_wrapper (MonoType *type) MONO_INTERNAL;
 234
 235 MonoMethod *
 236 mono_marshal_get_ldflda_wrapper (MonoType *type) MONO_INTERNAL;
 237
 238 MonoMethod *
 239 mono_marshal_get_ldfld_remote_wrapper (MonoClass *klass) MONO_INTERNAL;
 240
 241 MonoMethod *
 242 mono_marshal_get_stfld_remote_wrapper (MonoClass *klass) MONO_INTERNAL;
 243
 244 MonoMethod *
 245 mono_marshal_get_synchronized_wrapper (MonoMethod *method) MONO_INTERNAL;
 246
 247 MonoMethod *
 248 mono_marshal_get_unbox_wrapper (MonoMethod *method) MONO_INTERNAL;
 249
 250 MonoMethod *
 251 mono_marshal_get_isinst (MonoClass *klass) MONO_INTERNAL;
 252
 253 MonoMethod *
 254 mono_marshal_get_castclass (MonoClass *klass) MONO_INTERNAL;
 255
 256 MonoMethod *
 257 mono_marshal_get_proxy_cancast (MonoClass *klass) MONO_INTERNAL;
 258
 259 MonoMethod *
 260 mono_marshal_get_stelemref (void) MONO_INTERNAL;
 261
 262 MonoMethod*
 263 mono_marshal_get_array_address (int rank, int elem_size) MONO_INTERNAL;
 264
 265 MonoMethod *
 266 mono_marshal_get_generic_array_helper (MonoClass *class, MonoClass *iface,
 267                                        gchar *name, MonoMethod *method) MONO_INTERNAL;
 268
 269 MonoMethod *
 270 mono_marshal_get_thunk_invoke_wrapper (MonoMethod *method) MONO_INTERNAL;
 271
 272 void
 273 mono_marshal_free_dynamic_wrappers (MonoMethod *method) MONO_INTERNAL;
 274
 275 void
 276 mono_marshal_free_inflated_wrappers (MonoMethod *method) MONO_INTERNAL;
 277
 278 /* marshaling internal calls */
 279
 280 void *
 281 mono_marshal_alloc (gulong size) MONO_INTERNAL;
 282
 283 void
 284 mono_marshal_free (gpointer ptr) MONO_INTERNAL;
 285
 286 void
 287 mono_marshal_free_array (gpointer *ptr, int size) MONO_INTERNAL;
 288
 289 gboolean
 290 mono_marshal_free_ccw (MonoObject* obj) MONO_INTERNAL;
 291
 292 MonoObject *
 293 mono_marshal_xdomain_copy_value (MonoObject *val) MONO_INTERNAL;
 294
 295 void
 296 cominterop_release_all_rcws (void) MONO_INTERNAL;
 297
 298 void
 299 ves_icall_System_Runtime_InteropServices_Marshal_copy_to_unmanaged (MonoArray *src, gint32 start_index,
 300                                                                     gpointer dest, gint32 length) MONO_INTERNAL;
 301
 302 void
 303 ves_icall_System_Runtime_InteropServices_Marshal_copy_from_unmanaged (gpointer src, gint32 start_index,
 304                                                                       MonoArray *dest, gint32 length) MONO_INTERNAL;
 305
 306 gpointer
 307 ves_icall_System_Runtime_InteropServices_Marshal_ReadIntPtr (gpointer ptr, gint32 offset) MONO_INTERNAL;
 308
 309 unsigned char
 310 ves_icall_System_Runtime_InteropServices_Marshal_ReadByte (gpointer ptr, gint32 offset) MONO_INTERNAL;
 311
 312 gint16
 313 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt16 (gpointer ptr, gint32 offset) MONO_INTERNAL;
 314
 315 gint32
 316 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt32 (gpointer ptr, gint32 offset) MONO_INTERNAL;
 317
 318 gint64
 319 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt64 (gpointer ptr, gint32 offset) MONO_INTERNAL;
 320
 321 void
 322 ves_icall_System_Runtime_InteropServices_Marshal_WriteByte (gpointer ptr, gint32 offset, unsigned char val) MONO_INTERNAL;
 323
 324 void
 325 ves_icall_System_Runtime_InteropServices_Marshal_WriteIntPtr (gpointer ptr, gint32 offset, gpointer val) MONO_INTERNAL;
 326
 327 void
 328 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt16 (gpointer ptr, gint32 offset, gint16 val) MONO_INTERNAL;
 329
 330 void
 331 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt32 (gpointer ptr, gint32 offset, gint32 val) MONO_INTERNAL;
 332
 333 void
 334 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt64 (gpointer ptr, gint32 offset, gint64 val) MONO_INTERNAL;
 335
 336 MonoString *
 337 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi (char *ptr) MONO_INTERNAL;
 338
 339 MonoString *
 340 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi_len (char *ptr, gint32 len) MONO_INTERNAL;
 341
 342 MonoString *
 343 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni (guint16 *ptr) MONO_INTERNAL;
 344
 345 MonoString *
 346 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni_len (guint16 *ptr, gint32 len) MONO_INTERNAL;
 347
 348 MonoString *
 349 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringBSTR (gpointer ptr) MONO_INTERNAL;
 350
 351 guint32
 352 ves_icall_System_Runtime_InteropServices_Marshal_GetComSlotForMethodInfoInternal (MonoReflectionMethod *m) MONO_INTERNAL;
 353
 354 guint32
 355 ves_icall_System_Runtime_InteropServices_Marshal_GetLastWin32Error (void) MONO_INTERNAL;
 356
 357 guint32
 358 ves_icall_System_Runtime_InteropServices_Marshal_SizeOf (MonoReflectionType *rtype) MONO_INTERNAL;
 359
 360 void
 361 ves_icall_System_Runtime_InteropServices_Marshal_StructureToPtr (MonoObject *obj, gpointer dst, MonoBoolean delete_old) MONO_INTERNAL;
 362
 363 void
 364 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure (gpointer src, MonoObject *dst) MONO_INTERNAL;
 365
 366 MonoObject *
 367 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure_type (gpointer src, MonoReflectionType *type) MONO_INTERNAL;
 368
 369 int
 370 ves_icall_System_Runtime_InteropServices_Marshal_OffsetOf (MonoReflectionType *type, MonoString *field_name) MONO_INTERNAL;
 371
 372 gpointer
 373 ves_icall_System_Runtime_InteropServices_Marshal_StringToBSTR (MonoString *string) MONO_INTERNAL;
 374
 375 gpointer
 376 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalAnsi (MonoString *string) MONO_INTERNAL;
 377
 378 gpointer
 379 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalUni (MonoString *string) MONO_INTERNAL;
 380
 381 void
 382 ves_icall_System_Runtime_InteropServices_Marshal_DestroyStructure (gpointer src, MonoReflectionType *type) MONO_INTERNAL;
 383
 384 void*
 385 ves_icall_System_Runtime_InteropServices_Marshal_AllocCoTaskMem (int size) MONO_INTERNAL;
 386
 387 void
 388 ves_icall_System_Runtime_InteropServices_Marshal_FreeCoTaskMem (void *ptr) MONO_INTERNAL;
 389
 390 gpointer
 391 ves_icall_System_Runtime_InteropServices_Marshal_ReAllocCoTaskMem (gpointer ptr, int size) MONO_INTERNAL;
 392
 393 void*
 394 ves_icall_System_Runtime_InteropServices_Marshal_AllocHGlobal (int size) MONO_INTERNAL;
 395
 396 gpointer
 397 ves_icall_System_Runtime_InteropServices_Marshal_ReAllocHGlobal (gpointer ptr, int size) MONO_INTERNAL;
 398
 399 void
 400 ves_icall_System_Runtime_InteropServices_Marshal_FreeHGlobal (void *ptr) MONO_INTERNAL;
 401
 402 void
 403 ves_icall_System_Runtime_InteropServices_Marshal_FreeBSTR (void *ptr) MONO_INTERNAL;
 404
 405 void*
 406 ves_icall_System_Runtime_InteropServices_Marshal_UnsafeAddrOfPinnedArrayElement (MonoArray *arrayobj, int index) MONO_INTERNAL;
 407
 408 MonoDelegate*
 409 ves_icall_System_Runtime_InteropServices_Marshal_GetDelegateForFunctionPointerInternal (void *ftn, MonoReflectionType *type) MONO_INTERNAL;
 410
 411 int
 412 ves_icall_System_Runtime_InteropServices_Marshal_AddRefInternal (gpointer pUnk) MONO_INTERNAL;
 413
 414 int
 415 ves_icall_System_Runtime_InteropServices_Marshal_QueryInterfaceInternal (gpointer pUnk, gpointer riid, gpointer* ppv) MONO_INTERNAL;
 416
 417 int
 418 ves_icall_System_Runtime_InteropServices_Marshal_ReleaseInternal (gpointer pUnk) MONO_INTERNAL;
 419
 420 void*
 421 ves_icall_System_Runtime_InteropServices_Marshal_GetIUnknownForObjectInternal (MonoObject* object) MONO_INTERNAL;
 422
 423 MonoObject*
 424 ves_icall_System_Runtime_InteropServices_Marshal_GetObjectForCCW (void* pUnk) MONO_INTERNAL;
 425
 426 void*
 427 ves_icall_System_Runtime_InteropServices_Marshal_GetIDispatchForObjectInternal (MonoObject* object) MONO_INTERNAL;
 428
 429 void*
 430 ves_icall_System_Runtime_InteropServices_Marshal_GetCCW (MonoObject* object, MonoReflectionType* type) MONO_INTERNAL;
 431
 432 MonoBoolean
 433 ves_icall_System_Runtime_InteropServices_Marshal_IsComObject (MonoObject* object) MONO_INTERNAL;
 434
 435 gint32
 436 ves_icall_System_Runtime_InteropServices_Marshal_ReleaseComObjectInternal (MonoObject* object) MONO_INTERNAL;
 437
 438 MonoObject *
 439 ves_icall_System_ComObject_CreateRCW (MonoReflectionType *type) MONO_INTERNAL;
 440
 441 void
 442 ves_icall_System_ComObject_ReleaseInterfaces(MonoComObject* obj) MONO_INTERNAL;
 443
 444 gpointer
 445 ves_icall_System_ComObject_GetInterfaceInternal (MonoComObject* obj, MonoReflectionType* type, MonoBoolean throw_exception) MONO_INTERNAL;
 446
 447 void
 448 ves_icall_Mono_Interop_ComInteropProxy_AddProxy (gpointer pUnk, MonoComInteropProxy* proxy) MONO_INTERNAL;
 449
 450 MonoComInteropProxy*
 451 ves_icall_Mono_Interop_ComInteropProxy_FindProxy (gpointer pUnk) MONO_INTERNAL;
 452
 453 void
 454 mono_win32_compat_CopyMemory (gpointer dest, gconstpointer source, gsize length);
 455
 456 void
 457 mono_win32_compat_FillMemory (gpointer dest, gsize length, guchar fill);
 458
 459 void
 460 mono_win32_compat_MoveMemory (gpointer dest, gconstpointer source, gsize length);
 461
 462 void
 463 mono_win32_compat_ZeroMemory (gpointer dest, gsize length);
 464
 465 void
 466 mono_marshal_find_nonzero_bit_offset (guint8 *buf, int len, int *byte_offset, guint8 *bitmask) MONO_INTERNAL;
 467
 468 MonoMethodSignature*
 469 mono_signature_no_pinvoke (MonoMethod *method) MONO_INTERNAL;
 470
 471 /* Called from cominterop.c */
 472
 473 void
 474 mono_marshal_emit_native_wrapper (MonoImage *image, MonoMethodBuilder *mb, MonoMethodSignature *sig, MonoMethodPInvoke *piinfo, MonoMarshalSpec **mspecs, gpointer func, gboolean aot, gboolean check_exceptions) MONO_INTERNAL;
 475
 476 void
 477 mono_marshal_emit_managed_wrapper (MonoMethodBuilder *mb, MonoMethodSignature *invoke_sig, MonoMarshalSpec **mspecs, EmitMarshalContext* m, MonoMethod *method, uint32_t target_handle) MONO_INTERNAL;
 478
 479 GHashTable*
 480 mono_marshal_get_cache (GHashTable **var, GHashFunc hash_func, GCompareFunc equal_func) MONO_INTERNAL;
 481
 482 MonoMethod*
 483 mono_marshal_find_in_cache (GHashTable *cache, gpointer key) MONO_INTERNAL;
 484
 485 MonoMethod*
 486 mono_mb_create_and_cache (GHashTable *cache, gpointer key,
 487                                                   MonoMethodBuilder *mb, MonoMethodSignature *sig,
 488                                                   int max_stack) MONO_INTERNAL;
 489 void
 490 mono_marshal_emit_thread_interrupt_checkpoint (MonoMethodBuilder *mb) MONO_INTERNAL;
 491
 492 G_END_DECLS
 493
 494 #endif /* __MONO_MARSHAL_H__ */
 495
 496