[mini] Always emit safepoints, except WASM
[mono-project.git] / mono / metadata / metadata.h
blobc280f10e838d35bc9b88b322348d352b6f49e97e
1 /**
2 * \file
3 */
5 #ifndef __MONO_METADATA_H__
6 #define __MONO_METADATA_H__
8 #include <mono/utils/mono-publib.h>
10 #include <mono/utils/mono-forward.h>
11 #include <mono/metadata/blob.h>
12 #include <mono/metadata/row-indexes.h>
13 #include <mono/metadata/image.h>
14 #include <mono/metadata/object-forward.h>
16 MONO_BEGIN_DECLS
18 #define MONO_TYPE_ISSTRUCT(t) mono_type_is_struct (t)
19 #define MONO_TYPE_IS_VOID(t) mono_type_is_void (t)
20 #define MONO_TYPE_IS_POINTER(t) mono_type_is_pointer (t)
21 #define MONO_TYPE_IS_REFERENCE(t) mono_type_is_reference (t)
23 #define MONO_CLASS_IS_INTERFACE(c) ((mono_class_get_flags (c) & TYPE_ATTRIBUTE_INTERFACE) || mono_type_is_generic_parameter (mono_class_get_type (c)))
25 #define MONO_CLASS_IS_IMPORT(c) ((mono_class_get_flags (c) & TYPE_ATTRIBUTE_IMPORT))
27 typedef enum {
28 MONO_EXCEPTION_CLAUSE_NONE,
29 MONO_EXCEPTION_CLAUSE_FILTER,
30 MONO_EXCEPTION_CLAUSE_FINALLY,
31 MONO_EXCEPTION_CLAUSE_FAULT = 4
32 } MonoExceptionEnum;
34 typedef enum {
35 MONO_CALL_DEFAULT,
36 MONO_CALL_C,
37 MONO_CALL_STDCALL,
38 MONO_CALL_THISCALL,
39 MONO_CALL_FASTCALL,
40 MONO_CALL_VARARG
41 } MonoCallConvention;
43 /* ECMA lamespec: the old spec had more info... */
44 typedef enum {
45 MONO_NATIVE_BOOLEAN = 0x02, /* 4 bytes, 0 is false, != 0 is true */
46 MONO_NATIVE_I1 = 0x03,
47 MONO_NATIVE_U1 = 0x04,
48 MONO_NATIVE_I2 = 0x05,
49 MONO_NATIVE_U2 = 0x06,
50 MONO_NATIVE_I4 = 0x07,
51 MONO_NATIVE_U4 = 0x08,
52 MONO_NATIVE_I8 = 0x09,
53 MONO_NATIVE_U8 = 0x0a,
54 MONO_NATIVE_R4 = 0x0b,
55 MONO_NATIVE_R8 = 0x0c,
56 MONO_NATIVE_CURRENCY = 0x0f,
57 MONO_NATIVE_BSTR = 0x13, /* prefixed length, Unicode */
58 MONO_NATIVE_LPSTR = 0x14, /* ANSI, null terminated */
59 MONO_NATIVE_LPWSTR = 0x15, /* UNICODE, null terminated */
60 MONO_NATIVE_LPTSTR = 0x16, /* plattform dep., null terminated */
61 MONO_NATIVE_BYVALTSTR = 0x17,
62 MONO_NATIVE_IUNKNOWN = 0x19,
63 MONO_NATIVE_IDISPATCH = 0x1a,
64 MONO_NATIVE_STRUCT = 0x1b,
65 MONO_NATIVE_INTERFACE = 0x1c,
66 MONO_NATIVE_SAFEARRAY = 0x1d,
67 MONO_NATIVE_BYVALARRAY = 0x1e,
68 MONO_NATIVE_INT = 0x1f,
69 MONO_NATIVE_UINT = 0x20,
70 MONO_NATIVE_VBBYREFSTR = 0x22,
71 MONO_NATIVE_ANSIBSTR = 0x23, /* prefixed length, ANSI */
72 MONO_NATIVE_TBSTR = 0x24, /* prefixed length, plattform dep. */
73 MONO_NATIVE_VARIANTBOOL = 0x25,
74 MONO_NATIVE_FUNC = 0x26,
75 MONO_NATIVE_ASANY = 0x28,
76 MONO_NATIVE_LPARRAY = 0x2a,
77 MONO_NATIVE_LPSTRUCT = 0x2b,
78 MONO_NATIVE_CUSTOM = 0x2c,
79 MONO_NATIVE_ERROR = 0x2d,
80 // TODO: MONO_NATIVE_IINSPECTABLE = 0x2e
81 // TODO: MONO_NATIVE_HSTRING = 0x2f
82 MONO_NATIVE_UTF8STR = 0x30,
83 MONO_NATIVE_MAX = 0x50 /* no info */
84 } MonoMarshalNative;
86 /* Used only in context of SafeArray */
87 typedef enum {
88 MONO_VARIANT_EMPTY = 0x00,
89 MONO_VARIANT_NULL = 0x01,
90 MONO_VARIANT_I2 = 0x02,
91 MONO_VARIANT_I4 = 0x03,
92 MONO_VARIANT_R4 = 0x04,
93 MONO_VARIANT_R8 = 0x05,
94 MONO_VARIANT_CY = 0x06,
95 MONO_VARIANT_DATE = 0x07,
96 MONO_VARIANT_BSTR = 0x08,
97 MONO_VARIANT_DISPATCH = 0x09,
98 MONO_VARIANT_ERROR = 0x0a,
99 MONO_VARIANT_BOOL = 0x0b,
100 MONO_VARIANT_VARIANT = 0x0c,
101 MONO_VARIANT_UNKNOWN = 0x0d,
102 MONO_VARIANT_DECIMAL = 0x0e,
103 MONO_VARIANT_I1 = 0x10,
104 MONO_VARIANT_UI1 = 0x11,
105 MONO_VARIANT_UI2 = 0x12,
106 MONO_VARIANT_UI4 = 0x13,
107 MONO_VARIANT_I8 = 0x14,
108 MONO_VARIANT_UI8 = 0x15,
109 MONO_VARIANT_INT = 0x16,
110 MONO_VARIANT_UINT = 0x17,
111 MONO_VARIANT_VOID = 0x18,
112 MONO_VARIANT_HRESULT = 0x19,
113 MONO_VARIANT_PTR = 0x1a,
114 MONO_VARIANT_SAFEARRAY = 0x1b,
115 MONO_VARIANT_CARRAY = 0x1c,
116 MONO_VARIANT_USERDEFINED = 0x1d,
117 MONO_VARIANT_LPSTR = 0x1e,
118 MONO_VARIANT_LPWSTR = 0x1f,
119 MONO_VARIANT_RECORD = 0x24,
120 MONO_VARIANT_FILETIME = 0x40,
121 MONO_VARIANT_BLOB = 0x41,
122 MONO_VARIANT_STREAM = 0x42,
123 MONO_VARIANT_STORAGE = 0x43,
124 MONO_VARIANT_STREAMED_OBJECT = 0x44,
125 MONO_VARIANT_STORED_OBJECT = 0x45,
126 MONO_VARIANT_BLOB_OBJECT = 0x46,
127 MONO_VARIANT_CF = 0x47,
128 MONO_VARIANT_CLSID = 0x48,
129 MONO_VARIANT_VECTOR = 0x1000,
130 MONO_VARIANT_ARRAY = 0x2000,
131 MONO_VARIANT_BYREF = 0x4000
132 } MonoMarshalVariant;
134 typedef enum {
135 MONO_MARSHAL_CONV_NONE,
136 MONO_MARSHAL_CONV_BOOL_VARIANTBOOL,
137 MONO_MARSHAL_CONV_BOOL_I4,
138 MONO_MARSHAL_CONV_STR_BSTR,
139 MONO_MARSHAL_CONV_STR_LPSTR,
140 MONO_MARSHAL_CONV_LPSTR_STR,
141 MONO_MARSHAL_CONV_LPTSTR_STR,
142 MONO_MARSHAL_CONV_STR_LPWSTR,
143 MONO_MARSHAL_CONV_LPWSTR_STR,
144 MONO_MARSHAL_CONV_STR_LPTSTR,
145 MONO_MARSHAL_CONV_STR_ANSIBSTR,
146 MONO_MARSHAL_CONV_STR_TBSTR,
147 MONO_MARSHAL_CONV_STR_BYVALSTR,
148 MONO_MARSHAL_CONV_STR_BYVALWSTR,
149 MONO_MARSHAL_CONV_SB_LPSTR,
150 MONO_MARSHAL_CONV_SB_LPTSTR,
151 MONO_MARSHAL_CONV_SB_LPWSTR,
152 MONO_MARSHAL_CONV_LPSTR_SB,
153 MONO_MARSHAL_CONV_LPTSTR_SB,
154 MONO_MARSHAL_CONV_LPWSTR_SB,
155 MONO_MARSHAL_CONV_ARRAY_BYVALARRAY,
156 MONO_MARSHAL_CONV_ARRAY_BYVALCHARARRAY,
157 MONO_MARSHAL_CONV_ARRAY_SAVEARRAY,
158 MONO_MARSHAL_CONV_ARRAY_LPARRAY,
159 MONO_MARSHAL_FREE_LPARRAY,
160 MONO_MARSHAL_CONV_OBJECT_INTERFACE,
161 MONO_MARSHAL_CONV_OBJECT_IDISPATCH,
162 MONO_MARSHAL_CONV_OBJECT_IUNKNOWN,
163 MONO_MARSHAL_CONV_OBJECT_STRUCT,
164 MONO_MARSHAL_CONV_DEL_FTN,
165 MONO_MARSHAL_CONV_FTN_DEL,
166 MONO_MARSHAL_FREE_ARRAY,
167 MONO_MARSHAL_CONV_BSTR_STR,
168 MONO_MARSHAL_CONV_SAFEHANDLE,
169 MONO_MARSHAL_CONV_HANDLEREF,
170 MONO_MARSHAL_CONV_STR_UTF8STR,
171 MONO_MARSHAL_CONV_SB_UTF8STR,
172 MONO_MARSHAL_CONV_UTF8STR_STR,
173 MONO_MARSHAL_CONV_UTF8STR_SB,
174 MONO_MARSHAL_CONV_FIXED_BUFFER
175 } MonoMarshalConv;
177 #define MONO_MARSHAL_CONV_INVALID ((MonoMarshalConv)-1)
179 typedef struct {
180 MonoMarshalNative native;
181 union {
182 struct {
183 MonoMarshalNative elem_type;
184 int32_t num_elem; /* -1 if not set */
185 int16_t param_num; /* -1 if not set */
186 int16_t elem_mult; /* -1 if not set */
187 } array_data;
188 struct {
189 char *custom_name;
190 char *cookie;
191 MonoImage *image;
192 } custom_data;
193 struct {
194 MonoMarshalVariant elem_type;
195 int32_t num_elem;
196 } safearray_data;
197 } data;
198 } MonoMarshalSpec;
200 MONO_API void mono_metadata_init (void);
202 MONO_API void mono_metadata_decode_row (const MonoTableInfo *t,
203 int idx,
204 uint32_t *res,
205 int res_size);
207 MONO_API uint32_t mono_metadata_decode_row_col (const MonoTableInfo *t,
208 int idx,
209 unsigned int col);
212 * This macro is used to extract the size of the table encoded in
213 * the size_bitfield of MonoTableInfo.
215 #define mono_metadata_table_size(bitfield,table) ((((bitfield) >> ((table)*2)) & 0x3) + 1)
216 #define mono_metadata_table_count(bitfield) ((bitfield) >> 24)
218 MONO_API int mono_metadata_compute_size (MonoImage *meta,
219 int tableindex,
220 uint32_t *result_bitfield);
225 MONO_API const char *mono_metadata_locate (MonoImage *meta, int table, int idx);
226 MONO_API const char *mono_metadata_locate_token (MonoImage *meta, uint32_t token);
228 MONO_API const char *mono_metadata_string_heap (MonoImage *meta, uint32_t table_index);
229 MONO_API const char *mono_metadata_blob_heap (MonoImage *meta, uint32_t table_index);
230 MONO_API const char *mono_metadata_user_string (MonoImage *meta, uint32_t table_index);
231 MONO_API const char *mono_metadata_guid_heap (MonoImage *meta, uint32_t table_index);
233 MONO_API uint32_t mono_metadata_typedef_from_field (MonoImage *meta, uint32_t table_index);
234 MONO_API uint32_t mono_metadata_typedef_from_method (MonoImage *meta, uint32_t table_index);
235 MONO_API uint32_t mono_metadata_nested_in_typedef (MonoImage *meta, uint32_t table_index);
236 MONO_API uint32_t mono_metadata_nesting_typedef (MonoImage *meta, uint32_t table_index, uint32_t start_index);
238 MONO_API MONO_RT_EXTERNAL_ONLY
239 MonoClass** mono_metadata_interfaces_from_typedef (MonoImage *meta, uint32_t table_index, unsigned int *count);
241 MONO_API uint32_t mono_metadata_events_from_typedef (MonoImage *meta, uint32_t table_index, unsigned int *end_idx);
242 MONO_API uint32_t mono_metadata_methods_from_event (MonoImage *meta, uint32_t table_index, unsigned int *end);
243 MONO_API uint32_t mono_metadata_properties_from_typedef (MonoImage *meta, uint32_t table_index, unsigned int *end);
244 MONO_API uint32_t mono_metadata_methods_from_property (MonoImage *meta, uint32_t table_index, unsigned int *end);
245 MONO_API uint32_t mono_metadata_packing_from_typedef (MonoImage *meta, uint32_t table_index, uint32_t *packing, uint32_t *size);
246 MONO_API const char* mono_metadata_get_marshal_info (MonoImage *meta, uint32_t idx, mono_bool is_field);
247 MONO_API uint32_t mono_metadata_custom_attrs_from_index (MonoImage *meta, uint32_t cattr_index);
249 MONO_API MonoMarshalSpec *mono_metadata_parse_marshal_spec (MonoImage *image, const char *ptr);
251 MONO_API void mono_metadata_free_marshal_spec (MonoMarshalSpec *spec);
253 MONO_API uint32_t mono_metadata_implmap_from_method (MonoImage *meta, uint32_t method_idx);
255 MONO_API void mono_metadata_field_info (MonoImage *meta,
256 uint32_t table_index,
257 uint32_t *offset,
258 uint32_t *rva,
259 MonoMarshalSpec **marshal_spec);
261 MONO_API uint32_t mono_metadata_get_constant_index (MonoImage *meta, uint32_t token, uint32_t hint);
264 * Functions to extract information from the Blobs
266 MONO_API uint32_t mono_metadata_decode_value (const char *ptr,
267 const char **rptr);
268 MONO_API int32_t mono_metadata_decode_signed_value (const char *ptr, const char **rptr);
270 MONO_API uint32_t mono_metadata_decode_blob_size (const char *ptr,
271 const char **rptr);
273 MONO_API void mono_metadata_encode_value (uint32_t value, char *bug, char **endbuf);
275 #define MONO_OFFSET_IN_CLAUSE(clause,offset) \
276 ((clause)->try_offset <= (offset) && (offset) < ((clause)->try_offset + (clause)->try_len))
277 #define MONO_OFFSET_IN_HANDLER(clause,offset) \
278 ((clause)->handler_offset <= (offset) && (offset) < ((clause)->handler_offset + (clause)->handler_len))
279 #define MONO_OFFSET_IN_FILTER(clause,offset) \
280 ((clause)->flags == MONO_EXCEPTION_CLAUSE_FILTER && (clause)->data.filter_offset <= (offset) && (offset) < ((clause)->handler_offset))
282 typedef struct {
283 uint32_t flags;
284 uint32_t try_offset;
285 uint32_t try_len;
286 uint32_t handler_offset;
287 uint32_t handler_len;
288 union {
289 uint32_t filter_offset;
290 MonoClass *catch_class;
291 } data;
292 } MonoExceptionClause;
294 typedef struct _MonoType MonoType;
295 typedef struct _MonoGenericInst MonoGenericInst;
296 typedef struct _MonoGenericClass MonoGenericClass;
297 typedef struct _MonoGenericContext MonoGenericContext;
298 typedef struct _MonoGenericContainer MonoGenericContainer;
299 typedef struct _MonoGenericParam MonoGenericParam;
300 typedef struct _MonoArrayType MonoArrayType;
301 typedef struct _MonoMethodSignature MonoMethodSignature;
303 /* FIXME: Keeping this name alive for now, since it is part of the exposed API, even though no entrypoint uses it. */
304 typedef struct invalid_name MonoGenericMethod;
306 typedef struct {
307 unsigned int required : 1;
308 unsigned int token : 31;
309 } MonoCustomMod;
311 typedef struct _MonoCustomModContainer {
312 uint8_t count; /* max 64 modifiers follow at the end */
313 MonoImage *image; /* Image containing types in modifiers array */
314 MonoCustomMod modifiers [1]; /* Actual length is count */
315 } MonoCustomModContainer;
317 struct _MonoArrayType {
318 MonoClass *eklass;
319 // Number of dimensions of the array
320 uint8_t rank;
322 // Arrays recording known upper and lower index bounds for each dimension
323 uint8_t numsizes;
324 uint8_t numlobounds;
325 int *sizes;
326 int *lobounds;
329 typedef struct _MonoMethodHeader MonoMethodHeader;
331 typedef enum {
332 MONO_PARSE_TYPE,
333 MONO_PARSE_MOD_TYPE,
334 MONO_PARSE_LOCAL,
335 MONO_PARSE_PARAM,
336 MONO_PARSE_RET,
337 MONO_PARSE_FIELD
338 } MonoParseTypeMode;
340 MONO_API mono_bool
341 mono_type_is_byref (MonoType *type);
343 MONO_API int
344 mono_type_get_type (MonoType *type);
346 /* For MONO_TYPE_FNPTR */
347 MONO_API MonoMethodSignature*
348 mono_type_get_signature (MonoType *type);
350 /* For MONO_TYPE_CLASS, VALUETYPE */
351 MONO_API MonoClass*
352 mono_type_get_class (MonoType *type);
354 MONO_API MonoArrayType*
355 mono_type_get_array_type (MonoType *type);
357 /* For MONO_TYPE_PTR */
358 MONO_API MonoType*
359 mono_type_get_ptr_type (MonoType *type);
361 MONO_API MonoClass*
362 mono_type_get_modifiers (MonoType *type, mono_bool *is_required, void **iter);
364 MONO_API mono_bool mono_type_is_struct (MonoType *type);
365 MONO_API mono_bool mono_type_is_void (MonoType *type);
366 MONO_API mono_bool mono_type_is_pointer (MonoType *type);
367 MONO_API mono_bool mono_type_is_reference (MonoType *type);
368 mono_bool mono_type_is_generic_parameter (MonoType *type);
370 MONO_API MonoType*
371 mono_signature_get_return_type (MonoMethodSignature *sig);
373 MONO_API MonoType*
374 mono_signature_get_params (MonoMethodSignature *sig, void **iter);
376 MONO_API uint32_t
377 mono_signature_get_param_count (MonoMethodSignature *sig);
379 MONO_API uint32_t
380 mono_signature_get_call_conv (MonoMethodSignature *sig);
382 MONO_API int
383 mono_signature_vararg_start (MonoMethodSignature *sig);
385 MONO_API mono_bool
386 mono_signature_is_instance (MonoMethodSignature *sig);
388 MONO_API mono_bool
389 mono_signature_explicit_this (MonoMethodSignature *sig);
391 MONO_API mono_bool
392 mono_signature_param_is_out (MonoMethodSignature *sig, int param_num);
394 MONO_API uint32_t mono_metadata_parse_typedef_or_ref (MonoImage *m,
395 const char *ptr,
396 const char **rptr);
397 MONO_API int mono_metadata_parse_custom_mod (MonoImage *m,
398 MonoCustomMod *dest,
399 const char *ptr,
400 const char **rptr);
401 MONO_API MONO_RT_EXTERNAL_ONLY
402 MonoArrayType *mono_metadata_parse_array (MonoImage *m,
403 const char *ptr,
404 const char **rptr);
405 MONO_API void mono_metadata_free_array (MonoArrayType *array);
406 MONO_API MONO_RT_EXTERNAL_ONLY MonoType *mono_metadata_parse_type (MonoImage *m,
407 MonoParseTypeMode mode,
408 short opt_attrs,
409 const char *ptr,
410 const char **rptr);
411 MONO_API MONO_RT_EXTERNAL_ONLY
412 MonoType *mono_metadata_parse_param (MonoImage *m,
413 const char *ptr,
414 const char **rptr);
415 MONO_API MONO_RT_EXTERNAL_ONLY
416 MonoType *mono_metadata_parse_field_type (MonoImage *m,
417 short field_flags,
418 const char *ptr,
419 const char **rptr);
420 MONO_API MONO_RT_EXTERNAL_ONLY
421 MonoType *mono_type_create_from_typespec (MonoImage *image,
422 uint32_t type_spec);
423 MONO_API void mono_metadata_free_type (MonoType *type);
424 MONO_API int mono_type_size (MonoType *type,
425 int *alignment);
426 MONO_API int mono_type_stack_size (MonoType *type,
427 int *alignment);
429 MONO_API mono_bool mono_type_generic_inst_is_valuetype (MonoType *type);
430 MONO_API mono_bool mono_metadata_generic_class_is_valuetype (MonoGenericClass *gclass);
432 MONO_API unsigned int mono_metadata_type_hash (MonoType *t1);
433 MONO_API mono_bool mono_metadata_type_equal (MonoType *t1, MonoType *t2);
435 MONO_API MonoMethodSignature *mono_metadata_signature_alloc (MonoImage *image, uint32_t nparams);
437 MONO_API MonoMethodSignature *mono_metadata_signature_dup (MonoMethodSignature *sig);
439 MONO_API MONO_RT_EXTERNAL_ONLY
440 MonoMethodSignature *mono_metadata_parse_signature (MonoImage *image,
441 uint32_t token);
443 MONO_API MONO_RT_EXTERNAL_ONLY
444 MonoMethodSignature *mono_metadata_parse_method_signature (MonoImage *m,
445 int def,
446 const char *ptr,
447 const char **rptr);
448 MONO_API void mono_metadata_free_method_signature (MonoMethodSignature *method);
450 MONO_API mono_bool mono_metadata_signature_equal (MonoMethodSignature *sig1,
451 MonoMethodSignature *sig2);
453 MONO_API unsigned int mono_signature_hash (MonoMethodSignature *sig);
455 MONO_API MONO_RT_EXTERNAL_ONLY
456 MonoMethodHeader *mono_metadata_parse_mh (MonoImage *m, const char *ptr);
457 MONO_API void mono_metadata_free_mh (MonoMethodHeader *mh);
459 /* MonoMethodHeader acccessors */
460 MONO_API const unsigned char*
461 mono_method_header_get_code (MonoMethodHeader *header, uint32_t* code_size, uint32_t* max_stack);
463 MONO_API MonoType**
464 mono_method_header_get_locals (MonoMethodHeader *header, uint32_t* num_locals, mono_bool *init_locals);
466 MONO_API int
467 mono_method_header_get_num_clauses (MonoMethodHeader *header);
469 MONO_API int
470 mono_method_header_get_clauses (MonoMethodHeader *header, MonoMethod *method, void **iter, MonoExceptionClause *clause);
472 MONO_API uint32_t
473 mono_type_to_unmanaged (MonoType *type, MonoMarshalSpec *mspec,
474 mono_bool as_field, mono_bool unicode, MonoMarshalConv *conv);
477 * Makes a token based on a table and an index
479 #define mono_metadata_make_token(table,idx) (((table) << 24)| (idx))
482 * Returns the table index that this token encodes.
484 #define mono_metadata_token_table(token) ((token) >> 24)
487 * Returns the index that a token refers to
489 #define mono_metadata_token_index(token) ((token) & 0xffffff)
492 #define mono_metadata_token_code(token) ((token) & 0xff000000)
494 MONO_API uint32_t mono_metadata_token_from_dor (uint32_t dor_index);
496 MONO_API char *mono_guid_to_string (const uint8_t *guid);
498 MONO_API char *mono_guid_to_string_minimal (const uint8_t *guid);
500 MONO_API uint32_t mono_metadata_declsec_from_index (MonoImage *meta, uint32_t idx);
502 MONO_API uint32_t mono_metadata_translate_token_index (MonoImage *image, int table, uint32_t idx);
504 MONO_API void mono_metadata_decode_table_row (MonoImage *image, int table,
505 int idx,
506 uint32_t *res,
507 int res_size);
509 MONO_API uint32_t mono_metadata_decode_table_row_col (MonoImage *image, int table,
510 int idx,
511 unsigned int col);
513 MONO_END_DECLS
515 #endif /* __MONO_METADATA_H__ */