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