3 * marshal.h: 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 */
42 MonoClass *retobj_class;
43 MonoMethodSignature *csig; /* Might need to be changed due to MarshalAs directives */
44 MonoImage *image; /* The image to use for looking up custom marshallers */
49 * This is invoked to convert arguments from the current types to
50 * the underlying types expected by the platform routine. If required,
51 * the methods create a temporary variable with the proper type, and return
52 * the location for it (either the passed argument, or the newly allocated
55 MARSHAL_ACTION_CONV_IN,
58 * This operation is called to push the actual value that was optionally
59 * converted on the first stage
64 * Convert byref arguments back or free resources allocated during the
67 MARSHAL_ACTION_CONV_OUT,
70 * The result from the unmanaged call is at the top of the stack when
71 * this action is invoked. The result should be stored in the
72 * third local variable slot.
74 MARSHAL_ACTION_CONV_RESULT,
76 MARSHAL_ACTION_MANAGED_CONV_IN,
77 MARSHAL_ACTION_MANAGED_CONV_OUT,
78 MARSHAL_ACTION_MANAGED_CONV_RESULT
82 * This is an extension of the MONO_WRAPPER_ enum to avoid adding more elements to that
87 /* Subtypes of MONO_WRAPPER_MANAGED_TO_MANAGED */
88 WRAPPER_SUBTYPE_ELEMENT_ADDR,
89 WRAPPER_SUBTYPE_STRING_CTOR,
90 /* Subtypes of MONO_WRAPPER_STELEMREF */
91 WRAPPER_SUBTYPE_VIRTUAL_STELEMREF,
92 /* Subtypes of MONO_WRAPPER_UNKNOWN */
93 WRAPPER_SUBTYPE_FAST_MONITOR_ENTER,
94 WRAPPER_SUBTYPE_FAST_MONITOR_ENTER_V4,
95 WRAPPER_SUBTYPE_FAST_MONITOR_EXIT,
96 WRAPPER_SUBTYPE_PTR_TO_STRUCTURE,
97 WRAPPER_SUBTYPE_STRUCTURE_TO_PTR,
98 /* Subtypes of MONO_WRAPPER_CASTCLASS */
99 WRAPPER_SUBTYPE_CASTCLASS_WITH_CACHE,
100 WRAPPER_SUBTYPE_ISINST_WITH_CACHE,
101 /* Subtypes of MONO_WRAPPER_RUNTIME_INVOKE */
102 WRAPPER_SUBTYPE_RUNTIME_INVOKE_NORMAL,
103 WRAPPER_SUBTYPE_RUNTIME_INVOKE_DYNAMIC,
104 WRAPPER_SUBTYPE_RUNTIME_INVOKE_DIRECT,
105 WRAPPER_SUBTYPE_RUNTIME_INVOKE_VIRTUAL,
106 /* Subtypes of MONO_WRAPPER_MANAGED_TO_NATIVE */
107 WRAPPER_SUBTYPE_ICALL_WRAPPER,
108 WRAPPER_SUBTYPE_NATIVE_FUNC_AOT,
109 WRAPPER_SUBTYPE_PINVOKE,
110 /* Subtypes of MONO_WRAPPER_UNKNOWN */
111 WRAPPER_SUBTYPE_SYNCHRONIZED_INNER,
112 WRAPPER_SUBTYPE_GSHAREDVT_IN,
113 WRAPPER_SUBTYPE_GSHAREDVT_OUT,
114 WRAPPER_SUBTYPE_ARRAY_ACCESSOR,
115 /* Subtypes of MONO_WRAPPER_MANAGED_TO_MANAGED */
116 WRAPPER_SUBTYPE_GENERIC_ARRAY_HELPER,
117 /* Subtypes of MONO_WRAPPER_DELEGATE_INVOKE */
118 WRAPPER_SUBTYPE_DELEGATE_INVOKE_VIRTUAL,
119 WRAPPER_SUBTYPE_DELEGATE_INVOKE_BOUND,
120 /* Subtypes of MONO_WRAPPER_UNKNOWN */
121 WRAPPER_SUBTYPE_GSHAREDVT_IN_SIG,
122 WRAPPER_SUBTYPE_GSHAREDVT_OUT_SIG,
128 } NativeToManagedWrapperInfo;
132 } StringCtorWrapperInfo;
136 } VirtualStelemrefWrapperInfo;
139 guint32 rank, elem_size;
140 } ElementAddrWrapperInfo;
144 /* For WRAPPER_SUBTYPE_RUNTIME_INVOKE_NORMAL */
145 MonoMethodSignature *sig;
146 } RuntimeInvokeWrapperInfo;
150 } ManagedToNativeWrapperInfo;
154 } SynchronizedWrapperInfo;
158 } SynchronizedInnerWrapperInfo;
162 } GenericArrayHelperWrapperInfo;
170 } ArrayAccessorWrapperInfo;
179 } AllocatorWrapperInfo;
187 } RemotingWrapperInfo;
190 MonoMethodSignature *sig;
191 } GsharedvtWrapperInfo;
194 * This structure contains additional information to uniquely identify a given wrapper
195 * method. It can be retrieved by mono_marshal_get_wrapper_info () for certain types
196 * of wrappers, i.e. ones which do not have a 1-1 association with a method/class.
199 WrapperSubtype subtype;
201 /* RUNTIME_INVOKE_... */
202 RuntimeInvokeWrapperInfo runtime_invoke;
204 StringCtorWrapperInfo string_ctor;
206 ElementAddrWrapperInfo element_addr;
207 /* VIRTUAL_STELEMREF */
208 VirtualStelemrefWrapperInfo virtual_stelemref;
209 /* MONO_WRAPPER_NATIVE_TO_MANAGED */
210 NativeToManagedWrapperInfo native_to_managed;
211 /* MONO_WRAPPER_MANAGED_TO_NATIVE */
212 ManagedToNativeWrapperInfo managed_to_native;
214 SynchronizedWrapperInfo synchronized;
215 /* SYNCHRONIZED_INNER */
216 SynchronizedInnerWrapperInfo synchronized_inner;
217 /* GENERIC_ARRAY_HELPER */
218 GenericArrayHelperWrapperInfo generic_array_helper;
220 ICallWrapperInfo icall;
222 ArrayAccessorWrapperInfo array_accessor;
223 /* PROXY_ISINST etc. */
224 ProxyWrapperInfo proxy;
226 AllocatorWrapperInfo alloc;
228 UnboxWrapperInfo unbox;
229 /* MONO_WRAPPER_REMOTING_INVOKE/MONO_WRAPPER_REMOTING_INVOKE_WITH_CHECK/MONO_WRAPPER_XDOMAIN_INVOKE */
230 RemotingWrapperInfo remoting;
231 /* GSHAREDVT_IN_SIG/GSHAREDVT_OUT_SIG */
232 GsharedvtWrapperInfo gsharedvt;
238 /*type of the function pointer of methods returned by mono_marshal_get_runtime_invoke*/
239 typedef MonoObject *(*RuntimeInvokeFunction) (MonoObject *this_obj, void **params, MonoObject **exc, void* compiled_method);
241 typedef void (*RuntimeInvokeDynamicFunction) (void *args, MonoObject **exc, void* compiled_method);
243 /* marshaling helper functions */
246 mono_marshal_init (void);
249 mono_marshal_init_tls (void);
252 mono_marshal_cleanup (void);
255 mono_class_native_size (MonoClass *klass, guint32 *align);
258 mono_marshal_load_type_info (MonoClass* klass);
261 mono_marshal_type_size (MonoType *type, MonoMarshalSpec *mspec, guint32 *align,
262 gboolean as_field, gboolean unicode);
265 mono_type_native_stack_size (MonoType *type, guint32 *alignment);
268 mono_array_to_savearray (MonoArray *array);
271 mono_array_to_lparray (MonoArray *array);
274 mono_free_lparray (MonoArray *array, gpointer* nativeArray);
277 mono_string_utf8_to_builder (MonoStringBuilder *sb, char *text);
280 mono_string_utf16_to_builder (MonoStringBuilder *sb, gunichar2 *text);
283 mono_string_builder_to_utf8 (MonoStringBuilder *sb);
286 mono_string_builder_to_utf16 (MonoStringBuilder *sb);
289 mono_string_to_ansibstr (MonoString *string_obj);
292 mono_string_to_bstr (MonoString *string_obj);
295 mono_string_to_byvalstr (gpointer dst, MonoString *src, int size);
298 mono_string_to_byvalwstr (gpointer dst, MonoString *src, int size);
301 mono_delegate_to_ftnptr (MonoDelegate *delegate);
304 mono_ftnptr_to_delegate (MonoClass *klass, gpointer ftn);
306 void mono_delegate_free_ftnptr (MonoDelegate *delegate);
309 mono_marshal_set_last_error (void);
312 mono_marshal_asany (MonoObject *obj, MonoMarshalNative string_encoding, int param_attrs);
315 mono_marshal_free_asany (MonoObject *o, gpointer ptr, MonoMarshalNative string_encoding, int param_attrs);
318 mono_type_to_ldind (MonoType *type);
321 mono_type_to_stind (MonoType *type);
323 /* functions to create various architecture independent helper functions */
326 mono_marshal_method_from_wrapper (MonoMethod *wrapper);
329 mono_wrapper_info_create (MonoMethodBuilder *mb, WrapperSubtype subtype);
332 mono_marshal_set_wrapper_info (MonoMethod *method, WrapperInfo *info);
335 mono_marshal_get_wrapper_info (MonoMethod *wrapper);
338 mono_marshal_get_delegate_begin_invoke (MonoMethod *method);
341 mono_marshal_get_delegate_end_invoke (MonoMethod *method);
344 mono_marshal_get_delegate_invoke (MonoMethod *method, MonoDelegate *del);
347 mono_marshal_get_delegate_invoke_internal (MonoMethod *method, gboolean callvirt, gboolean static_method_with_first_arg_bound, MonoMethod *target_method);
350 mono_marshal_get_runtime_invoke (MonoMethod *method, gboolean is_virtual);
353 mono_marshal_get_runtime_invoke_dynamic (void);
356 mono_marshal_get_runtime_invoke_for_sig (MonoMethodSignature *sig);
359 mono_marshal_get_string_ctor_signature (MonoMethod *method);
362 mono_marshal_get_managed_wrapper (MonoMethod *method, MonoClass *delegate_klass, uint32_t this_loc);
365 mono_marshal_get_vtfixup_ftnptr (MonoImage *image, guint32 token, guint16 type);
368 mono_marshal_get_icall_wrapper (MonoMethodSignature *sig, const char *name, gconstpointer func, gboolean check_exceptions);
371 mono_marshal_get_native_wrapper (MonoMethod *method, gboolean check_exceptions, gboolean aot);
374 mono_marshal_get_native_func_wrapper (MonoImage *image, MonoMethodSignature *sig, MonoMethodPInvoke *piinfo, MonoMarshalSpec **mspecs, gpointer func);
377 mono_marshal_get_native_func_wrapper_aot (MonoClass *klass);
380 mono_marshal_get_struct_to_ptr (MonoClass *klass);
383 mono_marshal_get_ptr_to_struct (MonoClass *klass);
386 mono_marshal_get_synchronized_wrapper (MonoMethod *method);
389 mono_marshal_get_synchronized_inner_wrapper (MonoMethod *method);
392 mono_marshal_get_unbox_wrapper (MonoMethod *method);
395 mono_marshal_get_castclass_with_cache (void);
398 mono_marshal_get_isinst_with_cache (void);
401 mono_marshal_get_isinst (MonoClass *klass);
404 mono_marshal_get_castclass (MonoClass *klass);
407 mono_marshal_get_stelemref (void);
410 mono_marshal_get_virtual_stelemref (MonoClass *array_class);
413 mono_marshal_get_virtual_stelemref_wrappers (int *nwrappers);
416 mono_marshal_get_array_address (int rank, int elem_size);
419 mono_marshal_get_array_accessor_wrapper (MonoMethod *method);
422 mono_marshal_get_generic_array_helper (MonoClass *klass, MonoClass *iface,
423 gchar *name, MonoMethod *method);
426 mono_marshal_get_thunk_invoke_wrapper (MonoMethod *method);
429 mono_marshal_get_gsharedvt_in_wrapper (void);
432 mono_marshal_get_gsharedvt_out_wrapper (void);
435 mono_marshal_free_dynamic_wrappers (MonoMethod *method);
438 mono_marshal_lock_internal (void);
441 mono_marshal_unlock_internal (void);
443 /* marshaling internal calls */
446 mono_marshal_alloc (gulong size, MonoError *error);
449 mono_marshal_free (gpointer ptr);
452 mono_marshal_free_array (gpointer *ptr, int size);
455 mono_marshal_free_ccw (MonoObject* obj);
458 cominterop_release_all_rcws (void);
461 ves_icall_System_Runtime_InteropServices_Marshal_copy_to_unmanaged (MonoArray *src, gint32 start_index,
462 gpointer dest, gint32 length);
465 ves_icall_System_Runtime_InteropServices_Marshal_copy_from_unmanaged (gpointer src, gint32 start_index,
466 MonoArray *dest, gint32 length);
469 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi (char *ptr);
472 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi_len (char *ptr, gint32 len);
475 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni (guint16 *ptr);
478 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni_len (guint16 *ptr, gint32 len);
481 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringBSTR (gpointer ptr);
484 ves_icall_System_Runtime_InteropServices_Marshal_GetComSlotForMethodInfoInternal (MonoReflectionMethod *m);
487 ves_icall_System_Runtime_InteropServices_Marshal_GetLastWin32Error (void);
490 ves_icall_System_Runtime_InteropServices_Marshal_SizeOf (MonoReflectionType *rtype);
493 ves_icall_System_Runtime_InteropServices_Marshal_StructureToPtr (MonoObject *obj, gpointer dst, MonoBoolean delete_old);
496 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure (gpointer src, MonoObject *dst);
499 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure_type (gpointer src, MonoReflectionType *type);
502 ves_icall_System_Runtime_InteropServices_Marshal_OffsetOf (MonoReflectionType *type, MonoString *field_name);
505 ves_icall_System_Runtime_InteropServices_Marshal_StringToBSTR (MonoString *string);
508 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalAnsi (MonoString *string);
511 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalUni (MonoString *string);
514 ves_icall_System_Runtime_InteropServices_Marshal_DestroyStructure (gpointer src, MonoReflectionType *type);
517 ves_icall_System_Runtime_InteropServices_Marshal_AllocCoTaskMem (int size);
520 ves_icall_System_Runtime_InteropServices_Marshal_FreeCoTaskMem (void *ptr);
523 ves_icall_System_Runtime_InteropServices_Marshal_ReAllocCoTaskMem (gpointer ptr, int size);
526 ves_icall_System_Runtime_InteropServices_Marshal_AllocHGlobal (gpointer size);
529 ves_icall_System_Runtime_InteropServices_Marshal_ReAllocHGlobal (gpointer ptr, gpointer size);
532 ves_icall_System_Runtime_InteropServices_Marshal_FreeHGlobal (void *ptr);
535 ves_icall_System_Runtime_InteropServices_Marshal_FreeBSTR (void *ptr);
538 ves_icall_System_Runtime_InteropServices_Marshal_UnsafeAddrOfPinnedArrayElement (MonoArray *arrayobj, int index);
541 ves_icall_System_Runtime_InteropServices_Marshal_GetDelegateForFunctionPointerInternal (void *ftn, MonoReflectionType *type);
544 ves_icall_System_Runtime_InteropServices_Marshal_AddRefInternal (gpointer pUnk);
547 ves_icall_System_Runtime_InteropServices_Marshal_QueryInterfaceInternal (gpointer pUnk, gpointer riid, gpointer* ppv);
550 ves_icall_System_Runtime_InteropServices_Marshal_ReleaseInternal (gpointer pUnk);
553 ves_icall_System_Runtime_InteropServices_Marshal_GetIUnknownForObjectInternal (MonoObject* object);
556 ves_icall_System_Runtime_InteropServices_Marshal_GetObjectForCCW (void* pUnk);
559 ves_icall_System_Runtime_InteropServices_Marshal_GetIDispatchForObjectInternal (MonoObject* object);
562 ves_icall_System_Runtime_InteropServices_Marshal_GetCCW (MonoObject* object, MonoReflectionType* type);
565 ves_icall_System_Runtime_InteropServices_Marshal_IsComObject (MonoObject* object);
568 ves_icall_System_Runtime_InteropServices_Marshal_ReleaseComObjectInternal (MonoObject* object);
571 ves_icall_System_ComObject_CreateRCW (MonoReflectionType *type);
574 ves_icall_System_ComObject_ReleaseInterfaces(MonoComObject* obj);
577 ves_icall_System_ComObject_GetInterfaceInternal (MonoComObject* obj, MonoReflectionType* type, MonoBoolean throw_exception);
580 ves_icall_Mono_Interop_ComInteropProxy_AddProxy (gpointer pUnk, MonoComInteropProxy* proxy);
583 ves_icall_Mono_Interop_ComInteropProxy_FindProxy (gpointer pUnk);
586 mono_win32_compat_CopyMemory (gpointer dest, gconstpointer source, gsize length);
589 mono_win32_compat_FillMemory (gpointer dest, gsize length, guchar fill);
592 mono_win32_compat_MoveMemory (gpointer dest, gconstpointer source, gsize length);
595 mono_win32_compat_ZeroMemory (gpointer dest, gsize length);
598 mono_marshal_find_nonzero_bit_offset (guint8 *buf, int len, int *byte_offset, guint8 *bitmask) MONO_LLVM_INTERNAL;
601 mono_signature_no_pinvoke (MonoMethod *method);
603 /* Called from cominterop.c/remoting.c */
606 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);
609 mono_marshal_emit_managed_wrapper (MonoMethodBuilder *mb, MonoMethodSignature *invoke_sig, MonoMarshalSpec **mspecs, EmitMarshalContext* m, MonoMethod *method, uint32_t target_handle);
612 mono_marshal_get_cache (GHashTable **var, GHashFunc hash_func, GCompareFunc equal_func);
615 mono_marshal_find_in_cache (GHashTable *cache, gpointer key);
618 mono_mb_create_and_cache (GHashTable *cache, gpointer key,
619 MonoMethodBuilder *mb, MonoMethodSignature *sig,
622 mono_marshal_emit_thread_interrupt_checkpoint (MonoMethodBuilder *mb);
625 mono_marshal_emit_thread_force_interrupt_checkpoint (MonoMethodBuilder *mb);
628 mono_marshal_use_aot_wrappers (gboolean use);
631 mono_marshal_xdomain_copy_value (MonoObject *val);
634 mono_mb_emit_save_args (MonoMethodBuilder *mb, MonoMethodSignature *sig, gboolean save_this);
637 mono_mb_emit_restore_result (MonoMethodBuilder *mb, MonoType *return_type);
640 mono_mb_create (MonoMethodBuilder *mb, MonoMethodSignature *sig,
641 int max_stack, WrapperInfo *info);
644 mono_mb_create_and_cache_full (GHashTable *cache, gpointer key,
645 MonoMethodBuilder *mb, MonoMethodSignature *sig,
646 int max_stack, WrapperInfo *info, gboolean *out_found);
650 #endif /* __MONO_MARSHAL_H__ */