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.h>
17 #include <mono/metadata/opcodes.h>
18 #include <mono/metadata/reflection.h>
20 typedef struct _MonoMethodBuilder MonoMethodBuilder;
22 /* marshaling helper functions */
25 mono_marshal_init (void);
28 mono_class_native_size (MonoClass *klass, guint32 *align);
31 mono_marshal_load_type_info (MonoClass* klass);
34 mono_marshal_type_size (MonoType *type, MonoMarshalSpec *mspec, gint32 *align,
35 gboolean as_field, gboolean unicode);
38 mono_type_native_stack_size (MonoType *type, int *alignment);
41 mono_array_to_savearray (MonoArray *array);
44 mono_array_to_lparray (MonoArray *array);
47 mono_string_utf8_to_builder (MonoStringBuilder *sb, char *text);
50 mono_string_utf16_to_builder (MonoStringBuilder *sb, gunichar2 *text);
53 mono_string_builder_to_utf8 (MonoStringBuilder *sb);
56 mono_string_builder_to_utf16 (MonoStringBuilder *sb);
59 mono_string_to_ansibstr (MonoString *string_obj);
62 mono_string_to_bstr (MonoString *string_obj);
65 mono_string_to_byvalstr (gpointer dst, MonoString *src, int size);
68 mono_string_to_byvalwstr (gpointer dst, MonoString *src, int size);
71 mono_delegate_to_ftnptr (MonoDelegate *delegate);
74 mono_ftnptr_to_delegate (MonoClass *klass, gpointer ftn);
77 mono_marshal_string_array (MonoArray *array);
80 mono_marshal_string_array_to_unicode (MonoArray *array);
83 mono_marshal_set_last_error (void);
86 mono_marshal_asany (MonoObject *obj, MonoMarshalNative string_encoding);
89 mono_marshal_free_asany (MonoObject *o, gpointer ptr, MonoMarshalNative string_encoding);
91 /* method builder functions */
94 mono_mb_free (MonoMethodBuilder *mb);
97 mono_mb_new (MonoClass *klass, const char *name, MonoWrapperType type);
100 mono_mb_patch_addr (MonoMethodBuilder *mb, int pos, int value);
103 mono_mb_patch_addr_s (MonoMethodBuilder *mb, int pos, gint8 value);
106 mono_mb_add_data (MonoMethodBuilder *mb, gpointer data);
109 mono_mb_emit_native_call (MonoMethodBuilder *mb, MonoMethodSignature *sig, gpointer func);
112 mono_mb_emit_managed_call (MonoMethodBuilder *mb, MonoMethod *method, MonoMethodSignature *opt_sig);
115 mono_mb_add_local (MonoMethodBuilder *mb, MonoType *type);
118 mono_mb_create_method (MonoMethodBuilder *mb, MonoMethodSignature *signature, int max_stack);
121 mono_mb_emit_ldarg (MonoMethodBuilder *mb, guint argnum);
124 mono_mb_emit_ldarg_addr (MonoMethodBuilder *mb, guint argnum);
127 mono_mb_emit_ldloc (MonoMethodBuilder *mb, guint num);
130 mono_mb_emit_ldloc_addr (MonoMethodBuilder *mb, guint locnum);
133 mono_mb_emit_stloc (MonoMethodBuilder *mb, guint num);
136 mono_mb_emit_exception (MonoMethodBuilder *mb, const char *exc_name, const char *msg);
139 mono_mb_emit_icon (MonoMethodBuilder *mb, gint32 value);
142 mono_mb_emit_branch (MonoMethodBuilder *mb, guint8 op);
145 mono_mb_emit_add_to_local (MonoMethodBuilder *mb, guint16 local, gint32 incr);
148 mono_mb_emit_ldflda (MonoMethodBuilder *mb, gint32 offset);
151 mono_mb_emit_byte (MonoMethodBuilder *mb, guint8 op);
154 mono_mb_emit_i2 (MonoMethodBuilder *mb, gint16 data);
157 mono_mb_emit_i4 (MonoMethodBuilder *mb, gint32 data);
160 mono_mb_emit_ldstr (MonoMethodBuilder *mb, char *str);
162 /* functions to create various architecture independent helper functions */
165 mono_marshal_method_from_wrapper (MonoMethod *wrapper);
168 mono_marshal_get_remoting_invoke (MonoMethod *method);
171 mono_marshal_get_remoting_invoke_with_check (MonoMethod *method);
174 mono_marshal_get_delegate_begin_invoke (MonoMethod *method);
177 mono_marshal_get_delegate_end_invoke (MonoMethod *method);
180 mono_marshal_get_delegate_invoke (MonoMethod *method);
183 mono_marshal_get_runtime_invoke (MonoMethod *method);
186 mono_marshal_get_managed_wrapper (MonoMethod *method, MonoObject *this, MonoMarshalSpec **mspecs);
189 mono_marshal_get_icall_wrapper (MonoMethodSignature *sig, const char *name, gconstpointer func);
192 mono_marshal_get_native_wrapper (MonoMethod *method);
195 mono_marshal_get_struct_to_ptr (MonoClass *klass);
198 mono_marshal_get_ptr_to_struct (MonoClass *klass);
201 mono_marshal_get_stfld_wrapper (MonoType *type);
204 mono_marshal_get_ldfld_wrapper (MonoType *type);
207 mono_marshal_get_synchronized_wrapper (MonoMethod *method);
210 mono_marshal_get_isinst (MonoClass *klass);
213 mono_marshal_get_castclass (MonoClass *klass);
216 mono_marshal_get_proxy_cancast (MonoClass *klass);
218 /* marshaling internal calls */
221 mono_marshal_alloc (gpointer size);
224 mono_marshal_free (gpointer ptr);
227 mono_marshal_free_array (gpointer *ptr, int size);
230 mono_marshal_realloc (gpointer ptr, gpointer size);
233 ves_icall_System_Runtime_InteropServices_Marshal_copy_to_unmanaged (MonoArray *src, gint32 start_index,
234 gpointer dest, gint32 length);
237 ves_icall_System_Runtime_InteropServices_Marshal_copy_from_unmanaged (gpointer src, gint32 start_index,
238 MonoArray *dest, gint32 length);
241 ves_icall_System_Runtime_InteropServices_Marshal_ReadIntPtr (gpointer ptr, gint32 offset);
244 ves_icall_System_Runtime_InteropServices_Marshal_ReadByte (gpointer ptr, gint32 offset);
247 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt16 (gpointer ptr, gint32 offset);
250 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt32 (gpointer ptr, gint32 offset);
253 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt64 (gpointer ptr, gint32 offset);
256 ves_icall_System_Runtime_InteropServices_Marshal_WriteByte (gpointer ptr, gint32 offset, unsigned char val);
259 ves_icall_System_Runtime_InteropServices_Marshal_WriteIntPtr (gpointer ptr, gint32 offset, gpointer val);
262 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt16 (gpointer ptr, gint32 offset, gint16 val);
265 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt32 (gpointer ptr, gint32 offset, gint32 val);
268 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt64 (gpointer ptr, gint32 offset, gint64 val);
271 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi (char *ptr);
274 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi_len (char *ptr, gint32 len);
277 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni (guint16 *ptr);
280 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni_len (guint16 *ptr, gint32 len);
283 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringBSTR (gpointer ptr);
286 ves_icall_System_Runtime_InteropServices_Marshal_GetLastWin32Error (void);
289 ves_icall_System_Runtime_InteropServices_Marshal_SizeOf (MonoReflectionType *rtype);
292 ves_icall_System_Runtime_InteropServices_Marshal_StructureToPtr (MonoObject *obj, gpointer dst, MonoBoolean delete_old);
295 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure (gpointer src, MonoObject *dst);
298 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure_type (gpointer src, MonoReflectionType *type);
301 ves_icall_System_Runtime_InteropServices_Marshal_OffsetOf (MonoReflectionType *type, MonoString *field_name);
304 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalAnsi (MonoString *string);
307 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalUni (MonoString *string);
310 ves_icall_System_Runtime_InteropServices_Marshal_DestroyStructure (gpointer src, MonoReflectionType *type);
313 ves_icall_System_Runtime_InteropServices_Marshal_AllocCoTaskMem (int size);
316 ves_icall_System_Runtime_InteropServices_Marshal_FreeCoTaskMem (void *ptr);
319 ves_icall_System_Runtime_InteropServices_Marshal_UnsafeAddrOfPinnedArrayElement (MonoArray *arrayobj, int index);
321 #endif /* __MONO_MARSHAL_H__ */