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