2 #ifndef __MONO_METADATA_H__
3 #define __MONO_METADATA_H__
7 #include <mono/metadata/blob.h>
8 #include <mono/metadata/row-indexes.h>
9 #include <mono/metadata/image.h>
14 #define MONO_ZERO_LEN_ARRAY 0
16 #define MONO_ZERO_LEN_ARRAY 1
19 #define MONO_TYPE_ISSTRUCT(t) (!(t)->byref && (((t)->type == MONO_TYPE_VALUETYPE && \
20 !(t)->data.klass->enumtype) || ((t)->type == MONO_TYPE_TYPEDBYREF) || \
21 (((t)->type == MONO_TYPE_GENERICINST) && mono_metadata_generic_class_is_valuetype ((t)->data.generic_class) && !(t)->data.generic_class->container_class->enumtype)))
23 #define MONO_TYPE_IS_VOID(t) ((t) && ((t)->type == MONO_TYPE_VOID) && !(t)->byref)
24 #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)))
26 #define MONO_TYPE_IS_REFERENCE(t) ((t) && \
27 ((((t)->type == MONO_TYPE_STRING) || \
28 ((t)->type == MONO_TYPE_SZARRAY) || \
29 ((t)->type == MONO_TYPE_CLASS) || \
30 ((t)->type == MONO_TYPE_OBJECT) || \
31 ((t)->type == MONO_TYPE_ARRAY)) || \
32 (((t)->type == MONO_TYPE_GENERICINST) && \
33 !mono_metadata_generic_class_is_valuetype ((t)->data.generic_class))))
35 #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))
37 #define MONO_CLASS_IS_IMPORT(c) ((c->flags & TYPE_ATTRIBUTE_IMPORT))
39 typedef struct _MonoClass MonoClass;
40 typedef struct _MonoDomain MonoDomain;
41 typedef struct _MonoMethod MonoMethod;
44 MONO_EXCEPTION_CLAUSE_NONE,
45 MONO_EXCEPTION_CLAUSE_FILTER,
46 MONO_EXCEPTION_CLAUSE_FINALLY,
47 MONO_EXCEPTION_CLAUSE_FAULT = 4
59 /* ECMA lamespec: the old spec had more info... */
61 MONO_NATIVE_BOOLEAN = 0x02, /* 4 bytes, 0 is false, != 0 is true */
62 MONO_NATIVE_I1 = 0x03,
63 MONO_NATIVE_U1 = 0x04,
64 MONO_NATIVE_I2 = 0x05,
65 MONO_NATIVE_U2 = 0x06,
66 MONO_NATIVE_I4 = 0x07,
67 MONO_NATIVE_U4 = 0x08,
68 MONO_NATIVE_I8 = 0x09,
69 MONO_NATIVE_U8 = 0x0a,
70 MONO_NATIVE_R4 = 0x0b,
71 MONO_NATIVE_R8 = 0x0c,
72 MONO_NATIVE_CURRENCY = 0x0f,
73 MONO_NATIVE_BSTR = 0x13, /* prefixed length, Unicode */
74 MONO_NATIVE_LPSTR = 0x14, /* ANSI, null terminated */
75 MONO_NATIVE_LPWSTR = 0x15, /* UNICODE, null terminated */
76 MONO_NATIVE_LPTSTR = 0x16, /* plattform dep., null terminated */
77 MONO_NATIVE_BYVALTSTR = 0x17,
78 MONO_NATIVE_IUNKNOWN = 0x19,
79 MONO_NATIVE_IDISPATCH = 0x1a,
80 MONO_NATIVE_STRUCT = 0x1b,
81 MONO_NATIVE_INTERFACE = 0x1c,
82 MONO_NATIVE_SAFEARRAY = 0x1d,
83 MONO_NATIVE_BYVALARRAY = 0x1e,
84 MONO_NATIVE_INT = 0x1f,
85 MONO_NATIVE_UINT = 0x20,
86 MONO_NATIVE_VBBYREFSTR = 0x22,
87 MONO_NATIVE_ANSIBSTR = 0x23, /* prefixed length, ANSI */
88 MONO_NATIVE_TBSTR = 0x24, /* prefixed length, plattform dep. */
89 MONO_NATIVE_VARIANTBOOL = 0x25,
90 MONO_NATIVE_FUNC = 0x26,
91 MONO_NATIVE_ASANY = 0x28,
92 MONO_NATIVE_LPARRAY = 0x2a,
93 MONO_NATIVE_LPSTRUCT = 0x2b,
94 MONO_NATIVE_CUSTOM = 0x2c,
95 MONO_NATIVE_ERROR = 0x2d,
96 MONO_NATIVE_MAX = 0x50 /* no info */
99 /* Used only in context of SafeArray */
101 MONO_VARIANT_EMPTY = 0x00,
102 MONO_VARIANT_NULL = 0x01,
103 MONO_VARIANT_I2 = 0x02,
104 MONO_VARIANT_I4 = 0x03,
105 MONO_VARIANT_R4 = 0x04,
106 MONO_VARIANT_R8 = 0x05,
107 MONO_VARIANT_CY = 0x06,
108 MONO_VARIANT_DATE = 0x07,
109 MONO_VARIANT_BSTR = 0x08,
110 MONO_VARIANT_DISPATCH = 0x09,
111 MONO_VARIANT_ERROR = 0x0a,
112 MONO_VARIANT_BOOL = 0x0b,
113 MONO_VARIANT_VARIANT = 0x0c,
114 MONO_VARIANT_UNKNOWN = 0x0d,
115 MONO_VARIANT_DECIMAL = 0x0e,
116 MONO_VARIANT_I1 = 0x10,
117 MONO_VARIANT_UI1 = 0x11,
118 MONO_VARIANT_UI2 = 0x12,
119 MONO_VARIANT_UI4 = 0x13,
120 MONO_VARIANT_I8 = 0x14,
121 MONO_VARIANT_UI8 = 0x15,
122 MONO_VARIANT_INT = 0x16,
123 MONO_VARIANT_UINT = 0x17,
124 MONO_VARIANT_VOID = 0x18,
125 MONO_VARIANT_HRESULT = 0x19,
126 MONO_VARIANT_PTR = 0x1a,
127 MONO_VARIANT_SAFEARRAY = 0x1b,
128 MONO_VARIANT_CARRAY = 0x1c,
129 MONO_VARIANT_USERDEFINED = 0x1d,
130 MONO_VARIANT_LPSTR = 0x1e,
131 MONO_VARIANT_LPWSTR = 0x1f,
132 MONO_VARIANT_RECORD = 0x24,
133 MONO_VARIANT_FILETIME = 0x40,
134 MONO_VARIANT_BLOB = 0x41,
135 MONO_VARIANT_STREAM = 0x42,
136 MONO_VARIANT_STORAGE = 0x43,
137 MONO_VARIANT_STREAMED_OBJECT = 0x44,
138 MONO_VARIANT_STORED_OBJECT = 0x45,
139 MONO_VARIANT_BLOB_OBJECT = 0x46,
140 MONO_VARIANT_CF = 0x47,
141 MONO_VARIANT_CLSID = 0x48,
142 MONO_VARIANT_VECTOR = 0x1000,
143 MONO_VARIANT_ARRAY = 0x2000,
144 MONO_VARIANT_BYREF = 0x4000
145 } MonoMarshalVariant;
148 MONO_MARSHAL_CONV_NONE,
149 MONO_MARSHAL_CONV_BOOL_VARIANTBOOL,
150 MONO_MARSHAL_CONV_BOOL_I4,
151 MONO_MARSHAL_CONV_STR_BSTR,
152 MONO_MARSHAL_CONV_STR_LPSTR,
153 MONO_MARSHAL_CONV_LPSTR_STR,
154 MONO_MARSHAL_CONV_LPTSTR_STR,
155 MONO_MARSHAL_CONV_STR_LPWSTR,
156 MONO_MARSHAL_CONV_LPWSTR_STR,
157 MONO_MARSHAL_CONV_STR_LPTSTR,
158 MONO_MARSHAL_CONV_STR_ANSIBSTR,
159 MONO_MARSHAL_CONV_STR_TBSTR,
160 MONO_MARSHAL_CONV_STR_BYVALSTR,
161 MONO_MARSHAL_CONV_STR_BYVALWSTR,
162 MONO_MARSHAL_CONV_SB_LPSTR,
163 MONO_MARSHAL_CONV_SB_LPTSTR,
164 MONO_MARSHAL_CONV_SB_LPWSTR,
165 MONO_MARSHAL_CONV_LPSTR_SB,
166 MONO_MARSHAL_CONV_LPTSTR_SB,
167 MONO_MARSHAL_CONV_LPWSTR_SB,
168 MONO_MARSHAL_CONV_ARRAY_BYVALARRAY,
169 MONO_MARSHAL_CONV_ARRAY_BYVALCHARARRAY,
170 MONO_MARSHAL_CONV_ARRAY_SAVEARRAY,
171 MONO_MARSHAL_CONV_ARRAY_LPARRAY,
172 MONO_MARSHAL_FREE_LPARRAY,
173 MONO_MARSHAL_CONV_OBJECT_INTERFACE,
174 MONO_MARSHAL_CONV_OBJECT_IDISPATCH,
175 MONO_MARSHAL_CONV_OBJECT_IUNKNOWN,
176 MONO_MARSHAL_CONV_OBJECT_STRUCT,
177 MONO_MARSHAL_CONV_DEL_FTN,
178 MONO_MARSHAL_CONV_FTN_DEL,
179 MONO_MARSHAL_FREE_ARRAY,
180 MONO_MARSHAL_CONV_BSTR_STR,
181 MONO_MARSHAL_CONV_SAFEHANDLE,
182 MONO_MARSHAL_CONV_HANDLEREF
186 MonoMarshalNative native;
189 MonoMarshalNative elem_type;
190 gint32 num_elem; /* -1 if not set */
191 gint16 param_num; /* -1 if not set */
192 gint16 elem_mult; /* -1 if not set */
199 MonoMarshalVariant elem_type;
205 void mono_metadata_init (void);
207 void mono_metadata_decode_row (const MonoTableInfo *t,
212 guint32 mono_metadata_decode_row_col (const MonoTableInfo *t,
217 * This macro is used to extract the size of the table encoded in
218 * the size_bitfield of MonoTableInfo.
220 #define mono_metadata_table_size(bitfield,table) ((((bitfield) >> ((table)*2)) & 0x3) + 1)
221 #define mono_metadata_table_count(bitfield) ((bitfield) >> 24)
223 int mono_metadata_compute_size (MonoImage *meta,
225 guint32 *result_bitfield);
230 const char *mono_metadata_locate (MonoImage *meta, int table, int idx);
231 const char *mono_metadata_locate_token (MonoImage *meta, guint32 token);
233 const char *mono_metadata_string_heap (MonoImage *meta, guint32 table_index);
234 const char *mono_metadata_blob_heap (MonoImage *meta, guint32 table_index);
235 const char *mono_metadata_user_string (MonoImage *meta, guint32 table_index);
236 const char *mono_metadata_guid_heap (MonoImage *meta, guint32 table_index);
238 guint32 mono_metadata_typedef_from_field (MonoImage *meta, guint32 table_index);
239 guint32 mono_metadata_typedef_from_method (MonoImage *meta, guint32 table_index);
240 guint32 mono_metadata_nested_in_typedef (MonoImage *meta, guint32 table_index);
241 guint32 mono_metadata_nesting_typedef (MonoImage *meta, guint32 table_index, guint32 start_index);
243 MonoClass** mono_metadata_interfaces_from_typedef (MonoImage *meta, guint32 table_index, guint *count);
245 guint32 mono_metadata_events_from_typedef (MonoImage *meta, guint32 table_index, guint *end_idx);
246 guint32 mono_metadata_methods_from_event (MonoImage *meta, guint32 table_index, guint *end);
247 guint32 mono_metadata_properties_from_typedef (MonoImage *meta, guint32 table_index, guint *end);
248 guint32 mono_metadata_methods_from_property (MonoImage *meta, guint32 table_index, guint *end);
249 guint32 mono_metadata_packing_from_typedef (MonoImage *meta, guint32 table_index, guint32 *packing, guint32 *size);
250 const char* mono_metadata_get_marshal_info (MonoImage *meta, guint32 idx, gboolean is_field);
251 guint32 mono_metadata_custom_attrs_from_index (MonoImage *meta, guint32 cattr_index);
253 MonoMarshalSpec *mono_metadata_parse_marshal_spec (MonoImage *image, const char *ptr);
255 void mono_metadata_free_marshal_spec (MonoMarshalSpec *spec);
257 guint32 mono_metadata_implmap_from_method (MonoImage *meta, guint32 method_idx);
259 void mono_metadata_field_info (MonoImage *meta,
263 MonoMarshalSpec **marshal_spec);
265 guint32 mono_metadata_get_constant_index (MonoImage *meta, guint32 token, guint32 hint);
268 * Functions to extract information from the Blobs
270 guint32 mono_metadata_decode_value (const char *ptr,
272 gint32 mono_metadata_decode_signed_value (const char *ptr, const char **rptr);
274 guint32 mono_metadata_decode_blob_size (const char *ptr,
277 void mono_metadata_encode_value (guint32 value, char *bug, char **endbuf);
279 #define MONO_OFFSET_IN_CLAUSE(clause,offset) \
280 ((clause)->try_offset <= (offset) && (offset) < ((clause)->try_offset + (clause)->try_len))
281 #define MONO_OFFSET_IN_HANDLER(clause,offset) \
282 ((clause)->handler_offset <= (offset) && (offset) < ((clause)->handler_offset + (clause)->handler_len))
283 #define MONO_OFFSET_IN_FILTER(clause,offset) \
284 ((clause)->flags == MONO_EXCEPTION_CLAUSE_FILTER && (clause)->data.filter_offset <= (offset) && (offset) < ((clause)->handler_offset))
290 guint32 handler_offset;
293 guint32 filter_offset;
294 MonoClass *catch_class;
296 } MonoExceptionClause;
298 typedef struct _MonoType MonoType;
299 typedef struct _MonoGenericInst MonoGenericInst;
300 typedef struct _MonoGenericClass MonoGenericClass;
301 typedef struct _MonoDynamicGenericClass MonoDynamicGenericClass;
302 typedef struct _MonoGenericContext MonoGenericContext;
303 typedef struct _MonoGenericContainer MonoGenericContainer;
304 typedef struct _MonoGenericParam MonoGenericParam;
305 typedef struct _MonoArrayType MonoArrayType;
306 typedef struct _MonoMethodSignature MonoMethodSignature;
308 /* FIXME: Keeping this name alive for now, since it is part of the exposed API, even though no entrypoint uses it. */
309 typedef struct invalid_name MonoGenericMethod;
312 unsigned int required : 1;
313 unsigned int token : 31;
316 struct _MonoArrayType {
325 /* This structure is internal to the runtime: use the mono_type*
326 * accessors below, because it will soon ago away from the public header file.
330 MonoClass *klass; /* for VALUETYPE and CLASS */
331 MonoType *type; /* for PTR */
332 MonoArrayType *array; /* for ARRAY */
333 MonoMethodSignature *method;
334 MonoGenericParam *generic_param; /* for VAR and MVAR */
335 MonoGenericClass *generic_class; /* for GENERICINST */
337 unsigned int attrs : 16; /* param attributes or field flags */
338 MonoTypeEnum type : 8;
339 unsigned int num_mods : 6; /* max 64 modifiers follow at the end */
340 unsigned int byref : 1;
341 unsigned int pinned : 1; /* valid when included in a local var signature */
342 MonoCustomMod modifiers [MONO_ZERO_LEN_ARRAY]; /* this may grow */
346 * This structure is an internal runtime detail: use the mono_signature_*
347 * accessors below, because it will go away from the public header.
349 struct _MonoMethodSignature {
350 unsigned int hasthis : 1;
351 unsigned int explicit_this : 1;
352 unsigned int call_convention : 6;
353 unsigned int pinvoke : 1;
354 unsigned int ref_count : 23;
357 unsigned int generic_param_count : 30;
358 unsigned int is_inflated : 1;
359 unsigned int has_type_parameters : 1;
361 MonoType *params [MONO_ZERO_LEN_ARRAY];
364 typedef struct _MonoMethodHeader MonoMethodHeader;
376 mono_type_is_byref (MonoType *type);
379 mono_type_get_type (MonoType *type);
381 /* For MONO_TYPE_FNPTR */
383 mono_type_get_signature (MonoType *type);
385 /* For MONO_TYPE_CLASS, VALUETYPE */
387 mono_type_get_class (MonoType *type);
390 mono_type_get_array_type (MonoType *type);
392 /* For MONO_TYPE_PTR */
394 mono_type_get_ptr_type (MonoType *type);
397 mono_type_get_modifiers (MonoType *type, gboolean *is_required, gpointer *iter);
400 mono_signature_get_return_type (MonoMethodSignature *sig);
403 mono_signature_get_params (MonoMethodSignature *sig, gpointer *iter);
406 mono_signature_get_param_count (MonoMethodSignature *sig);
409 mono_signature_get_call_conv (MonoMethodSignature *sig);
412 mono_signature_vararg_start (MonoMethodSignature *sig);
415 mono_signature_is_instance (MonoMethodSignature *sig);
418 mono_signature_explicit_this (MonoMethodSignature *sig);
420 guint32 mono_metadata_parse_typedef_or_ref (MonoImage *m,
423 int mono_metadata_parse_custom_mod (MonoImage *m,
427 MonoArrayType *mono_metadata_parse_array (MonoImage *m,
430 void mono_metadata_free_array (MonoArrayType *array);
431 MonoType *mono_metadata_parse_type (MonoImage *m,
432 MonoParseTypeMode mode,
436 MonoType *mono_metadata_parse_param (MonoImage *m,
439 MonoType *mono_metadata_parse_ret_type (MonoImage *m,
442 MonoType *mono_metadata_parse_field_type (MonoImage *m,
446 MonoType *mono_type_create_from_typespec (MonoImage *image,
448 void mono_metadata_free_type (MonoType *type);
449 int mono_type_size (MonoType *type,
451 int mono_type_stack_size (MonoType *type,
454 gboolean mono_type_generic_inst_is_valuetype (MonoType *type);
455 gboolean mono_metadata_generic_class_is_valuetype (MonoGenericClass *gclass);
456 guint mono_metadata_generic_class_hash (MonoGenericClass *gclass);
457 gboolean mono_metadata_generic_class_equal (MonoGenericClass *g1, MonoGenericClass *g2);
459 guint mono_metadata_type_hash (MonoType *t1);
460 gboolean mono_metadata_type_equal (MonoType *t1, MonoType *t2);
462 MonoMethodSignature *mono_metadata_signature_alloc (MonoImage *image, guint32 nparams);
464 MonoMethodSignature *mono_metadata_signature_dup (MonoMethodSignature *sig);
466 MonoMethodSignature *mono_metadata_parse_signature (MonoImage *image,
469 MonoMethodSignature *mono_metadata_parse_method_signature (MonoImage *m,
473 void mono_metadata_free_method_signature (MonoMethodSignature *method);
475 gboolean mono_metadata_signature_equal (MonoMethodSignature *sig1,
476 MonoMethodSignature *sig2);
478 guint mono_signature_hash (MonoMethodSignature *sig);
480 MonoMethodHeader *mono_metadata_parse_mh (MonoImage *m, const char *ptr);
481 void mono_metadata_free_mh (MonoMethodHeader *mh);
483 /* MonoMethodHeader acccessors */
485 mono_method_header_get_code (MonoMethodHeader *header, guint32* code_size, guint32* max_stack);
488 mono_method_header_get_locals (MonoMethodHeader *header, guint32* num_locals, gboolean *init_locals);
491 mono_method_header_get_num_clauses (MonoMethodHeader *header);
494 mono_method_header_get_clauses (MonoMethodHeader *header, MonoMethod *method, gpointer *iter, MonoExceptionClause *clause);
497 mono_type_to_unmanaged (MonoType *type, MonoMarshalSpec *mspec,
498 gboolean as_field, gboolean unicode, MonoMarshalConv *conv);
501 * Makes a token based on a table and an index
503 #define mono_metadata_make_token(table,idx) (((table) << 24)| (idx))
506 * Returns the table index that this token encodes.
508 #define mono_metadata_token_table(token) ((token) >> 24)
511 * Returns the index that a token refers to
513 #define mono_metadata_token_index(token) ((token & 0xffffff))
516 #define mono_metadata_token_code(token) ((token & 0xff000000))
518 guint32 mono_metadata_token_from_dor (guint32 dor_index);
520 char *mono_guid_to_string (const guint8 *guid);
522 guint32 mono_metadata_declsec_from_index (MonoImage *meta, guint32 idx);
524 guint32 mono_metadata_translate_token_index (MonoImage *image, int table, guint32 idx);
526 void mono_metadata_decode_table_row (MonoImage *image, int table,
531 guint32 mono_metadata_decode_table_row_col (MonoImage *image, int table,
537 #endif /* __MONO_METADATA_H__ */