In mono/dis:
[mono.git] / 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 G_BEGIN_DECLS
12
13 #ifdef __GNUC__
14 #define MONO_ZERO_LEN_ARRAY 0
15 #else
16 #define MONO_ZERO_LEN_ARRAY 1
17 #endif
18
19 #define MONO_TYPE_ISSTRUCT(t) (!(t)->byref && (((t)->type == MONO_TYPE_VALUETYPE && !(t)->data.klass->enumtype) || ((t)->type == MONO_TYPE_TYPEDBYREF) || (((t)->type == MONO_TYPE_GENERICINST) && mono_metadata_generic_class_is_valuetype ((t)->data.generic_class))))
20 #define MONO_TYPE_IS_VOID(t) ((t) && ((t)->type == MONO_TYPE_VOID) && !(t)->byref)
21 #define MONO_TYPE_IS_POINTER(t) ((t) && (((t)->byref || ((t)->type == MONO_TYPE_I) || (t)->type == MONO_TYPE_STRING) || ((t)->type == MONO_TYPE_SZARRAY) || ((t)->type == MONO_TYPE_CLASS) || ((t)->type == MONO_TYPE_CLASS) || ((t)->type == MONO_TYPE_OBJECT) || ((t)->type == MONO_TYPE_ARRAY) || ((t)->type == MONO_TYPE_PTR)))
22
23 #define MONO_TYPE_IS_REFERENCE(t) ((t) &&                                       \
24                                    ((((t)->type == MONO_TYPE_STRING) ||         \
25                                      ((t)->type == MONO_TYPE_SZARRAY) ||        \
26                                      ((t)->type == MONO_TYPE_CLASS) ||          \
27                                      ((t)->type == MONO_TYPE_OBJECT) ||         \
28                                      ((t)->type == MONO_TYPE_ARRAY)) ||         \
29                                     (((t)->type == MONO_TYPE_GENERICINST) &&    \
30                                      !mono_metadata_generic_class_is_valuetype ((t)->data.generic_class))))
31
32 #define MONO_CLASS_IS_INTERFACE(c) ((c->flags & TYPE_ATTRIBUTE_INTERFACE) || (c->byval_arg.type == MONO_TYPE_VAR) || (c->byval_arg.type == MONO_TYPE_MVAR))
33
34 typedef struct _MonoClass MonoClass;
35 typedef struct _MonoDomain MonoDomain;
36
37 typedef enum {
38         MONO_EXCEPTION_CLAUSE_NONE,
39         MONO_EXCEPTION_CLAUSE_FILTER,
40         MONO_EXCEPTION_CLAUSE_FINALLY,
41         MONO_EXCEPTION_CLAUSE_FAULT = 4
42 } MonoExceptionEnum;
43
44 typedef enum {
45         MONO_CALL_DEFAULT,
46         MONO_CALL_C,
47         MONO_CALL_STDCALL,
48         MONO_CALL_THISCALL,
49         MONO_CALL_FASTCALL,
50         MONO_CALL_VARARG
51 } MonoCallConvention;
52
53 /* ECMA lamespec: the old spec had more info... */
54 typedef enum {
55         MONO_NATIVE_BOOLEAN = 0x02, /* 4 bytes, 0 is false, != 0 is true */
56         MONO_NATIVE_I1 = 0x03,
57         MONO_NATIVE_U1 = 0x04,
58         MONO_NATIVE_I2 = 0x05,
59         MONO_NATIVE_U2 = 0x06,
60         MONO_NATIVE_I4 = 0x07,
61         MONO_NATIVE_U4 = 0x08,
62         MONO_NATIVE_I8 = 0x09,
63         MONO_NATIVE_U8 = 0x0a,
64         MONO_NATIVE_R4 = 0x0b,
65         MONO_NATIVE_R8 = 0x0c,
66         MONO_NATIVE_CURRENCY = 0x0f,
67         MONO_NATIVE_BSTR = 0x13, /* prefixed length, Unicode */
68         MONO_NATIVE_LPSTR = 0x14, /* ANSI, null terminated */
69         MONO_NATIVE_LPWSTR = 0x15, /* UNICODE, null terminated */
70         MONO_NATIVE_LPTSTR = 0x16, /* plattform dep., null terminated */
71         MONO_NATIVE_BYVALTSTR = 0x17,
72         MONO_NATIVE_IUNKNOWN = 0x19,
73         MONO_NATIVE_IDISPATCH = 0x1a,
74         MONO_NATIVE_STRUCT = 0x1b,
75         MONO_NATIVE_INTERFACE = 0x1c,
76         MONO_NATIVE_SAFEARRAY = 0x1d,
77         MONO_NATIVE_BYVALARRAY = 0x1e,
78         MONO_NATIVE_INT   = 0x1f,
79         MONO_NATIVE_UINT  = 0x20,
80         MONO_NATIVE_VBBYREFSTR  = 0x22,
81         MONO_NATIVE_ANSIBSTR  = 0x23,  /* prefixed length, ANSI */
82         MONO_NATIVE_TBSTR  = 0x24, /* prefixed length, plattform dep. */
83         MONO_NATIVE_VARIANTBOOL  = 0x25,
84         MONO_NATIVE_FUNC  = 0x26,
85         MONO_NATIVE_ASANY = 0x28,
86         MONO_NATIVE_LPARRAY = 0x2a,
87         MONO_NATIVE_LPSTRUCT = 0x2b,
88         MONO_NATIVE_CUSTOM = 0x2c,
89         MONO_NATIVE_ERROR = 0x2d,
90         MONO_NATIVE_MAX = 0x50 /* no info */
91 } MonoMarshalNative;
92
93 /* Used only in context of SafeArray */
94 typedef enum {
95         MONO_VARIANT_EMPTY = 0x00,
96         MONO_VARIANT_NULL = 0x01,
97         MONO_VARIANT_I2 = 0x02,
98         MONO_VARIANT_I4 = 0x03,
99         MONO_VARIANT_R4 = 0x04,
100         MONO_VARIANT_R8 = 0x05,
101         MONO_VARIANT_CY = 0x06,
102         MONO_VARIANT_DATE = 0x07,
103         MONO_VARIANT_BSTR = 0x08,
104         MONO_VARIANT_DISPATCH = 0x09,
105         MONO_VARIANT_ERROR = 0x0a,
106         MONO_VARIANT_BOOL = 0x0b,
107         MONO_VARIANT_VARIANT = 0x0c,
108         MONO_VARIANT_UNKNOWN = 0x0d,
109         MONO_VARIANT_DECIMAL = 0x0e,
110         MONO_VARIANT_I1 = 0x10,
111         MONO_VARIANT_UI1 = 0x11,
112         MONO_VARIANT_UI2 = 0x12,
113         MONO_VARIANT_UI4 = 0x13,
114         MONO_VARIANT_I8 = 0x14,
115         MONO_VARIANT_UI8 = 0x15,
116         MONO_VARIANT_INT = 0x16,
117         MONO_VARIANT_UINT = 0x17,
118         MONO_VARIANT_VOID = 0x18,
119         MONO_VARIANT_HRESULT = 0x19,
120         MONO_VARIANT_PTR = 0x1a,
121         MONO_VARIANT_SAFEARRAY = 0x1b,
122         MONO_VARIANT_CARRAY = 0x1c,
123         MONO_VARIANT_USERDEFINED = 0x1d,
124         MONO_VARIANT_LPSTR = 0x1e,
125         MONO_VARIANT_LPWSTR = 0x1f,
126         MONO_VARIANT_RECORD = 0x24,
127         MONO_VARIANT_FILETIME = 0x40,
128         MONO_VARIANT_BLOB = 0x41,
129         MONO_VARIANT_STREAM = 0x42,
130         MONO_VARIANT_STORAGE = 0x43,
131         MONO_VARIANT_STREAMED_OBJECT = 0x44,
132         MONO_VARIANT_STORED_OBJECT = 0x45,
133         MONO_VARIANT_BLOB_OBJECT = 0x46,
134         MONO_VARIANT_CF = 0x47,
135         MONO_VARIANT_CLSID = 0x48,
136         MONO_VARIANT_VECTOR = 0x1000,
137         MONO_VARIANT_ARRAY = 0x2000,
138         MONO_VARIANT_BYREF = 0x4000
139 } MonoMarshalVariant;
140
141 typedef enum {
142         MONO_MARSHAL_CONV_NONE,
143         MONO_MARSHAL_CONV_BOOL_VARIANTBOOL,
144         MONO_MARSHAL_CONV_BOOL_I4,
145         MONO_MARSHAL_CONV_STR_BSTR,
146         MONO_MARSHAL_CONV_STR_LPSTR,
147         MONO_MARSHAL_CONV_LPSTR_STR,
148         MONO_MARSHAL_CONV_LPTSTR_STR,
149         MONO_MARSHAL_CONV_STR_LPWSTR,
150         MONO_MARSHAL_CONV_LPWSTR_STR,
151         MONO_MARSHAL_CONV_STR_LPTSTR,
152         MONO_MARSHAL_CONV_STR_ANSIBSTR,
153         MONO_MARSHAL_CONV_STR_TBSTR,
154         MONO_MARSHAL_CONV_STR_BYVALSTR,
155         MONO_MARSHAL_CONV_STR_BYVALWSTR,
156         MONO_MARSHAL_CONV_SB_LPSTR,
157         MONO_MARSHAL_CONV_SB_LPTSTR,
158         MONO_MARSHAL_CONV_SB_LPWSTR,
159         MONO_MARSHAL_CONV_LPSTR_SB,
160         MONO_MARSHAL_CONV_LPTSTR_SB,
161         MONO_MARSHAL_CONV_LPWSTR_SB,
162         MONO_MARSHAL_CONV_ARRAY_BYVALARRAY,
163         MONO_MARSHAL_CONV_ARRAY_SAVEARRAY,
164         MONO_MARSHAL_CONV_ARRAY_LPARRAY,
165         MONO_MARSHAL_CONV_OBJECT_INTERFACE,
166         MONO_MARSHAL_CONV_OBJECT_IDISPATCH,
167         MONO_MARSHAL_CONV_OBJECT_IUNKNOWN,
168         MONO_MARSHAL_CONV_OBJECT_STRUCT,
169         MONO_MARSHAL_CONV_DEL_FTN,
170         MONO_MARSHAL_CONV_FTN_DEL,
171         MONO_MARSHAL_FREE_ARRAY
172 } MonoMarshalConv;
173
174 typedef struct {
175         MonoMarshalNative native;
176         union {
177                 struct {
178                         MonoMarshalNative elem_type;
179                         gint32 num_elem; /* -1 if not set */
180                         gint16 param_num; /* -1 if not set */
181                         gint16 elem_mult; /* -1 if not set */
182                 } array_data;
183                 struct {
184                         char *custom_name;
185                         char *cookie;
186                 } custom_data;
187                 struct {
188                         MonoMarshalVariant elem_type;
189                         gint32 num_elem;
190                 } safearray_data;
191         } data;
192 } MonoMarshalSpec;
193
194 void         mono_metadata_init (void);
195
196 void         mono_metadata_decode_row (const MonoTableInfo   *t,
197                                        int                    idx,
198                                        guint32               *res,
199                                        int                    res_size);
200
201 guint32      mono_metadata_decode_row_col (const MonoTableInfo *t, 
202                                            int            idx, 
203                                            guint          col);
204
205 /*
206  * This macro is used to extract the size of the table encoded in
207  * the size_bitfield of MonoTableInfo.
208  */
209 #define mono_metadata_table_size(bitfield,table) ((((bitfield) >> ((table)*2)) & 0x3) + 1)
210 #define mono_metadata_table_count(bitfield) ((bitfield) >> 24)
211
212 int mono_metadata_compute_size (MonoImage   *meta,
213                                 int             tableindex,
214                                 guint32        *result_bitfield);
215
216 /*
217  *
218  */
219 const char    *mono_metadata_locate        (MonoImage *meta, int table, int idx);
220 const char    *mono_metadata_locate_token  (MonoImage *meta, guint32 token);
221                                            
222 const char    *mono_metadata_string_heap   (MonoImage *meta, guint32 table_index);
223 const char    *mono_metadata_blob_heap     (MonoImage *meta, guint32 table_index);
224 const char    *mono_metadata_user_string   (MonoImage *meta, guint32 table_index);
225 const char    *mono_metadata_guid_heap     (MonoImage *meta, guint32 table_index);
226
227 guint32 mono_metadata_typedef_from_field  (MonoImage *meta, guint32 table_index);
228 guint32 mono_metadata_typedef_from_method (MonoImage *meta, guint32 table_index);
229 guint32 mono_metadata_nested_in_typedef   (MonoImage *meta, guint32 table_index);
230 guint32 mono_metadata_nesting_typedef     (MonoImage *meta, guint32 table_index, guint32 start_index);
231
232 MonoClass** mono_metadata_interfaces_from_typedef (MonoImage *meta, guint32 table_index, guint *count);
233
234 guint32     mono_metadata_events_from_typedef     (MonoImage *meta, guint32 table_index, guint *end_idx);
235 guint32     mono_metadata_methods_from_event      (MonoImage *meta, guint32 table_index, guint *end);
236 guint32     mono_metadata_properties_from_typedef (MonoImage *meta, guint32 table_index, guint *end);
237 guint32     mono_metadata_methods_from_property   (MonoImage *meta, guint32 table_index, guint *end);
238 guint32     mono_metadata_packing_from_typedef    (MonoImage *meta, guint32 table_index, guint32 *packing, guint32 *size);
239 const char* mono_metadata_get_marshal_info        (MonoImage *meta, guint32 idx, gboolean is_field);
240 guint32     mono_metadata_custom_attrs_from_index (MonoImage *meta, guint32 cattr_index);
241
242 MonoMarshalSpec *mono_metadata_parse_marshal_spec (MonoImage *image, const char *ptr);
243
244 void mono_metadata_free_marshal_spec (MonoMarshalSpec *spec);
245
246 guint32     mono_metadata_implmap_from_method     (MonoImage *meta, guint32 method_idx);
247
248 void        mono_metadata_field_info (MonoImage *meta, 
249                                       guint32       table_index,
250                                       guint32      *offset,
251                                       guint32      *rva,
252                                       MonoMarshalSpec **marshal_spec);
253
254 guint32     mono_metadata_get_constant_index (MonoImage *meta, guint32 token, guint32 hint);
255
256 /*
257  * Functions to extract information from the Blobs
258  */
259 guint32 mono_metadata_decode_value     (const char            *ptr,
260                                         const char           **rptr);
261 guint32 mono_metadata_decode_blob_size (const char            *ptr,
262                                         const char           **rptr);
263
264 void mono_metadata_encode_value (guint32 value, char *bug, char **endbuf);
265
266 #define MONO_OFFSET_IN_CLAUSE(clause,offset) \
267         ((clause)->try_offset <= (offset) && (offset) < ((clause)->try_offset + (clause)->try_len))
268 #define MONO_OFFSET_IN_HANDLER(clause,offset) \
269         ((clause)->handler_offset <= (offset) && (offset) < ((clause)->handler_offset + (clause)->handler_len))
270
271 typedef struct {
272         guint32 flags;
273         guint32 try_offset;
274         guint32 try_len;
275         guint32 handler_offset;
276         guint32 handler_len;
277         union {
278                 guint32 filter_offset;
279                 MonoClass *catch_class;
280         } data;
281 } MonoExceptionClause;
282
283 typedef struct _MonoType MonoType;
284 typedef struct _MonoGenericInst MonoGenericInst;
285 typedef struct _MonoGenericClass MonoGenericClass;
286 typedef struct _MonoInflatedGenericClass MonoInflatedGenericClass;
287 typedef struct _MonoDynamicGenericClass MonoDynamicGenericClass;
288 typedef struct _MonoGenericMethod MonoGenericMethod;
289 typedef struct _MonoGenericContext MonoGenericContext;
290 typedef struct _MonoGenericContainer MonoGenericContainer;
291 typedef struct _MonoGenericParam MonoGenericParam;
292 typedef struct _MonoArrayType MonoArrayType;
293 typedef struct _MonoMethodSignature MonoMethodSignature;
294
295 typedef struct {
296         unsigned int required : 1;
297         unsigned int token    : 31;
298 } MonoCustomMod;
299
300 struct _MonoArrayType {
301         MonoClass *eklass;
302         guint8 rank;
303         guint8 numsizes;
304         guint8 numlobounds;
305         int *sizes;
306         int *lobounds;
307 };
308
309 struct _MonoType {
310         union {
311                 MonoClass *klass; /* for VALUETYPE and CLASS */
312                 MonoType *type;   /* for PTR */
313                 MonoArrayType *array; /* for ARRAY */
314                 MonoMethodSignature *method;
315                 MonoGenericParam *generic_param; /* for VAR and MVAR */
316                 MonoGenericClass *generic_class; /* for GENERICINST */
317         } data;
318         unsigned int attrs    : 16; /* param attributes or field flags */
319         unsigned int type     : 8;  /* ElementTypeEnum */
320         unsigned int num_mods : 6;  /* max 64 modifiers follow at the end */
321         unsigned int byref    : 1;
322         unsigned int pinned   : 1;  /* valid when included in a local var signature */
323         MonoCustomMod modifiers [MONO_ZERO_LEN_ARRAY]; /* this may grow */
324 };
325
326 struct _MonoMethodSignature {
327         unsigned int  hasthis : 1;
328         unsigned int  explicit_this   : 1;
329         unsigned int  call_convention : 6;
330         unsigned int  pinvoke   : 1;
331         unsigned int  ref_count : 23;
332         guint16       param_count;
333         gint16        sentinelpos;
334         unsigned int  generic_param_count : 30;
335         unsigned int  is_inflated         : 1;
336         unsigned int  has_type_parameters : 1;
337         MonoType     *ret;
338         MonoType     *params [MONO_ZERO_LEN_ARRAY];
339 };
340
341 typedef struct {
342         guint32      code_size;
343         const unsigned char  *code;
344         guint16      max_stack;
345         unsigned int num_clauses : 15;
346         /* if num_locals != 0, then the following apply: */
347         unsigned int init_locals : 1;
348         guint16      num_locals;
349         MonoExceptionClause *clauses;
350         MonoType    *locals [MONO_ZERO_LEN_ARRAY];
351 } MonoMethodHeader;
352
353 typedef enum {
354         MONO_PARSE_TYPE,
355         MONO_PARSE_MOD_TYPE,
356         MONO_PARSE_LOCAL,
357         MONO_PARSE_PARAM,
358         MONO_PARSE_RET,
359         MONO_PARSE_FIELD
360 } MonoParseTypeMode;
361
362 gboolean
363 mono_type_is_byref       (MonoType *type);
364
365 int
366 mono_type_get_type       (MonoType *type);
367
368 /* For MONO_TYPE_FNPTR */
369 MonoMethodSignature*
370 mono_type_get_signature  (MonoType *type);
371
372 /* For MONO_TYPE_CLASS, VALUETYPE */
373 MonoClass*
374 mono_type_get_class      (MonoType *type);
375
376 MonoArrayType*
377 mono_type_get_array_type (MonoType *type);
378
379 MonoClass*
380 mono_type_get_modifiers  (MonoType *type, gboolean *is_required, gpointer *iter);
381
382 MonoType*
383 mono_signature_get_return_type (MonoMethodSignature *sig);
384
385 MonoType*
386 mono_signature_get_params      (MonoMethodSignature *sig, gpointer *iter);
387
388 guint32
389 mono_signature_get_param_count (MonoMethodSignature *sig);
390
391 guint32
392 mono_signature_get_call_conv   (MonoMethodSignature *sig);
393
394 int
395 mono_signature_vararg_start    (MonoMethodSignature *sig);
396
397 gboolean
398 mono_signature_is_instance     (MonoMethodSignature *sig);
399
400 gboolean
401 mono_signature_explicit_this   (MonoMethodSignature *sig);
402
403 guint32     mono_metadata_parse_typedef_or_ref (MonoImage      *m,
404                                                 const char      *ptr,
405                                                 const char     **rptr);
406 int            mono_metadata_parse_custom_mod  (MonoImage      *m,
407                                                 MonoCustomMod   *dest,
408                                                 const char      *ptr,
409                                                 const char     **rptr);
410 MonoArrayType *mono_metadata_parse_array       (MonoImage      *m,
411                                                 const char      *ptr,
412                                                 const char     **rptr);
413 void           mono_metadata_free_array        (MonoArrayType     *array);
414 MonoType      *mono_metadata_parse_type        (MonoImage      *m,
415                                                 MonoParseTypeMode  mode,
416                                                 short              opt_attrs,
417                                                 const char        *ptr,
418                                                 const char       **rptr);
419 MonoType      *mono_metadata_parse_param       (MonoImage      *m,
420                                                 const char      *ptr,
421                                                 const char      **rptr);
422 MonoType      *mono_metadata_parse_ret_type    (MonoImage      *m,
423                                                 const char      *ptr,
424                                                 const char      **rptr);
425 MonoType      *mono_metadata_parse_field_type  (MonoImage      *m,
426                                                 short            field_flags,
427                                                 const char      *ptr,
428                                                 const char      **rptr);
429 MonoType      *mono_type_create_from_typespec  (MonoImage        *image, 
430                                                 guint32           type_spec);
431 void           mono_metadata_free_type         (MonoType        *type);
432 int            mono_type_size                  (MonoType        *type, 
433                                                 int             *alignment);
434 int            mono_type_stack_size            (MonoType        *type, 
435                                                 int             *alignment);
436
437 gboolean       mono_metadata_generic_class_is_valuetype (MonoGenericClass *gclass);
438 guint          mono_metadata_generic_class_hash  (MonoGenericClass *gclass);
439 gboolean       mono_metadata_generic_class_equal (MonoGenericClass *g1, MonoGenericClass *g2);
440
441 guint          mono_metadata_type_hash         (MonoType *t1);
442 gboolean       mono_metadata_type_equal        (MonoType *t1, MonoType *t2);
443
444 MonoMethodSignature  *mono_metadata_signature_alloc (MonoImage *image, guint32 nparams);
445
446 MonoMethodSignature  *mono_metadata_signature_dup (MonoMethodSignature *sig);
447
448 MonoMethodSignature  *mono_metadata_parse_signature (MonoImage *image, 
449                                                      guint32    token);
450
451 MonoMethodSignature  *mono_metadata_parse_method_signature (MonoImage            *m,
452                                                             int                    def,
453                                                             const char            *ptr,
454                                                             const char           **rptr);
455 void                  mono_metadata_free_method_signature  (MonoMethodSignature   *method);
456
457 gboolean          mono_metadata_signature_equal (MonoMethodSignature *sig1, 
458                                                  MonoMethodSignature *sig2);
459
460 guint             mono_signature_hash (MonoMethodSignature *sig);
461
462 MonoMethodHeader *mono_metadata_parse_mh (MonoImage *m, const char *ptr);
463 void              mono_metadata_free_mh  (MonoMethodHeader *mh);
464
465 guint32 
466 mono_type_to_unmanaged (MonoType *type, MonoMarshalSpec *mspec, 
467                         gboolean as_field, gboolean unicode, MonoMarshalConv *conv);
468
469 /*
470  * Makes a token based on a table and an index
471  */
472 #define mono_metadata_make_token(table,idx) (((table) << 24)| (idx))
473
474 /*
475  * Returns the table index that this token encodes.
476  */
477 #define mono_metadata_token_table(token) ((token) >> 24)
478
479  /*
480  * Returns the index that a token refers to
481  */
482 #define mono_metadata_token_index(token) ((token & 0xffffff))
483
484
485 #define mono_metadata_token_code(token) ((token & 0xff000000))
486
487 guint32 mono_metadata_token_from_dor (guint32 dor_index);
488
489 char *mono_guid_to_string (const guint8 *guid);
490
491 guint32 mono_metadata_declsec_from_index (MonoImage *meta, guint32 idx);
492
493 G_END_DECLS
494
495 #endif /* __MONO_METADATA_H__ */