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>
23 #define mono_marshal_find_bitfield_offset(type, elem, byte_offset, bitmask) \
26 memset (&tmp, 0, sizeof (tmp)); \
28 mono_marshal_find_nonzero_bit_offset ((guint8*)&tmp, sizeof (tmp), (byte_offset), (bitmask)); \
32 * This structure holds the state kept by the emit_ marshalling functions.
33 * This is exported so it can be used by cominterop.c.
36 MonoMethodBuilder *mb;
37 MonoMethodSignature *sig;
38 MonoMethodPInvoke *piinfo;
39 int *orig_conv_args; /* Locals containing the original values of byref args */
41 MonoClass *retobj_class;
42 MonoMethodSignature *csig; /* Might need to be changed due to MarshalAs directives */
43 MonoImage *image; /* The image to use for looking up custom marshallers */
48 * This is invoked to convert arguments from the current types to
49 * the underlying types expected by the platform routine. If required,
50 * the methods create a temporary variable with the proper type, and return
51 * the location for it (either the passed argument, or the newly allocated
54 MARSHAL_ACTION_CONV_IN,
57 * This operation is called to push the actual value that was optionally
58 * converted on the first stage
63 * Convert byref arguments back or free resources allocated during the
66 MARSHAL_ACTION_CONV_OUT,
69 * The result from the unmanaged call is at the top of the stack when
70 * this action is invoked. The result should be stored in the
71 * third local variable slot.
73 MARSHAL_ACTION_CONV_RESULT,
75 MARSHAL_ACTION_MANAGED_CONV_IN,
76 MARSHAL_ACTION_MANAGED_CONV_OUT,
77 MARSHAL_ACTION_MANAGED_CONV_RESULT
81 * This is an extension of the MONO_WRAPPER_ enum to avoid adding more elements to that
86 /* Subtypes of MONO_WRAPPER_MANAGED_TO_MANAGED */
87 WRAPPER_SUBTYPE_ELEMENT_ADDR,
88 WRAPPER_SUBTYPE_STRING_CTOR,
89 /* Subtypes of MONO_WRAPPER_STELEMREF */
90 WRAPPER_SUBTYPE_VIRTUAL_STELEMREF,
91 /* Subtypes of MONO_WRAPPER_UNKNOWN */
92 WRAPPER_SUBTYPE_FAST_MONITOR_ENTER,
93 WRAPPER_SUBTYPE_FAST_MONITOR_ENTER_V4,
94 WRAPPER_SUBTYPE_FAST_MONITOR_EXIT,
95 WRAPPER_SUBTYPE_PTR_TO_STRUCTURE,
96 WRAPPER_SUBTYPE_STRUCTURE_TO_PTR,
97 /* Subtypes of MONO_WRAPPER_CASTCLASS */
98 WRAPPER_SUBTYPE_CASTCLASS_WITH_CACHE,
99 WRAPPER_SUBTYPE_ISINST_WITH_CACHE,
100 /* Subtypes of MONO_WRAPPER_RUNTIME_INVOKE */
101 WRAPPER_SUBTYPE_RUNTIME_INVOKE_NORMAL,
102 WRAPPER_SUBTYPE_RUNTIME_INVOKE_DYNAMIC,
103 WRAPPER_SUBTYPE_RUNTIME_INVOKE_DIRECT,
104 WRAPPER_SUBTYPE_RUNTIME_INVOKE_VIRTUAL,
105 /* Subtypes of MONO_WRAPPER_MANAGED_TO_NATIVE */
106 WRAPPER_SUBTYPE_ICALL_WRAPPER,
107 WRAPPER_SUBTYPE_NATIVE_FUNC_AOT,
108 WRAPPER_SUBTYPE_PINVOKE,
109 /* Subtypes of MONO_WRAPPER_UNKNOWN */
110 WRAPPER_SUBTYPE_SYNCHRONIZED_INNER,
111 WRAPPER_SUBTYPE_GSHAREDVT_IN,
112 WRAPPER_SUBTYPE_GSHAREDVT_OUT,
113 WRAPPER_SUBTYPE_ARRAY_ACCESSOR,
114 /* Subtypes of MONO_WRAPPER_MANAGED_TO_MANAGED */
115 WRAPPER_SUBTYPE_GENERIC_ARRAY_HELPER,
116 /* Subtypes of MONO_WRAPPER_DELEGATE_INVOKE */
117 WRAPPER_SUBTYPE_DELEGATE_INVOKE_VIRTUAL,
118 WRAPPER_SUBTYPE_DELEGATE_INVOKE_BOUND,
119 /* Subtypes of MONO_WRAPPER_UNKNOWN */
120 WRAPPER_SUBTYPE_GSHAREDVT_IN_SIG,
121 WRAPPER_SUBTYPE_GSHAREDVT_OUT_SIG,
127 } NativeToManagedWrapperInfo;
131 } StringCtorWrapperInfo;
135 } VirtualStelemrefWrapperInfo;
138 guint32 rank, elem_size;
139 } ElementAddrWrapperInfo;
143 /* For WRAPPER_SUBTYPE_RUNTIME_INVOKE_NORMAL */
144 MonoMethodSignature *sig;
145 } RuntimeInvokeWrapperInfo;
149 } ManagedToNativeWrapperInfo;
153 } SynchronizedWrapperInfo;
157 } SynchronizedInnerWrapperInfo;
161 } GenericArrayHelperWrapperInfo;
169 } ArrayAccessorWrapperInfo;
178 } AllocatorWrapperInfo;
186 } RemotingWrapperInfo;
189 MonoMethodSignature *sig;
190 } GsharedvtWrapperInfo;
193 * This structure contains additional information to uniquely identify a given wrapper
194 * method. It can be retrieved by mono_marshal_get_wrapper_info () for certain types
195 * of wrappers, i.e. ones which do not have a 1-1 association with a method/class.
198 WrapperSubtype subtype;
200 /* RUNTIME_INVOKE_... */
201 RuntimeInvokeWrapperInfo runtime_invoke;
203 StringCtorWrapperInfo string_ctor;
205 ElementAddrWrapperInfo element_addr;
206 /* VIRTUAL_STELEMREF */
207 VirtualStelemrefWrapperInfo virtual_stelemref;
208 /* MONO_WRAPPER_NATIVE_TO_MANAGED */
209 NativeToManagedWrapperInfo native_to_managed;
210 /* MONO_WRAPPER_MANAGED_TO_NATIVE */
211 ManagedToNativeWrapperInfo managed_to_native;
213 SynchronizedWrapperInfo synchronized;
214 /* SYNCHRONIZED_INNER */
215 SynchronizedInnerWrapperInfo synchronized_inner;
216 /* GENERIC_ARRAY_HELPER */
217 GenericArrayHelperWrapperInfo generic_array_helper;
219 ICallWrapperInfo icall;
221 ArrayAccessorWrapperInfo array_accessor;
222 /* PROXY_ISINST etc. */
223 ProxyWrapperInfo proxy;
225 AllocatorWrapperInfo alloc;
227 UnboxWrapperInfo unbox;
228 /* MONO_WRAPPER_REMOTING_INVOKE/MONO_WRAPPER_REMOTING_INVOKE_WITH_CHECK/MONO_WRAPPER_XDOMAIN_INVOKE */
229 RemotingWrapperInfo remoting;
230 /* GSHAREDVT_IN_SIG/GSHAREDVT_OUT_SIG */
231 GsharedvtWrapperInfo gsharedvt;
237 /*type of the function pointer of methods returned by mono_marshal_get_runtime_invoke*/
238 typedef MonoObject *(*RuntimeInvokeFunction) (MonoObject *this_obj, void **params, MonoObject **exc, void* compiled_method);
240 typedef void (*RuntimeInvokeDynamicFunction) (void *args, MonoObject **exc, void* compiled_method);
242 /* marshaling helper functions */
245 mono_marshal_init (void);
248 mono_marshal_init_tls (void);
251 mono_marshal_cleanup (void);
254 mono_class_native_size (MonoClass *klass, guint32 *align);
257 mono_marshal_load_type_info (MonoClass* klass);
260 mono_marshal_type_size (MonoType *type, MonoMarshalSpec *mspec, guint32 *align,
261 gboolean as_field, gboolean unicode);
264 mono_type_native_stack_size (MonoType *type, guint32 *alignment);
267 mono_array_to_savearray (MonoArray *array);
270 mono_array_to_lparray (MonoArray *array);
273 mono_free_lparray (MonoArray *array, gpointer* nativeArray);
276 mono_string_utf8_to_builder (MonoStringBuilder *sb, char *text);
279 mono_string_utf16_to_builder (MonoStringBuilder *sb, gunichar2 *text);
282 mono_string_builder_to_utf8 (MonoStringBuilder *sb);
285 mono_string_builder_to_utf16 (MonoStringBuilder *sb);
288 mono_string_to_ansibstr (MonoString *string_obj);
291 mono_string_to_bstr (MonoString *string_obj);
294 mono_string_to_byvalstr (gpointer dst, MonoString *src, int size);
297 mono_string_to_byvalwstr (gpointer dst, MonoString *src, int size);
300 mono_delegate_to_ftnptr (MonoDelegate *delegate);
303 mono_ftnptr_to_delegate (MonoClass *klass, gpointer ftn);
305 void mono_delegate_free_ftnptr (MonoDelegate *delegate);
308 mono_marshal_set_last_error (void);
311 mono_marshal_asany (MonoObject *obj, MonoMarshalNative string_encoding, int param_attrs);
314 mono_marshal_free_asany (MonoObject *o, gpointer ptr, MonoMarshalNative string_encoding, int param_attrs);
317 mono_type_to_ldind (MonoType *type);
320 mono_type_to_stind (MonoType *type);
322 /* functions to create various architecture independent helper functions */
325 mono_marshal_method_from_wrapper (MonoMethod *wrapper);
328 mono_wrapper_info_create (MonoMethodBuilder *mb, WrapperSubtype subtype);
331 mono_marshal_set_wrapper_info (MonoMethod *method, WrapperInfo *info);
334 mono_marshal_get_wrapper_info (MonoMethod *wrapper);
337 mono_marshal_get_delegate_begin_invoke (MonoMethod *method);
340 mono_marshal_get_delegate_end_invoke (MonoMethod *method);
343 mono_marshal_get_delegate_invoke (MonoMethod *method, MonoDelegate *del);
346 mono_marshal_get_delegate_invoke_internal (MonoMethod *method, gboolean callvirt, gboolean static_method_with_first_arg_bound, MonoMethod *target_method);
349 mono_marshal_get_runtime_invoke (MonoMethod *method, gboolean is_virtual);
352 mono_marshal_get_runtime_invoke_dynamic (void);
355 mono_marshal_get_runtime_invoke_for_sig (MonoMethodSignature *sig);
358 mono_marshal_get_string_ctor_signature (MonoMethod *method);
361 mono_marshal_get_managed_wrapper (MonoMethod *method, MonoClass *delegate_klass, uint32_t this_loc);
364 mono_marshal_get_vtfixup_ftnptr (MonoImage *image, guint32 token, guint16 type);
367 mono_marshal_get_icall_wrapper (MonoMethodSignature *sig, const char *name, gconstpointer func, gboolean check_exceptions);
370 mono_marshal_get_native_wrapper (MonoMethod *method, gboolean check_exceptions, gboolean aot);
373 mono_marshal_get_native_func_wrapper (MonoImage *image, MonoMethodSignature *sig, MonoMethodPInvoke *piinfo, MonoMarshalSpec **mspecs, gpointer func);
376 mono_marshal_get_native_func_wrapper_aot (MonoClass *klass);
379 mono_marshal_get_struct_to_ptr (MonoClass *klass);
382 mono_marshal_get_ptr_to_struct (MonoClass *klass);
385 mono_marshal_get_synchronized_wrapper (MonoMethod *method);
388 mono_marshal_get_synchronized_inner_wrapper (MonoMethod *method);
391 mono_marshal_get_unbox_wrapper (MonoMethod *method);
394 mono_marshal_get_castclass_with_cache (void);
397 mono_marshal_get_isinst_with_cache (void);
400 mono_marshal_get_isinst (MonoClass *klass);
403 mono_marshal_get_castclass (MonoClass *klass);
406 mono_marshal_get_stelemref (void);
409 mono_marshal_get_virtual_stelemref (MonoClass *array_class);
412 mono_marshal_get_virtual_stelemref_wrappers (int *nwrappers);
415 mono_marshal_get_array_address (int rank, int elem_size);
418 mono_marshal_get_array_accessor_wrapper (MonoMethod *method);
421 mono_marshal_get_generic_array_helper (MonoClass *klass, MonoClass *iface,
422 gchar *name, MonoMethod *method);
425 mono_marshal_get_thunk_invoke_wrapper (MonoMethod *method);
428 mono_marshal_get_gsharedvt_in_wrapper (void);
431 mono_marshal_get_gsharedvt_out_wrapper (void);
434 mono_marshal_free_dynamic_wrappers (MonoMethod *method);
437 mono_marshal_lock_internal (void);
440 mono_marshal_unlock_internal (void);
442 /* marshaling internal calls */
445 mono_marshal_alloc (gulong size);
448 mono_marshal_free (gpointer ptr);
451 mono_marshal_free_array (gpointer *ptr, int size);
454 mono_marshal_free_ccw (MonoObject* obj);
457 cominterop_release_all_rcws (void);
460 ves_icall_System_Runtime_InteropServices_Marshal_copy_to_unmanaged (MonoArray *src, gint32 start_index,
461 gpointer dest, gint32 length);
464 ves_icall_System_Runtime_InteropServices_Marshal_copy_from_unmanaged (gpointer src, gint32 start_index,
465 MonoArray *dest, gint32 length);
468 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi (char *ptr);
471 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi_len (char *ptr, gint32 len);
474 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni (guint16 *ptr);
477 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni_len (guint16 *ptr, gint32 len);
480 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringBSTR (gpointer ptr);
483 ves_icall_System_Runtime_InteropServices_Marshal_GetComSlotForMethodInfoInternal (MonoReflectionMethod *m);
486 ves_icall_System_Runtime_InteropServices_Marshal_GetLastWin32Error (void);
489 ves_icall_System_Runtime_InteropServices_Marshal_SizeOf (MonoReflectionType *rtype);
492 ves_icall_System_Runtime_InteropServices_Marshal_StructureToPtr (MonoObject *obj, gpointer dst, MonoBoolean delete_old);
495 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure (gpointer src, MonoObject *dst);
498 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure_type (gpointer src, MonoReflectionType *type);
501 ves_icall_System_Runtime_InteropServices_Marshal_OffsetOf (MonoReflectionType *type, MonoString *field_name);
504 ves_icall_System_Runtime_InteropServices_Marshal_StringToBSTR (MonoString *string);
507 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalAnsi (MonoString *string);
510 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalUni (MonoString *string);
513 ves_icall_System_Runtime_InteropServices_Marshal_DestroyStructure (gpointer src, MonoReflectionType *type);
516 ves_icall_System_Runtime_InteropServices_Marshal_AllocCoTaskMem (int size);
519 ves_icall_System_Runtime_InteropServices_Marshal_FreeCoTaskMem (void *ptr);
522 ves_icall_System_Runtime_InteropServices_Marshal_ReAllocCoTaskMem (gpointer ptr, int size);
525 ves_icall_System_Runtime_InteropServices_Marshal_AllocHGlobal (gpointer size);
528 ves_icall_System_Runtime_InteropServices_Marshal_ReAllocHGlobal (gpointer ptr, gpointer size);
531 ves_icall_System_Runtime_InteropServices_Marshal_FreeHGlobal (void *ptr);
534 ves_icall_System_Runtime_InteropServices_Marshal_FreeBSTR (void *ptr);
537 ves_icall_System_Runtime_InteropServices_Marshal_UnsafeAddrOfPinnedArrayElement (MonoArray *arrayobj, int index);
540 ves_icall_System_Runtime_InteropServices_Marshal_GetDelegateForFunctionPointerInternal (void *ftn, MonoReflectionType *type);
543 ves_icall_System_Runtime_InteropServices_Marshal_AddRefInternal (gpointer pUnk);
546 ves_icall_System_Runtime_InteropServices_Marshal_QueryInterfaceInternal (gpointer pUnk, gpointer riid, gpointer* ppv);
549 ves_icall_System_Runtime_InteropServices_Marshal_ReleaseInternal (gpointer pUnk);
552 ves_icall_System_Runtime_InteropServices_Marshal_GetIUnknownForObjectInternal (MonoObject* object);
555 ves_icall_System_Runtime_InteropServices_Marshal_GetObjectForCCW (void* pUnk);
558 ves_icall_System_Runtime_InteropServices_Marshal_GetIDispatchForObjectInternal (MonoObject* object);
561 ves_icall_System_Runtime_InteropServices_Marshal_GetCCW (MonoObject* object, MonoReflectionType* type);
564 ves_icall_System_Runtime_InteropServices_Marshal_IsComObject (MonoObject* object);
567 ves_icall_System_Runtime_InteropServices_Marshal_ReleaseComObjectInternal (MonoObject* object);
570 ves_icall_System_ComObject_CreateRCW (MonoReflectionType *type);
573 ves_icall_System_ComObject_ReleaseInterfaces(MonoComObject* obj);
576 ves_icall_System_ComObject_GetInterfaceInternal (MonoComObject* obj, MonoReflectionType* type, MonoBoolean throw_exception);
579 ves_icall_Mono_Interop_ComInteropProxy_AddProxy (gpointer pUnk, MonoComInteropProxy* proxy);
582 ves_icall_Mono_Interop_ComInteropProxy_FindProxy (gpointer pUnk);
585 mono_win32_compat_CopyMemory (gpointer dest, gconstpointer source, gsize length);
588 mono_win32_compat_FillMemory (gpointer dest, gsize length, guchar fill);
591 mono_win32_compat_MoveMemory (gpointer dest, gconstpointer source, gsize length);
594 mono_win32_compat_ZeroMemory (gpointer dest, gsize length);
597 mono_marshal_find_nonzero_bit_offset (guint8 *buf, int len, int *byte_offset, guint8 *bitmask) MONO_LLVM_INTERNAL;
600 mono_signature_no_pinvoke (MonoMethod *method);
602 /* Called from cominterop.c/remoting.c */
605 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);
608 mono_marshal_emit_managed_wrapper (MonoMethodBuilder *mb, MonoMethodSignature *invoke_sig, MonoMarshalSpec **mspecs, EmitMarshalContext* m, MonoMethod *method, uint32_t target_handle);
611 mono_marshal_get_cache (GHashTable **var, GHashFunc hash_func, GCompareFunc equal_func);
614 mono_marshal_find_in_cache (GHashTable *cache, gpointer key);
617 mono_mb_create_and_cache (GHashTable *cache, gpointer key,
618 MonoMethodBuilder *mb, MonoMethodSignature *sig,
621 mono_marshal_emit_thread_interrupt_checkpoint (MonoMethodBuilder *mb);
624 mono_marshal_emit_thread_force_interrupt_checkpoint (MonoMethodBuilder *mb);
627 mono_marshal_use_aot_wrappers (gboolean use);
630 mono_marshal_xdomain_copy_value (MonoObject *val);
633 mono_mb_emit_save_args (MonoMethodBuilder *mb, MonoMethodSignature *sig, gboolean save_this);
636 mono_mb_emit_restore_result (MonoMethodBuilder *mb, MonoType *return_type);
639 mono_mb_create (MonoMethodBuilder *mb, MonoMethodSignature *sig,
640 int max_stack, WrapperInfo *info);
643 mono_mb_create_and_cache_full (GHashTable *cache, gpointer key,
644 MonoMethodBuilder *mb, MonoMethodSignature *sig,
645 int max_stack, WrapperInfo *info, gboolean *out_found);
649 #endif /* __MONO_MARSHAL_H__ */