5 #ifndef __MONO_METADATA_H__
6 #define __MONO_METADATA_H__
8 #include <mono/utils/mono-publib.h>
10 #include <mono/metadata/blob.h>
11 #include <mono/metadata/row-indexes.h>
12 #include <mono/metadata/image.h>
13 #include <mono/metadata/object-forward.h>
17 #define MONO_TYPE_ISSTRUCT(t) mono_type_is_struct (t)
18 #define MONO_TYPE_IS_VOID(t) mono_type_is_void (t)
19 #define MONO_TYPE_IS_POINTER(t) mono_type_is_pointer (t)
20 #define MONO_TYPE_IS_REFERENCE(t) mono_type_is_reference (t)
22 #define MONO_CLASS_IS_INTERFACE(c) ((mono_class_get_flags (c) & TYPE_ATTRIBUTE_INTERFACE) || mono_type_is_generic_parameter (mono_class_get_type (c)))
24 #define MONO_CLASS_IS_IMPORT(c) ((mono_class_get_flags (c) & TYPE_ATTRIBUTE_IMPORT))
26 typedef struct _MonoDomain MonoDomain
;
29 MONO_EXCEPTION_CLAUSE_NONE
,
30 MONO_EXCEPTION_CLAUSE_FILTER
,
31 MONO_EXCEPTION_CLAUSE_FINALLY
,
32 MONO_EXCEPTION_CLAUSE_FAULT
= 4
44 /* ECMA lamespec: the old spec had more info... */
46 MONO_NATIVE_BOOLEAN
= 0x02, /* 4 bytes, 0 is false, != 0 is true */
47 MONO_NATIVE_I1
= 0x03,
48 MONO_NATIVE_U1
= 0x04,
49 MONO_NATIVE_I2
= 0x05,
50 MONO_NATIVE_U2
= 0x06,
51 MONO_NATIVE_I4
= 0x07,
52 MONO_NATIVE_U4
= 0x08,
53 MONO_NATIVE_I8
= 0x09,
54 MONO_NATIVE_U8
= 0x0a,
55 MONO_NATIVE_R4
= 0x0b,
56 MONO_NATIVE_R8
= 0x0c,
57 MONO_NATIVE_CURRENCY
= 0x0f,
58 MONO_NATIVE_BSTR
= 0x13, /* prefixed length, Unicode */
59 MONO_NATIVE_LPSTR
= 0x14, /* ANSI, null terminated */
60 MONO_NATIVE_LPWSTR
= 0x15, /* UNICODE, null terminated */
61 MONO_NATIVE_LPTSTR
= 0x16, /* plattform dep., null terminated */
62 MONO_NATIVE_BYVALTSTR
= 0x17,
63 MONO_NATIVE_IUNKNOWN
= 0x19,
64 MONO_NATIVE_IDISPATCH
= 0x1a,
65 MONO_NATIVE_STRUCT
= 0x1b,
66 MONO_NATIVE_INTERFACE
= 0x1c,
67 MONO_NATIVE_SAFEARRAY
= 0x1d,
68 MONO_NATIVE_BYVALARRAY
= 0x1e,
69 MONO_NATIVE_INT
= 0x1f,
70 MONO_NATIVE_UINT
= 0x20,
71 MONO_NATIVE_VBBYREFSTR
= 0x22,
72 MONO_NATIVE_ANSIBSTR
= 0x23, /* prefixed length, ANSI */
73 MONO_NATIVE_TBSTR
= 0x24, /* prefixed length, plattform dep. */
74 MONO_NATIVE_VARIANTBOOL
= 0x25,
75 MONO_NATIVE_FUNC
= 0x26,
76 MONO_NATIVE_ASANY
= 0x28,
77 MONO_NATIVE_LPARRAY
= 0x2a,
78 MONO_NATIVE_LPSTRUCT
= 0x2b,
79 MONO_NATIVE_CUSTOM
= 0x2c,
80 MONO_NATIVE_ERROR
= 0x2d,
81 // TODO: MONO_NATIVE_IINSPECTABLE = 0x2e
82 // TODO: MONO_NATIVE_HSTRING = 0x2f
83 MONO_NATIVE_UTF8STR
= 0x30,
84 MONO_NATIVE_MAX
= 0x50 /* no info */
87 /* Used only in context of SafeArray */
89 MONO_VARIANT_EMPTY
= 0x00,
90 MONO_VARIANT_NULL
= 0x01,
91 MONO_VARIANT_I2
= 0x02,
92 MONO_VARIANT_I4
= 0x03,
93 MONO_VARIANT_R4
= 0x04,
94 MONO_VARIANT_R8
= 0x05,
95 MONO_VARIANT_CY
= 0x06,
96 MONO_VARIANT_DATE
= 0x07,
97 MONO_VARIANT_BSTR
= 0x08,
98 MONO_VARIANT_DISPATCH
= 0x09,
99 MONO_VARIANT_ERROR
= 0x0a,
100 MONO_VARIANT_BOOL
= 0x0b,
101 MONO_VARIANT_VARIANT
= 0x0c,
102 MONO_VARIANT_UNKNOWN
= 0x0d,
103 MONO_VARIANT_DECIMAL
= 0x0e,
104 MONO_VARIANT_I1
= 0x10,
105 MONO_VARIANT_UI1
= 0x11,
106 MONO_VARIANT_UI2
= 0x12,
107 MONO_VARIANT_UI4
= 0x13,
108 MONO_VARIANT_I8
= 0x14,
109 MONO_VARIANT_UI8
= 0x15,
110 MONO_VARIANT_INT
= 0x16,
111 MONO_VARIANT_UINT
= 0x17,
112 MONO_VARIANT_VOID
= 0x18,
113 MONO_VARIANT_HRESULT
= 0x19,
114 MONO_VARIANT_PTR
= 0x1a,
115 MONO_VARIANT_SAFEARRAY
= 0x1b,
116 MONO_VARIANT_CARRAY
= 0x1c,
117 MONO_VARIANT_USERDEFINED
= 0x1d,
118 MONO_VARIANT_LPSTR
= 0x1e,
119 MONO_VARIANT_LPWSTR
= 0x1f,
120 MONO_VARIANT_RECORD
= 0x24,
121 MONO_VARIANT_FILETIME
= 0x40,
122 MONO_VARIANT_BLOB
= 0x41,
123 MONO_VARIANT_STREAM
= 0x42,
124 MONO_VARIANT_STORAGE
= 0x43,
125 MONO_VARIANT_STREAMED_OBJECT
= 0x44,
126 MONO_VARIANT_STORED_OBJECT
= 0x45,
127 MONO_VARIANT_BLOB_OBJECT
= 0x46,
128 MONO_VARIANT_CF
= 0x47,
129 MONO_VARIANT_CLSID
= 0x48,
130 MONO_VARIANT_VECTOR
= 0x1000,
131 MONO_VARIANT_ARRAY
= 0x2000,
132 MONO_VARIANT_BYREF
= 0x4000
133 } MonoMarshalVariant
;
136 MONO_MARSHAL_CONV_NONE
,
137 MONO_MARSHAL_CONV_BOOL_VARIANTBOOL
,
138 MONO_MARSHAL_CONV_BOOL_I4
,
139 MONO_MARSHAL_CONV_STR_BSTR
,
140 MONO_MARSHAL_CONV_STR_LPSTR
,
141 MONO_MARSHAL_CONV_LPSTR_STR
,
142 MONO_MARSHAL_CONV_LPTSTR_STR
,
143 MONO_MARSHAL_CONV_STR_LPWSTR
,
144 MONO_MARSHAL_CONV_LPWSTR_STR
,
145 MONO_MARSHAL_CONV_STR_LPTSTR
,
146 MONO_MARSHAL_CONV_STR_ANSIBSTR
,
147 MONO_MARSHAL_CONV_STR_TBSTR
,
148 MONO_MARSHAL_CONV_STR_BYVALSTR
,
149 MONO_MARSHAL_CONV_STR_BYVALWSTR
,
150 MONO_MARSHAL_CONV_SB_LPSTR
,
151 MONO_MARSHAL_CONV_SB_LPTSTR
,
152 MONO_MARSHAL_CONV_SB_LPWSTR
,
153 MONO_MARSHAL_CONV_LPSTR_SB
,
154 MONO_MARSHAL_CONV_LPTSTR_SB
,
155 MONO_MARSHAL_CONV_LPWSTR_SB
,
156 MONO_MARSHAL_CONV_ARRAY_BYVALARRAY
,
157 MONO_MARSHAL_CONV_ARRAY_BYVALCHARARRAY
,
158 MONO_MARSHAL_CONV_ARRAY_SAVEARRAY
,
159 MONO_MARSHAL_CONV_ARRAY_LPARRAY
,
160 MONO_MARSHAL_FREE_LPARRAY
,
161 MONO_MARSHAL_CONV_OBJECT_INTERFACE
,
162 MONO_MARSHAL_CONV_OBJECT_IDISPATCH
,
163 MONO_MARSHAL_CONV_OBJECT_IUNKNOWN
,
164 MONO_MARSHAL_CONV_OBJECT_STRUCT
,
165 MONO_MARSHAL_CONV_DEL_FTN
,
166 MONO_MARSHAL_CONV_FTN_DEL
,
167 MONO_MARSHAL_FREE_ARRAY
,
168 MONO_MARSHAL_CONV_BSTR_STR
,
169 MONO_MARSHAL_CONV_SAFEHANDLE
,
170 MONO_MARSHAL_CONV_HANDLEREF
,
171 MONO_MARSHAL_CONV_STR_UTF8STR
,
172 MONO_MARSHAL_CONV_SB_UTF8STR
,
173 MONO_MARSHAL_CONV_UTF8STR_STR
,
174 MONO_MARSHAL_CONV_UTF8STR_SB
,
175 MONO_MARSHAL_CONV_FIXED_BUFFER
178 #define MONO_MARSHAL_CONV_INVALID ((MonoMarshalConv)-1)
181 MonoMarshalNative native
;
184 MonoMarshalNative elem_type
;
185 int32_t num_elem
; /* -1 if not set */
186 int16_t param_num
; /* -1 if not set */
187 int16_t elem_mult
; /* -1 if not set */
195 MonoMarshalVariant elem_type
;
201 MONO_API
void mono_metadata_init (void);
203 MONO_API
void mono_metadata_decode_row (const MonoTableInfo
*t
,
208 MONO_API
uint32_t mono_metadata_decode_row_col (const MonoTableInfo
*t
,
213 * This macro is used to extract the size of the table encoded in
214 * the size_bitfield of MonoTableInfo.
216 #define mono_metadata_table_size(bitfield,table) ((((bitfield) >> ((table)*2)) & 0x3) + 1)
217 #define mono_metadata_table_count(bitfield) ((bitfield) >> 24)
219 MONO_API
int mono_metadata_compute_size (MonoImage
*meta
,
221 uint32_t *result_bitfield
);
226 MONO_API
const char *mono_metadata_locate (MonoImage
*meta
, int table
, int idx
);
227 MONO_API
const char *mono_metadata_locate_token (MonoImage
*meta
, uint32_t token
);
229 MONO_API
const char *mono_metadata_string_heap (MonoImage
*meta
, uint32_t table_index
);
230 MONO_API
const char *mono_metadata_blob_heap (MonoImage
*meta
, uint32_t table_index
);
231 MONO_API
const char *mono_metadata_user_string (MonoImage
*meta
, uint32_t table_index
);
232 MONO_API
const char *mono_metadata_guid_heap (MonoImage
*meta
, uint32_t table_index
);
234 MONO_API
uint32_t mono_metadata_typedef_from_field (MonoImage
*meta
, uint32_t table_index
);
235 MONO_API
uint32_t mono_metadata_typedef_from_method (MonoImage
*meta
, uint32_t table_index
);
236 MONO_API
uint32_t mono_metadata_nested_in_typedef (MonoImage
*meta
, uint32_t table_index
);
237 MONO_API
uint32_t mono_metadata_nesting_typedef (MonoImage
*meta
, uint32_t table_index
, uint32_t start_index
);
239 MONO_RT_EXTERNAL_ONLY
240 MONO_API MonoClass
** mono_metadata_interfaces_from_typedef (MonoImage
*meta
, uint32_t table_index
, unsigned int *count
);
242 MONO_API
uint32_t mono_metadata_events_from_typedef (MonoImage
*meta
, uint32_t table_index
, unsigned int *end_idx
);
243 MONO_API
uint32_t mono_metadata_methods_from_event (MonoImage
*meta
, uint32_t table_index
, unsigned int *end
);
244 MONO_API
uint32_t mono_metadata_properties_from_typedef (MonoImage
*meta
, uint32_t table_index
, unsigned int *end
);
245 MONO_API
uint32_t mono_metadata_methods_from_property (MonoImage
*meta
, uint32_t table_index
, unsigned int *end
);
246 MONO_API
uint32_t mono_metadata_packing_from_typedef (MonoImage
*meta
, uint32_t table_index
, uint32_t *packing
, uint32_t *size
);
247 MONO_API
const char* mono_metadata_get_marshal_info (MonoImage
*meta
, uint32_t idx
, mono_bool is_field
);
248 MONO_API
uint32_t mono_metadata_custom_attrs_from_index (MonoImage
*meta
, uint32_t cattr_index
);
250 MONO_API MonoMarshalSpec
*mono_metadata_parse_marshal_spec (MonoImage
*image
, const char *ptr
);
252 MONO_API
void mono_metadata_free_marshal_spec (MonoMarshalSpec
*spec
);
254 MONO_API
uint32_t mono_metadata_implmap_from_method (MonoImage
*meta
, uint32_t method_idx
);
256 MONO_API
void mono_metadata_field_info (MonoImage
*meta
,
257 uint32_t table_index
,
260 MonoMarshalSpec
**marshal_spec
);
262 MONO_API
uint32_t mono_metadata_get_constant_index (MonoImage
*meta
, uint32_t token
, uint32_t hint
);
265 * Functions to extract information from the Blobs
267 MONO_API
uint32_t mono_metadata_decode_value (const char *ptr
,
269 MONO_API
int32_t mono_metadata_decode_signed_value (const char *ptr
, const char **rptr
);
271 MONO_API
uint32_t mono_metadata_decode_blob_size (const char *ptr
,
274 MONO_API
void mono_metadata_encode_value (uint32_t value
, char *bug
, char **endbuf
);
276 #define MONO_OFFSET_IN_CLAUSE(clause,offset) \
277 ((clause)->try_offset <= (offset) && (offset) < ((clause)->try_offset + (clause)->try_len))
278 #define MONO_OFFSET_IN_HANDLER(clause,offset) \
279 ((clause)->handler_offset <= (offset) && (offset) < ((clause)->handler_offset + (clause)->handler_len))
280 #define MONO_OFFSET_IN_FILTER(clause,offset) \
281 ((clause)->flags == MONO_EXCEPTION_CLAUSE_FILTER && (clause)->data.filter_offset <= (offset) && (offset) < ((clause)->handler_offset))
287 uint32_t handler_offset
;
288 uint32_t handler_len
;
290 uint32_t filter_offset
;
291 MonoClass
*catch_class
;
293 } MonoExceptionClause
;
295 typedef struct _MonoType MonoType
;
296 typedef struct _MonoGenericInst MonoGenericInst
;
297 typedef struct _MonoGenericClass MonoGenericClass
;
298 typedef struct _MonoGenericContext MonoGenericContext
;
299 typedef struct _MonoGenericContainer MonoGenericContainer
;
300 typedef struct _MonoGenericParam MonoGenericParam
;
301 typedef struct _MonoArrayType MonoArrayType
;
302 typedef struct _MonoMethodSignature MonoMethodSignature
;
304 /* FIXME: Keeping this name alive for now, since it is part of the exposed API, even though no entrypoint uses it. */
305 typedef struct invalid_name MonoGenericMethod
;
308 unsigned int required
: 1;
309 unsigned int token
: 31;
312 typedef struct _MonoCustomModContainer
{
313 uint8_t count
; /* max 64 modifiers follow at the end */
314 MonoImage
*image
; /* Image containing types in modifiers array */
315 MonoCustomMod modifiers
[1]; /* Actual length is count */
316 } MonoCustomModContainer
;
318 struct _MonoArrayType
{
320 // Number of dimensions of the array
323 // Arrays recording known upper and lower index bounds for each dimension
330 typedef struct _MonoMethodHeader MonoMethodHeader
;
342 mono_type_is_byref (MonoType
*type
);
345 mono_type_get_type (MonoType
*type
);
347 /* For MONO_TYPE_FNPTR */
348 MONO_API MonoMethodSignature
*
349 mono_type_get_signature (MonoType
*type
);
351 /* For MONO_TYPE_CLASS, VALUETYPE */
353 mono_type_get_class (MonoType
*type
);
355 MONO_API MonoArrayType
*
356 mono_type_get_array_type (MonoType
*type
);
358 /* For MONO_TYPE_PTR */
360 mono_type_get_ptr_type (MonoType
*type
);
363 mono_type_get_modifiers (MonoType
*type
, mono_bool
*is_required
, void **iter
);
365 MONO_API mono_bool
mono_type_is_struct (MonoType
*type
);
366 MONO_API mono_bool
mono_type_is_void (MonoType
*type
);
367 MONO_API mono_bool
mono_type_is_pointer (MonoType
*type
);
368 MONO_API mono_bool
mono_type_is_reference (MonoType
*type
);
369 mono_bool
mono_type_is_generic_parameter (MonoType
*type
);
372 mono_signature_get_return_type (MonoMethodSignature
*sig
);
375 mono_signature_get_params (MonoMethodSignature
*sig
, void **iter
);
378 mono_signature_get_param_count (MonoMethodSignature
*sig
);
381 mono_signature_get_call_conv (MonoMethodSignature
*sig
);
384 mono_signature_vararg_start (MonoMethodSignature
*sig
);
387 mono_signature_is_instance (MonoMethodSignature
*sig
);
390 mono_signature_explicit_this (MonoMethodSignature
*sig
);
393 mono_signature_param_is_out (MonoMethodSignature
*sig
, int param_num
);
395 MONO_API
uint32_t mono_metadata_parse_typedef_or_ref (MonoImage
*m
,
398 MONO_API
int mono_metadata_parse_custom_mod (MonoImage
*m
,
402 MONO_RT_EXTERNAL_ONLY
403 MONO_API MonoArrayType
*mono_metadata_parse_array (MonoImage
*m
,
406 MONO_API
void mono_metadata_free_array (MonoArrayType
*array
);
407 MONO_RT_EXTERNAL_ONLY
408 MONO_API MonoType
*mono_metadata_parse_type (MonoImage
*m
,
409 MonoParseTypeMode mode
,
413 MONO_RT_EXTERNAL_ONLY
414 MONO_API MonoType
*mono_metadata_parse_param (MonoImage
*m
,
417 MONO_RT_EXTERNAL_ONLY
418 MONO_API MonoType
*mono_metadata_parse_field_type (MonoImage
*m
,
422 MONO_RT_EXTERNAL_ONLY
423 MONO_API MonoType
*mono_type_create_from_typespec (MonoImage
*image
,
425 MONO_API
void mono_metadata_free_type (MonoType
*type
);
426 MONO_API
int mono_type_size (MonoType
*type
,
428 MONO_API
int mono_type_stack_size (MonoType
*type
,
431 MONO_API mono_bool
mono_type_generic_inst_is_valuetype (MonoType
*type
);
432 MONO_API mono_bool
mono_metadata_generic_class_is_valuetype (MonoGenericClass
*gclass
);
434 MONO_API
unsigned int mono_metadata_type_hash (MonoType
*t1
);
435 MONO_API mono_bool
mono_metadata_type_equal (MonoType
*t1
, MonoType
*t2
);
437 MONO_API MonoMethodSignature
*mono_metadata_signature_alloc (MonoImage
*image
, uint32_t nparams
);
439 MONO_API MonoMethodSignature
*mono_metadata_signature_dup (MonoMethodSignature
*sig
);
441 MONO_RT_EXTERNAL_ONLY
442 MONO_API MonoMethodSignature
*mono_metadata_parse_signature (MonoImage
*image
,
445 MONO_RT_EXTERNAL_ONLY
446 MONO_API MonoMethodSignature
*mono_metadata_parse_method_signature (MonoImage
*m
,
450 MONO_API
void mono_metadata_free_method_signature (MonoMethodSignature
*method
);
452 MONO_API mono_bool
mono_metadata_signature_equal (MonoMethodSignature
*sig1
,
453 MonoMethodSignature
*sig2
);
455 MONO_API
unsigned int mono_signature_hash (MonoMethodSignature
*sig
);
457 MONO_RT_EXTERNAL_ONLY
458 MONO_API MonoMethodHeader
*mono_metadata_parse_mh (MonoImage
*m
, const char *ptr
);
459 MONO_API
void mono_metadata_free_mh (MonoMethodHeader
*mh
);
461 /* MonoMethodHeader acccessors */
462 MONO_API
const unsigned char*
463 mono_method_header_get_code (MonoMethodHeader
*header
, uint32_t* code_size
, uint32_t* max_stack
);
466 mono_method_header_get_locals (MonoMethodHeader
*header
, uint32_t* num_locals
, mono_bool
*init_locals
);
469 mono_method_header_get_num_clauses (MonoMethodHeader
*header
);
472 mono_method_header_get_clauses (MonoMethodHeader
*header
, MonoMethod
*method
, void **iter
, MonoExceptionClause
*clause
);
475 mono_type_to_unmanaged (MonoType
*type
, MonoMarshalSpec
*mspec
,
476 mono_bool as_field
, mono_bool unicode
, MonoMarshalConv
*conv
);
479 * Makes a token based on a table and an index
481 #define mono_metadata_make_token(table,idx) (((table) << 24)| (idx))
484 * Returns the table index that this token encodes.
486 #define mono_metadata_token_table(token) ((token) >> 24)
489 * Returns the index that a token refers to
491 #define mono_metadata_token_index(token) ((token) & 0xffffff)
494 #define mono_metadata_token_code(token) ((token) & 0xff000000)
496 MONO_API
uint32_t mono_metadata_token_from_dor (uint32_t dor_index
);
498 MONO_API
char *mono_guid_to_string (const uint8_t *guid
);
500 MONO_API
char *mono_guid_to_string_minimal (const uint8_t *guid
);
502 MONO_API
uint32_t mono_metadata_declsec_from_index (MonoImage
*meta
, uint32_t idx
);
504 MONO_API
uint32_t mono_metadata_translate_token_index (MonoImage
*image
, int table
, uint32_t idx
);
506 MONO_API
void mono_metadata_decode_table_row (MonoImage
*image
, int table
,
511 MONO_API
uint32_t mono_metadata_decode_table_row_col (MonoImage
*image
, int table
,
517 #endif /* __MONO_METADATA_H__ */