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, guint32 *align,
  36                         gboolean as_field, gboolean unicode);
  37
  38 int
  39 mono_type_native_stack_size (MonoType *type, guint32 *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 mono_delegate_free_ftnptr (MonoDelegate *delegate);
  78
  79 void
  80 mono_marshal_set_last_error (void);
  81
  82 gpointer
  83 mono_marshal_asany (MonoObject *obj, MonoMarshalNative string_encoding);
  84
  85 void
  86 mono_marshal_free_asany (MonoObject *o, gpointer ptr, MonoMarshalNative string_encoding);
  87
  88 /* method builder functions */
  89
  90 void
  91 mono_mb_free (MonoMethodBuilder *mb);
  92
  93 MonoMethodBuilder *
  94 mono_mb_new (MonoClass *klass, const char *name, MonoWrapperType type);
  95
  96 void
  97 mono_mb_patch_addr (MonoMethodBuilder *mb, int pos, int value);
  98
  99 void
 100 mono_mb_patch_addr_s (MonoMethodBuilder *mb, int pos, gint8 value);
 101
 102 guint32
 103 mono_mb_add_data (MonoMethodBuilder *mb, gpointer data);
 104
 105 void
 106 mono_mb_emit_native_call (MonoMethodBuilder *mb, MonoMethodSignature *sig, gpointer func);
 107
 108 void
 109 mono_mb_emit_managed_call (MonoMethodBuilder *mb, MonoMethod *method, MonoMethodSignature *opt_sig);
 110
 111 int
 112 mono_mb_add_local (MonoMethodBuilder *mb, MonoType *type);
 113
 114 MonoMethod *
 115 mono_mb_create_method (MonoMethodBuilder *mb, MonoMethodSignature *signature, int max_stack);
 116
 117 void
 118 mono_mb_emit_ldarg (MonoMethodBuilder *mb, guint argnum);
 119
 120 void
 121 mono_mb_emit_ldarg_addr (MonoMethodBuilder *mb, guint argnum);
 122
 123 void
 124 mono_mb_emit_ldloc (MonoMethodBuilder *mb, guint num);
 125
 126 void
 127 mono_mb_emit_ldloc_addr (MonoMethodBuilder *mb, guint locnum);
 128
 129 void
 130 mono_mb_emit_stloc (MonoMethodBuilder *mb, guint num);
 131
 132 void
 133 mono_mb_emit_exception (MonoMethodBuilder *mb, const char *exc_name, const char *msg);
 134
 135 void
 136 mono_mb_emit_icon (MonoMethodBuilder *mb, gint32 value);
 137
 138 guint32
 139 mono_mb_emit_branch (MonoMethodBuilder *mb, guint8 op);
 140
 141 void
 142 mono_mb_emit_add_to_local (MonoMethodBuilder *mb, guint16 local, gint32 incr);
 143
 144 void
 145 mono_mb_emit_ldflda (MonoMethodBuilder *mb, gint32 offset);
 146
 147 void
 148 mono_mb_emit_byte (MonoMethodBuilder *mb, guint8 op);
 149
 150 void
 151 mono_mb_emit_i2 (MonoMethodBuilder *mb, gint16 data);
 152
 153 void
 154 mono_mb_emit_i4 (MonoMethodBuilder *mb, gint32 data);
 155
 156 void
 157 mono_mb_emit_ldstr (MonoMethodBuilder *mb, char *str);
 158
 159 /* functions to create various architecture independent helper functions */
 160
 161 MonoMethod *
 162 mono_marshal_method_from_wrapper (MonoMethod *wrapper);
 163
 164 MonoMethod *
 165 mono_marshal_get_remoting_invoke (MonoMethod *method);
 166
 167 MonoMethod *
 168 mono_marshal_get_xappdomain_invoke (MonoMethod *method);
 169
 170 MonoMethod *
 171 mono_marshal_get_remoting_invoke_for_target (MonoMethod *method, MonoRemotingTarget target_type);
 172
 173 MonoMethod *
 174 mono_marshal_get_remoting_invoke_with_check (MonoMethod *method);
 175
 176 MonoMethod *
 177 mono_marshal_get_delegate_begin_invoke (MonoMethod *method);
 178
 179 MonoMethod *
 180 mono_marshal_get_delegate_end_invoke (MonoMethod *method);
 181
 182 MonoMethod *
 183 mono_marshal_get_delegate_invoke (MonoMethod *method);
 184
 185 MonoMethod *
 186 mono_marshal_get_runtime_invoke (MonoMethod *method);
 187
 188 MonoMethod *
 189 mono_marshal_get_managed_wrapper (MonoMethod *method, MonoClass *delegate_klass, MonoObject *this);
 190
 191 MonoMethod *
 192 mono_marshal_get_icall_wrapper (MonoMethodSignature *sig, const char *name, gconstpointer func);
 193
 194 MonoMethod *
 195 mono_marshal_get_native_wrapper (MonoMethod *method);
 196
 197 MonoMethod *
 198 mono_marshal_get_native_func_wrapper (MonoMethodSignature *sig, MonoMethodPInvoke *piinfo, MonoMarshalSpec **mspecs, gpointer func);
 199
 200 MonoMethod *
 201 mono_marshal_get_struct_to_ptr (MonoClass *klass);
 202
 203 MonoMethod *
 204 mono_marshal_get_ptr_to_struct (MonoClass *klass);
 205
 206 MonoMethod *
 207 mono_marshal_get_stfld_wrapper (MonoType *type);
 208
 209 MonoMethod *
 210 mono_marshal_get_ldfld_wrapper (MonoType *type);
 211
 212 MonoMethod *
 213 mono_marshal_get_ldfld_remote_wrapper (MonoClass *klass);
 214
 215 MonoMethod *
 216 mono_marshal_get_stfld_remote_wrapper (MonoClass *klass);
 217
 218 MonoMethod *
 219 mono_marshal_get_synchronized_wrapper (MonoMethod *method);
 220
 221 MonoMethod *
 222 mono_marshal_get_unbox_wrapper (MonoMethod *method);
 223
 224 MonoMethod *
 225 mono_marshal_get_isinst (MonoClass *klass);
 226
 227 MonoMethod *
 228 mono_marshal_get_castclass (MonoClass *klass);
 229
 230 MonoMethod *
 231 mono_marshal_get_proxy_cancast (MonoClass *klass);
 232
 233 MonoMethod *
 234 mono_marshal_get_stelemref (void);
 235
 236 /* marshaling internal calls */
 237
 238 void *
 239 mono_marshal_alloc (gulong size);
 240
 241 void
 242 mono_marshal_free (gpointer ptr);
 243
 244 void
 245 mono_marshal_free_array (gpointer *ptr, int size);
 246
 247 void *
 248 mono_marshal_realloc (gpointer ptr, gpointer size);
 249
 250 void
 251 ves_icall_System_Runtime_InteropServices_Marshal_copy_to_unmanaged (MonoArray *src, gint32 start_index,
 252                                                                     gpointer dest, gint32 length);
 253
 254 void
 255 ves_icall_System_Runtime_InteropServices_Marshal_copy_from_unmanaged (gpointer src, gint32 start_index,
 256                                                                       MonoArray *dest, gint32 length);
 257
 258 gpointer
 259 ves_icall_System_Runtime_InteropServices_Marshal_ReadIntPtr (gpointer ptr, gint32 offset);
 260
 261 unsigned char
 262 ves_icall_System_Runtime_InteropServices_Marshal_ReadByte (gpointer ptr, gint32 offset);
 263
 264 gint16
 265 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt16 (gpointer ptr, gint32 offset);
 266
 267 gint32
 268 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt32 (gpointer ptr, gint32 offset);
 269
 270 gint64
 271 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt64 (gpointer ptr, gint32 offset);
 272
 273 void
 274 ves_icall_System_Runtime_InteropServices_Marshal_WriteByte (gpointer ptr, gint32 offset, unsigned char val);
 275
 276 void
 277 ves_icall_System_Runtime_InteropServices_Marshal_WriteIntPtr (gpointer ptr, gint32 offset, gpointer val);
 278
 279 void
 280 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt16 (gpointer ptr, gint32 offset, gint16 val);
 281
 282 void
 283 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt32 (gpointer ptr, gint32 offset, gint32 val);
 284
 285 void
 286 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt64 (gpointer ptr, gint32 offset, gint64 val);
 287
 288 MonoString *
 289 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi (char *ptr);
 290
 291 MonoString *
 292 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi_len (char *ptr, gint32 len);
 293
 294 MonoString *
 295 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni (guint16 *ptr);
 296
 297 MonoString *
 298 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni_len (guint16 *ptr, gint32 len);
 299
 300 MonoString *
 301 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringBSTR (gpointer ptr);
 302
 303 guint32
 304 ves_icall_System_Runtime_InteropServices_Marshal_GetLastWin32Error (void);
 305
 306 guint32
 307 ves_icall_System_Runtime_InteropServices_Marshal_SizeOf (MonoReflectionType *rtype);
 308
 309 void
 310 ves_icall_System_Runtime_InteropServices_Marshal_StructureToPtr (MonoObject *obj, gpointer dst, MonoBoolean delete_old);
 311
 312 void
 313 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure (gpointer src, MonoObject *dst);
 314
 315 MonoObject *
 316 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure_type (gpointer src, MonoReflectionType *type);
 317
 318 int
 319 ves_icall_System_Runtime_InteropServices_Marshal_OffsetOf (MonoReflectionType *type, MonoString *field_name);
 320
 321 gpointer
 322 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalAnsi (MonoString *string);
 323
 324 gpointer
 325 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalUni (MonoString *string);
 326
 327 void
 328 ves_icall_System_Runtime_InteropServices_Marshal_DestroyStructure (gpointer src, MonoReflectionType *type);
 329
 330 void*
 331 ves_icall_System_Runtime_InteropServices_Marshal_AllocCoTaskMem (int size);
 332
 333 void
 334 ves_icall_System_Runtime_InteropServices_Marshal_FreeCoTaskMem (void *ptr);
 335
 336 void*
 337 ves_icall_System_Runtime_InteropServices_Marshal_AllocHGlobal (int size);
 338
 339 void
 340 ves_icall_System_Runtime_InteropServices_Marshal_FreeHGlobal (void *ptr);
 341
 342 void*
 343 ves_icall_System_Runtime_InteropServices_Marshal_UnsafeAddrOfPinnedArrayElement (MonoArray *arrayobj, int index);
 344
 345 MonoDelegate*
 346 ves_icall_System_Runtime_InteropServices_Marshal_GetDelegateForFunctionPointerInternal (void *ftn, MonoReflectionType *type);
 347
 348 #endif /* __MONO_MARSHAL_H__ */
 349