/* * marshal.h: Routines for marshaling complex types in P/Invoke methods. * * Author: * Paolo Molaro (lupus@ximian.com) * * (C) 2002 Ximian, Inc. http://www.ximian.com * */ #ifndef __MONO_MARSHAL_H__ #define __MONO_MARSHAL_H__ #include #include #include #include #include #include #define mono_marshal_find_bitfield_offset(type, elem, byte_offset, bitmask) \ do { \ type tmp; \ memset (&tmp, 0, sizeof (tmp)); \ tmp.elem = 1; \ mono_marshal_find_nonzero_bit_offset ((guint8*)&tmp, sizeof (tmp), (byte_offset), (bitmask)); \ } while (0) /* * This structure holds the state kept by the emit_ marshalling functions. * This is exported so it can be used by cominterop.c. */ typedef struct { MonoMethodBuilder *mb; MonoMethodSignature *sig; MonoMethodPInvoke *piinfo; int *orig_conv_args; /* Locals containing the original values of byref args */ int retobj_var; MonoClass *retobj_class; MonoMethodSignature *csig; /* Might need to be changed due to MarshalAs directives */ MonoImage *image; /* The image to use for looking up custom marshallers */ } EmitMarshalContext; typedef enum { /* * This is invoked to convert arguments from the current types to * the underlying types expected by the platform routine. If required, * the methods create a temporary variable with the proper type, and return * the location for it (either the passed argument, or the newly allocated * local slot). */ MARSHAL_ACTION_CONV_IN, /* * This operation is called to push the actual value that was optionally * converted on the first stage */ MARSHAL_ACTION_PUSH, /* * Convert byref arguments back or free resources allocated during the * CONV_IN stage */ MARSHAL_ACTION_CONV_OUT, /* * The result from the unmanaged call is at the top of the stack when * this action is invoked. The result should be stored in the * third local variable slot. */ MARSHAL_ACTION_CONV_RESULT, MARSHAL_ACTION_MANAGED_CONV_IN, MARSHAL_ACTION_MANAGED_CONV_OUT, MARSHAL_ACTION_MANAGED_CONV_RESULT } MarshalAction; /* * This is an extension of the MONO_WRAPPER_ enum to avoid adding more elements to that * enum. */ typedef enum { WRAPPER_SUBTYPE_NONE, /* Subtypes of MONO_WRAPPER_MANAGED_TO_MANAGED */ WRAPPER_SUBTYPE_ELEMENT_ADDR, WRAPPER_SUBTYPE_STRING_CTOR, /* Subtypes of MONO_WRAPPER_STELEMREF */ WRAPPER_SUBTYPE_VIRTUAL_STELEMREF, /* Subtypes of MONO_WRAPPER_UNKNOWN */ WRAPPER_SUBTYPE_FAST_MONITOR_ENTER, WRAPPER_SUBTYPE_FAST_MONITOR_ENTER_V4, WRAPPER_SUBTYPE_FAST_MONITOR_EXIT, WRAPPER_SUBTYPE_PTR_TO_STRUCTURE, WRAPPER_SUBTYPE_STRUCTURE_TO_PTR, /* Subtypes of MONO_WRAPPER_CASTCLASS */ WRAPPER_SUBTYPE_CASTCLASS_WITH_CACHE, WRAPPER_SUBTYPE_ISINST_WITH_CACHE, /* Subtypes of MONO_WRAPPER_RUNTIME_INVOKE */ WRAPPER_SUBTYPE_RUNTIME_INVOKE_NORMAL, WRAPPER_SUBTYPE_RUNTIME_INVOKE_DYNAMIC, WRAPPER_SUBTYPE_RUNTIME_INVOKE_DIRECT, WRAPPER_SUBTYPE_RUNTIME_INVOKE_VIRTUAL, /* Subtypes of MONO_WRAPPER_MANAGED_TO_NATIVE */ WRAPPER_SUBTYPE_ICALL_WRAPPER, WRAPPER_SUBTYPE_NATIVE_FUNC_AOT, /* Subtypes of MONO_WRAPPER_UNKNOWN */ WRAPPER_SUBTYPE_SYNCHRONIZED_INNER, WRAPPER_SUBTYPE_GSHAREDVT_IN, WRAPPER_SUBTYPE_GSHAREDVT_OUT, WRAPPER_SUBTYPE_ARRAY_ACCESSOR, /* Subtypes of MONO_WRAPPER_MANAGED_TO_MANAGED */ WRAPPER_SUBTYPE_GENERIC_ARRAY_HELPER, /* Subtypes of MONO_WRAPPER_DELEGATE_INVOKE */ WRAPPER_SUBTYPE_DELEGATE_INVOKE_VIRTUAL, WRAPPER_SUBTYPE_DELEGATE_INVOKE_BOUND } WrapperSubtype; typedef struct { MonoMethod *method; MonoClass *klass; } NativeToManagedWrapperInfo; typedef struct { MonoMethod *method; } StringCtorWrapperInfo; typedef struct { int kind; } VirtualStelemrefWrapperInfo; typedef struct { guint32 rank, elem_size; } ElementAddrWrapperInfo; typedef struct { MonoMethod *method; /* For WRAPPER_SUBTYPE_RUNTIME_INVOKE_NORMAL */ MonoMethodSignature *sig; } RuntimeInvokeWrapperInfo; typedef struct { MonoMethod *method; } ManagedToNativeWrapperInfo; typedef struct { MonoMethod *method; } SynchronizedInnerWrapperInfo; typedef struct { MonoMethod *method; } GenericArrayHelperWrapperInfo; typedef struct { gpointer func; } ICallWrapperInfo; typedef struct { MonoMethod *method; } ArrayAccessorWrapperInfo; /* * This structure contains additional information to uniquely identify a given wrapper * method. It can be retrieved by mono_marshal_get_wrapper_info () for certain types * of wrappers, i.e. ones which do not have a 1-1 association with a method/class. */ typedef struct { WrapperSubtype subtype; union { /* RUNTIME_INVOKE_... */ RuntimeInvokeWrapperInfo runtime_invoke; /* STRING_CTOR */ StringCtorWrapperInfo string_ctor; /* ELEMENT_ADDR */ ElementAddrWrapperInfo element_addr; /* VIRTUAL_STELEMREF */ VirtualStelemrefWrapperInfo virtual_stelemref; /* MONO_WRAPPER_NATIVE_TO_MANAGED */ NativeToManagedWrapperInfo native_to_managed; /* MONO_WRAPPER_MANAGED_TO_NATIVE */ ManagedToNativeWrapperInfo managed_to_native; /* SYNCHRONIZED_INNER */ SynchronizedInnerWrapperInfo synchronized_inner; /* GENERIC_ARRAY_HELPER */ GenericArrayHelperWrapperInfo generic_array_helper; /* ICALL_WRAPPER */ ICallWrapperInfo icall; /* ARRAY_ACCESSOR */ ArrayAccessorWrapperInfo array_accessor; } d; } WrapperInfo; G_BEGIN_DECLS /*type of the function pointer of methods returned by mono_marshal_get_runtime_invoke*/ typedef MonoObject *(*RuntimeInvokeFunction) (MonoObject *this, void **params, MonoObject **exc, void* compiled_method); typedef void (*RuntimeInvokeDynamicFunction) (void *args, MonoObject **exc, void* compiled_method); /* marshaling helper functions */ void mono_marshal_init (void) MONO_INTERNAL; void mono_marshal_init_tls (void) MONO_INTERNAL; void mono_marshal_cleanup (void) MONO_INTERNAL; gint32 mono_class_native_size (MonoClass *klass, guint32 *align) MONO_INTERNAL; MonoMarshalType * mono_marshal_load_type_info (MonoClass* klass) MONO_INTERNAL; gint32 mono_marshal_type_size (MonoType *type, MonoMarshalSpec *mspec, guint32 *align, gboolean as_field, gboolean unicode) MONO_INTERNAL; int mono_type_native_stack_size (MonoType *type, guint32 *alignment) MONO_INTERNAL; gpointer mono_array_to_savearray (MonoArray *array) MONO_INTERNAL; gpointer mono_array_to_lparray (MonoArray *array) MONO_INTERNAL; void mono_free_lparray (MonoArray *array, gpointer* nativeArray) MONO_INTERNAL; void mono_string_utf8_to_builder (MonoStringBuilder *sb, char *text) MONO_INTERNAL; void mono_string_utf16_to_builder (MonoStringBuilder *sb, gunichar2 *text) MONO_INTERNAL; gpointer mono_string_builder_to_utf8 (MonoStringBuilder *sb) MONO_INTERNAL; gpointer mono_string_builder_to_utf16 (MonoStringBuilder *sb) MONO_INTERNAL; gpointer mono_string_to_ansibstr (MonoString *string_obj) MONO_INTERNAL; gpointer mono_string_to_bstr (MonoString *string_obj) MONO_INTERNAL; void mono_string_to_byvalstr (gpointer dst, MonoString *src, int size) MONO_INTERNAL; void mono_string_to_byvalwstr (gpointer dst, MonoString *src, int size) MONO_INTERNAL; gpointer mono_delegate_to_ftnptr (MonoDelegate *delegate) MONO_INTERNAL; MonoDelegate* mono_ftnptr_to_delegate (MonoClass *klass, gpointer ftn) MONO_INTERNAL; void mono_delegate_free_ftnptr (MonoDelegate *delegate) MONO_INTERNAL; void mono_marshal_set_last_error (void) MONO_INTERNAL; gpointer mono_marshal_asany (MonoObject *obj, MonoMarshalNative string_encoding, int param_attrs) MONO_INTERNAL; void mono_marshal_free_asany (MonoObject *o, gpointer ptr, MonoMarshalNative string_encoding, int param_attrs) MONO_INTERNAL; guint mono_type_to_ldind (MonoType *type) MONO_INTERNAL; guint mono_type_to_stind (MonoType *type) MONO_INTERNAL; /* functions to create various architecture independent helper functions */ MonoMethod * mono_marshal_method_from_wrapper (MonoMethod *wrapper) MONO_INTERNAL; void mono_marshal_set_wrapper_info (MonoMethod *method, gpointer data) MONO_INTERNAL; gpointer mono_marshal_get_wrapper_info (MonoMethod *wrapper) MONO_INTERNAL; MonoMethod * mono_marshal_get_delegate_begin_invoke (MonoMethod *method) MONO_INTERNAL; MonoMethod * mono_marshal_get_delegate_end_invoke (MonoMethod *method) MONO_INTERNAL; MonoMethod * mono_marshal_get_delegate_invoke (MonoMethod *method, MonoDelegate *del) MONO_INTERNAL; MonoMethod * mono_marshal_get_runtime_invoke (MonoMethod *method, gboolean virtual) MONO_INTERNAL; MonoMethod* mono_marshal_get_runtime_invoke_dynamic (void) MONO_INTERNAL; MonoMethodSignature* mono_marshal_get_string_ctor_signature (MonoMethod *method) MONO_INTERNAL; MonoMethod * mono_marshal_get_managed_wrapper (MonoMethod *method, MonoClass *delegate_klass, uint32_t this_loc) MONO_INTERNAL; gpointer mono_marshal_get_vtfixup_ftnptr (MonoImage *image, guint32 token, guint16 type) MONO_INTERNAL; MonoMethod * mono_marshal_get_icall_wrapper (MonoMethodSignature *sig, const char *name, gconstpointer func, gboolean check_exceptions) MONO_INTERNAL; MonoMethod * mono_marshal_get_native_wrapper (MonoMethod *method, gboolean check_exceptions, gboolean aot) MONO_INTERNAL; MonoMethod * mono_marshal_get_native_func_wrapper (MonoImage *image, MonoMethodSignature *sig, MonoMethodPInvoke *piinfo, MonoMarshalSpec **mspecs, gpointer func) MONO_INTERNAL; MonoMethod* mono_marshal_get_native_func_wrapper_aot (MonoClass *klass) MONO_INTERNAL; MonoMethod * mono_marshal_get_struct_to_ptr (MonoClass *klass) MONO_INTERNAL; MonoMethod * mono_marshal_get_ptr_to_struct (MonoClass *klass) MONO_INTERNAL; MonoMethod * mono_marshal_get_synchronized_wrapper (MonoMethod *method) MONO_INTERNAL; MonoMethod * mono_marshal_get_synchronized_inner_wrapper (MonoMethod *method) MONO_INTERNAL; MonoMethod * mono_marshal_get_unbox_wrapper (MonoMethod *method) MONO_INTERNAL; MonoMethod * mono_marshal_get_castclass_with_cache (void) MONO_INTERNAL; MonoMethod * mono_marshal_get_isinst_with_cache (void) MONO_INTERNAL; MonoMethod * mono_marshal_get_isinst (MonoClass *klass) MONO_INTERNAL; MonoMethod * mono_marshal_get_castclass (MonoClass *klass) MONO_INTERNAL; MonoMethod * mono_marshal_get_stelemref (void) MONO_INTERNAL; MonoMethod* mono_marshal_get_virtual_stelemref (MonoClass *array_class) MONO_INTERNAL; MonoMethod** mono_marshal_get_virtual_stelemref_wrappers (int *nwrappers) MONO_INTERNAL; MonoMethod* mono_marshal_get_array_address (int rank, int elem_size) MONO_INTERNAL; MonoMethod * mono_marshal_get_array_accessor_wrapper (MonoMethod *method) MONO_INTERNAL; MonoMethod * mono_marshal_get_generic_array_helper (MonoClass *class, MonoClass *iface, gchar *name, MonoMethod *method) MONO_INTERNAL; MonoMethod * mono_marshal_get_thunk_invoke_wrapper (MonoMethod *method) MONO_INTERNAL; MonoMethod* mono_marshal_get_gsharedvt_in_wrapper (void) MONO_INTERNAL; MonoMethod* mono_marshal_get_gsharedvt_out_wrapper (void) MONO_INTERNAL; void mono_marshal_free_dynamic_wrappers (MonoMethod *method) MONO_INTERNAL; void mono_marshal_free_inflated_wrappers (MonoMethod *method) MONO_INTERNAL; /* marshaling internal calls */ void * mono_marshal_alloc (gulong size) MONO_INTERNAL; void mono_marshal_free (gpointer ptr) MONO_INTERNAL; void mono_marshal_free_array (gpointer *ptr, int size) MONO_INTERNAL; gboolean mono_marshal_free_ccw (MonoObject* obj) MONO_INTERNAL; void cominterop_release_all_rcws (void) MONO_INTERNAL; void ves_icall_System_Runtime_InteropServices_Marshal_copy_to_unmanaged (MonoArray *src, gint32 start_index, gpointer dest, gint32 length) MONO_INTERNAL; void ves_icall_System_Runtime_InteropServices_Marshal_copy_from_unmanaged (gpointer src, gint32 start_index, MonoArray *dest, gint32 length) MONO_INTERNAL; MonoString * ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi (char *ptr) MONO_INTERNAL; MonoString * ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi_len (char *ptr, gint32 len) MONO_INTERNAL; MonoString * ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni (guint16 *ptr) MONO_INTERNAL; MonoString * ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni_len (guint16 *ptr, gint32 len) MONO_INTERNAL; MonoString * ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringBSTR (gpointer ptr) MONO_INTERNAL; guint32 ves_icall_System_Runtime_InteropServices_Marshal_GetComSlotForMethodInfoInternal (MonoReflectionMethod *m) MONO_INTERNAL; guint32 ves_icall_System_Runtime_InteropServices_Marshal_GetLastWin32Error (void) MONO_INTERNAL; guint32 ves_icall_System_Runtime_InteropServices_Marshal_SizeOf (MonoReflectionType *rtype) MONO_INTERNAL; void ves_icall_System_Runtime_InteropServices_Marshal_StructureToPtr (MonoObject *obj, gpointer dst, MonoBoolean delete_old) MONO_INTERNAL; void ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure (gpointer src, MonoObject *dst) MONO_INTERNAL; MonoObject * ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure_type (gpointer src, MonoReflectionType *type) MONO_INTERNAL; int ves_icall_System_Runtime_InteropServices_Marshal_OffsetOf (MonoReflectionType *type, MonoString *field_name) MONO_INTERNAL; gpointer ves_icall_System_Runtime_InteropServices_Marshal_StringToBSTR (MonoString *string) MONO_INTERNAL; gpointer ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalAnsi (MonoString *string) MONO_INTERNAL; gpointer ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalUni (MonoString *string) MONO_INTERNAL; void ves_icall_System_Runtime_InteropServices_Marshal_DestroyStructure (gpointer src, MonoReflectionType *type) MONO_INTERNAL; void* ves_icall_System_Runtime_InteropServices_Marshal_AllocCoTaskMem (int size) MONO_INTERNAL; void ves_icall_System_Runtime_InteropServices_Marshal_FreeCoTaskMem (void *ptr) MONO_INTERNAL; gpointer ves_icall_System_Runtime_InteropServices_Marshal_ReAllocCoTaskMem (gpointer ptr, int size) MONO_INTERNAL; void* ves_icall_System_Runtime_InteropServices_Marshal_AllocHGlobal (int size) MONO_INTERNAL; gpointer ves_icall_System_Runtime_InteropServices_Marshal_ReAllocHGlobal (gpointer ptr, int size) MONO_INTERNAL; void ves_icall_System_Runtime_InteropServices_Marshal_FreeHGlobal (void *ptr) MONO_INTERNAL; void ves_icall_System_Runtime_InteropServices_Marshal_FreeBSTR (void *ptr) MONO_INTERNAL; void* ves_icall_System_Runtime_InteropServices_Marshal_UnsafeAddrOfPinnedArrayElement (MonoArray *arrayobj, int index) MONO_INTERNAL; MonoDelegate* ves_icall_System_Runtime_InteropServices_Marshal_GetDelegateForFunctionPointerInternal (void *ftn, MonoReflectionType *type) MONO_INTERNAL; int ves_icall_System_Runtime_InteropServices_Marshal_AddRefInternal (gpointer pUnk) MONO_INTERNAL; int ves_icall_System_Runtime_InteropServices_Marshal_QueryInterfaceInternal (gpointer pUnk, gpointer riid, gpointer* ppv) MONO_INTERNAL; int ves_icall_System_Runtime_InteropServices_Marshal_ReleaseInternal (gpointer pUnk) MONO_INTERNAL; void* ves_icall_System_Runtime_InteropServices_Marshal_GetIUnknownForObjectInternal (MonoObject* object) MONO_INTERNAL; MonoObject* ves_icall_System_Runtime_InteropServices_Marshal_GetObjectForCCW (void* pUnk) MONO_INTERNAL; void* ves_icall_System_Runtime_InteropServices_Marshal_GetIDispatchForObjectInternal (MonoObject* object) MONO_INTERNAL; void* ves_icall_System_Runtime_InteropServices_Marshal_GetCCW (MonoObject* object, MonoReflectionType* type) MONO_INTERNAL; MonoBoolean ves_icall_System_Runtime_InteropServices_Marshal_IsComObject (MonoObject* object) MONO_INTERNAL; gint32 ves_icall_System_Runtime_InteropServices_Marshal_ReleaseComObjectInternal (MonoObject* object) MONO_INTERNAL; MonoObject * ves_icall_System_ComObject_CreateRCW (MonoReflectionType *type) MONO_INTERNAL; void ves_icall_System_ComObject_ReleaseInterfaces(MonoComObject* obj) MONO_INTERNAL; gpointer ves_icall_System_ComObject_GetInterfaceInternal (MonoComObject* obj, MonoReflectionType* type, MonoBoolean throw_exception) MONO_INTERNAL; void ves_icall_Mono_Interop_ComInteropProxy_AddProxy (gpointer pUnk, MonoComInteropProxy* proxy) MONO_INTERNAL; MonoComInteropProxy* ves_icall_Mono_Interop_ComInteropProxy_FindProxy (gpointer pUnk) MONO_INTERNAL; MONO_API void mono_win32_compat_CopyMemory (gpointer dest, gconstpointer source, gsize length); MONO_API void mono_win32_compat_FillMemory (gpointer dest, gsize length, guchar fill); MONO_API void mono_win32_compat_MoveMemory (gpointer dest, gconstpointer source, gsize length); MONO_API void mono_win32_compat_ZeroMemory (gpointer dest, gsize length); void mono_marshal_find_nonzero_bit_offset (guint8 *buf, int len, int *byte_offset, guint8 *bitmask) MONO_INTERNAL; MonoMethodSignature* mono_signature_no_pinvoke (MonoMethod *method) MONO_INTERNAL; /* Called from cominterop.c */ void 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; void mono_marshal_emit_managed_wrapper (MonoMethodBuilder *mb, MonoMethodSignature *invoke_sig, MonoMarshalSpec **mspecs, EmitMarshalContext* m, MonoMethod *method, uint32_t target_handle) MONO_INTERNAL; GHashTable* mono_marshal_get_cache (GHashTable **var, GHashFunc hash_func, GCompareFunc equal_func) MONO_INTERNAL; MonoMethod* mono_marshal_find_in_cache (GHashTable *cache, gpointer key) MONO_INTERNAL; MonoMethod* mono_mb_create_and_cache (GHashTable *cache, gpointer key, MonoMethodBuilder *mb, MonoMethodSignature *sig, int max_stack) MONO_INTERNAL; void mono_marshal_emit_thread_interrupt_checkpoint (MonoMethodBuilder *mb) MONO_INTERNAL; void mono_marshal_use_aot_wrappers (gboolean use) MONO_INTERNAL; MonoObject * mono_marshal_xdomain_copy_value (MonoObject *val) MONO_INTERNAL; #ifndef DISABLE_REMOTING MonoMethod * mono_marshal_get_remoting_invoke (MonoMethod *method) MONO_INTERNAL; MonoMethod * mono_marshal_get_xappdomain_invoke (MonoMethod *method) MONO_INTERNAL; MonoMethod * mono_marshal_get_remoting_invoke_for_target (MonoMethod *method, MonoRemotingTarget target_type) MONO_INTERNAL; MonoMethod * mono_marshal_get_remoting_invoke_with_check (MonoMethod *method) MONO_INTERNAL; MonoMethod * mono_marshal_get_stfld_wrapper (MonoType *type) MONO_INTERNAL; MonoMethod * mono_marshal_get_ldfld_wrapper (MonoType *type) MONO_INTERNAL; MonoMethod * mono_marshal_get_ldflda_wrapper (MonoType *type) MONO_INTERNAL; MonoMethod * mono_marshal_get_ldfld_remote_wrapper (MonoClass *klass) MONO_INTERNAL; MonoMethod * mono_marshal_get_stfld_remote_wrapper (MonoClass *klass) MONO_INTERNAL; MonoMethod * mono_marshal_get_proxy_cancast (MonoClass *klass) MONO_INTERNAL; #endif G_END_DECLS #endif /* __MONO_MARSHAL_H__ */