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 typedef struct _MonoClass MonoClass;
  18 typedef struct _MonoDomain MonoDomain;
  19
  20 typedef enum {
  21         MONO_TABLE_MODULE,
  22         MONO_TABLE_TYPEREF,
  23         MONO_TABLE_TYPEDEF,
  24         MONO_TABLE_UNUSED1,
  25         MONO_TABLE_FIELD,
  26         MONO_TABLE_UNUSED2,
  27         MONO_TABLE_METHOD,
  28         MONO_TABLE_UNUSED3,
  29         MONO_TABLE_PARAM,
  30         MONO_TABLE_INTERFACEIMPL,
  31         MONO_TABLE_MEMBERREF,
  32         MONO_TABLE_CONSTANT,
  33         MONO_TABLE_CUSTOMATTRIBUTE,
  34         MONO_TABLE_FIELDMARSHAL,
  35         MONO_TABLE_DECLSECURITY,
  36         MONO_TABLE_CLASSLAYOUT,
  37         MONO_TABLE_FIELDLAYOUT,
  38         MONO_TABLE_STANDALONESIG,
  39         MONO_TABLE_EVENTMAP,
  40         MONO_TABLE_UNUSED4,
  41         MONO_TABLE_EVENT,
  42         MONO_TABLE_PROPERTYMAP,
  43         MONO_TABLE_UNUSED5,
  44         MONO_TABLE_PROPERTY,
  45         MONO_TABLE_METHODSEMANTICS,
  46         MONO_TABLE_METHODIMPL,
  47         MONO_TABLE_MODULEREF,
  48         MONO_TABLE_TYPESPEC,
  49         MONO_TABLE_IMPLMAP,
  50         MONO_TABLE_FIELDRVA,
  51         MONO_TABLE_UNUSED6,
  52         MONO_TABLE_UNUSED7,
  53         MONO_TABLE_ASSEMBLY,
  54         MONO_TABLE_ASSEMBLYPROCESSOR,
  55         MONO_TABLE_ASSEMBLYOS,
  56         MONO_TABLE_ASSEMBLYREF,
  57         MONO_TABLE_ASSEMBLYREFPROCESSOR,
  58         MONO_TABLE_ASSEMBLYREFOS,
  59         MONO_TABLE_FILE,
  60         MONO_TABLE_EXPORTEDTYPE,
  61         MONO_TABLE_MANIFESTRESOURCE,
  62         MONO_TABLE_NESTEDCLASS
  63
  64 #define MONO_TABLE_LAST MONO_TABLE_NESTEDCLASS
  65 } MonoMetaTableEnum;
  66
  67 typedef enum {
  68         MONO_EXCEPTION_CLAUSE_NONE,
  69         MONO_EXCEPTION_CLAUSE_FILTER,
  70         MONO_EXCEPTION_CLAUSE_FINALLY,
  71         MONO_EXCEPTION_CLAUSE_FAULT = 4
  72 } MonoExceptionEnum;
  73
  74 typedef enum {
  75         MONO_CALL_DEFAULT,
  76         MONO_CALL_C,
  77         MONO_CALL_STDCALL,
  78         MONO_CALL_THISCALL,
  79         MONO_CALL_FASTCALL,
  80         MONO_CALL_VARARG
  81 } MonoCallConvention;
  82
  83 void         mono_metadata_decode_row (MonoTableInfo         *t,
  84                                        int                    idx,
  85                                        guint32               *res,
  86                                        int                    res_size);
  87
  88 guint32      mono_metadata_decode_row_col (MonoTableInfo *t,
  89                                            int            idx,
  90                                            guint          col);
  91
  92 /*
  93  * This macro is used to extract the size of the table encoded in
  94  * the size_bitfield of MonoTableInfo.
  95  */
  96 #define mono_metadata_table_size(bitfield,table) ((((bitfield) >> ((table)*2)) & 0x3) + 1)
  97 #define mono_metadata_table_count(bitfield) ((bitfield) >> 24)
  98
  99 int mono_metadata_compute_size (MonoImage   *meta,
 100                                 int             tableindex,
 101                                 guint32        *result_bitfield);
 102
 103 /*
 104  *
 105  */
 106 const char    *mono_metadata_locate        (MonoImage *meta, int table, int idx);
 107 const char    *mono_metadata_locate_token  (MonoImage *meta, guint32 token);
 108
 109 const char    *mono_metadata_string_heap   (MonoImage *meta, guint32 table_index);
 110 const char    *mono_metadata_blob_heap     (MonoImage *meta, guint32 table_index);
 111 const char    *mono_metadata_user_string   (MonoImage *meta, guint32 table_index);
 112 const char    *mono_metadata_guid_heap     (MonoImage *meta, guint32 table_index);
 113
 114 guint32 mono_metadata_typedef_from_field  (MonoImage *meta, guint32 table_index);
 115 guint32 mono_metadata_typedef_from_method (MonoImage *meta, guint32 table_index);
 116 guint32 mono_metadata_nested_in_typedef   (MonoImage *meta, guint32 table_index);
 117 guint32 mono_metadata_nesting_typedef     (MonoImage *meta, guint32 table_index);
 118
 119 MonoClass** mono_metadata_interfaces_from_typedef (MonoImage *meta, guint32 table_index, guint *count);
 120
 121 guint32     mono_metadata_events_from_typedef     (MonoImage *meta, guint32 table_index, guint *end_idx);
 122 guint32     mono_metadata_methods_from_event      (MonoImage *meta, guint32 table_index, guint *end);
 123 guint32     mono_metadata_properties_from_typedef (MonoImage *meta, guint32 table_index, guint *end);
 124 guint32     mono_metadata_methods_from_property   (MonoImage *meta, guint32 table_index, guint *end);
 125 guint32     mono_metadata_packing_from_typedef    (MonoImage *meta, guint32 table_index, guint32 *packing, guint32 *size);
 126
 127 void        mono_metadata_field_info (MonoImage *meta,
 128                                       guint32       table_index,
 129                                       guint32      *offset,
 130                                       guint32      *rva,
 131                                       const char  **marshal_info);
 132
 133 guint32     mono_metadata_get_constant_index (MonoImage *meta, guint32 token);
 134
 135 /*
 136  * Functions to extract information from the Blobs
 137  */
 138 guint32 mono_metadata_decode_value     (const char            *ptr,
 139                                         const char           **rptr);
 140 guint32 mono_metadata_decode_blob_size (const char            *ptr,
 141                                         const char           **rptr);
 142
 143 void mono_metadata_encode_value (guint32 value, char *bug, char **endbuf);
 144
 145 #define MONO_OFFSET_IN_CLAUSE(clause,offset) \
 146         ((clause)->try_offset <= (offset) && (offset) < ((clause)->try_offset + (clause)->try_len))
 147 #define MONO_OFFSET_IN_HANDLER(clause,offset) \
 148         ((clause)->handler_offset <= (offset) && (offset) < ((clause)->handler_offset + (clause)->handler_len))
 149
 150 typedef struct {
 151         guint32 flags;
 152         guint32 try_offset;
 153         guint32 try_len;
 154         guint32 handler_offset;
 155         guint32 handler_len;
 156         guint32 token_or_filter;
 157 } MonoExceptionClause;
 158
 159 typedef struct _MonoType MonoType;
 160 typedef struct _MonoArrayType MonoArrayType;
 161 typedef struct _MonoMethodSignature MonoMethodSignature;
 162
 163 typedef struct {
 164         unsigned int required : 1;
 165         unsigned int token    : 31;
 166 } MonoCustomMod;
 167
 168 struct _MonoArrayType {
 169         MonoType *type;
 170         int rank;
 171         int numsizes;
 172         int numlobounds;
 173         int *sizes;
 174         int *lobounds;
 175 };
 176
 177 struct _MonoType {
 178         union {
 179                 MonoClass *klass; /* for VALUETYPE and CLASS */
 180                 MonoType *type;   /* for PTR and SZARRAY */
 181                 MonoArrayType *array; /* for ARRAY */
 182                 MonoMethodSignature *method;
 183         } data;
 184         unsigned int attrs    : 16; /* param attributes or field flags */
 185         unsigned int type     : 8;  /* ElementTypeEnum */
 186         unsigned int num_mods : 6;  /* max 64 modifiers follow at the end */
 187         unsigned int byref    : 1;
 188         unsigned int pinned   : 1;  /* valid when included in a local var signature */
 189         MonoCustomMod modifiers [MONO_ZERO_LEN_ARRAY]; /* this may grow */
 190 };
 191
 192 struct _MonoMethodSignature {
 193         unsigned int  hasthis : 1;
 194         unsigned int  explicit_this   : 1;
 195         unsigned int  call_convention : 6;
 196         unsigned int  ref_count : 24;
 197         guint16       param_count;
 198         guint16       sentinelpos;
 199         MonoType     *ret;
 200         MonoType     *params [MONO_ZERO_LEN_ARRAY];
 201 };
 202
 203 typedef struct {
 204         guint32      code_size;
 205         const unsigned char  *code;
 206         guint16      max_stack;
 207         unsigned int num_clauses : 15;
 208         /* if num_locals != 0, then the following apply: */
 209         unsigned int init_locals : 1;
 210         guint16      num_locals;
 211         MonoExceptionClause *clauses;
 212         MonoType    *locals [MONO_ZERO_LEN_ARRAY];
 213 } MonoMethodHeader;
 214
 215 typedef enum {
 216         MONO_PARSE_TYPE,
 217         MONO_PARSE_MOD_TYPE,
 218         MONO_PARSE_LOCAL,
 219         MONO_PARSE_PARAM,
 220         MONO_PARSE_RET,
 221         MONO_PARSE_FIELD
 222 } MonoParseTypeMode;
 223
 224 guint32     mono_metadata_parse_typedef_or_ref (MonoImage      *m,
 225                                                 const char      *ptr,
 226                                                 const char     **rptr);
 227 int            mono_metadata_parse_custom_mod  (MonoImage      *m,
 228                                                 MonoCustomMod   *dest,
 229                                                 const char      *ptr,
 230                                                 const char     **rptr);
 231 MonoArrayType *mono_metadata_parse_array       (MonoImage      *m,
 232                                                 const char      *ptr,
 233                                                 const char     **rptr);
 234 void           mono_metadata_free_array        (MonoArrayType     *array);
 235 MonoType      *mono_metadata_parse_type        (MonoImage      *m,
 236                                                 MonoParseTypeMode  mode,
 237                                                 short              opt_attrs,
 238                                                 const char        *ptr,
 239                                                 const char       **rptr);
 240 MonoType      *mono_metadata_parse_param       (MonoImage      *m,
 241                                                 const char      *ptr,
 242                                                 const char      **rptr);
 243 MonoType      *mono_metadata_parse_ret_type    (MonoImage      *m,
 244                                                 const char      *ptr,
 245                                                 const char      **rptr);
 246 MonoType      *mono_metadata_parse_field_type  (MonoImage      *m,
 247                                                 short            field_flags,
 248                                                 const char      *ptr,
 249                                                 const char      **rptr);
 250 MonoType      *mono_type_create_from_typespec (MonoImage        *image,
 251                                                guint32           type_spec);
 252 void           mono_metadata_free_type         (MonoType        *type);
 253 int            mono_type_size                  (MonoType        *type,
 254                                                 int             *alignment);
 255 int            mono_type_stack_size            (MonoType        *type,
 256                                                 int             *alignment);
 257
 258 guint          mono_metadata_type_hash         (MonoType *t1);
 259 gboolean       mono_metadata_type_equal        (MonoType *t1, MonoType *t2);
 260
 261 MonoMethodSignature  *mono_metadata_parse_method_signature (MonoImage            *m,
 262                                                             int                    def,
 263                                                             const char            *ptr,
 264                                                             const char           **rptr);
 265 void                  mono_metadata_free_method_signature  (MonoMethodSignature   *method);
 266
 267 gboolean          mono_metadata_signature_equal (MonoMethodSignature *sig1,
 268                                                  MonoMethodSignature *sig2);
 269
 270 MonoMethodHeader *mono_metadata_parse_mh (MonoImage *m, const char *ptr);
 271 void              mono_metadata_free_mh  (MonoMethodHeader *mh);
 272
 273 /*
 274  * Makes a token based on a table and an index
 275  */
 276 #define mono_metadata_make_token(table,idx) (((table) << 24)| idx)
 277
 278 /*
 279  * Returns the table index that this token encodes.
 280  */
 281 #define mono_metadata_token_table(token) ((token) >> 24)
 282
 283  /*
 284  * Returns the index that a token refers to
 285  */
 286 #define mono_metadata_token_index(token) ((token & 0xffffff))
 287
 288
 289 #define mono_metadata_token_code(token) ((token & 0xff000000))
 290
 291 guint32 mono_metadata_token_from_dor (guint32 dor_index);
 292
 293 #endif /* __MONO_METADATA_H__ */