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 char          *mono_metadata_locate        (MonoImage *meta, int table, int idx);
 107 char          *mono_metadata_locate_token  (MonoImage *meta, guint32 token);
 108
 109 const char    *mono_metadata_string_heap   (MonoImage *meta, guint32 index);
 110 const char    *mono_metadata_blob_heap     (MonoImage *meta, guint32 index);
 111 const char    *mono_metadata_user_string   (MonoImage *meta, guint32 index);
 112
 113 guint32 mono_metadata_typedef_from_field  (MonoImage *meta, guint32 index);
 114 guint32 mono_metadata_typedef_from_method (MonoImage *meta, guint32 index);
 115 guint32 mono_metadata_nested_in_typedef   (MonoImage *meta, guint32 index);
 116 guint32 mono_metadata_nesting_typedef     (MonoImage *meta, guint32 index);
 117
 118 MonoClass** mono_metadata_interfaces_from_typedef (MonoImage *meta, guint32 index, guint *count);
 119
 120 guint32     mono_metadata_events_from_typedef     (MonoImage *meta, guint32 index, guint *end_idx);
 121 guint32     mono_metadata_methods_from_event      (MonoImage *meta, guint32 index, guint *end);
 122 guint32     mono_metadata_properties_from_typedef (MonoImage *meta, guint32 index, guint *end);
 123 guint32     mono_metadata_methods_from_property   (MonoImage *meta, guint32 index, guint *end);
 124 guint32     mono_metadata_packing_from_typedef    (MonoImage *meta, guint32 index, guint32 *packing, guint32 *size);
 125
 126 void        mono_metadata_field_info (MonoImage *meta,
 127                                       guint32       index,
 128                                       guint32      *offset,
 129                                       const char  **rva,
 130                                       const char  **marshal_info);
 131
 132 guint32     mono_metadata_get_constant_index (MonoImage *meta, guint32 token);
 133
 134 /*
 135  * Functions to extract information from the Blobs
 136  */
 137 guint32 mono_metadata_decode_value     (const char            *ptr,
 138                                         const char           **rptr);
 139 guint32 mono_metadata_decode_blob_size (const char            *ptr,
 140                                         const char           **rptr);
 141
 142 void mono_metadata_encode_value (guint32 value, char *bug, char **endbuf);
 143
 144 #define MONO_OFFSET_IN_CLAUSE(clause,offset) \
 145         ((clause)->try_offset <= (offset) && (offset) < ((clause)->try_offset + (clause)->try_len))
 146 #define MONO_OFFSET_IN_HANDLER(clause,offset) \
 147         ((clause)->handler_offset <= (offset) && (offset) < ((clause)->handler_offset + (clause)->handler_len))
 148
 149 typedef struct {
 150         guint32 flags;
 151         guint32 try_offset;
 152         guint32 try_len;
 153         guint32 handler_offset;
 154         guint32 handler_len;
 155         guint32 token_or_filter;
 156 } MonoExceptionClause;
 157
 158 typedef struct _MonoType MonoType;
 159 typedef struct _MonoArrayType MonoArrayType;
 160 typedef struct _MonoMethodSignature MonoMethodSignature;
 161
 162 typedef struct {
 163         unsigned int required : 1;
 164         unsigned int token    : 31;
 165 } MonoCustomMod;
 166
 167 struct _MonoArrayType {
 168         MonoType *type;
 169         int rank;
 170         int numsizes;
 171         int numlobounds;
 172         int *sizes;
 173         int *lobounds;
 174 };
 175
 176 struct _MonoType {
 177         union {
 178                 MonoClass *klass; /* for VALUETYPE and CLASS */
 179                 MonoType *type;   /* for PTR and SZARRAY */
 180                 MonoArrayType *array; /* for ARRAY */
 181                 MonoMethodSignature *method;
 182         } data;
 183         unsigned int attrs    : 16; /* param attributes or field flags */
 184         unsigned int type     : 8;  /* ElementTypeEnum */
 185         unsigned int num_mods : 6;  /* max 64 modifiers follow at the end */
 186         unsigned int byref    : 1;
 187         unsigned int pinned   : 1;  /* valid when included in a local var signature */
 188         MonoCustomMod modifiers [MONO_ZERO_LEN_ARRAY]; /* this may grow */
 189 };
 190
 191 struct _MonoMethodSignature {
 192         unsigned int  hasthis : 1;
 193         unsigned int  explicit_this   : 1;
 194         unsigned int  call_convention : 6;
 195         unsigned int  ref_count : 24;
 196         guint16       param_count;
 197         guint16       sentinelpos;
 198         MonoType     *ret;
 199         MonoType     *params [MONO_ZERO_LEN_ARRAY];
 200 };
 201
 202 typedef struct {
 203         guint32      code_size;
 204         const unsigned char  *code;
 205         guint16      max_stack;
 206         unsigned int num_clauses : 15;
 207         /* if num_locals != 0, then the following apply: */
 208         unsigned int init_locals : 1;
 209         guint16      num_locals;
 210         MonoExceptionClause *clauses;
 211         MonoType    *locals [MONO_ZERO_LEN_ARRAY];
 212 } MonoMethodHeader;
 213
 214 typedef enum {
 215         MONO_PARSE_TYPE,
 216         MONO_PARSE_MOD_TYPE,
 217         MONO_PARSE_LOCAL,
 218         MONO_PARSE_PARAM,
 219         MONO_PARSE_RET,
 220         MONO_PARSE_FIELD
 221 } MonoParseTypeMode;
 222
 223 guint32     mono_metadata_parse_typedef_or_ref (MonoImage      *m,
 224                                                 const char      *ptr,
 225                                                 const char     **rptr);
 226 int            mono_metadata_parse_custom_mod  (MonoImage      *m,
 227                                                 MonoCustomMod   *dest,
 228                                                 const char      *ptr,
 229                                                 const char     **rptr);
 230 MonoArrayType *mono_metadata_parse_array       (MonoImage      *m,
 231                                                 const char      *ptr,
 232                                                 const char     **rptr);
 233 void           mono_metadata_free_array        (MonoArrayType     *array);
 234 MonoType      *mono_metadata_parse_type        (MonoImage      *m,
 235                                                 MonoParseTypeMode  mode,
 236                                                 short              opt_attrs,
 237                                                 const char        *ptr,
 238                                                 const char       **rptr);
 239 MonoType      *mono_metadata_parse_param       (MonoImage      *m,
 240                                                 const char      *ptr,
 241                                                 const char      **rptr);
 242 MonoType      *mono_metadata_parse_ret_type    (MonoImage      *m,
 243                                                 const char      *ptr,
 244                                                 const char      **rptr);
 245 MonoType      *mono_metadata_parse_field_type  (MonoImage      *m,
 246                                                 short            field_flags,
 247                                                 const char      *ptr,
 248                                                 const char      **rptr);
 249 MonoType      *mono_type_create_from_typespec (MonoImage        *image,
 250                                                guint32           type_spec);
 251 void           mono_metadata_free_type         (MonoType        *type);
 252 int            mono_type_size                  (MonoType        *type,
 253                                                 int             *alignment);
 254 int            mono_type_stack_size            (MonoType        *type,
 255                                                 int             *alignment);
 256
 257 guint          mono_metadata_type_hash         (MonoType *t1);
 258 gboolean       mono_metadata_type_equal        (MonoType *t1, MonoType *t2);
 259
 260 MonoMethodSignature  *mono_metadata_parse_method_signature (MonoImage            *m,
 261                                                             int                    def,
 262                                                             const char            *ptr,
 263                                                             const char           **rptr);
 264 void                  mono_metadata_free_method_signature  (MonoMethodSignature   *method);
 265
 266 gboolean          mono_metadata_signature_equal (MonoMethodSignature *sig1,
 267                                                  MonoMethodSignature *sig2);
 268
 269 MonoMethodHeader *mono_metadata_parse_mh (MonoImage *m, const char *ptr);
 270 void              mono_metadata_free_mh  (MonoMethodHeader *mh);
 271
 272 /*
 273  * Makes a token based on a table and an index
 274  */
 275 #define mono_metadata_make_token(table,idx) (((table) << 24)| idx)
 276
 277 /*
 278  * Returns the table index that this token encodes.
 279  */
 280 #define mono_metadata_token_table(token) ((token) >> 24)
 281
 282  /*
 283  * Returns the index that a token refers to
 284  */
 285 #define mono_metadata_token_index(token) ((token & 0xffffff))
 286
 287
 288 #define mono_metadata_token_code(token) ((token & 0xff000000))
 289
 290 guint32 mono_metadata_token_from_dor (guint32 dor_index);
 291
 292 #endif /* __MONO_METADATA_H__ */