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