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