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
  10 #ifdef __GNUC__
  11 #define MONO_ZERO_LEN_ARRAY 0
  12 #else
  13 #define MONO_ZERO_LEN_ARRAY 1
  14 #endif
  15
  16 typedef enum {
  17         MONO_TABLE_MODULE,
  18         MONO_TABLE_TYPEREF,
  19         MONO_TABLE_TYPEDEF,
  20         MONO_TABLE_UNUSED1,
  21         MONO_TABLE_FIELD,
  22         MONO_TABLE_UNUSED2,
  23         MONO_TABLE_METHOD,
  24         MONO_TABLE_UNUSED3,
  25         MONO_TABLE_PARAM,
  26         MONO_TABLE_INTERFACEIMPL,
  27         MONO_TABLE_MEMBERREF,
  28         MONO_TABLE_CONSTANT,
  29         MONO_TABLE_CUSTOMATTRIBUTE,
  30         MONO_TABLE_FIELDMARSHAL,
  31         MONO_TABLE_DECLSECURITY,
  32         MONO_TABLE_CLASSLAYOUT,
  33         MONO_TABLE_FIELDLAYOUT,
  34         MONO_TABLE_STANDALONESIG,
  35         MONO_TABLE_EVENTMAP,
  36         MONO_TABLE_UNUSED4,
  37         MONO_TABLE_EVENT,
  38         MONO_TABLE_PROPERTYMAP,
  39         MONO_TABLE_UNUSED5,
  40         MONO_TABLE_PROPERTY,
  41         MONO_TABLE_METHODSEMANTICS,
  42         MONO_TABLE_METHODIMPL,
  43         MONO_TABLE_MODULEREF,
  44         MONO_TABLE_TYPESPEC,
  45         MONO_TABLE_IMPLMAP,
  46         MONO_TABLE_FIELDRVA,
  47         MONO_TABLE_UNUSED6,
  48         MONO_TABLE_UNUSED7,
  49         MONO_TABLE_ASSEMBLY,
  50         MONO_TABLE_ASSEMBLYPROCESSOR,
  51         MONO_TABLE_ASSEMBLYOS,
  52         MONO_TABLE_ASSEMBLYREF,
  53         MONO_TABLE_ASSEMBLYREFPROCESSOR,
  54         MONO_TABLE_ASSEMBLYREFOS,
  55         MONO_TABLE_FILE,
  56         MONO_TABLE_EXPORTEDTYPE,
  57         MONO_TABLE_MANIFESTRESOURCE,
  58         MONO_TABLE_NESTEDCLASS,
  59
  60 #define MONO_TABLE_LAST MONO_TABLE_NESTEDCLASS
  61 } MonoMetaTableEnum;
  62
  63 typedef enum {
  64         MONO_EXCEPTION_CLAUSE_NONE,
  65         MONO_EXCEPTION_CLAUSE_FILTER,
  66         MONO_EXCEPTION_CLAUSE_FINALLY,
  67         MONO_EXCEPTION_CLAUSE_FAULT = 4
  68 } MonoExceptionEnum;
  69
  70 typedef enum {
  71         MONO_CALL_DEFAULT,
  72         MONO_CALL_C,
  73         MONO_CALL_STDCALL,
  74         MONO_CALL_THISCALL,
  75         MONO_CALL_FASTCALL,
  76         MONO_CALL_VARARG
  77 } MonoCallConvention;
  78
  79 typedef struct {
  80         guint32  offset;
  81         guint32  size;
  82 } MonoStreamHeader;
  83
  84 typedef struct {
  85         guint32   rows, row_size;
  86         char     *base;
  87
  88         /*
  89          * Tables contain up to 9 rows and the possible sizes of the
  90          * fields in the documentation are 1, 2 and 4 bytes.  So we
  91          * can encode in 2 bits the size.
  92          *
  93          * A 32 bit value can encode the resulting size
  94          *
  95          * The top eight bits encode the number of columns in the table.
  96          * we only need 4, but 8 is aligned no shift required.
  97          */
  98         guint32   size_bitfield;
  99 } MonoTableInfo;
 100
 101 void         mono_metadata_decode_row (MonoTableInfo         *t,
 102                                        int                    idx,
 103                                        guint32               *res,
 104                                        int                    res_size);
 105
 106 /*
 107  * This macro is used to extract the size of the table encoded in
 108  * the size_bitfield of MonoTableInfo.
 109  */
 110 #define mono_metadata_table_size(bitfield,table) ((((bitfield) >> ((table)*2)) & 0x3) + 1)
 111 #define mono_metadata_table_count(bitfield) ((bitfield) >> 24)
 112
 113 typedef struct {
 114         char                *raw_metadata;
 115
 116         gboolean             idx_string_wide, idx_guid_wide, idx_blob_wide;
 117
 118         MonoStreamHeader     heap_strings;
 119         MonoStreamHeader     heap_us;
 120         MonoStreamHeader     heap_blob;
 121         MonoStreamHeader     heap_guid;
 122         MonoStreamHeader     heap_tables;
 123
 124         char                *tables_base;
 125
 126         MonoTableInfo        tables [64];
 127 } MonoMetadata;
 128
 129 /*
 130  *
 131  */
 132 char          *mono_metadata_locate        (MonoMetadata *meta, int table, int idx);
 133 char          *mono_metadata_locate_token  (MonoMetadata *meta, guint32 token);
 134
 135 const char    *mono_metadata_string_heap   (MonoMetadata *meta, guint32 index);
 136 const char    *mono_metadata_blob_heap     (MonoMetadata *meta, guint32 index);
 137 const char    *mono_metadata_user_string   (MonoMetadata *meta, guint32 index);
 138
 139 guint32 mono_metadata_typedef_from_field  (MonoMetadata *meta, guint32 index);
 140 guint32 mono_metadata_typedef_from_method (MonoMetadata *meta, guint32 index);
 141
 142 /*
 143  * Functions to extract information from the Blobs
 144  */
 145 guint32 mono_metadata_decode_value     (const char            *ptr,
 146                                         const char           **rptr);
 147 guint32 mono_metadata_decode_blob_size (const char            *ptr,
 148                                         const char           **rptr);
 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 _MonoArray MonoArray;
 161 typedef struct _MonoMethodSignature MonoMethodSignature;
 162
 163 typedef struct {
 164         guchar mod;
 165         guint32 token;
 166 } MonoCustomMod;
 167
 168 typedef struct {
 169         MonoType *type;
 170         int num_modifiers;
 171         MonoCustomMod modifiers[MONO_ZERO_LEN_ARRAY]; /* this may grow */
 172 } MonoModifiedType;
 173
 174 struct _MonoArray {
 175         MonoType *type;
 176         int rank;
 177         int numsizes;
 178         int numlobounds;
 179         int *sizes;
 180         int *lobounds;
 181 };
 182
 183 struct _MonoType {
 184         guchar type; /* ElementTypeEnum */
 185         guchar custom_mod; /* for PTR and SZARRAY: use data.mtype instead of data.type */
 186         guchar byref; /* when included in a MonoRetType */
 187         guchar constraint; /* valid when included in a local var signature */
 188         union {
 189                 guint32 token; /* for VALUETYPE and CLASS */
 190                 MonoType *type;
 191                 MonoModifiedType *mtype;
 192                 MonoArray *array; /* for ARRAY */
 193                 MonoMethodSignature *method;
 194         } data;
 195 };
 196
 197 typedef struct {
 198         /* maybe use a union here: saves 4 bytes */
 199         MonoType *type; /* NULL for VOID */
 200         short param_attrs; /* 22.1.11 */
 201         char typedbyref;
 202         char num_modifiers;
 203         MonoCustomMod modifiers[MONO_ZERO_LEN_ARRAY]; /* this may grow */
 204 } MonoRetType;
 205
 206 /* MonoRetType is used also for params and fields */
 207 typedef MonoRetType MonoParam;
 208 typedef MonoRetType MonoFieldType;
 209
 210 struct _MonoMethodSignature {
 211         char hasthis;
 212         char explicit_this;
 213         char call_convention;
 214         int param_count;
 215         int sentinelpos;
 216         MonoRetType *ret;
 217         MonoParam **params;
 218 };
 219
 220 typedef struct {
 221         guint32      code_size;
 222         const char  *code;
 223         short        max_stack;
 224         unsigned int num_clauses : 15;
 225         /* if num_locals != 0, then the following apply: */
 226         unsigned int init_locals : 1;
 227         int          num_locals;
 228         MonoType   **locals;
 229
 230         MonoExceptionClause *clauses;
 231 } MonoMethodHeader;
 232
 233 guint32     mono_metadata_parse_typedef_or_ref (MonoMetadata      *m,
 234                                                 const char      *ptr,
 235                                                 const char     **rptr);
 236 int            mono_metadata_parse_custom_mod  (MonoMetadata      *m,
 237                                                 MonoCustomMod   *dest,
 238                                                 const char      *ptr,
 239                                                 const char     **rptr);
 240 MonoArray     *mono_metadata_parse_array       (MonoMetadata      *m,
 241                                                 const char      *ptr,
 242                                                 const char     **rptr);
 243 void           mono_metadata_free_array        (MonoArray       *array);
 244 MonoParam     *mono_metadata_parse_param       (MonoMetadata      *m,
 245                                                 int              rettype,
 246                                                 const char      *ptr,
 247                                                 const char     **rptr);
 248 void           mono_metadata_free_param        (MonoParam       *param);
 249 MonoType      *mono_metadata_parse_type        (MonoMetadata      *m,
 250                                                 const char      *ptr,
 251                                                 const char     **rptr);
 252 void           mono_metadata_free_type         (MonoType        *type);
 253
 254 MonoFieldType *mono_metadata_parse_field_type  (MonoMetadata      *m,
 255                                                 const char      *ptr,
 256                                                 const char      **rptr);
 257
 258
 259 MonoMethodSignature  *mono_metadata_parse_method_signature (MonoMetadata            *m,
 260                                                             int                    def,
 261                                                             const char            *ptr,
 262                                                             const char           **rptr);
 263 void                  mono_metadata_free_method_signature  (MonoMethodSignature   *method);
 264
 265 MonoMethodHeader *mono_metadata_parse_mh (MonoMetadata *m, const char *ptr);
 266 void              mono_metadata_free_mh  (MonoMethodHeader *mh);
 267
 268 /*
 269  * Makes a token based on a table and an index
 270  */
 271 #define mono_metadata_make_token(table,idx) (((table) << 24)| idx)
 272
 273 /*
 274  * Returns the table index that this token encodes.
 275  */
 276 #define mono_metadata_token_table(token) ((token) >> 24)
 277
 278  /*
 279  * Returns the index that a token refers to
 280  */
 281 #define mono_metadata_token_index(token) ((token & 0xffffff))
 282
 283
 284 #define mono_metadata_token_code(token) ((token & 0xff000000))
 285
 286 guint32 mono_metadata_token_from_dor (guint32 dor_index);
 287
 288 #endif /* __MONO_METADATA_H__ */