mono/metadata/metadata.h

   1
   2 #ifndef __MONO_METADATA_H__
   3 #define __MONO_METADATA_H__
   4
   5 #include <glib.h>
   6
   7 #include <mono/metadata/blob.h>
   8 #include <mono/metadata/row-indexes.h>
   9 #include <mono/metadata/image.h>
  10
  11 G_BEGIN_DECLS
  12
  13 #ifdef __GNUC__
  14 #define MONO_ZERO_LEN_ARRAY 0
  15 #else
  16 #define MONO_ZERO_LEN_ARRAY 1
  17 #endif
  18
  19 #define MONO_TYPE_ISSTRUCT(t) (!(t)->byref && (((t)->type == MONO_TYPE_VALUETYPE && !(t)->data.klass->enumtype) || ((t)->type == MONO_TYPE_TYPEDBYREF) || (((t)->type == MONO_TYPE_GENERICINST) && mono_metadata_generic_class_is_valuetype ((t)->data.generic_class))))
  20 #define MONO_TYPE_IS_VOID(t) ((t) && ((t)->type == MONO_TYPE_VOID) && !(t)->byref)
  21 #define MONO_TYPE_IS_POINTER(t) ((t) && (((t)->byref || ((t)->type == MONO_TYPE_I) || (t)->type == MONO_TYPE_STRING) || ((t)->type == MONO_TYPE_SZARRAY) || ((t)->type == MONO_TYPE_CLASS) || ((t)->type == MONO_TYPE_CLASS) || ((t)->type == MONO_TYPE_OBJECT) || ((t)->type == MONO_TYPE_ARRAY) || ((t)->type == MONO_TYPE_PTR)))
  22
  23 #define MONO_TYPE_IS_REFERENCE(t) ((t) &&                                       \
  24                                    ((((t)->type == MONO_TYPE_STRING) ||         \
  25                                      ((t)->type == MONO_TYPE_SZARRAY) ||        \
  26                                      ((t)->type == MONO_TYPE_CLASS) ||          \
  27                                      ((t)->type == MONO_TYPE_OBJECT) ||         \
  28                                      ((t)->type == MONO_TYPE_ARRAY)) ||         \
  29                                     (((t)->type == MONO_TYPE_GENERICINST) &&    \
  30                                      !mono_metadata_generic_class_is_valuetype ((t)->data.generic_class))))
  31
  32 #define MONO_CLASS_IS_INTERFACE(c) ((c->flags & TYPE_ATTRIBUTE_INTERFACE) || (c->byval_arg.type == MONO_TYPE_VAR) || (c->byval_arg.type == MONO_TYPE_MVAR))
  33
  34 typedef struct _MonoClass MonoClass;
  35 typedef struct _MonoDomain MonoDomain;
  36
  37 typedef enum {
  38         MONO_EXCEPTION_CLAUSE_NONE,
  39         MONO_EXCEPTION_CLAUSE_FILTER,
  40         MONO_EXCEPTION_CLAUSE_FINALLY,
  41         MONO_EXCEPTION_CLAUSE_FAULT = 4
  42 } MonoExceptionEnum;
  43
  44 typedef enum {
  45         MONO_CALL_DEFAULT,
  46         MONO_CALL_C,
  47         MONO_CALL_STDCALL,
  48         MONO_CALL_THISCALL,
  49         MONO_CALL_FASTCALL,
  50         MONO_CALL_VARARG
  51 } MonoCallConvention;
  52
  53 /* ECMA lamespec: the old spec had more info... */
  54 typedef enum {
  55         MONO_NATIVE_BOOLEAN = 0x02, /* 4 bytes, 0 is false, != 0 is true */
  56         MONO_NATIVE_I1 = 0x03,
  57         MONO_NATIVE_U1 = 0x04,
  58         MONO_NATIVE_I2 = 0x05,
  59         MONO_NATIVE_U2 = 0x06,
  60         MONO_NATIVE_I4 = 0x07,
  61         MONO_NATIVE_U4 = 0x08,
  62         MONO_NATIVE_I8 = 0x09,
  63         MONO_NATIVE_U8 = 0x0a,
  64         MONO_NATIVE_R4 = 0x0b,
  65         MONO_NATIVE_R8 = 0x0c,
  66         MONO_NATIVE_CURRENCY = 0x0f,
  67         MONO_NATIVE_BSTR = 0x13, /* prefixed length, Unicode */
  68         MONO_NATIVE_LPSTR = 0x14, /* ANSI, null terminated */
  69         MONO_NATIVE_LPWSTR = 0x15, /* UNICODE, null terminated */
  70         MONO_NATIVE_LPTSTR = 0x16, /* plattform dep., null terminated */
  71         MONO_NATIVE_BYVALTSTR = 0x17,
  72         MONO_NATIVE_IUNKNOWN = 0x19,
  73         MONO_NATIVE_IDISPATCH = 0x1a,
  74         MONO_NATIVE_STRUCT = 0x1b,
  75         MONO_NATIVE_INTERFACE = 0x1c,
  76         MONO_NATIVE_SAFEARRAY = 0x1d,
  77         MONO_NATIVE_BYVALARRAY = 0x1e,
  78         MONO_NATIVE_INT   = 0x1f,
  79         MONO_NATIVE_UINT  = 0x20,
  80         MONO_NATIVE_VBBYREFSTR  = 0x22,
  81         MONO_NATIVE_ANSIBSTR  = 0x23,  /* prefixed length, ANSI */
  82         MONO_NATIVE_TBSTR  = 0x24, /* prefixed length, plattform dep. */
  83         MONO_NATIVE_VARIANTBOOL  = 0x25,
  84         MONO_NATIVE_FUNC  = 0x26,
  85         MONO_NATIVE_ASANY = 0x28,
  86         MONO_NATIVE_LPARRAY = 0x2a,
  87         MONO_NATIVE_LPSTRUCT = 0x2b,
  88         MONO_NATIVE_CUSTOM = 0x2c,
  89         MONO_NATIVE_ERROR = 0x2d,
  90         MONO_NATIVE_MAX = 0x50 /* no info */
  91 } MonoMarshalNative;
  92
  93 typedef enum {
  94         MONO_MARSHAL_CONV_NONE,
  95         MONO_MARSHAL_CONV_BOOL_VARIANTBOOL,
  96         MONO_MARSHAL_CONV_BOOL_I4,
  97         MONO_MARSHAL_CONV_STR_BSTR,
  98         MONO_MARSHAL_CONV_STR_LPSTR,
  99         MONO_MARSHAL_CONV_LPSTR_STR,
 100         MONO_MARSHAL_CONV_LPTSTR_STR,
 101         MONO_MARSHAL_CONV_STR_LPWSTR,
 102         MONO_MARSHAL_CONV_LPWSTR_STR,
 103         MONO_MARSHAL_CONV_STR_LPTSTR,
 104         MONO_MARSHAL_CONV_STR_ANSIBSTR,
 105         MONO_MARSHAL_CONV_STR_TBSTR,
 106         MONO_MARSHAL_CONV_STR_BYVALSTR,
 107         MONO_MARSHAL_CONV_STR_BYVALWSTR,
 108         MONO_MARSHAL_CONV_SB_LPSTR,
 109         MONO_MARSHAL_CONV_SB_LPTSTR,
 110         MONO_MARSHAL_CONV_SB_LPWSTR,
 111         MONO_MARSHAL_CONV_LPSTR_SB,
 112         MONO_MARSHAL_CONV_LPTSTR_SB,
 113         MONO_MARSHAL_CONV_LPWSTR_SB,
 114         MONO_MARSHAL_CONV_ARRAY_BYVALARRAY,
 115         MONO_MARSHAL_CONV_ARRAY_SAVEARRAY,
 116         MONO_MARSHAL_CONV_ARRAY_LPARRAY,
 117         MONO_MARSHAL_CONV_OBJECT_INTERFACE,
 118         MONO_MARSHAL_CONV_OBJECT_IDISPATCH,
 119         MONO_MARSHAL_CONV_OBJECT_IUNKNOWN,
 120         MONO_MARSHAL_CONV_OBJECT_STRUCT,
 121         MONO_MARSHAL_CONV_DEL_FTN,
 122         MONO_MARSHAL_CONV_FTN_DEL,
 123         MONO_MARSHAL_FREE_ARRAY
 124 } MonoMarshalConv;
 125
 126 typedef struct {
 127         MonoMarshalNative native;
 128         union {
 129                 struct {
 130                         MonoMarshalNative elem_type;
 131                         gint32 num_elem; /* -1 if not set */
 132                         gint16 param_num; /* -1 if not set */
 133                         gint16 elem_mult; /* -1 if not set */
 134                 } array_data;
 135                 struct {
 136                         char *custom_name;
 137                         char *cookie;
 138                 } custom_data;
 139         } data;
 140 } MonoMarshalSpec;
 141
 142 void         mono_metadata_init (void);
 143
 144 void         mono_metadata_decode_row (const MonoTableInfo   *t,
 145                                        int                    idx,
 146                                        guint32               *res,
 147                                        int                    res_size);
 148
 149 guint32      mono_metadata_decode_row_col (const MonoTableInfo *t,
 150                                            int            idx,
 151                                            guint          col);
 152
 153 /*
 154  * This macro is used to extract the size of the table encoded in
 155  * the size_bitfield of MonoTableInfo.
 156  */
 157 #define mono_metadata_table_size(bitfield,table) ((((bitfield) >> ((table)*2)) & 0x3) + 1)
 158 #define mono_metadata_table_count(bitfield) ((bitfield) >> 24)
 159
 160 int mono_metadata_compute_size (MonoImage   *meta,
 161                                 int             tableindex,
 162                                 guint32        *result_bitfield);
 163
 164 /*
 165  *
 166  */
 167 const char    *mono_metadata_locate        (MonoImage *meta, int table, int idx);
 168 const char    *mono_metadata_locate_token  (MonoImage *meta, guint32 token);
 169
 170 const char    *mono_metadata_string_heap   (MonoImage *meta, guint32 table_index);
 171 const char    *mono_metadata_blob_heap     (MonoImage *meta, guint32 table_index);
 172 const char    *mono_metadata_user_string   (MonoImage *meta, guint32 table_index);
 173 const char    *mono_metadata_guid_heap     (MonoImage *meta, guint32 table_index);
 174
 175 guint32 mono_metadata_typedef_from_field  (MonoImage *meta, guint32 table_index);
 176 guint32 mono_metadata_typedef_from_method (MonoImage *meta, guint32 table_index);
 177 guint32 mono_metadata_nested_in_typedef   (MonoImage *meta, guint32 table_index);
 178 guint32 mono_metadata_nesting_typedef     (MonoImage *meta, guint32 table_index, guint32 start_index);
 179
 180 MonoClass** mono_metadata_interfaces_from_typedef (MonoImage *meta, guint32 table_index, guint *count);
 181
 182 guint32     mono_metadata_events_from_typedef     (MonoImage *meta, guint32 table_index, guint *end_idx);
 183 guint32     mono_metadata_methods_from_event      (MonoImage *meta, guint32 table_index, guint *end);
 184 guint32     mono_metadata_properties_from_typedef (MonoImage *meta, guint32 table_index, guint *end);
 185 guint32     mono_metadata_methods_from_property   (MonoImage *meta, guint32 table_index, guint *end);
 186 guint32     mono_metadata_packing_from_typedef    (MonoImage *meta, guint32 table_index, guint32 *packing, guint32 *size);
 187 const char* mono_metadata_get_marshal_info        (MonoImage *meta, guint32 idx, gboolean is_field);
 188 guint32     mono_metadata_custom_attrs_from_index (MonoImage *meta, guint32 cattr_index);
 189
 190 MonoMarshalSpec *mono_metadata_parse_marshal_spec (MonoImage *image, const char *ptr);
 191
 192 void mono_metadata_free_marshal_spec (MonoMarshalSpec *spec);
 193
 194 guint32     mono_metadata_implmap_from_method     (MonoImage *meta, guint32 method_idx);
 195
 196 void        mono_metadata_field_info (MonoImage *meta,
 197                                       guint32       table_index,
 198                                       guint32      *offset,
 199                                       guint32      *rva,
 200                                       MonoMarshalSpec **marshal_spec);
 201
 202 guint32     mono_metadata_get_constant_index (MonoImage *meta, guint32 token, guint32 hint);
 203
 204 /*
 205  * Functions to extract information from the Blobs
 206  */
 207 guint32 mono_metadata_decode_value     (const char            *ptr,
 208                                         const char           **rptr);
 209 guint32 mono_metadata_decode_blob_size (const char            *ptr,
 210                                         const char           **rptr);
 211
 212 void mono_metadata_encode_value (guint32 value, char *bug, char **endbuf);
 213
 214 #define MONO_OFFSET_IN_CLAUSE(clause,offset) \
 215         ((clause)->try_offset <= (offset) && (offset) < ((clause)->try_offset + (clause)->try_len))
 216 #define MONO_OFFSET_IN_HANDLER(clause,offset) \
 217         ((clause)->handler_offset <= (offset) && (offset) < ((clause)->handler_offset + (clause)->handler_len))
 218
 219 typedef struct {
 220         guint32 flags;
 221         guint32 try_offset;
 222         guint32 try_len;
 223         guint32 handler_offset;
 224         guint32 handler_len;
 225         union {
 226                 guint32 filter_offset;
 227                 MonoClass *catch_class;
 228         } data;
 229 } MonoExceptionClause;
 230
 231 typedef struct _MonoType MonoType;
 232 typedef struct _MonoGenericInst MonoGenericInst;
 233 typedef struct _MonoGenericClass MonoGenericClass;
 234 typedef struct _MonoInflatedGenericClass MonoInflatedGenericClass;
 235 typedef struct _MonoDynamicGenericClass MonoDynamicGenericClass;
 236 typedef struct _MonoGenericMethod MonoGenericMethod;
 237 typedef struct _MonoGenericContext MonoGenericContext;
 238 typedef struct _MonoGenericContainer MonoGenericContainer;
 239 typedef struct _MonoGenericParam MonoGenericParam;
 240 typedef struct _MonoArrayType MonoArrayType;
 241 typedef struct _MonoMethodSignature MonoMethodSignature;
 242
 243 typedef struct {
 244         unsigned int required : 1;
 245         unsigned int token    : 31;
 246 } MonoCustomMod;
 247
 248 struct _MonoArrayType {
 249         MonoClass *eklass;
 250         guint8 rank;
 251         guint8 numsizes;
 252         guint8 numlobounds;
 253         int *sizes;
 254         int *lobounds;
 255 };
 256
 257 struct _MonoType {
 258         union {
 259                 MonoClass *klass; /* for VALUETYPE and CLASS */
 260                 MonoType *type;   /* for PTR */
 261                 MonoArrayType *array; /* for ARRAY */
 262                 MonoMethodSignature *method;
 263                 MonoGenericParam *generic_param; /* for VAR and MVAR */
 264                 MonoGenericClass *generic_class; /* for GENERICINST */
 265         } data;
 266         unsigned int attrs    : 16; /* param attributes or field flags */
 267         unsigned int type     : 8;  /* ElementTypeEnum */
 268         unsigned int num_mods : 6;  /* max 64 modifiers follow at the end */
 269         unsigned int byref    : 1;
 270         unsigned int pinned   : 1;  /* valid when included in a local var signature */
 271         MonoCustomMod modifiers [MONO_ZERO_LEN_ARRAY]; /* this may grow */
 272 };
 273
 274 struct _MonoMethodSignature {
 275         unsigned int  hasthis : 1;
 276         unsigned int  explicit_this   : 1;
 277         unsigned int  call_convention : 6;
 278         unsigned int  pinvoke   : 1;
 279         unsigned int  ref_count : 23;
 280         guint16       param_count;
 281         gint16        sentinelpos;
 282         unsigned int  generic_param_count : 30;
 283         unsigned int  is_inflated         : 1;
 284         unsigned int  has_type_parameters : 1;
 285         MonoType     *ret;
 286         MonoType     *params [MONO_ZERO_LEN_ARRAY];
 287 };
 288
 289 typedef struct {
 290         guint32      code_size;
 291         const unsigned char  *code;
 292         guint16      max_stack;
 293         unsigned int num_clauses : 15;
 294         /* if num_locals != 0, then the following apply: */
 295         unsigned int init_locals : 1;
 296         guint16      num_locals;
 297         MonoExceptionClause *clauses;
 298         MonoType    *locals [MONO_ZERO_LEN_ARRAY];
 299 } MonoMethodHeader;
 300
 301 typedef enum {
 302         MONO_PARSE_TYPE,
 303         MONO_PARSE_MOD_TYPE,
 304         MONO_PARSE_LOCAL,
 305         MONO_PARSE_PARAM,
 306         MONO_PARSE_RET,
 307         MONO_PARSE_FIELD
 308 } MonoParseTypeMode;
 309
 310 gboolean
 311 mono_type_is_byref       (MonoType *type);
 312
 313 int
 314 mono_type_get_type       (MonoType *type);
 315
 316 /* For MONO_TYPE_FNPTR */
 317 MonoMethodSignature*
 318 mono_type_get_signature  (MonoType *type);
 319
 320 /* For MONO_TYPE_CLASS, VALUETYPE */
 321 MonoClass*
 322 mono_type_get_class      (MonoType *type);
 323
 324 MonoArrayType*
 325 mono_type_get_array_type (MonoType *type);
 326
 327 MonoClass*
 328 mono_type_get_modifiers  (MonoType *type, gboolean *is_required, gpointer *iter);
 329
 330 MonoType*
 331 mono_signature_get_return_type (MonoMethodSignature *sig);
 332
 333 MonoType*
 334 mono_signature_get_params      (MonoMethodSignature *sig, gpointer *iter);
 335
 336 guint32
 337 mono_signature_get_param_count (MonoMethodSignature *sig);
 338
 339 guint32
 340 mono_signature_get_call_conv   (MonoMethodSignature *sig);
 341
 342 int
 343 mono_signature_vararg_start    (MonoMethodSignature *sig);
 344
 345 gboolean
 346 mono_signature_is_instance     (MonoMethodSignature *sig);
 347
 348 gboolean
 349 mono_signature_explicit_this   (MonoMethodSignature *sig);
 350
 351 guint32     mono_metadata_parse_typedef_or_ref (MonoImage      *m,
 352                                                 const char      *ptr,
 353                                                 const char     **rptr);
 354 int            mono_metadata_parse_custom_mod  (MonoImage      *m,
 355                                                 MonoCustomMod   *dest,
 356                                                 const char      *ptr,
 357                                                 const char     **rptr);
 358 MonoArrayType *mono_metadata_parse_array       (MonoImage      *m,
 359                                                 const char      *ptr,
 360                                                 const char     **rptr);
 361 void           mono_metadata_free_array        (MonoArrayType     *array);
 362 MonoType      *mono_metadata_parse_type        (MonoImage      *m,
 363                                                 MonoParseTypeMode  mode,
 364                                                 short              opt_attrs,
 365                                                 const char        *ptr,
 366                                                 const char       **rptr);
 367 MonoType      *mono_metadata_parse_param       (MonoImage      *m,
 368                                                 const char      *ptr,
 369                                                 const char      **rptr);
 370 MonoType      *mono_metadata_parse_ret_type    (MonoImage      *m,
 371                                                 const char      *ptr,
 372                                                 const char      **rptr);
 373 MonoType      *mono_metadata_parse_field_type  (MonoImage      *m,
 374                                                 short            field_flags,
 375                                                 const char      *ptr,
 376                                                 const char      **rptr);
 377 MonoType      *mono_type_create_from_typespec  (MonoImage        *image,
 378                                                 guint32           type_spec);
 379 void           mono_metadata_free_type         (MonoType        *type);
 380 int            mono_type_size                  (MonoType        *type,
 381                                                 int             *alignment);
 382 int            mono_type_stack_size            (MonoType        *type,
 383                                                 int             *alignment);
 384
 385 gboolean       mono_metadata_generic_class_is_valuetype (MonoGenericClass *gclass);
 386 guint          mono_metadata_generic_class_hash  (MonoGenericClass *gclass);
 387 gboolean       mono_metadata_generic_class_equal (MonoGenericClass *g1, MonoGenericClass *g2);
 388
 389 guint          mono_metadata_type_hash         (MonoType *t1);
 390 gboolean       mono_metadata_type_equal        (MonoType *t1, MonoType *t2);
 391
 392 MonoMethodSignature  *mono_metadata_signature_alloc (MonoImage *image, guint32 nparams);
 393
 394 MonoMethodSignature  *mono_metadata_signature_dup (MonoMethodSignature *sig);
 395
 396 MonoMethodSignature  *mono_metadata_parse_signature (MonoImage *image,
 397                                                      guint32    token);
 398
 399 MonoMethodSignature  *mono_metadata_parse_method_signature (MonoImage            *m,
 400                                                             int                    def,
 401                                                             const char            *ptr,
 402                                                             const char           **rptr);
 403 void                  mono_metadata_free_method_signature  (MonoMethodSignature   *method);
 404
 405 gboolean          mono_metadata_signature_equal (MonoMethodSignature *sig1,
 406                                                  MonoMethodSignature *sig2);
 407
 408 guint             mono_signature_hash (MonoMethodSignature *sig);
 409
 410 MonoMethodHeader *mono_metadata_parse_mh (MonoImage *m, const char *ptr);
 411 void              mono_metadata_free_mh  (MonoMethodHeader *mh);
 412
 413 guint32
 414 mono_type_to_unmanaged (MonoType *type, MonoMarshalSpec *mspec,
 415                         gboolean as_field, gboolean unicode, MonoMarshalConv *conv);
 416
 417 /*
 418  * Makes a token based on a table and an index
 419  */
 420 #define mono_metadata_make_token(table,idx) (((table) << 24)| (idx))
 421
 422 /*
 423  * Returns the table index that this token encodes.
 424  */
 425 #define mono_metadata_token_table(token) ((token) >> 24)
 426
 427  /*
 428  * Returns the index that a token refers to
 429  */
 430 #define mono_metadata_token_index(token) ((token & 0xffffff))
 431
 432
 433 #define mono_metadata_token_code(token) ((token & 0xff000000))
 434
 435 guint32 mono_metadata_token_from_dor (guint32 dor_index);
 436
 437 char *mono_guid_to_string (const guint8 *guid);
 438
 439 guint32 mono_metadata_declsec_from_index (MonoImage *meta, guint32 idx);
 440
 441 G_END_DECLS
 442
 443 #endif /* __MONO_METADATA_H__ */