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 * When embedding, you have to define MONO_ZERO_LEN_ARRAY before including any
15 * other Mono header file if you use a different compiler from the one used to
18 #ifndef MONO_ZERO_LEN_ARRAY
20 #define MONO_ZERO_LEN_ARRAY 0
22 #define MONO_ZERO_LEN_ARRAY 1
26 #define MONO_TYPE_ISSTRUCT(t) (!(t)->byref && (((t)->type == MONO_TYPE_VALUETYPE && \
27 !(t)->data.klass->enumtype) || ((t)->type == MONO_TYPE_TYPEDBYREF) || \
28 (((t)->type == MONO_TYPE_GENERICINST) && mono_metadata_generic_class_is_valuetype ((t)->data.generic_class) && !(t)->data.generic_class->container_class->enumtype)))
30 #define MONO_TYPE_IS_VOID(t) ((t) && ((t)->type == MONO_TYPE_VOID) && !(t)->byref)
31 #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)))
33 #define MONO_TYPE_IS_REFERENCE(t) ((t) && \
34 ((((t)->type == MONO_TYPE_STRING) || \
35 ((t)->type == MONO_TYPE_SZARRAY) || \
36 ((t)->type == MONO_TYPE_CLASS) || \
37 ((t)->type == MONO_TYPE_OBJECT) || \
38 ((t)->type == MONO_TYPE_ARRAY)) || \
39 (((t)->type == MONO_TYPE_GENERICINST) && \
40 !mono_metadata_generic_class_is_valuetype ((t)->data.generic_class))))
42 #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))
44 #define MONO_CLASS_IS_IMPORT(c) ((c->flags & TYPE_ATTRIBUTE_IMPORT))
46 typedef struct _MonoClass MonoClass
;
47 typedef struct _MonoDomain MonoDomain
;
48 typedef struct _MonoMethod MonoMethod
;
51 MONO_EXCEPTION_CLAUSE_NONE
,
52 MONO_EXCEPTION_CLAUSE_FILTER
,
53 MONO_EXCEPTION_CLAUSE_FINALLY
,
54 MONO_EXCEPTION_CLAUSE_FAULT
= 4
66 /* ECMA lamespec: the old spec had more info... */
68 MONO_NATIVE_BOOLEAN
= 0x02, /* 4 bytes, 0 is false, != 0 is true */
69 MONO_NATIVE_I1
= 0x03,
70 MONO_NATIVE_U1
= 0x04,
71 MONO_NATIVE_I2
= 0x05,
72 MONO_NATIVE_U2
= 0x06,
73 MONO_NATIVE_I4
= 0x07,
74 MONO_NATIVE_U4
= 0x08,
75 MONO_NATIVE_I8
= 0x09,
76 MONO_NATIVE_U8
= 0x0a,
77 MONO_NATIVE_R4
= 0x0b,
78 MONO_NATIVE_R8
= 0x0c,
79 MONO_NATIVE_CURRENCY
= 0x0f,
80 MONO_NATIVE_BSTR
= 0x13, /* prefixed length, Unicode */
81 MONO_NATIVE_LPSTR
= 0x14, /* ANSI, null terminated */
82 MONO_NATIVE_LPWSTR
= 0x15, /* UNICODE, null terminated */
83 MONO_NATIVE_LPTSTR
= 0x16, /* plattform dep., null terminated */
84 MONO_NATIVE_BYVALTSTR
= 0x17,
85 MONO_NATIVE_IUNKNOWN
= 0x19,
86 MONO_NATIVE_IDISPATCH
= 0x1a,
87 MONO_NATIVE_STRUCT
= 0x1b,
88 MONO_NATIVE_INTERFACE
= 0x1c,
89 MONO_NATIVE_SAFEARRAY
= 0x1d,
90 MONO_NATIVE_BYVALARRAY
= 0x1e,
91 MONO_NATIVE_INT
= 0x1f,
92 MONO_NATIVE_UINT
= 0x20,
93 MONO_NATIVE_VBBYREFSTR
= 0x22,
94 MONO_NATIVE_ANSIBSTR
= 0x23, /* prefixed length, ANSI */
95 MONO_NATIVE_TBSTR
= 0x24, /* prefixed length, plattform dep. */
96 MONO_NATIVE_VARIANTBOOL
= 0x25,
97 MONO_NATIVE_FUNC
= 0x26,
98 MONO_NATIVE_ASANY
= 0x28,
99 MONO_NATIVE_LPARRAY
= 0x2a,
100 MONO_NATIVE_LPSTRUCT
= 0x2b,
101 MONO_NATIVE_CUSTOM
= 0x2c,
102 MONO_NATIVE_ERROR
= 0x2d,
103 MONO_NATIVE_MAX
= 0x50 /* no info */
106 /* Used only in context of SafeArray */
108 MONO_VARIANT_EMPTY
= 0x00,
109 MONO_VARIANT_NULL
= 0x01,
110 MONO_VARIANT_I2
= 0x02,
111 MONO_VARIANT_I4
= 0x03,
112 MONO_VARIANT_R4
= 0x04,
113 MONO_VARIANT_R8
= 0x05,
114 MONO_VARIANT_CY
= 0x06,
115 MONO_VARIANT_DATE
= 0x07,
116 MONO_VARIANT_BSTR
= 0x08,
117 MONO_VARIANT_DISPATCH
= 0x09,
118 MONO_VARIANT_ERROR
= 0x0a,
119 MONO_VARIANT_BOOL
= 0x0b,
120 MONO_VARIANT_VARIANT
= 0x0c,
121 MONO_VARIANT_UNKNOWN
= 0x0d,
122 MONO_VARIANT_DECIMAL
= 0x0e,
123 MONO_VARIANT_I1
= 0x10,
124 MONO_VARIANT_UI1
= 0x11,
125 MONO_VARIANT_UI2
= 0x12,
126 MONO_VARIANT_UI4
= 0x13,
127 MONO_VARIANT_I8
= 0x14,
128 MONO_VARIANT_UI8
= 0x15,
129 MONO_VARIANT_INT
= 0x16,
130 MONO_VARIANT_UINT
= 0x17,
131 MONO_VARIANT_VOID
= 0x18,
132 MONO_VARIANT_HRESULT
= 0x19,
133 MONO_VARIANT_PTR
= 0x1a,
134 MONO_VARIANT_SAFEARRAY
= 0x1b,
135 MONO_VARIANT_CARRAY
= 0x1c,
136 MONO_VARIANT_USERDEFINED
= 0x1d,
137 MONO_VARIANT_LPSTR
= 0x1e,
138 MONO_VARIANT_LPWSTR
= 0x1f,
139 MONO_VARIANT_RECORD
= 0x24,
140 MONO_VARIANT_FILETIME
= 0x40,
141 MONO_VARIANT_BLOB
= 0x41,
142 MONO_VARIANT_STREAM
= 0x42,
143 MONO_VARIANT_STORAGE
= 0x43,
144 MONO_VARIANT_STREAMED_OBJECT
= 0x44,
145 MONO_VARIANT_STORED_OBJECT
= 0x45,
146 MONO_VARIANT_BLOB_OBJECT
= 0x46,
147 MONO_VARIANT_CF
= 0x47,
148 MONO_VARIANT_CLSID
= 0x48,
149 MONO_VARIANT_VECTOR
= 0x1000,
150 MONO_VARIANT_ARRAY
= 0x2000,
151 MONO_VARIANT_BYREF
= 0x4000
152 } MonoMarshalVariant
;
155 MONO_MARSHAL_CONV_NONE
,
156 MONO_MARSHAL_CONV_BOOL_VARIANTBOOL
,
157 MONO_MARSHAL_CONV_BOOL_I4
,
158 MONO_MARSHAL_CONV_STR_BSTR
,
159 MONO_MARSHAL_CONV_STR_LPSTR
,
160 MONO_MARSHAL_CONV_LPSTR_STR
,
161 MONO_MARSHAL_CONV_LPTSTR_STR
,
162 MONO_MARSHAL_CONV_STR_LPWSTR
,
163 MONO_MARSHAL_CONV_LPWSTR_STR
,
164 MONO_MARSHAL_CONV_STR_LPTSTR
,
165 MONO_MARSHAL_CONV_STR_ANSIBSTR
,
166 MONO_MARSHAL_CONV_STR_TBSTR
,
167 MONO_MARSHAL_CONV_STR_BYVALSTR
,
168 MONO_MARSHAL_CONV_STR_BYVALWSTR
,
169 MONO_MARSHAL_CONV_SB_LPSTR
,
170 MONO_MARSHAL_CONV_SB_LPTSTR
,
171 MONO_MARSHAL_CONV_SB_LPWSTR
,
172 MONO_MARSHAL_CONV_LPSTR_SB
,
173 MONO_MARSHAL_CONV_LPTSTR_SB
,
174 MONO_MARSHAL_CONV_LPWSTR_SB
,
175 MONO_MARSHAL_CONV_ARRAY_BYVALARRAY
,
176 MONO_MARSHAL_CONV_ARRAY_BYVALCHARARRAY
,
177 MONO_MARSHAL_CONV_ARRAY_SAVEARRAY
,
178 MONO_MARSHAL_CONV_ARRAY_LPARRAY
,
179 MONO_MARSHAL_FREE_LPARRAY
,
180 MONO_MARSHAL_CONV_OBJECT_INTERFACE
,
181 MONO_MARSHAL_CONV_OBJECT_IDISPATCH
,
182 MONO_MARSHAL_CONV_OBJECT_IUNKNOWN
,
183 MONO_MARSHAL_CONV_OBJECT_STRUCT
,
184 MONO_MARSHAL_CONV_DEL_FTN
,
185 MONO_MARSHAL_CONV_FTN_DEL
,
186 MONO_MARSHAL_FREE_ARRAY
,
187 MONO_MARSHAL_CONV_BSTR_STR
,
188 MONO_MARSHAL_CONV_SAFEHANDLE
,
189 MONO_MARSHAL_CONV_HANDLEREF
193 MonoMarshalNative native
;
196 MonoMarshalNative elem_type
;
197 gint32 num_elem
; /* -1 if not set */
198 gint16 param_num
; /* -1 if not set */
199 gint16 elem_mult
; /* -1 if not set */
206 MonoMarshalVariant elem_type
;
212 void mono_metadata_init (void);
214 void mono_metadata_decode_row (const MonoTableInfo
*t
,
219 guint32
mono_metadata_decode_row_col (const MonoTableInfo
*t
,
224 * This macro is used to extract the size of the table encoded in
225 * the size_bitfield of MonoTableInfo.
227 #define mono_metadata_table_size(bitfield,table) ((((bitfield) >> ((table)*2)) & 0x3) + 1)
228 #define mono_metadata_table_count(bitfield) ((bitfield) >> 24)
230 int mono_metadata_compute_size (MonoImage
*meta
,
232 guint32
*result_bitfield
);
237 const char *mono_metadata_locate (MonoImage
*meta
, int table
, int idx
);
238 const char *mono_metadata_locate_token (MonoImage
*meta
, guint32 token
);
240 const char *mono_metadata_string_heap (MonoImage
*meta
, guint32 table_index
);
241 const char *mono_metadata_blob_heap (MonoImage
*meta
, guint32 table_index
);
242 const char *mono_metadata_user_string (MonoImage
*meta
, guint32 table_index
);
243 const char *mono_metadata_guid_heap (MonoImage
*meta
, guint32 table_index
);
245 guint32
mono_metadata_typedef_from_field (MonoImage
*meta
, guint32 table_index
);
246 guint32
mono_metadata_typedef_from_method (MonoImage
*meta
, guint32 table_index
);
247 guint32
mono_metadata_nested_in_typedef (MonoImage
*meta
, guint32 table_index
);
248 guint32
mono_metadata_nesting_typedef (MonoImage
*meta
, guint32 table_index
, guint32 start_index
);
250 MonoClass
** mono_metadata_interfaces_from_typedef (MonoImage
*meta
, guint32 table_index
, guint
*count
);
252 guint32
mono_metadata_events_from_typedef (MonoImage
*meta
, guint32 table_index
, guint
*end_idx
);
253 guint32
mono_metadata_methods_from_event (MonoImage
*meta
, guint32 table_index
, guint
*end
);
254 guint32
mono_metadata_properties_from_typedef (MonoImage
*meta
, guint32 table_index
, guint
*end
);
255 guint32
mono_metadata_methods_from_property (MonoImage
*meta
, guint32 table_index
, guint
*end
);
256 guint32
mono_metadata_packing_from_typedef (MonoImage
*meta
, guint32 table_index
, guint32
*packing
, guint32
*size
);
257 const char* mono_metadata_get_marshal_info (MonoImage
*meta
, guint32 idx
, gboolean is_field
);
258 guint32
mono_metadata_custom_attrs_from_index (MonoImage
*meta
, guint32 cattr_index
);
260 MonoMarshalSpec
*mono_metadata_parse_marshal_spec (MonoImage
*image
, const char *ptr
);
262 void mono_metadata_free_marshal_spec (MonoMarshalSpec
*spec
);
264 guint32
mono_metadata_implmap_from_method (MonoImage
*meta
, guint32 method_idx
);
266 void mono_metadata_field_info (MonoImage
*meta
,
270 MonoMarshalSpec
**marshal_spec
);
272 guint32
mono_metadata_get_constant_index (MonoImage
*meta
, guint32 token
, guint32 hint
);
275 * Functions to extract information from the Blobs
277 guint32
mono_metadata_decode_value (const char *ptr
,
279 gint32
mono_metadata_decode_signed_value (const char *ptr
, const char **rptr
);
281 guint32
mono_metadata_decode_blob_size (const char *ptr
,
284 void mono_metadata_encode_value (guint32 value
, char *bug
, char **endbuf
);
286 #define MONO_OFFSET_IN_CLAUSE(clause,offset) \
287 ((clause)->try_offset <= (offset) && (offset) < ((clause)->try_offset + (clause)->try_len))
288 #define MONO_OFFSET_IN_HANDLER(clause,offset) \
289 ((clause)->handler_offset <= (offset) && (offset) < ((clause)->handler_offset + (clause)->handler_len))
290 #define MONO_OFFSET_IN_FILTER(clause,offset) \
291 ((clause)->flags == MONO_EXCEPTION_CLAUSE_FILTER && (clause)->data.filter_offset <= (offset) && (offset) < ((clause)->handler_offset))
297 guint32 handler_offset
;
300 guint32 filter_offset
;
301 MonoClass
*catch_class
;
303 } MonoExceptionClause
;
305 typedef struct _MonoType MonoType
;
306 typedef struct _MonoGenericInst MonoGenericInst
;
307 typedef struct _MonoGenericClass MonoGenericClass
;
308 typedef struct _MonoDynamicGenericClass MonoDynamicGenericClass
;
309 typedef struct _MonoGenericContext MonoGenericContext
;
310 typedef struct _MonoGenericContainer MonoGenericContainer
;
311 typedef struct _MonoGenericParam MonoGenericParam
;
312 typedef struct _MonoArrayType MonoArrayType
;
313 typedef struct _MonoMethodSignature MonoMethodSignature
;
315 /* FIXME: Keeping this name alive for now, since it is part of the exposed API, even though no entrypoint uses it. */
316 typedef struct invalid_name MonoGenericMethod
;
319 unsigned int required
: 1;
320 unsigned int token
: 31;
323 struct _MonoArrayType
{
332 /* This structure is internal to the runtime: use the mono_type*
333 * accessors below, because it will soon ago away from the public header file.
337 MonoClass
*klass
; /* for VALUETYPE and CLASS */
338 MonoType
*type
; /* for PTR */
339 MonoArrayType
*array
; /* for ARRAY */
340 MonoMethodSignature
*method
;
341 MonoGenericParam
*generic_param
; /* for VAR and MVAR */
342 MonoGenericClass
*generic_class
; /* for GENERICINST */
344 unsigned int attrs
: 16; /* param attributes or field flags */
345 MonoTypeEnum type
: 8;
346 unsigned int num_mods
: 6; /* max 64 modifiers follow at the end */
347 unsigned int byref
: 1;
348 unsigned int pinned
: 1; /* valid when included in a local var signature */
349 MonoCustomMod modifiers
[MONO_ZERO_LEN_ARRAY
]; /* this may grow */
352 #define MONO_SIZEOF_TYPE (offsetof (struct _MonoType, modifiers))
355 * This structure is an internal runtime detail: use the mono_signature_*
356 * accessors below, because it will go away from the public header.
358 struct _MonoMethodSignature
{
359 unsigned int hasthis
: 1;
360 unsigned int explicit_this
: 1;
361 unsigned int call_convention
: 6;
362 unsigned int pinvoke
: 1;
363 unsigned int ref_count
: 23;
366 unsigned int generic_param_count
: 30;
367 unsigned int is_inflated
: 1;
368 unsigned int has_type_parameters
: 1;
370 MonoType
*params
[MONO_ZERO_LEN_ARRAY
];
373 #define MONO_SIZEOF_METHOD_SIGNATURE (sizeof (struct _MonoMethodSignature) - MONO_ZERO_LEN_ARRAY * SIZEOF_VOID_P)
375 typedef struct _MonoMethodHeader MonoMethodHeader
;
387 mono_type_is_byref (MonoType
*type
);
390 mono_type_get_type (MonoType
*type
);
392 /* For MONO_TYPE_FNPTR */
394 mono_type_get_signature (MonoType
*type
);
396 /* For MONO_TYPE_CLASS, VALUETYPE */
398 mono_type_get_class (MonoType
*type
);
401 mono_type_get_array_type (MonoType
*type
);
403 /* For MONO_TYPE_PTR */
405 mono_type_get_ptr_type (MonoType
*type
);
408 mono_type_get_modifiers (MonoType
*type
, gboolean
*is_required
, gpointer
*iter
);
411 mono_signature_get_return_type (MonoMethodSignature
*sig
);
414 mono_signature_get_params (MonoMethodSignature
*sig
, gpointer
*iter
);
417 mono_signature_get_param_count (MonoMethodSignature
*sig
);
420 mono_signature_get_call_conv (MonoMethodSignature
*sig
);
423 mono_signature_vararg_start (MonoMethodSignature
*sig
);
426 mono_signature_is_instance (MonoMethodSignature
*sig
);
429 mono_signature_explicit_this (MonoMethodSignature
*sig
);
431 guint32
mono_metadata_parse_typedef_or_ref (MonoImage
*m
,
434 int mono_metadata_parse_custom_mod (MonoImage
*m
,
438 MonoArrayType
*mono_metadata_parse_array (MonoImage
*m
,
441 void mono_metadata_free_array (MonoArrayType
*array
);
442 MonoType
*mono_metadata_parse_type (MonoImage
*m
,
443 MonoParseTypeMode mode
,
447 MonoType
*mono_metadata_parse_param (MonoImage
*m
,
450 MonoType
*mono_metadata_parse_ret_type (MonoImage
*m
,
453 MonoType
*mono_metadata_parse_field_type (MonoImage
*m
,
457 MonoType
*mono_type_create_from_typespec (MonoImage
*image
,
459 void mono_metadata_free_type (MonoType
*type
);
460 int mono_type_size (MonoType
*type
,
462 int mono_type_stack_size (MonoType
*type
,
465 gboolean
mono_type_generic_inst_is_valuetype (MonoType
*type
);
466 gboolean
mono_metadata_generic_class_is_valuetype (MonoGenericClass
*gclass
);
467 guint
mono_metadata_generic_class_hash (MonoGenericClass
*gclass
);
468 gboolean
mono_metadata_generic_class_equal (MonoGenericClass
*g1
, MonoGenericClass
*g2
);
470 guint
mono_metadata_type_hash (MonoType
*t1
);
471 gboolean
mono_metadata_type_equal (MonoType
*t1
, MonoType
*t2
);
473 MonoMethodSignature
*mono_metadata_signature_alloc (MonoImage
*image
, guint32 nparams
);
475 MonoMethodSignature
*mono_metadata_signature_dup (MonoMethodSignature
*sig
);
477 MonoMethodSignature
*mono_metadata_parse_signature (MonoImage
*image
,
480 MonoMethodSignature
*mono_metadata_parse_method_signature (MonoImage
*m
,
484 void mono_metadata_free_method_signature (MonoMethodSignature
*method
);
486 gboolean
mono_metadata_signature_equal (MonoMethodSignature
*sig1
,
487 MonoMethodSignature
*sig2
);
489 guint
mono_signature_hash (MonoMethodSignature
*sig
);
491 MonoMethodHeader
*mono_metadata_parse_mh (MonoImage
*m
, const char *ptr
);
492 void mono_metadata_free_mh (MonoMethodHeader
*mh
);
494 /* MonoMethodHeader acccessors */
496 mono_method_header_get_code (MonoMethodHeader
*header
, guint32
* code_size
, guint32
* max_stack
);
499 mono_method_header_get_locals (MonoMethodHeader
*header
, guint32
* num_locals
, gboolean
*init_locals
);
502 mono_method_header_get_num_clauses (MonoMethodHeader
*header
);
505 mono_method_header_get_clauses (MonoMethodHeader
*header
, MonoMethod
*method
, gpointer
*iter
, MonoExceptionClause
*clause
);
508 mono_type_to_unmanaged (MonoType
*type
, MonoMarshalSpec
*mspec
,
509 gboolean as_field
, gboolean unicode
, MonoMarshalConv
*conv
);
512 * Makes a token based on a table and an index
514 #define mono_metadata_make_token(table,idx) (((table) << 24)| (idx))
517 * Returns the table index that this token encodes.
519 #define mono_metadata_token_table(token) ((token) >> 24)
522 * Returns the index that a token refers to
524 #define mono_metadata_token_index(token) ((token & 0xffffff))
527 #define mono_metadata_token_code(token) ((token & 0xff000000))
529 guint32
mono_metadata_token_from_dor (guint32 dor_index
);
531 char *mono_guid_to_string (const guint8
*guid
);
533 guint32
mono_metadata_declsec_from_index (MonoImage
*meta
, guint32 idx
);
535 guint32
mono_metadata_translate_token_index (MonoImage
*image
, int table
, guint32 idx
);
537 void mono_metadata_decode_table_row (MonoImage
*image
, int table
,
542 guint32
mono_metadata_decode_table_row_col (MonoImage
*image
, int table
,
548 #endif /* __MONO_METADATA_H__ */