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>
22 #define mono_marshal_find_bitfield_offset(type, elem, byte_offset, bitmask) \
25 memset (&tmp, 0, sizeof (tmp)); \
27 mono_marshal_find_nonzero_bit_offset ((guint8*)&tmp, sizeof (tmp), (byte_offset), (bitmask)); \
31 * This structure holds the state kept by the emit_ marshalling functions.
32 * This is exported so it can be used by cominterop.c.
35 MonoMethodBuilder *mb;
36 MonoMethodSignature *sig;
37 MonoMethodPInvoke *piinfo;
38 int *orig_conv_args; /* Locals containing the original values of byref args */
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 */
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
53 MARSHAL_ACTION_CONV_IN,
56 * This operation is called to push the actual value that was optionally
57 * converted on the first stage
62 * Convert byref arguments back or free resources allocated during the
65 MARSHAL_ACTION_CONV_OUT,
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.
72 MARSHAL_ACTION_CONV_RESULT,
74 MARSHAL_ACTION_MANAGED_CONV_IN,
75 MARSHAL_ACTION_MANAGED_CONV_OUT,
76 MARSHAL_ACTION_MANAGED_CONV_RESULT
80 * This is an extension of the MONO_WRAPPER_ enum to avoid adding more elements to that
85 /* Subtypes of MONO_WRAPPER_MANAGED_TO_MANAGED */
86 WRAPPER_SUBTYPE_ELEMENT_ADDR,
87 WRAPPER_SUBTYPE_STRING_CTOR,
88 /* Subtypes of MONO_WRAPPER_STELEMREF */
89 WRAPPER_SUBTYPE_VIRTUAL_STELEMREF,
90 /* Subtypes of MONO_WRAPPER_UNKNOWN */
91 WRAPPER_SUBTYPE_FAST_MONITOR_ENTER,
92 WRAPPER_SUBTYPE_FAST_MONITOR_ENTER_V4,
93 WRAPPER_SUBTYPE_FAST_MONITOR_EXIT,
94 WRAPPER_SUBTYPE_PTR_TO_STRUCTURE,
95 WRAPPER_SUBTYPE_STRUCTURE_TO_PTR,
96 /* Subtypes of MONO_WRAPPER_CASTCLASS */
97 WRAPPER_SUBTYPE_CASTCLASS_WITH_CACHE,
98 WRAPPER_SUBTYPE_ISINST_WITH_CACHE,
99 /* Subtypes of MONO_WRAPPER_RUNTIME_INVOKE */
100 WRAPPER_SUBTYPE_RUNTIME_INVOKE_NORMAL,
101 WRAPPER_SUBTYPE_RUNTIME_INVOKE_DYNAMIC,
102 WRAPPER_SUBTYPE_RUNTIME_INVOKE_DIRECT,
103 WRAPPER_SUBTYPE_RUNTIME_INVOKE_VIRTUAL,
104 /* Subtypes of MONO_WRAPPER_MANAGED_TO_NATIVE */
105 WRAPPER_SUBTYPE_ICALL_WRAPPER,
106 WRAPPER_SUBTYPE_NATIVE_FUNC_AOT,
107 /* Subtypes of MONO_WRAPPER_UNKNOWN */
108 WRAPPER_SUBTYPE_SYNCHRONIZED_INNER,
109 WRAPPER_SUBTYPE_GSHAREDVT_IN,
110 WRAPPER_SUBTYPE_GSHAREDVT_OUT,
111 /* Subtypes of MONO_WRAPPER_MANAGED_TO_MANAGED */
112 WRAPPER_SUBTYPE_GENERIC_ARRAY_HELPER
118 } NativeToManagedWrapperInfo;
122 } StringCtorWrapperInfo;
126 } VirtualStelemrefWrapperInfo;
129 guint32 rank, elem_size;
130 } ElementAddrWrapperInfo;
134 /* For WRAPPER_SUBTYPE_RUNTIME_INVOKE_NORMAL */
135 MonoMethodSignature *sig;
136 } RuntimeInvokeWrapperInfo;
140 } ManagedToNativeWrapperInfo;
144 } SynchronizedInnerWrapperInfo;
148 } GenericArrayHelperWrapperInfo;
155 * This structure contains additional information to uniquely identify a given wrapper
156 * method. It can be retrieved by mono_marshal_get_wrapper_info () for certain types
157 * of wrappers, i.e. ones which do not have a 1-1 association with a method/class.
160 WrapperSubtype subtype;
162 /* RUNTIME_INVOKE_... */
163 RuntimeInvokeWrapperInfo runtime_invoke;
165 StringCtorWrapperInfo string_ctor;
167 ElementAddrWrapperInfo element_addr;
168 /* VIRTUAL_STELEMREF */
169 VirtualStelemrefWrapperInfo virtual_stelemref;
170 /* MONO_WRAPPER_NATIVE_TO_MANAGED */
171 NativeToManagedWrapperInfo native_to_managed;
172 /* MONO_WRAPPER_MANAGED_TO_NATIVE */
173 ManagedToNativeWrapperInfo managed_to_native;
174 /* SYNCHRONIZED_INNER */
175 SynchronizedInnerWrapperInfo synchronized_inner;
176 /* GENERIC_ARRAY_HELPER */
177 GenericArrayHelperWrapperInfo generic_array_helper;
179 ICallWrapperInfo icall;
185 /*type of the function pointer of methods returned by mono_marshal_get_runtime_invoke*/
186 typedef MonoObject *(*RuntimeInvokeFunction) (MonoObject *this, void **params, MonoObject **exc, void* compiled_method);
188 typedef void (*RuntimeInvokeDynamicFunction) (void *args, MonoObject **exc, void* compiled_method);
190 /* marshaling helper functions */
193 mono_marshal_init (void) MONO_INTERNAL;
196 mono_marshal_init_tls (void) MONO_INTERNAL;
199 mono_marshal_cleanup (void) MONO_INTERNAL;
202 mono_class_native_size (MonoClass *klass, guint32 *align) MONO_INTERNAL;
205 mono_marshal_load_type_info (MonoClass* klass) MONO_INTERNAL;
208 mono_marshal_type_size (MonoType *type, MonoMarshalSpec *mspec, guint32 *align,
209 gboolean as_field, gboolean unicode) MONO_INTERNAL;
212 mono_type_native_stack_size (MonoType *type, guint32 *alignment) MONO_INTERNAL;
215 mono_array_to_savearray (MonoArray *array) MONO_INTERNAL;
218 mono_array_to_lparray (MonoArray *array) MONO_INTERNAL;
221 mono_free_lparray (MonoArray *array, gpointer* nativeArray) MONO_INTERNAL;
224 mono_string_utf8_to_builder (MonoStringBuilder *sb, char *text) MONO_INTERNAL;
227 mono_string_utf16_to_builder (MonoStringBuilder *sb, gunichar2 *text) MONO_INTERNAL;
230 mono_string_builder_to_utf8 (MonoStringBuilder *sb) MONO_INTERNAL;
233 mono_string_builder_to_utf16 (MonoStringBuilder *sb) MONO_INTERNAL;
236 mono_string_to_ansibstr (MonoString *string_obj) MONO_INTERNAL;
239 mono_string_to_bstr (MonoString *string_obj) MONO_INTERNAL;
242 mono_string_to_byvalstr (gpointer dst, MonoString *src, int size) MONO_INTERNAL;
245 mono_string_to_byvalwstr (gpointer dst, MonoString *src, int size) MONO_INTERNAL;
248 mono_delegate_to_ftnptr (MonoDelegate *delegate) MONO_INTERNAL;
251 mono_ftnptr_to_delegate (MonoClass *klass, gpointer ftn) MONO_INTERNAL;
253 void mono_delegate_free_ftnptr (MonoDelegate *delegate) MONO_INTERNAL;
256 mono_marshal_set_last_error (void) MONO_INTERNAL;
259 mono_marshal_asany (MonoObject *obj, MonoMarshalNative string_encoding, int param_attrs) MONO_INTERNAL;
262 mono_marshal_free_asany (MonoObject *o, gpointer ptr, MonoMarshalNative string_encoding, int param_attrs) MONO_INTERNAL;
265 mono_type_to_ldind (MonoType *type) MONO_INTERNAL;
268 mono_type_to_stind (MonoType *type) MONO_INTERNAL;
270 /* functions to create various architecture independent helper functions */
273 mono_marshal_method_from_wrapper (MonoMethod *wrapper) MONO_INTERNAL;
276 mono_marshal_set_wrapper_info (MonoMethod *method, gpointer data) MONO_INTERNAL;
279 mono_marshal_get_wrapper_info (MonoMethod *wrapper) MONO_INTERNAL;
282 mono_marshal_get_delegate_begin_invoke (MonoMethod *method) MONO_INTERNAL;
285 mono_marshal_get_delegate_end_invoke (MonoMethod *method) MONO_INTERNAL;
288 mono_marshal_get_delegate_invoke (MonoMethod *method, MonoDelegate *del) MONO_INTERNAL;
291 mono_marshal_get_runtime_invoke (MonoMethod *method, gboolean virtual) MONO_INTERNAL;
294 mono_marshal_get_runtime_invoke_dynamic (void) MONO_INTERNAL;
297 mono_marshal_get_string_ctor_signature (MonoMethod *method) MONO_INTERNAL;
300 mono_marshal_get_managed_wrapper (MonoMethod *method, MonoClass *delegate_klass, uint32_t this_loc) MONO_INTERNAL;
303 mono_marshal_get_vtfixup_ftnptr (MonoImage *image, guint32 token, guint16 type) MONO_INTERNAL;
306 mono_marshal_get_icall_wrapper (MonoMethodSignature *sig, const char *name, gconstpointer func, gboolean check_exceptions) MONO_INTERNAL;
309 mono_marshal_get_native_wrapper (MonoMethod *method, gboolean check_exceptions, gboolean aot) MONO_INTERNAL;
312 mono_marshal_get_native_func_wrapper (MonoImage *image, MonoMethodSignature *sig, MonoMethodPInvoke *piinfo, MonoMarshalSpec **mspecs, gpointer func) MONO_INTERNAL;
315 mono_marshal_get_native_func_wrapper_aot (MonoClass *klass) MONO_INTERNAL;
318 mono_marshal_get_struct_to_ptr (MonoClass *klass) MONO_INTERNAL;
321 mono_marshal_get_ptr_to_struct (MonoClass *klass) MONO_INTERNAL;
324 mono_marshal_get_synchronized_wrapper (MonoMethod *method) MONO_INTERNAL;
327 mono_marshal_get_synchronized_inner_wrapper (MonoMethod *method) MONO_INTERNAL;
330 mono_marshal_get_unbox_wrapper (MonoMethod *method) MONO_INTERNAL;
333 mono_marshal_get_castclass_with_cache (void) MONO_INTERNAL;
336 mono_marshal_get_isinst_with_cache (void) MONO_INTERNAL;
339 mono_marshal_get_isinst (MonoClass *klass) MONO_INTERNAL;
342 mono_marshal_get_castclass (MonoClass *klass) MONO_INTERNAL;
345 mono_marshal_get_stelemref (void) MONO_INTERNAL;
348 mono_marshal_get_virtual_stelemref (MonoClass *array_class) MONO_INTERNAL;
351 mono_marshal_get_virtual_stelemref_wrappers (int *nwrappers) MONO_INTERNAL;
354 mono_marshal_get_array_address (int rank, int elem_size) MONO_INTERNAL;
357 mono_marshal_get_generic_array_helper (MonoClass *class, MonoClass *iface,
358 gchar *name, MonoMethod *method) MONO_INTERNAL;
361 mono_marshal_get_thunk_invoke_wrapper (MonoMethod *method) MONO_INTERNAL;
364 mono_marshal_get_gsharedvt_in_wrapper (void) MONO_INTERNAL;
367 mono_marshal_get_gsharedvt_out_wrapper (void) MONO_INTERNAL;
370 mono_marshal_free_dynamic_wrappers (MonoMethod *method) MONO_INTERNAL;
373 mono_marshal_free_inflated_wrappers (MonoMethod *method) MONO_INTERNAL;
375 /* marshaling internal calls */
378 mono_marshal_alloc (gulong size) MONO_INTERNAL;
381 mono_marshal_free (gpointer ptr) MONO_INTERNAL;
384 mono_marshal_free_array (gpointer *ptr, int size) MONO_INTERNAL;
387 mono_marshal_free_ccw (MonoObject* obj) MONO_INTERNAL;
390 cominterop_release_all_rcws (void) MONO_INTERNAL;
393 ves_icall_System_Runtime_InteropServices_Marshal_copy_to_unmanaged (MonoArray *src, gint32 start_index,
394 gpointer dest, gint32 length) MONO_INTERNAL;
397 ves_icall_System_Runtime_InteropServices_Marshal_copy_from_unmanaged (gpointer src, gint32 start_index,
398 MonoArray *dest, gint32 length) MONO_INTERNAL;
401 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi (char *ptr) MONO_INTERNAL;
404 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi_len (char *ptr, gint32 len) MONO_INTERNAL;
407 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni (guint16 *ptr) MONO_INTERNAL;
410 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni_len (guint16 *ptr, gint32 len) MONO_INTERNAL;
413 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringBSTR (gpointer ptr) MONO_INTERNAL;
416 ves_icall_System_Runtime_InteropServices_Marshal_GetComSlotForMethodInfoInternal (MonoReflectionMethod *m) MONO_INTERNAL;
419 ves_icall_System_Runtime_InteropServices_Marshal_GetLastWin32Error (void) MONO_INTERNAL;
422 ves_icall_System_Runtime_InteropServices_Marshal_SizeOf (MonoReflectionType *rtype) MONO_INTERNAL;
425 ves_icall_System_Runtime_InteropServices_Marshal_StructureToPtr (MonoObject *obj, gpointer dst, MonoBoolean delete_old) MONO_INTERNAL;
428 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure (gpointer src, MonoObject *dst) MONO_INTERNAL;
431 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure_type (gpointer src, MonoReflectionType *type) MONO_INTERNAL;
434 ves_icall_System_Runtime_InteropServices_Marshal_OffsetOf (MonoReflectionType *type, MonoString *field_name) MONO_INTERNAL;
437 ves_icall_System_Runtime_InteropServices_Marshal_StringToBSTR (MonoString *string) MONO_INTERNAL;
440 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalAnsi (MonoString *string) MONO_INTERNAL;
443 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalUni (MonoString *string) MONO_INTERNAL;
446 ves_icall_System_Runtime_InteropServices_Marshal_DestroyStructure (gpointer src, MonoReflectionType *type) MONO_INTERNAL;
449 ves_icall_System_Runtime_InteropServices_Marshal_AllocCoTaskMem (int size) MONO_INTERNAL;
452 ves_icall_System_Runtime_InteropServices_Marshal_FreeCoTaskMem (void *ptr) MONO_INTERNAL;
455 ves_icall_System_Runtime_InteropServices_Marshal_ReAllocCoTaskMem (gpointer ptr, int size) MONO_INTERNAL;
458 ves_icall_System_Runtime_InteropServices_Marshal_AllocHGlobal (int size) MONO_INTERNAL;
461 ves_icall_System_Runtime_InteropServices_Marshal_ReAllocHGlobal (gpointer ptr, int size) MONO_INTERNAL;
464 ves_icall_System_Runtime_InteropServices_Marshal_FreeHGlobal (void *ptr) MONO_INTERNAL;
467 ves_icall_System_Runtime_InteropServices_Marshal_FreeBSTR (void *ptr) MONO_INTERNAL;
470 ves_icall_System_Runtime_InteropServices_Marshal_UnsafeAddrOfPinnedArrayElement (MonoArray *arrayobj, int index) MONO_INTERNAL;
473 ves_icall_System_Runtime_InteropServices_Marshal_GetDelegateForFunctionPointerInternal (void *ftn, MonoReflectionType *type) MONO_INTERNAL;
476 ves_icall_System_Runtime_InteropServices_Marshal_AddRefInternal (gpointer pUnk) MONO_INTERNAL;
479 ves_icall_System_Runtime_InteropServices_Marshal_QueryInterfaceInternal (gpointer pUnk, gpointer riid, gpointer* ppv) MONO_INTERNAL;
482 ves_icall_System_Runtime_InteropServices_Marshal_ReleaseInternal (gpointer pUnk) MONO_INTERNAL;
485 ves_icall_System_Runtime_InteropServices_Marshal_GetIUnknownForObjectInternal (MonoObject* object) MONO_INTERNAL;
488 ves_icall_System_Runtime_InteropServices_Marshal_GetObjectForCCW (void* pUnk) MONO_INTERNAL;
491 ves_icall_System_Runtime_InteropServices_Marshal_GetIDispatchForObjectInternal (MonoObject* object) MONO_INTERNAL;
494 ves_icall_System_Runtime_InteropServices_Marshal_GetCCW (MonoObject* object, MonoReflectionType* type) MONO_INTERNAL;
497 ves_icall_System_Runtime_InteropServices_Marshal_IsComObject (MonoObject* object) MONO_INTERNAL;
500 ves_icall_System_Runtime_InteropServices_Marshal_ReleaseComObjectInternal (MonoObject* object) MONO_INTERNAL;
503 ves_icall_System_ComObject_CreateRCW (MonoReflectionType *type) MONO_INTERNAL;
506 ves_icall_System_ComObject_ReleaseInterfaces(MonoComObject* obj) MONO_INTERNAL;
509 ves_icall_System_ComObject_GetInterfaceInternal (MonoComObject* obj, MonoReflectionType* type, MonoBoolean throw_exception) MONO_INTERNAL;
512 ves_icall_Mono_Interop_ComInteropProxy_AddProxy (gpointer pUnk, MonoComInteropProxy* proxy) MONO_INTERNAL;
515 ves_icall_Mono_Interop_ComInteropProxy_FindProxy (gpointer pUnk) MONO_INTERNAL;
518 mono_win32_compat_CopyMemory (gpointer dest, gconstpointer source, gsize length);
521 mono_win32_compat_FillMemory (gpointer dest, gsize length, guchar fill);
524 mono_win32_compat_MoveMemory (gpointer dest, gconstpointer source, gsize length);
527 mono_win32_compat_ZeroMemory (gpointer dest, gsize length);
530 mono_marshal_find_nonzero_bit_offset (guint8 *buf, int len, int *byte_offset, guint8 *bitmask) MONO_INTERNAL;
533 mono_signature_no_pinvoke (MonoMethod *method) MONO_INTERNAL;
535 /* Called from cominterop.c */
538 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) MONO_INTERNAL;
541 mono_marshal_emit_managed_wrapper (MonoMethodBuilder *mb, MonoMethodSignature *invoke_sig, MonoMarshalSpec **mspecs, EmitMarshalContext* m, MonoMethod *method, uint32_t target_handle) MONO_INTERNAL;
544 mono_marshal_get_cache (GHashTable **var, GHashFunc hash_func, GCompareFunc equal_func) MONO_INTERNAL;
547 mono_marshal_find_in_cache (GHashTable *cache, gpointer key) MONO_INTERNAL;
550 mono_mb_create_and_cache (GHashTable *cache, gpointer key,
551 MonoMethodBuilder *mb, MonoMethodSignature *sig,
552 int max_stack) MONO_INTERNAL;
554 mono_marshal_emit_thread_interrupt_checkpoint (MonoMethodBuilder *mb) MONO_INTERNAL;
557 mono_marshal_use_aot_wrappers (gboolean use) MONO_INTERNAL;
560 mono_marshal_xdomain_copy_value (MonoObject *val) MONO_INTERNAL;
563 #ifndef DISABLE_REMOTING
566 mono_marshal_get_remoting_invoke (MonoMethod *method) MONO_INTERNAL;
569 mono_marshal_get_xappdomain_invoke (MonoMethod *method) MONO_INTERNAL;
572 mono_marshal_get_remoting_invoke_for_target (MonoMethod *method, MonoRemotingTarget target_type) MONO_INTERNAL;
575 mono_marshal_get_remoting_invoke_with_check (MonoMethod *method) MONO_INTERNAL;
578 mono_marshal_get_stfld_wrapper (MonoType *type) MONO_INTERNAL;
581 mono_marshal_get_ldfld_wrapper (MonoType *type) MONO_INTERNAL;
584 mono_marshal_get_ldflda_wrapper (MonoType *type) MONO_INTERNAL;
587 mono_marshal_get_ldfld_remote_wrapper (MonoClass *klass) MONO_INTERNAL;
590 mono_marshal_get_stfld_remote_wrapper (MonoClass *klass) MONO_INTERNAL;
593 mono_marshal_get_proxy_cancast (MonoClass *klass) MONO_INTERNAL;
599 #endif /* __MONO_MARSHAL_H__ */