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