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_DYNAMIC,
101 WRAPPER_SUBTYPE_RUNTIME_INVOKE_DIRECT,
102 WRAPPER_SUBTYPE_RUNTIME_INVOKE_VIRTUAL,
103 /* Subtypes of MONO_WRAPPER_MANAGED_TO_NATIVE */
104 WRAPPER_SUBTYPE_ICALL_WRAPPER
110 } NativeToManagedWrapperInfo;
114 } StringCtorWrapperInfo;
118 } VirtualStelemrefWrapperInfo;
121 guint32 rank, elem_size;
122 } ElementAddrWrapperInfo;
126 } RuntimeInvokeWrapperInfo;
130 } ManagedToNativeWrapperInfo;
133 * This structure contains additional information to uniquely identify a given wrapper
134 * method. It can be retrieved by mono_marshal_get_wrapper_info () for certain types
135 * of wrappers, i.e. ones which do not have a 1-1 association with a method/class.
138 WrapperSubtype subtype;
140 /* RUNTIME_INVOKE_... */
141 RuntimeInvokeWrapperInfo runtime_invoke;
143 StringCtorWrapperInfo string_ctor;
145 ElementAddrWrapperInfo element_addr;
146 /* VIRTUAL_STELEMREF */
147 VirtualStelemrefWrapperInfo virtual_stelemref;
148 /* MONO_WRAPPER_NATIVE_TO_MANAGED */
149 NativeToManagedWrapperInfo native_to_managed;
150 /* MONO_WRAPPER_MANAGED_TO_NATIVE */
151 ManagedToNativeWrapperInfo managed_to_native;
157 /*type of the function pointer of methods returned by mono_marshal_get_runtime_invoke*/
158 typedef MonoObject *(*RuntimeInvokeFunction) (MonoObject *this, void **params, MonoObject **exc, void* compiled_method);
160 typedef void (*RuntimeInvokeDynamicFunction) (void *args, MonoObject **exc, void* compiled_method);
162 /* marshaling helper functions */
165 mono_marshal_init (void) MONO_INTERNAL;
168 mono_marshal_cleanup (void) MONO_INTERNAL;
171 mono_class_native_size (MonoClass *klass, guint32 *align) MONO_INTERNAL;
174 mono_marshal_load_type_info (MonoClass* klass) MONO_INTERNAL;
177 mono_marshal_type_size (MonoType *type, MonoMarshalSpec *mspec, guint32 *align,
178 gboolean as_field, gboolean unicode) MONO_INTERNAL;
181 mono_type_native_stack_size (MonoType *type, guint32 *alignment) MONO_INTERNAL;
184 mono_array_to_savearray (MonoArray *array) MONO_INTERNAL;
187 mono_array_to_lparray (MonoArray *array) MONO_INTERNAL;
190 mono_free_lparray (MonoArray *array, gpointer* nativeArray) MONO_INTERNAL;
193 mono_string_utf8_to_builder (MonoStringBuilder *sb, char *text) MONO_INTERNAL;
196 mono_string_utf16_to_builder (MonoStringBuilder *sb, gunichar2 *text) MONO_INTERNAL;
199 mono_string_builder_to_utf8 (MonoStringBuilder *sb) MONO_INTERNAL;
202 mono_string_builder_to_utf16 (MonoStringBuilder *sb) MONO_INTERNAL;
205 mono_string_to_ansibstr (MonoString *string_obj) MONO_INTERNAL;
208 mono_string_to_bstr (MonoString *string_obj) MONO_INTERNAL;
211 mono_string_to_byvalstr (gpointer dst, MonoString *src, int size) MONO_INTERNAL;
214 mono_string_to_byvalwstr (gpointer dst, MonoString *src, int size) MONO_INTERNAL;
217 mono_delegate_to_ftnptr (MonoDelegate *delegate) MONO_INTERNAL;
220 mono_ftnptr_to_delegate (MonoClass *klass, gpointer ftn) MONO_INTERNAL;
222 void mono_delegate_free_ftnptr (MonoDelegate *delegate) MONO_INTERNAL;
225 mono_marshal_set_last_error (void) MONO_INTERNAL;
228 mono_marshal_asany (MonoObject *obj, MonoMarshalNative string_encoding, int param_attrs) MONO_INTERNAL;
231 mono_marshal_free_asany (MonoObject *o, gpointer ptr, MonoMarshalNative string_encoding, int param_attrs) MONO_INTERNAL;
234 mono_type_to_ldind (MonoType *type) MONO_INTERNAL;
237 mono_type_to_stind (MonoType *type) MONO_INTERNAL;
239 /* functions to create various architecture independent helper functions */
242 mono_marshal_method_from_wrapper (MonoMethod *wrapper) MONO_INTERNAL;
245 mono_marshal_set_wrapper_info (MonoMethod *method, gpointer data) MONO_INTERNAL;
248 mono_marshal_get_wrapper_info (MonoMethod *wrapper) MONO_INTERNAL;
251 mono_marshal_get_remoting_invoke (MonoMethod *method) MONO_INTERNAL;
254 mono_marshal_get_xappdomain_invoke (MonoMethod *method) MONO_INTERNAL;
257 mono_marshal_get_remoting_invoke_for_target (MonoMethod *method, MonoRemotingTarget target_type) MONO_INTERNAL;
260 mono_marshal_get_remoting_invoke_with_check (MonoMethod *method) MONO_INTERNAL;
263 mono_marshal_get_delegate_begin_invoke (MonoMethod *method) MONO_INTERNAL;
266 mono_marshal_get_delegate_end_invoke (MonoMethod *method) MONO_INTERNAL;
269 mono_marshal_get_delegate_invoke (MonoMethod *method, MonoDelegate *del) MONO_INTERNAL;
272 mono_marshal_get_runtime_invoke (MonoMethod *method, gboolean virtual) MONO_INTERNAL;
275 mono_marshal_get_runtime_invoke_dynamic (void) MONO_INTERNAL;
278 mono_marshal_get_string_ctor_signature (MonoMethod *method) MONO_INTERNAL;
281 mono_marshal_get_managed_wrapper (MonoMethod *method, MonoClass *delegate_klass, uint32_t this_loc) MONO_INTERNAL;
284 mono_marshal_get_vtfixup_ftnptr (MonoImage *image, guint32 token, guint16 type) MONO_INTERNAL;
287 mono_marshal_get_icall_wrapper (MonoMethodSignature *sig, const char *name, gconstpointer func, gboolean check_exceptions) MONO_INTERNAL;
290 mono_marshal_get_native_wrapper (MonoMethod *method, gboolean check_exceptions, gboolean aot) MONO_INTERNAL;
293 mono_marshal_get_native_func_wrapper (MonoImage *image, MonoMethodSignature *sig, MonoMethodPInvoke *piinfo, MonoMarshalSpec **mspecs, gpointer func) MONO_INTERNAL;
296 mono_marshal_get_struct_to_ptr (MonoClass *klass) MONO_INTERNAL;
299 mono_marshal_get_ptr_to_struct (MonoClass *klass) MONO_INTERNAL;
302 mono_marshal_get_stfld_wrapper (MonoType *type) MONO_INTERNAL;
305 mono_marshal_get_ldfld_wrapper (MonoType *type) MONO_INTERNAL;
308 mono_marshal_get_ldflda_wrapper (MonoType *type) MONO_INTERNAL;
311 mono_marshal_get_ldfld_remote_wrapper (MonoClass *klass) MONO_INTERNAL;
314 mono_marshal_get_stfld_remote_wrapper (MonoClass *klass) MONO_INTERNAL;
317 mono_marshal_get_synchronized_wrapper (MonoMethod *method) MONO_INTERNAL;
320 mono_marshal_get_unbox_wrapper (MonoMethod *method) MONO_INTERNAL;
323 mono_marshal_get_castclass_with_cache (void) MONO_INTERNAL;
326 mono_marshal_get_isinst_with_cache (void) MONO_INTERNAL;
329 mono_marshal_get_isinst (MonoClass *klass) MONO_INTERNAL;
332 mono_marshal_get_castclass (MonoClass *klass) MONO_INTERNAL;
335 mono_marshal_get_proxy_cancast (MonoClass *klass) MONO_INTERNAL;
338 mono_marshal_get_stelemref (void) MONO_INTERNAL;
341 mono_marshal_get_virtual_stelemref (MonoClass *array_class) MONO_INTERNAL;
344 mono_marshal_get_array_address (int rank, int elem_size) MONO_INTERNAL;
347 mono_marshal_get_generic_array_helper (MonoClass *class, MonoClass *iface,
348 gchar *name, MonoMethod *method) MONO_INTERNAL;
351 mono_marshal_get_thunk_invoke_wrapper (MonoMethod *method) MONO_INTERNAL;
354 mono_marshal_free_dynamic_wrappers (MonoMethod *method) MONO_INTERNAL;
357 mono_marshal_free_inflated_wrappers (MonoMethod *method) MONO_INTERNAL;
359 /* marshaling internal calls */
362 mono_marshal_alloc (gulong size) MONO_INTERNAL;
365 mono_marshal_free (gpointer ptr) MONO_INTERNAL;
368 mono_marshal_free_array (gpointer *ptr, int size) MONO_INTERNAL;
371 mono_marshal_free_ccw (MonoObject* obj) MONO_INTERNAL;
374 mono_marshal_xdomain_copy_value (MonoObject *val) MONO_INTERNAL;
377 cominterop_release_all_rcws (void) MONO_INTERNAL;
380 ves_icall_System_Runtime_InteropServices_Marshal_copy_to_unmanaged (MonoArray *src, gint32 start_index,
381 gpointer dest, gint32 length) MONO_INTERNAL;
384 ves_icall_System_Runtime_InteropServices_Marshal_copy_from_unmanaged (gpointer src, gint32 start_index,
385 MonoArray *dest, gint32 length) MONO_INTERNAL;
388 ves_icall_System_Runtime_InteropServices_Marshal_ReadIntPtr (gpointer ptr, gint32 offset) MONO_INTERNAL;
391 ves_icall_System_Runtime_InteropServices_Marshal_ReadByte (gpointer ptr, gint32 offset) MONO_INTERNAL;
394 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt16 (gpointer ptr, gint32 offset) MONO_INTERNAL;
397 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt32 (gpointer ptr, gint32 offset) MONO_INTERNAL;
400 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt64 (gpointer ptr, gint32 offset) MONO_INTERNAL;
403 ves_icall_System_Runtime_InteropServices_Marshal_WriteByte (gpointer ptr, gint32 offset, unsigned char val) MONO_INTERNAL;
406 ves_icall_System_Runtime_InteropServices_Marshal_WriteIntPtr (gpointer ptr, gint32 offset, gpointer val) MONO_INTERNAL;
409 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt16 (gpointer ptr, gint32 offset, gint16 val) MONO_INTERNAL;
412 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt32 (gpointer ptr, gint32 offset, gint32 val) MONO_INTERNAL;
415 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt64 (gpointer ptr, gint32 offset, gint64 val) MONO_INTERNAL;
418 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi (char *ptr) MONO_INTERNAL;
421 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi_len (char *ptr, gint32 len) MONO_INTERNAL;
424 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni (guint16 *ptr) MONO_INTERNAL;
427 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni_len (guint16 *ptr, gint32 len) MONO_INTERNAL;
430 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringBSTR (gpointer ptr) MONO_INTERNAL;
433 ves_icall_System_Runtime_InteropServices_Marshal_GetComSlotForMethodInfoInternal (MonoReflectionMethod *m) MONO_INTERNAL;
436 ves_icall_System_Runtime_InteropServices_Marshal_GetLastWin32Error (void) MONO_INTERNAL;
439 ves_icall_System_Runtime_InteropServices_Marshal_SizeOf (MonoReflectionType *rtype) MONO_INTERNAL;
442 ves_icall_System_Runtime_InteropServices_Marshal_StructureToPtr (MonoObject *obj, gpointer dst, MonoBoolean delete_old) MONO_INTERNAL;
445 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure (gpointer src, MonoObject *dst) MONO_INTERNAL;
448 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure_type (gpointer src, MonoReflectionType *type) MONO_INTERNAL;
451 ves_icall_System_Runtime_InteropServices_Marshal_OffsetOf (MonoReflectionType *type, MonoString *field_name) MONO_INTERNAL;
454 ves_icall_System_Runtime_InteropServices_Marshal_StringToBSTR (MonoString *string) MONO_INTERNAL;
457 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalAnsi (MonoString *string) MONO_INTERNAL;
460 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalUni (MonoString *string) MONO_INTERNAL;
463 ves_icall_System_Runtime_InteropServices_Marshal_DestroyStructure (gpointer src, MonoReflectionType *type) MONO_INTERNAL;
466 ves_icall_System_Runtime_InteropServices_Marshal_AllocCoTaskMem (int size) MONO_INTERNAL;
469 ves_icall_System_Runtime_InteropServices_Marshal_FreeCoTaskMem (void *ptr) MONO_INTERNAL;
472 ves_icall_System_Runtime_InteropServices_Marshal_ReAllocCoTaskMem (gpointer ptr, int size) MONO_INTERNAL;
475 ves_icall_System_Runtime_InteropServices_Marshal_AllocHGlobal (int size) MONO_INTERNAL;
478 ves_icall_System_Runtime_InteropServices_Marshal_ReAllocHGlobal (gpointer ptr, int size) MONO_INTERNAL;
481 ves_icall_System_Runtime_InteropServices_Marshal_FreeHGlobal (void *ptr) MONO_INTERNAL;
484 ves_icall_System_Runtime_InteropServices_Marshal_FreeBSTR (void *ptr) MONO_INTERNAL;
487 ves_icall_System_Runtime_InteropServices_Marshal_UnsafeAddrOfPinnedArrayElement (MonoArray *arrayobj, int index) MONO_INTERNAL;
490 ves_icall_System_Runtime_InteropServices_Marshal_GetDelegateForFunctionPointerInternal (void *ftn, MonoReflectionType *type) MONO_INTERNAL;
493 ves_icall_System_Runtime_InteropServices_Marshal_AddRefInternal (gpointer pUnk) MONO_INTERNAL;
496 ves_icall_System_Runtime_InteropServices_Marshal_QueryInterfaceInternal (gpointer pUnk, gpointer riid, gpointer* ppv) MONO_INTERNAL;
499 ves_icall_System_Runtime_InteropServices_Marshal_ReleaseInternal (gpointer pUnk) MONO_INTERNAL;
502 ves_icall_System_Runtime_InteropServices_Marshal_GetIUnknownForObjectInternal (MonoObject* object) MONO_INTERNAL;
505 ves_icall_System_Runtime_InteropServices_Marshal_GetObjectForCCW (void* pUnk) MONO_INTERNAL;
508 ves_icall_System_Runtime_InteropServices_Marshal_GetIDispatchForObjectInternal (MonoObject* object) MONO_INTERNAL;
511 ves_icall_System_Runtime_InteropServices_Marshal_GetCCW (MonoObject* object, MonoReflectionType* type) MONO_INTERNAL;
514 ves_icall_System_Runtime_InteropServices_Marshal_IsComObject (MonoObject* object) MONO_INTERNAL;
517 ves_icall_System_Runtime_InteropServices_Marshal_ReleaseComObjectInternal (MonoObject* object) MONO_INTERNAL;
520 ves_icall_System_ComObject_CreateRCW (MonoReflectionType *type) MONO_INTERNAL;
523 ves_icall_System_ComObject_ReleaseInterfaces(MonoComObject* obj) MONO_INTERNAL;
526 ves_icall_System_ComObject_GetInterfaceInternal (MonoComObject* obj, MonoReflectionType* type, MonoBoolean throw_exception) MONO_INTERNAL;
529 ves_icall_Mono_Interop_ComInteropProxy_AddProxy (gpointer pUnk, MonoComInteropProxy* proxy) MONO_INTERNAL;
532 ves_icall_Mono_Interop_ComInteropProxy_FindProxy (gpointer pUnk) MONO_INTERNAL;
535 mono_win32_compat_CopyMemory (gpointer dest, gconstpointer source, gsize length);
538 mono_win32_compat_FillMemory (gpointer dest, gsize length, guchar fill);
541 mono_win32_compat_MoveMemory (gpointer dest, gconstpointer source, gsize length);
544 mono_win32_compat_ZeroMemory (gpointer dest, gsize length);
547 mono_marshal_find_nonzero_bit_offset (guint8 *buf, int len, int *byte_offset, guint8 *bitmask) MONO_INTERNAL;
550 mono_signature_no_pinvoke (MonoMethod *method) MONO_INTERNAL;
552 /* Called from cominterop.c */
555 mono_marshal_emit_native_wrapper (MonoImage *image, MonoMethodBuilder *mb, MonoMethodSignature *sig, MonoMethodPInvoke *piinfo, MonoMarshalSpec **mspecs, gpointer func, gboolean aot, gboolean check_exceptions) MONO_INTERNAL;
558 mono_marshal_emit_managed_wrapper (MonoMethodBuilder *mb, MonoMethodSignature *invoke_sig, MonoMarshalSpec **mspecs, EmitMarshalContext* m, MonoMethod *method, uint32_t target_handle) MONO_INTERNAL;
561 mono_marshal_get_cache (GHashTable **var, GHashFunc hash_func, GCompareFunc equal_func) MONO_INTERNAL;
564 mono_marshal_find_in_cache (GHashTable *cache, gpointer key) MONO_INTERNAL;
567 mono_mb_create_and_cache (GHashTable *cache, gpointer key,
568 MonoMethodBuilder *mb, MonoMethodSignature *sig,
569 int max_stack) MONO_INTERNAL;
571 mono_marshal_emit_thread_interrupt_checkpoint (MonoMethodBuilder *mb) MONO_INTERNAL;
575 #endif /* __MONO_MARSHAL_H__ */