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>
23 typedef struct _MonoMethodBuilder MonoMethodBuilder;
25 /* marshaling helper functions */
28 mono_marshal_init (void);
31 mono_class_native_size (MonoClass *klass, guint32 *align);
34 mono_marshal_load_type_info (MonoClass* klass);
37 mono_marshal_type_size (MonoType *type, MonoMarshalSpec *mspec, guint32 *align,
38 gboolean as_field, gboolean unicode);
41 mono_type_native_stack_size (MonoType *type, guint32 *alignment);
44 mono_array_to_savearray (MonoArray *array);
47 mono_array_to_lparray (MonoArray *array);
50 mono_string_utf8_to_builder (MonoStringBuilder *sb, char *text);
53 mono_string_utf16_to_builder (MonoStringBuilder *sb, gunichar2 *text);
56 mono_string_builder_to_utf8 (MonoStringBuilder *sb);
59 mono_string_builder_to_utf16 (MonoStringBuilder *sb);
62 mono_string_to_ansibstr (MonoString *string_obj);
65 mono_string_to_bstr (MonoString *string_obj);
68 mono_string_to_byvalstr (gpointer dst, MonoString *src, int size);
71 mono_string_to_byvalwstr (gpointer dst, MonoString *src, int size);
74 mono_delegate_to_ftnptr (MonoDelegate *delegate);
77 mono_ftnptr_to_delegate (MonoClass *klass, gpointer ftn);
79 void mono_delegate_free_ftnptr (MonoDelegate *delegate);
82 mono_marshal_set_last_error (void);
85 mono_marshal_asany (MonoObject *obj, MonoMarshalNative string_encoding, int param_attrs);
88 mono_marshal_free_asany (MonoObject *o, gpointer ptr, MonoMarshalNative string_encoding, int param_attrs);
90 /* method builder functions */
93 mono_mb_free (MonoMethodBuilder *mb);
96 mono_mb_new (MonoClass *klass, const char *name, MonoWrapperType type);
99 mono_mb_patch_addr (MonoMethodBuilder *mb, int pos, int value);
102 mono_mb_patch_addr_s (MonoMethodBuilder *mb, int pos, gint8 value);
105 mono_mb_add_data (MonoMethodBuilder *mb, gpointer data);
108 mono_mb_emit_native_call (MonoMethodBuilder *mb, MonoMethodSignature *sig, gpointer func);
111 mono_mb_emit_managed_call (MonoMethodBuilder *mb, MonoMethod *method, MonoMethodSignature *opt_sig);
114 mono_mb_add_local (MonoMethodBuilder *mb, MonoType *type);
117 mono_mb_create_method (MonoMethodBuilder *mb, MonoMethodSignature *signature, int max_stack);
120 mono_mb_emit_ldarg (MonoMethodBuilder *mb, guint argnum);
123 mono_mb_emit_ldarg_addr (MonoMethodBuilder *mb, guint argnum);
126 mono_mb_emit_ldloc (MonoMethodBuilder *mb, guint num);
129 mono_mb_emit_ldloc_addr (MonoMethodBuilder *mb, guint locnum);
132 mono_mb_emit_stloc (MonoMethodBuilder *mb, guint num);
135 mono_mb_emit_exception (MonoMethodBuilder *mb, const char *exc_name, const char *msg);
138 mono_mb_emit_icon (MonoMethodBuilder *mb, gint32 value);
141 mono_mb_emit_branch (MonoMethodBuilder *mb, guint8 op);
144 mono_mb_emit_add_to_local (MonoMethodBuilder *mb, guint16 local, gint32 incr);
147 mono_mb_emit_ldflda (MonoMethodBuilder *mb, gint32 offset);
150 mono_mb_emit_byte (MonoMethodBuilder *mb, guint8 op);
153 mono_mb_emit_i2 (MonoMethodBuilder *mb, gint16 data);
156 mono_mb_emit_i4 (MonoMethodBuilder *mb, gint32 data);
159 mono_mb_emit_ldstr (MonoMethodBuilder *mb, char *str);
162 mono_type_to_ldind (MonoType *type);
165 mono_type_to_stind (MonoType *type);
167 /* functions to create various architecture independent helper functions */
170 mono_marshal_method_from_wrapper (MonoMethod *wrapper);
173 mono_marshal_get_remoting_invoke (MonoMethod *method);
176 mono_marshal_get_xappdomain_invoke (MonoMethod *method);
179 mono_marshal_get_remoting_invoke_for_target (MonoMethod *method, MonoRemotingTarget target_type);
182 mono_marshal_get_remoting_invoke_with_check (MonoMethod *method);
185 mono_marshal_get_delegate_begin_invoke (MonoMethod *method);
188 mono_marshal_get_delegate_end_invoke (MonoMethod *method);
191 mono_marshal_get_delegate_invoke (MonoMethod *method);
194 mono_marshal_get_runtime_invoke (MonoMethod *method);
197 mono_marshal_get_managed_wrapper (MonoMethod *method, MonoClass *delegate_klass, MonoObject *this);
200 mono_marshal_get_icall_wrapper (MonoMethodSignature *sig, const char *name, gconstpointer func);
203 mono_marshal_get_native_wrapper (MonoMethod *method);
206 mono_marshal_get_native_func_wrapper (MonoMethodSignature *sig, MonoMethodPInvoke *piinfo, MonoMarshalSpec **mspecs, gpointer func);
209 mono_marshal_get_struct_to_ptr (MonoClass *klass);
212 mono_marshal_get_ptr_to_struct (MonoClass *klass);
215 mono_marshal_get_stfld_wrapper (MonoType *type);
218 mono_marshal_get_ldfld_wrapper (MonoType *type);
221 mono_marshal_get_ldflda_wrapper (MonoType *type);
224 mono_marshal_get_ldfld_remote_wrapper (MonoClass *klass);
227 mono_marshal_get_stfld_remote_wrapper (MonoClass *klass);
230 mono_marshal_get_synchronized_wrapper (MonoMethod *method);
233 mono_marshal_get_unbox_wrapper (MonoMethod *method);
236 mono_marshal_get_isinst (MonoClass *klass);
239 mono_marshal_get_castclass (MonoClass *klass);
242 mono_marshal_get_proxy_cancast (MonoClass *klass);
245 mono_marshal_get_stelemref (void);
247 /* marshaling internal calls */
250 mono_marshal_alloc (gulong size);
253 mono_marshal_free (gpointer ptr);
256 mono_marshal_free_array (gpointer *ptr, int size);
259 mono_marshal_realloc (gpointer ptr, gpointer size);
262 ves_icall_System_Runtime_InteropServices_Marshal_copy_to_unmanaged (MonoArray *src, gint32 start_index,
263 gpointer dest, gint32 length);
266 ves_icall_System_Runtime_InteropServices_Marshal_copy_from_unmanaged (gpointer src, gint32 start_index,
267 MonoArray *dest, gint32 length);
270 ves_icall_System_Runtime_InteropServices_Marshal_ReadIntPtr (gpointer ptr, gint32 offset);
273 ves_icall_System_Runtime_InteropServices_Marshal_ReadByte (gpointer ptr, gint32 offset);
276 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt16 (gpointer ptr, gint32 offset);
279 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt32 (gpointer ptr, gint32 offset);
282 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt64 (gpointer ptr, gint32 offset);
285 ves_icall_System_Runtime_InteropServices_Marshal_WriteByte (gpointer ptr, gint32 offset, unsigned char val);
288 ves_icall_System_Runtime_InteropServices_Marshal_WriteIntPtr (gpointer ptr, gint32 offset, gpointer val);
291 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt16 (gpointer ptr, gint32 offset, gint16 val);
294 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt32 (gpointer ptr, gint32 offset, gint32 val);
297 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt64 (gpointer ptr, gint32 offset, gint64 val);
300 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi (char *ptr);
303 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi_len (char *ptr, gint32 len);
306 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni (guint16 *ptr);
309 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni_len (guint16 *ptr, gint32 len);
312 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringBSTR (gpointer ptr);
315 ves_icall_System_Runtime_InteropServices_Marshal_GetLastWin32Error (void);
318 ves_icall_System_Runtime_InteropServices_Marshal_SizeOf (MonoReflectionType *rtype);
321 ves_icall_System_Runtime_InteropServices_Marshal_StructureToPtr (MonoObject *obj, gpointer dst, MonoBoolean delete_old);
324 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure (gpointer src, MonoObject *dst);
327 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure_type (gpointer src, MonoReflectionType *type);
330 ves_icall_System_Runtime_InteropServices_Marshal_OffsetOf (MonoReflectionType *type, MonoString *field_name);
333 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalAnsi (MonoString *string);
336 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalUni (MonoString *string);
339 ves_icall_System_Runtime_InteropServices_Marshal_DestroyStructure (gpointer src, MonoReflectionType *type);
342 ves_icall_System_Runtime_InteropServices_Marshal_AllocCoTaskMem (int size);
345 ves_icall_System_Runtime_InteropServices_Marshal_FreeCoTaskMem (void *ptr);
348 ves_icall_System_Runtime_InteropServices_Marshal_AllocHGlobal (int size);
351 ves_icall_System_Runtime_InteropServices_Marshal_FreeHGlobal (void *ptr);
354 ves_icall_System_Runtime_InteropServices_Marshal_UnsafeAddrOfPinnedArrayElement (MonoArray *arrayobj, int index);
357 ves_icall_System_Runtime_InteropServices_Marshal_GetDelegateForFunctionPointerInternal (void *ftn, MonoReflectionType *type);
361 #endif /* __MONO_MARSHAL_H__ */