mono/metadata/marshal.h

   1
   2 /*
   3  * marshal.h: Routines for marshaling complex types in P/Invoke methods.
   4  *
   5  * Author:
   6  *   Paolo Molaro (lupus@ximian.com)
   7  *
   8  * (C) 2002 Ximian, Inc.  http://www.ximian.com
   9  *
  10  */
  11
  12 #ifndef __MONO_MARSHAL_H__
  13 #define __MONO_MARSHAL_H__
  14
  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
  21 typedef struct _MonoMethodBuilder MonoMethodBuilder;
  22
  23 /* marshaling helper functions */
  24
  25 void
  26 mono_marshal_init (void);
  27
  28 gint32
  29 mono_class_native_size (MonoClass *klass, guint32 *align);
  30
  31 MonoMarshalType *
  32 mono_marshal_load_type_info (MonoClass* klass);
  33
  34 gint32
  35 mono_marshal_type_size (MonoType *type, MonoMarshalSpec *mspec, gint32 *align,
  36                         gboolean as_field, gboolean unicode);
  37
  38 int
  39 mono_type_native_stack_size (MonoType *type, int *alignment);
  40
  41 gpointer
  42 mono_array_to_savearray (MonoArray *array);
  43
  44 gpointer
  45 mono_array_to_lparray (MonoArray *array);
  46
  47 void
  48 mono_string_utf8_to_builder (MonoStringBuilder *sb, char *text);
  49
  50 void
  51 mono_string_utf16_to_builder (MonoStringBuilder *sb, gunichar2 *text);
  52
  53 gpointer
  54 mono_string_builder_to_utf8 (MonoStringBuilder *sb);
  55
  56 gpointer
  57 mono_string_builder_to_utf16 (MonoStringBuilder *sb);
  58
  59 gpointer
  60 mono_string_to_ansibstr (MonoString *string_obj);
  61
  62 gpointer
  63 mono_string_to_bstr (MonoString *string_obj);
  64
  65 void
  66 mono_string_to_byvalstr (gpointer dst, MonoString *src, int size);
  67
  68 void
  69 mono_string_to_byvalwstr (gpointer dst, MonoString *src, int size);
  70
  71 gpointer
  72 mono_delegate_to_ftnptr (MonoDelegate *delegate);
  73
  74 MonoDelegate*
  75 mono_ftnptr_to_delegate (MonoClass *klass, gpointer ftn);
  76
  77 void *
  78 mono_marshal_string_array (MonoArray *array);
  79
  80 void *
  81 mono_marshal_string_array_to_unicode (MonoArray *array);
  82
  83 void
  84 mono_marshal_set_last_error (void);
  85
  86 gpointer
  87 mono_marshal_asany (MonoObject *obj, MonoMarshalNative string_encoding);
  88
  89 void
  90 mono_marshal_free_asany (MonoObject *o, gpointer ptr, MonoMarshalNative string_encoding);
  91
  92 /* method builder functions */
  93
  94 void
  95 mono_mb_free (MonoMethodBuilder *mb);
  96
  97 MonoMethodBuilder *
  98 mono_mb_new (MonoClass *klass, const char *name, MonoWrapperType type);
  99
 100 void
 101 mono_mb_patch_addr (MonoMethodBuilder *mb, int pos, int value);
 102
 103 void
 104 mono_mb_patch_addr_s (MonoMethodBuilder *mb, int pos, gint8 value);
 105
 106 guint32
 107 mono_mb_add_data (MonoMethodBuilder *mb, gpointer data);
 108
 109 void
 110 mono_mb_emit_native_call (MonoMethodBuilder *mb, MonoMethodSignature *sig, gpointer func);
 111
 112 void
 113 mono_mb_emit_managed_call (MonoMethodBuilder *mb, MonoMethod *method, MonoMethodSignature *opt_sig);
 114
 115 int
 116 mono_mb_add_local (MonoMethodBuilder *mb, MonoType *type);
 117
 118 MonoMethod *
 119 mono_mb_create_method (MonoMethodBuilder *mb, MonoMethodSignature *signature, int max_stack);
 120
 121 void
 122 mono_mb_emit_ldarg (MonoMethodBuilder *mb, guint argnum);
 123
 124 void
 125 mono_mb_emit_ldarg_addr (MonoMethodBuilder *mb, guint argnum);
 126
 127 void
 128 mono_mb_emit_ldloc (MonoMethodBuilder *mb, guint num);
 129
 130 void
 131 mono_mb_emit_ldloc_addr (MonoMethodBuilder *mb, guint locnum);
 132
 133 void
 134 mono_mb_emit_stloc (MonoMethodBuilder *mb, guint num);
 135
 136 void
 137 mono_mb_emit_exception (MonoMethodBuilder *mb, const char *exc_name, const char *msg);
 138
 139 void
 140 mono_mb_emit_icon (MonoMethodBuilder *mb, gint32 value);
 141
 142 guint32
 143 mono_mb_emit_branch (MonoMethodBuilder *mb, guint8 op);
 144
 145 void
 146 mono_mb_emit_add_to_local (MonoMethodBuilder *mb, guint16 local, gint32 incr);
 147
 148 void
 149 mono_mb_emit_ldflda (MonoMethodBuilder *mb, gint32 offset);
 150
 151 void
 152 mono_mb_emit_byte (MonoMethodBuilder *mb, guint8 op);
 153
 154 void
 155 mono_mb_emit_i2 (MonoMethodBuilder *mb, gint16 data);
 156
 157 void
 158 mono_mb_emit_i4 (MonoMethodBuilder *mb, gint32 data);
 159
 160 void
 161 mono_mb_emit_ldstr (MonoMethodBuilder *mb, char *str);
 162
 163 /* functions to create various architecture independent helper functions */
 164
 165 MonoMethod *
 166 mono_marshal_method_from_wrapper (MonoMethod *wrapper);
 167
 168 MonoMethod *
 169 mono_marshal_get_remoting_invoke (MonoMethod *method);
 170
 171 MonoMethod *
 172 mono_marshal_get_remoting_invoke_with_check (MonoMethod *method);
 173
 174 MonoMethod *
 175 mono_marshal_get_delegate_begin_invoke (MonoMethod *method);
 176
 177 MonoMethod *
 178 mono_marshal_get_delegate_end_invoke (MonoMethod *method);
 179
 180 MonoMethod *
 181 mono_marshal_get_delegate_invoke (MonoMethod *method);
 182
 183 MonoMethod *
 184 mono_marshal_get_runtime_invoke (MonoMethod *method);
 185
 186 MonoMethod *
 187 mono_marshal_get_managed_wrapper (MonoMethod *method, MonoObject *this, MonoMarshalSpec **mspecs);
 188
 189 MonoMethod *
 190 mono_marshal_get_icall_wrapper (MonoMethodSignature *sig, const char *name, gconstpointer func);
 191
 192 MonoMethod *
 193 mono_marshal_get_native_wrapper (MonoMethod *method);
 194
 195 MonoMethod *
 196 mono_marshal_get_struct_to_ptr (MonoClass *klass);
 197
 198 MonoMethod *
 199 mono_marshal_get_ptr_to_struct (MonoClass *klass);
 200
 201 MonoMethod *
 202 mono_marshal_get_stfld_wrapper (MonoType *type);
 203
 204 MonoMethod *
 205 mono_marshal_get_ldfld_wrapper (MonoType *type);
 206
 207 MonoMethod *
 208 mono_marshal_get_synchronized_wrapper (MonoMethod *method);
 209
 210 MonoMethod *
 211 mono_marshal_get_isinst (MonoClass *klass);
 212
 213 MonoMethod *
 214 mono_marshal_get_castclass (MonoClass *klass);
 215
 216 MonoMethod *
 217 mono_marshal_get_proxy_cancast (MonoClass *klass);
 218
 219 /* marshaling internal calls */
 220
 221 void *
 222 mono_marshal_alloc (gpointer size);
 223
 224 void
 225 mono_marshal_free (gpointer ptr);
 226
 227 void
 228 mono_marshal_free_array (gpointer *ptr, int size);
 229
 230 void *
 231 mono_marshal_realloc (gpointer ptr, gpointer size);
 232
 233 void
 234 ves_icall_System_Runtime_InteropServices_Marshal_copy_to_unmanaged (MonoArray *src, gint32 start_index,
 235                                                                     gpointer dest, gint32 length);
 236
 237 void
 238 ves_icall_System_Runtime_InteropServices_Marshal_copy_from_unmanaged (gpointer src, gint32 start_index,
 239                                                                       MonoArray *dest, gint32 length);
 240
 241 gpointer
 242 ves_icall_System_Runtime_InteropServices_Marshal_ReadIntPtr (gpointer ptr, gint32 offset);
 243
 244 unsigned char
 245 ves_icall_System_Runtime_InteropServices_Marshal_ReadByte (gpointer ptr, gint32 offset);
 246
 247 gint16
 248 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt16 (gpointer ptr, gint32 offset);
 249
 250 gint32
 251 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt32 (gpointer ptr, gint32 offset);
 252
 253 gint64
 254 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt64 (gpointer ptr, gint32 offset);
 255
 256 void
 257 ves_icall_System_Runtime_InteropServices_Marshal_WriteByte (gpointer ptr, gint32 offset, unsigned char val);
 258
 259 void
 260 ves_icall_System_Runtime_InteropServices_Marshal_WriteIntPtr (gpointer ptr, gint32 offset, gpointer val);
 261
 262 void
 263 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt16 (gpointer ptr, gint32 offset, gint16 val);
 264
 265 void
 266 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt32 (gpointer ptr, gint32 offset, gint32 val);
 267
 268 void
 269 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt64 (gpointer ptr, gint32 offset, gint64 val);
 270
 271 MonoString *
 272 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi (char *ptr);
 273
 274 MonoString *
 275 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi_len (char *ptr, gint32 len);
 276
 277 MonoString *
 278 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni (guint16 *ptr);
 279
 280 MonoString *
 281 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni_len (guint16 *ptr, gint32 len);
 282
 283 MonoString *
 284 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringBSTR (gpointer ptr);
 285
 286 guint32
 287 ves_icall_System_Runtime_InteropServices_Marshal_GetLastWin32Error (void);
 288
 289 guint32
 290 ves_icall_System_Runtime_InteropServices_Marshal_SizeOf (MonoReflectionType *rtype);
 291
 292 void
 293 ves_icall_System_Runtime_InteropServices_Marshal_StructureToPtr (MonoObject *obj, gpointer dst, MonoBoolean delete_old);
 294
 295 void
 296 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure (gpointer src, MonoObject *dst);
 297
 298 MonoObject *
 299 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure_type (gpointer src, MonoReflectionType *type);
 300
 301 int
 302 ves_icall_System_Runtime_InteropServices_Marshal_OffsetOf (MonoReflectionType *type, MonoString *field_name);
 303
 304 gpointer
 305 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalAnsi (MonoString *string);
 306
 307 gpointer
 308 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalUni (MonoString *string);
 309
 310 void
 311 ves_icall_System_Runtime_InteropServices_Marshal_DestroyStructure (gpointer src, MonoReflectionType *type);
 312
 313 void*
 314 ves_icall_System_Runtime_InteropServices_Marshal_AllocCoTaskMem (int size);
 315
 316 void
 317 ves_icall_System_Runtime_InteropServices_Marshal_FreeCoTaskMem (void *ptr);
 318
 319 void*
 320 ves_icall_System_Runtime_InteropServices_Marshal_UnsafeAddrOfPinnedArrayElement (MonoArray *arrayobj, int index);
 321
 322 #endif /* __MONO_MARSHAL_H__ */
 323