3 * Routines for marshaling complex types in P/Invoke methods.
6 * Paolo Molaro (lupus@ximian.com)
8 * (C) 2002 Ximian, Inc. http://www.ximian.com
12 #ifndef __MONO_MARSHAL_H__
13 #define __MONO_MARSHAL_H__
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 #include <mono/metadata/remoting.h>
22 #include <mono/utils/mono-error.h>
24 #define mono_marshal_find_bitfield_offset(type, elem, byte_offset, bitmask) \
27 memset (&tmp, 0, sizeof (tmp)); \
29 mono_marshal_find_nonzero_bit_offset ((guint8*)&tmp, sizeof (tmp), (byte_offset), (bitmask)); \
33 * This structure holds the state kept by the emit_ marshalling functions.
34 * This is exported so it can be used by cominterop.c.
37 MonoMethodBuilder
*mb
;
38 MonoMethodSignature
*sig
;
39 MonoMethodPInvoke
*piinfo
;
40 int *orig_conv_args
; /* Locals containing the original values of byref args */
43 MonoClass
*retobj_class
;
44 MonoMethodSignature
*csig
; /* Might need to be changed due to MarshalAs directives */
45 MonoImage
*image
; /* The image to use for looking up custom marshallers */
50 * This is invoked to convert arguments from the current types to
51 * the underlying types expected by the platform routine. If required,
52 * the methods create a temporary variable with the proper type, and return
53 * the location for it (either the passed argument, or the newly allocated
56 MARSHAL_ACTION_CONV_IN
,
59 * This operation is called to push the actual value that was optionally
60 * converted on the first stage
65 * Convert byref arguments back or free resources allocated during the
68 MARSHAL_ACTION_CONV_OUT
,
71 * The result from the unmanaged call is at the top of the stack when
72 * this action is invoked. The result should be stored in the
73 * third local variable slot.
75 MARSHAL_ACTION_CONV_RESULT
,
77 MARSHAL_ACTION_MANAGED_CONV_IN
,
78 MARSHAL_ACTION_MANAGED_CONV_OUT
,
79 MARSHAL_ACTION_MANAGED_CONV_RESULT
83 * This is an extension of the MONO_WRAPPER_ enum to avoid adding more elements to that
88 /* Subtypes of MONO_WRAPPER_MANAGED_TO_MANAGED */
89 WRAPPER_SUBTYPE_ELEMENT_ADDR
,
90 WRAPPER_SUBTYPE_STRING_CTOR
,
91 /* Subtypes of MONO_WRAPPER_STELEMREF */
92 WRAPPER_SUBTYPE_VIRTUAL_STELEMREF
,
93 /* Subtypes of MONO_WRAPPER_UNKNOWN */
94 WRAPPER_SUBTYPE_FAST_MONITOR_ENTER
,
95 WRAPPER_SUBTYPE_FAST_MONITOR_ENTER_V4
,
96 WRAPPER_SUBTYPE_FAST_MONITOR_EXIT
,
97 WRAPPER_SUBTYPE_PTR_TO_STRUCTURE
,
98 WRAPPER_SUBTYPE_STRUCTURE_TO_PTR
,
99 /* Subtypes of MONO_WRAPPER_CASTCLASS */
100 WRAPPER_SUBTYPE_CASTCLASS_WITH_CACHE
,
101 WRAPPER_SUBTYPE_ISINST_WITH_CACHE
,
102 /* Subtypes of MONO_WRAPPER_RUNTIME_INVOKE */
103 WRAPPER_SUBTYPE_RUNTIME_INVOKE_NORMAL
,
104 WRAPPER_SUBTYPE_RUNTIME_INVOKE_DYNAMIC
,
105 WRAPPER_SUBTYPE_RUNTIME_INVOKE_DIRECT
,
106 WRAPPER_SUBTYPE_RUNTIME_INVOKE_VIRTUAL
,
107 /* Subtypes of MONO_WRAPPER_MANAGED_TO_NATIVE */
108 WRAPPER_SUBTYPE_ICALL_WRAPPER
,
109 WRAPPER_SUBTYPE_NATIVE_FUNC_AOT
,
110 WRAPPER_SUBTYPE_PINVOKE
,
111 /* Subtypes of MONO_WRAPPER_UNKNOWN */
112 WRAPPER_SUBTYPE_SYNCHRONIZED_INNER
,
113 WRAPPER_SUBTYPE_GSHAREDVT_IN
,
114 WRAPPER_SUBTYPE_GSHAREDVT_OUT
,
115 WRAPPER_SUBTYPE_ARRAY_ACCESSOR
,
116 /* Subtypes of MONO_WRAPPER_MANAGED_TO_MANAGED */
117 WRAPPER_SUBTYPE_GENERIC_ARRAY_HELPER
,
118 /* Subtypes of MONO_WRAPPER_DELEGATE_INVOKE */
119 WRAPPER_SUBTYPE_DELEGATE_INVOKE_VIRTUAL
,
120 WRAPPER_SUBTYPE_DELEGATE_INVOKE_BOUND
,
121 /* Subtypes of MONO_WRAPPER_UNKNOWN */
122 WRAPPER_SUBTYPE_GSHAREDVT_IN_SIG
,
123 WRAPPER_SUBTYPE_GSHAREDVT_OUT_SIG
,
124 WRAPPER_SUBTYPE_INTERP_IN
130 } NativeToManagedWrapperInfo
;
134 } StringCtorWrapperInfo
;
138 } VirtualStelemrefWrapperInfo
;
141 guint32 rank
, elem_size
;
142 } ElementAddrWrapperInfo
;
146 /* For WRAPPER_SUBTYPE_RUNTIME_INVOKE_NORMAL */
147 MonoMethodSignature
*sig
;
148 } RuntimeInvokeWrapperInfo
;
152 } ManagedToNativeWrapperInfo
;
156 } SynchronizedWrapperInfo
;
160 } SynchronizedInnerWrapperInfo
;
164 } GenericArrayHelperWrapperInfo
;
172 } ArrayAccessorWrapperInfo
;
181 } AllocatorWrapperInfo
;
189 } RemotingWrapperInfo
;
192 MonoMethodSignature
*sig
;
193 } GsharedvtWrapperInfo
;
197 } DelegateInvokeWrapperInfo
;
200 MonoMethodSignature
*sig
;
201 } InterpInWrapperInfo
;
204 * This structure contains additional information to uniquely identify a given wrapper
205 * method. It can be retrieved by mono_marshal_get_wrapper_info () for certain types
206 * of wrappers, i.e. ones which do not have a 1-1 association with a method/class.
209 WrapperSubtype subtype
;
211 /* RUNTIME_INVOKE_... */
212 RuntimeInvokeWrapperInfo runtime_invoke
;
214 StringCtorWrapperInfo string_ctor
;
216 ElementAddrWrapperInfo element_addr
;
217 /* VIRTUAL_STELEMREF */
218 VirtualStelemrefWrapperInfo virtual_stelemref
;
219 /* MONO_WRAPPER_NATIVE_TO_MANAGED */
220 NativeToManagedWrapperInfo native_to_managed
;
221 /* MONO_WRAPPER_MANAGED_TO_NATIVE */
222 ManagedToNativeWrapperInfo managed_to_native
;
224 SynchronizedWrapperInfo synchronized
;
225 /* SYNCHRONIZED_INNER */
226 SynchronizedInnerWrapperInfo synchronized_inner
;
227 /* GENERIC_ARRAY_HELPER */
228 GenericArrayHelperWrapperInfo generic_array_helper
;
230 ICallWrapperInfo icall
;
232 ArrayAccessorWrapperInfo array_accessor
;
233 /* PROXY_ISINST etc. */
234 ProxyWrapperInfo proxy
;
236 AllocatorWrapperInfo alloc
;
238 UnboxWrapperInfo unbox
;
239 /* MONO_WRAPPER_REMOTING_INVOKE/MONO_WRAPPER_REMOTING_INVOKE_WITH_CHECK/MONO_WRAPPER_XDOMAIN_INVOKE */
240 RemotingWrapperInfo remoting
;
241 /* GSHAREDVT_IN_SIG/GSHAREDVT_OUT_SIG */
242 GsharedvtWrapperInfo gsharedvt
;
243 /* DELEGATE_INVOKE */
244 DelegateInvokeWrapperInfo delegate_invoke
;
246 InterpInWrapperInfo interp_in
;
252 /*type of the function pointer of methods returned by mono_marshal_get_runtime_invoke*/
253 typedef MonoObject
*(*RuntimeInvokeFunction
) (MonoObject
*this_obj
, void **params
, MonoObject
**exc
, void* compiled_method
);
255 typedef void (*RuntimeInvokeDynamicFunction
) (void *args
, MonoObject
**exc
, void* compiled_method
);
257 /* marshaling helper functions */
260 mono_marshal_init (void);
263 mono_marshal_init_tls (void);
266 mono_marshal_cleanup (void);
269 mono_class_native_size (MonoClass
*klass
, guint32
*align
);
272 mono_marshal_load_type_info (MonoClass
* klass
);
275 mono_marshal_type_size (MonoType
*type
, MonoMarshalSpec
*mspec
, guint32
*align
,
276 gboolean as_field
, gboolean unicode
);
279 mono_type_native_stack_size (MonoType
*type
, guint32
*alignment
);
282 mono_string_to_ansibstr (MonoString
*string_obj
);
285 mono_ptr_to_bstr (gpointer ptr
, int slen
);
288 mono_string_to_bstr(MonoString
* str
);
290 void mono_delegate_free_ftnptr (MonoDelegate
*delegate
);
293 mono_marshal_set_last_error (void);
296 mono_type_to_ldind (MonoType
*type
);
299 mono_type_to_stind (MonoType
*type
);
301 /* functions to create various architecture independent helper functions */
304 mono_marshal_method_from_wrapper (MonoMethod
*wrapper
);
307 mono_wrapper_info_create (MonoMethodBuilder
*mb
, WrapperSubtype subtype
);
310 mono_marshal_set_wrapper_info (MonoMethod
*method
, WrapperInfo
*info
);
313 mono_marshal_get_wrapper_info (MonoMethod
*wrapper
);
316 mono_marshal_get_delegate_begin_invoke (MonoMethod
*method
);
319 mono_marshal_get_delegate_end_invoke (MonoMethod
*method
);
322 mono_marshal_get_delegate_invoke (MonoMethod
*method
, MonoDelegate
*del
);
325 mono_marshal_get_delegate_invoke_internal (MonoMethod
*method
, gboolean callvirt
, gboolean static_method_with_first_arg_bound
, MonoMethod
*target_method
);
328 mono_marshal_get_runtime_invoke (MonoMethod
*method
, gboolean is_virtual
);
331 mono_marshal_get_runtime_invoke_dynamic (void);
334 mono_marshal_get_runtime_invoke_for_sig (MonoMethodSignature
*sig
);
337 mono_marshal_get_string_ctor_signature (MonoMethod
*method
);
340 mono_marshal_get_managed_wrapper (MonoMethod
*method
, MonoClass
*delegate_klass
, uint32_t this_loc
, MonoError
*exernal_error
);
343 mono_marshal_get_vtfixup_ftnptr (MonoImage
*image
, guint32 token
, guint16 type
);
346 mono_marshal_get_icall_wrapper (MonoMethodSignature
*sig
, const char *name
, gconstpointer func
, gboolean check_exceptions
);
349 mono_marshal_get_native_wrapper (MonoMethod
*method
, gboolean check_exceptions
, gboolean aot
);
352 mono_marshal_get_native_func_wrapper (MonoImage
*image
, MonoMethodSignature
*sig
, MonoMethodPInvoke
*piinfo
, MonoMarshalSpec
**mspecs
, gpointer func
);
355 mono_marshal_get_native_func_wrapper_aot (MonoClass
*klass
);
358 mono_marshal_get_struct_to_ptr (MonoClass
*klass
);
361 mono_marshal_get_ptr_to_struct (MonoClass
*klass
);
364 mono_marshal_get_synchronized_wrapper (MonoMethod
*method
);
367 mono_marshal_get_synchronized_inner_wrapper (MonoMethod
*method
);
370 mono_marshal_get_unbox_wrapper (MonoMethod
*method
);
373 mono_marshal_get_castclass_with_cache (void);
376 mono_marshal_get_isinst_with_cache (void);
379 mono_marshal_get_stelemref (void);
382 mono_marshal_get_virtual_stelemref (MonoClass
*array_class
);
385 mono_marshal_get_virtual_stelemref_wrappers (int *nwrappers
);
388 mono_marshal_get_array_address (int rank
, int elem_size
);
391 mono_marshal_get_array_accessor_wrapper (MonoMethod
*method
);
394 mono_marshal_get_generic_array_helper (MonoClass
*klass
, gchar
*name
, MonoMethod
*method
);
397 mono_marshal_get_thunk_invoke_wrapper (MonoMethod
*method
);
400 mono_marshal_get_gsharedvt_in_wrapper (void);
403 mono_marshal_get_gsharedvt_out_wrapper (void);
406 mono_marshal_free_dynamic_wrappers (MonoMethod
*method
);
409 mono_marshal_lock_internal (void);
412 mono_marshal_unlock_internal (void);
414 /* marshaling internal calls */
417 mono_marshal_alloc (gsize size
, MonoError
*error
);
420 mono_marshal_free (gpointer ptr
);
423 mono_marshal_free_array (gpointer
*ptr
, int size
);
426 mono_marshal_free_ccw (MonoObject
* obj
);
429 cominterop_release_all_rcws (void);
432 ves_icall_System_Runtime_InteropServices_Marshal_copy_to_unmanaged (MonoArray
*src
, gint32 start_index
,
433 gpointer dest
, gint32 length
);
436 ves_icall_System_Runtime_InteropServices_Marshal_copy_from_unmanaged (gpointer src
, gint32 start_index
,
437 MonoArray
*dest
, gint32 length
);
440 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi (char *ptr
, MonoError
*error
);
443 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi_len (char *ptr
, gint32 len
);
446 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni (guint16
*ptr
);
449 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni_len (guint16
*ptr
, gint32 len
);
452 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringBSTR (gpointer ptr
);
455 ves_icall_System_Runtime_InteropServices_Marshal_GetComSlotForMethodInfoInternal (MonoReflectionMethod
*m
);
458 ves_icall_System_Runtime_InteropServices_Marshal_GetLastWin32Error (void);
461 ves_icall_System_Runtime_InteropServices_Marshal_SizeOf (MonoReflectionTypeHandle rtype
, MonoError
*error
);
464 ves_icall_System_Runtime_InteropServices_Marshal_StructureToPtr (MonoObject
*obj
, gpointer dst
, MonoBoolean delete_old
);
467 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure (gpointer src
, MonoObject
*dst
);
470 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure_type (gpointer src
, MonoReflectionType
*type
);
473 ves_icall_System_Runtime_InteropServices_Marshal_OffsetOf (MonoReflectionTypeHandle type
, MonoStringHandle field_name
, MonoError
*error
);
476 ves_icall_System_Runtime_InteropServices_Marshal_StringToBSTR (MonoString
*string
);
479 ves_icall_System_Runtime_InteropServices_Marshal_BufferToBSTR (MonoArray
*ptr
, int len
);
482 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalAnsi (MonoString
*string
);
485 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalUni (MonoString
*string
);
488 ves_icall_System_Runtime_InteropServices_Marshal_DestroyStructure (gpointer src
, MonoReflectionType
*type
);
491 ves_icall_System_Runtime_InteropServices_Marshal_AllocCoTaskMem (int size
);
494 ves_icall_System_Runtime_InteropServices_Marshal_AllocCoTaskMemSize (gulong size
);
497 ves_icall_System_Runtime_InteropServices_Marshal_FreeCoTaskMem (void *ptr
);
500 ves_icall_System_Runtime_InteropServices_Marshal_ReAllocCoTaskMem (gpointer ptr
, int size
);
503 ves_icall_System_Runtime_InteropServices_Marshal_AllocHGlobal (gpointer size
);
506 ves_icall_System_Runtime_InteropServices_Marshal_ReAllocHGlobal (gpointer ptr
, gpointer size
);
509 ves_icall_System_Runtime_InteropServices_Marshal_FreeHGlobal (void *ptr
);
512 ves_icall_System_Runtime_InteropServices_Marshal_FreeBSTR (void *ptr
);
515 ves_icall_System_Runtime_InteropServices_Marshal_UnsafeAddrOfPinnedArrayElement (MonoArray
*arrayobj
, int index
);
518 ves_icall_System_Runtime_InteropServices_Marshal_GetDelegateForFunctionPointerInternal (void *ftn
, MonoReflectionType
*type
);
521 ves_icall_System_Runtime_InteropServices_Marshal_GetFunctionPointerForDelegateInternal (MonoDelegate
*delegate
);
524 ves_icall_System_Runtime_InteropServices_Marshal_AddRefInternal (gpointer pUnk
);
527 ves_icall_System_Runtime_InteropServices_Marshal_QueryInterfaceInternal (gpointer pUnk
, gpointer riid
, gpointer
* ppv
);
530 ves_icall_System_Runtime_InteropServices_Marshal_ReleaseInternal (gpointer pUnk
);
533 ves_icall_System_Runtime_InteropServices_Marshal_GetIUnknownForObjectInternal (MonoObject
* object
);
536 ves_icall_System_Runtime_InteropServices_Marshal_GetObjectForCCW (void* pUnk
);
539 ves_icall_System_Runtime_InteropServices_Marshal_GetIDispatchForObjectInternal (MonoObject
* object
);
542 ves_icall_System_Runtime_InteropServices_Marshal_GetCCW (MonoObject
* object
, MonoReflectionType
* type
);
545 ves_icall_System_Runtime_InteropServices_Marshal_IsComObject (MonoObject
* object
);
548 ves_icall_System_Runtime_InteropServices_Marshal_ReleaseComObjectInternal (MonoObject
* object
);
551 ves_icall_System_ComObject_CreateRCW (MonoReflectionType
*type
);
554 ves_icall_System_ComObject_ReleaseInterfaces(MonoComObject
* obj
);
557 ves_icall_System_ComObject_GetInterfaceInternal (MonoComObject
* obj
, MonoReflectionType
* type
, MonoBoolean throw_exception
);
560 ves_icall_Mono_Interop_ComInteropProxy_AddProxy (gpointer pUnk
, MonoComInteropProxy
* proxy
);
563 ves_icall_Mono_Interop_ComInteropProxy_FindProxy (gpointer pUnk
);
566 mono_win32_compat_CopyMemory (gpointer dest
, gconstpointer source
, gsize length
);
569 mono_win32_compat_FillMemory (gpointer dest
, gsize length
, guchar fill
);
572 mono_win32_compat_MoveMemory (gpointer dest
, gconstpointer source
, gsize length
);
575 mono_win32_compat_ZeroMemory (gpointer dest
, gsize length
);
578 mono_marshal_find_nonzero_bit_offset (guint8
*buf
, int len
, int *byte_offset
, guint8
*bitmask
) MONO_LLVM_INTERNAL
;
581 mono_signature_no_pinvoke (MonoMethod
*method
);
583 /* Called from cominterop.c/remoting.c */
586 mono_marshal_emit_native_wrapper (MonoImage
*image
, MonoMethodBuilder
*mb
, MonoMethodSignature
*sig
, MonoMethodPInvoke
*piinfo
, MonoMarshalSpec
**mspecs
, gpointer func
, gboolean aot
, gboolean check_exceptions
, gboolean func_param
);
589 mono_marshal_emit_managed_wrapper (MonoMethodBuilder
*mb
, MonoMethodSignature
*invoke_sig
, MonoMarshalSpec
**mspecs
, EmitMarshalContext
* m
, MonoMethod
*method
, uint32_t target_handle
);
592 mono_marshal_get_cache (GHashTable
**var
, GHashFunc hash_func
, GCompareFunc equal_func
);
595 mono_marshal_find_in_cache (GHashTable
*cache
, gpointer key
);
598 mono_mb_create_and_cache (GHashTable
*cache
, gpointer key
,
599 MonoMethodBuilder
*mb
, MonoMethodSignature
*sig
,
602 mono_marshal_emit_thread_interrupt_checkpoint (MonoMethodBuilder
*mb
);
605 mono_marshal_emit_thread_force_interrupt_checkpoint (MonoMethodBuilder
*mb
);
608 mono_marshal_use_aot_wrappers (gboolean use
);
611 mono_marshal_xdomain_copy_value (MonoObject
*val
, MonoError
*error
);
614 ves_icall_mono_marshal_xdomain_copy_value (MonoObject
*val
);
617 mono_mb_emit_save_args (MonoMethodBuilder
*mb
, MonoMethodSignature
*sig
, gboolean save_this
);
620 mono_mb_emit_restore_result (MonoMethodBuilder
*mb
, MonoType
*return_type
);
623 mono_mb_create (MonoMethodBuilder
*mb
, MonoMethodSignature
*sig
,
624 int max_stack
, WrapperInfo
*info
);
627 mono_mb_create_and_cache_full (GHashTable
*cache
, gpointer key
,
628 MonoMethodBuilder
*mb
, MonoMethodSignature
*sig
,
629 int max_stack
, WrapperInfo
*info
, gboolean
*out_found
);
631 typedef void (*MonoFtnPtrEHCallback
) (guint32 gchandle
);
634 mono_install_ftnptr_eh_callback (MonoFtnPtrEHCallback callback
);
638 #endif /* __MONO_MARSHAL_H__ */