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