2010-02-22 Rodrigo Kumpera <rkumpera@novell.com>
[mono.git] / mono / metadata / metadata-internals.h
blob12fe338a364f437f9a4fdc0ac5bbf0056e1e26f4
2 #ifndef __MONO_METADATA_INTERNALS_H__
3 #define __MONO_METADATA_INTERNALS_H__
5 #include "mono/metadata/image.h"
6 #include "mono/metadata/blob.h"
7 #include "mono/metadata/mempool.h"
8 #include "mono/metadata/domain-internals.h"
9 #include "mono/utils/mono-hash.h"
10 #include "mono/utils/mono-compiler.h"
11 #include "mono/utils/mono-dl.h"
12 #include "mono/utils/monobitset.h"
13 #include "mono/utils/mono-property-hash.h"
14 #include "mono/utils/mono-value-hash.h"
16 #define MONO_SECMAN_FLAG_INIT(x) (x & 0x2)
17 #define MONO_SECMAN_FLAG_GET_VALUE(x) (x & 0x1)
18 #define MONO_SECMAN_FLAG_SET_VALUE(x,y) do { x = ((y) ? 0x3 : 0x2); } while (0)
20 struct _MonoAssembly {
21 /*
22 * The number of appdomains which have this assembly loaded plus the number of
23 * assemblies referencing this assembly through an entry in their image->references
24 * arrays. The later is needed because entries in the image->references array
25 * might point to assemblies which are only loaded in some appdomains, and without
26 * the additional reference, they can be freed at any time.
27 * The ref_count is initially 0.
29 int ref_count; /* use atomic operations only */
30 char *basedir;
31 MonoAssemblyName aname;
32 MonoImage *image;
33 GSList *friend_assembly_names; /* Computed by mono_assembly_load_friends () */
34 guint8 friend_assembly_names_inited;
35 guint8 in_gac;
36 guint8 dynamic;
37 guint8 corlib_internal;
38 gboolean ref_only;
39 /* security manager flags (one bit is for lazy initialization) */
40 guint32 ecma:2; /* Has the ECMA key */
41 guint32 aptc:2; /* Has the [AllowPartiallyTrustedCallers] attributes */
42 guint32 fulltrust:2; /* Has FullTrust permission */
43 guint32 unmanaged:2; /* Has SecurityPermissionFlag.UnmanagedCode permission */
44 guint32 skipverification:2; /* Has SecurityPermissionFlag.SkipVerification permission */
47 typedef struct {
48 const char* data;
49 guint32 size;
50 } MonoStreamHeader;
52 struct _MonoTableInfo {
53 const char *base;
54 guint rows : 24;
55 guint row_size : 8;
58 * Tables contain up to 9 columns and the possible sizes of the
59 * fields in the documentation are 1, 2 and 4 bytes. So we
60 * can encode in 2 bits the size.
62 * A 32 bit value can encode the resulting size
64 * The top eight bits encode the number of columns in the table.
65 * we only need 4, but 8 is aligned no shift required.
67 guint32 size_bitfield;
70 #define REFERENCE_MISSING ((gpointer) -1)
72 typedef struct _MonoDllMap MonoDllMap;
74 struct _MonoImage {
76 * The number of assemblies which reference this MonoImage though their 'image'
77 * field plus the number of images which reference this MonoImage through their
78 * 'modules' field, plus the number of threads holding temporary references to
79 * this image between calls of mono_image_open () and mono_image_close ().
81 int ref_count;
82 void *raw_data_handle;
83 char *raw_data;
84 guint32 raw_data_len;
85 guint8 raw_buffer_used : 1;
86 guint8 raw_data_allocated : 1;
88 #ifdef HOST_WIN32
89 /* Module was loaded using LoadLibrary. */
90 guint8 is_module_handle : 1;
92 /* Module entry point is _CorDllMain. */
93 guint8 has_entry_point : 1;
94 #endif
96 /* Whenever this is a dynamically emitted module */
97 guint8 dynamic : 1;
99 /* Whenever this is a reflection only image */
100 guint8 ref_only : 1;
102 /* Whenever this image contains uncompressed metadata */
103 guint8 uncompressed_metadata : 1;
105 guint8 checked_module_cctor : 1;
106 guint8 has_module_cctor : 1;
108 guint8 idx_string_wide : 1;
109 guint8 idx_guid_wide : 1;
110 guint8 idx_blob_wide : 1;
112 /* Whenever this image is considered as platform code for the CoreCLR security model */
113 guint8 core_clr_platform_code : 1;
115 char *name;
116 const char *assembly_name;
117 const char *module_name;
118 char *version;
119 gint16 md_version_major, md_version_minor;
120 char *guid;
121 void *image_info;
122 MonoMemPool *mempool; /*protected by the image lock*/
124 char *raw_metadata;
126 MonoStreamHeader heap_strings;
127 MonoStreamHeader heap_us;
128 MonoStreamHeader heap_blob;
129 MonoStreamHeader heap_guid;
130 MonoStreamHeader heap_tables;
132 const char *tables_base;
134 /**/
135 MonoTableInfo tables [MONO_TABLE_NUM];
138 * references is initialized only by using the mono_assembly_open
139 * function, and not by using the lowlevel mono_image_open.
141 * It is NULL terminated.
143 MonoAssembly **references;
145 MonoImage **modules;
146 guint32 module_count;
147 gboolean *modules_loaded;
149 MonoImage **files;
151 gpointer aot_module;
154 * The Assembly this image was loaded from.
156 MonoAssembly *assembly;
159 * Indexed by method tokens and typedef tokens.
161 GHashTable *method_cache; /*protected by the image lock*/
162 MonoInternalHashTable class_cache;
164 /* Indexed by memberref + methodspec tokens */
165 GHashTable *methodref_cache; /*protected by the image lock*/
168 * Indexed by fielddef and memberref tokens
170 GHashTable *field_cache;
172 /* indexed by typespec tokens. */
173 GHashTable *typespec_cache;
174 /* indexed by token */
175 GHashTable *memberref_signatures;
176 GHashTable *helper_signatures;
178 /* Indexed by blob heap indexes */
179 GHashTable *method_signatures;
182 * Indexes namespaces to hash tables that map class name to typedef token.
184 GHashTable *name_cache; /*protected by the image lock*/
187 * Indexed by MonoClass
189 GHashTable *array_cache;
190 GHashTable *ptr_cache;
192 GHashTable *szarray_cache;
193 /* This has a separate lock to improve scalability */
194 CRITICAL_SECTION szarray_cache_lock;
197 * indexed by MonoMethodSignature
199 GHashTable *delegate_begin_invoke_cache;
200 GHashTable *delegate_end_invoke_cache;
201 GHashTable *delegate_invoke_cache;
202 GHashTable *runtime_invoke_cache;
205 * indexed by SignatureMethodPair
207 GHashTable *delegate_abstract_invoke_cache;
210 * indexed by MonoMethod pointers
212 GHashTable *runtime_invoke_direct_cache;
213 GHashTable *runtime_invoke_vcall_cache;
214 GHashTable *managed_wrapper_cache;
215 GHashTable *native_wrapper_cache;
216 GHashTable *native_wrapper_aot_cache;
217 GHashTable *remoting_invoke_cache;
218 GHashTable *synchronized_cache;
219 GHashTable *unbox_wrapper_cache;
220 GHashTable *cominterop_invoke_cache;
221 GHashTable *cominterop_wrapper_cache; /* LOCKING: marshal lock */
222 GHashTable *thunk_invoke_cache;
225 * indexed by MonoClass pointers
227 GHashTable *ldfld_wrapper_cache;
228 GHashTable *ldflda_wrapper_cache;
229 GHashTable *stfld_wrapper_cache;
230 GHashTable *isinst_cache;
231 GHashTable *castclass_cache;
232 GHashTable *proxy_isinst_cache;
233 GHashTable *rgctx_template_hash; /* LOCKING: templates lock */
235 /* Contains rarely used fields of runtime structures belonging to this image */
236 MonoPropertyHash *property_hash;
238 void *reflection_info;
241 * user_info is a public field and is not touched by the
242 * metadata engine
244 void *user_info;
246 /* dll map entries */
247 MonoDllMap *dll_map;
249 /* interfaces IDs from this image */
250 MonoBitSet *interface_bitset;
252 /* when the image is being closed, this is abused as a list of
253 malloc'ed regions to be freed. */
254 GSList *reflection_info_unregister_classes;
256 /* List of image sets containing this image */
257 GSList *image_sets;
260 * No other runtime locks must be taken while holding this lock.
261 * It's meant to be used only to mutate and query structures part of this image.
263 CRITICAL_SECTION lock;
267 * Generic instances depend on many images, and they need to be deleted if one
268 * of the images they depend on is unloaded. For example,
269 * List<Foo> depends on both List's image and Foo's image.
270 * A MonoImageSet is the owner of all generic instances depending on the same set of
271 * images.
273 typedef struct {
274 int nimages;
275 MonoImage **images;
277 GHashTable *gclass_cache, *ginst_cache, *gmethod_cache, *gsignature_cache;
279 CRITICAL_SECTION lock;
282 * Memory for generic instances owned by this image set should be allocated from
283 * this mempool, using the mono_image_set_alloc family of functions.
285 MonoMemPool *mempool;
286 } MonoImageSet;
288 enum {
289 MONO_SECTION_TEXT,
290 MONO_SECTION_RSRC,
291 MONO_SECTION_RELOC,
292 MONO_SECTION_MAX
295 typedef struct {
296 GHashTable *hash;
297 char *data;
298 guint32 alloc_size; /* malloced bytes */
299 guint32 index;
300 guint32 offset; /* from start of metadata */
301 } MonoDynamicStream;
303 typedef struct {
304 guint32 alloc_rows;
305 guint32 rows;
306 guint8 row_size; /* calculated later with column_sizes */
307 guint8 columns;
308 guint32 next_idx;
309 guint32 *values; /* rows * columns */
310 } MonoDynamicTable;
312 struct _MonoDynamicAssembly {
313 MonoAssembly assembly;
314 char *strong_name;
315 guint32 strong_name_size;
316 guint8 run;
317 guint8 save;
318 MonoDomain *domain;
321 struct _MonoDynamicImage {
322 MonoImage image;
323 guint32 meta_size;
324 guint32 text_rva;
325 guint32 metadata_rva;
326 guint32 image_base;
327 guint32 cli_header_offset;
328 guint32 iat_offset;
329 guint32 idt_offset;
330 guint32 ilt_offset;
331 guint32 imp_names_offset;
332 struct {
333 guint32 rva;
334 guint32 size;
335 guint32 offset;
336 guint32 attrs;
337 } sections [MONO_SECTION_MAX];
338 GHashTable *typespec;
339 GHashTable *typeref;
340 GHashTable *handleref;
341 MonoGHashTable *handleref_managed;
342 MonoGHashTable *tokens;
343 GHashTable *blob_cache;
344 GHashTable *standalonesig_cache;
345 GList *array_methods;
346 GPtrArray *gen_params;
347 MonoGHashTable *token_fixups;
348 GHashTable *method_to_table_idx;
349 GHashTable *field_to_table_idx;
350 GHashTable *method_aux_hash;
351 MonoGHashTable *generic_def_objects;
352 MonoGHashTable *methodspec;
353 gboolean run;
354 gboolean save;
355 gboolean initial_image;
356 guint32 pe_kind, machine;
357 char *strong_name;
358 guint32 strong_name_size;
359 char *win32_res;
360 guint32 win32_res_size;
361 guint8 *public_key;
362 int public_key_len;
363 MonoDynamicStream sheap;
364 MonoDynamicStream code; /* used to store method headers and bytecode */
365 MonoDynamicStream resources; /* managed embedded resources */
366 MonoDynamicStream us;
367 MonoDynamicStream blob;
368 MonoDynamicStream tstream;
369 MonoDynamicStream guid;
370 MonoDynamicTable tables [MONO_TABLE_NUM];
371 MonoClass *wrappers_type; /*wrappers are bound to this type instead of <Module>*/
374 /* Contains information about assembly binding */
375 typedef struct _MonoAssemblyBindingInfo {
376 char *name;
377 char *culture;
378 guchar public_key_token [MONO_PUBLIC_KEY_TOKEN_LENGTH];
379 int major;
380 int minor;
381 AssemblyVersionSet old_version_bottom;
382 AssemblyVersionSet old_version_top;
383 AssemblyVersionSet new_version;
384 guint has_old_version_bottom : 1;
385 guint has_old_version_top : 1;
386 guint has_new_version : 1;
387 guint is_valid : 1;
388 } MonoAssemblyBindingInfo;
390 struct _MonoMethodHeader {
391 guint32 code_size;
392 const unsigned char *code;
393 guint16 max_stack;
394 unsigned int num_clauses : 15;
395 /* if num_locals != 0, then the following apply: */
396 unsigned int init_locals : 1;
397 guint16 num_locals;
398 MonoExceptionClause *clauses;
399 MonoType *locals [MONO_ZERO_LEN_ARRAY];
402 typedef struct {
403 guint32 code_size;
404 gboolean has_clauses;
405 } MonoMethodHeaderSummary;
407 #define MONO_SIZEOF_METHOD_HEADER (sizeof (struct _MonoMethodHeader) - MONO_ZERO_LEN_ARRAY * SIZEOF_VOID_P)
409 /* for use with allocated memory blocks (assumes alignment is to 8 bytes) */
410 guint mono_aligned_addr_hash (gconstpointer ptr) MONO_INTERNAL;
412 void
413 mono_image_check_for_module_cctor (MonoImage *image) MONO_INTERNAL;
415 gpointer
416 mono_image_alloc (MonoImage *image, guint size) MONO_INTERNAL;
418 gpointer
419 mono_image_alloc0 (MonoImage *image, guint size) MONO_INTERNAL;
421 char*
422 mono_image_strdup (MonoImage *image, const char *s) MONO_INTERNAL;
424 GList*
425 g_list_prepend_image (MonoImage *image, GList *list, gpointer data) MONO_INTERNAL;
427 GSList*
428 g_slist_append_image (MonoImage *image, GSList *list, gpointer data) MONO_INTERNAL;
430 void
431 mono_image_lock (MonoImage *image) MONO_INTERNAL;
433 void
434 mono_image_unlock (MonoImage *image) MONO_INTERNAL;
436 gpointer
437 mono_image_property_lookup (MonoImage *image, gpointer subject, guint32 property) MONO_INTERNAL;
439 void
440 mono_image_property_insert (MonoImage *image, gpointer subject, guint32 property, gpointer value) MONO_INTERNAL;
442 void
443 mono_image_property_remove (MonoImage *image, gpointer subject) MONO_INTERNAL;
445 gboolean
446 mono_image_close_except_pools (MonoImage *image) MONO_INTERNAL;
448 void
449 mono_image_close_finish (MonoImage *image) MONO_INTERNAL;
452 MonoType*
453 mono_metadata_get_shared_type (MonoType *type) MONO_INTERNAL;
455 GSList*
456 mono_metadata_clean_for_image (MonoImage *image) MONO_INTERNAL;
458 void
459 mono_metadata_clean_generic_classes_for_image (MonoImage *image) MONO_INTERNAL;
461 void
462 mono_metadata_cleanup (void);
464 const char * mono_meta_table_name (int table) MONO_INTERNAL;
465 void mono_metadata_compute_table_bases (MonoImage *meta) MONO_INTERNAL;
467 gboolean
468 mono_metadata_interfaces_from_typedef_full (MonoImage *image,
469 guint32 table_index,
470 MonoClass ***interfaces,
471 guint *count,
472 gboolean heap_alloc_result,
473 MonoGenericContext *context) MONO_INTERNAL;
475 MonoArrayType *
476 mono_metadata_parse_array_full (MonoImage *image,
477 MonoGenericContainer *container,
478 const char *ptr,
479 const char **rptr) MONO_INTERNAL;
481 MonoType *
482 mono_metadata_parse_type_full (MonoImage *image,
483 MonoGenericContainer *container,
484 MonoParseTypeMode mode,
485 short opt_attrs,
486 const char *ptr,
487 const char **rptr);
489 MonoMethodSignature *
490 mono_metadata_parse_signature_full (MonoImage *image,
491 MonoGenericContainer *generic_container,
492 guint32 token) MONO_INTERNAL;
494 MonoMethodSignature *
495 mono_metadata_parse_method_signature_full (MonoImage *image,
496 MonoGenericContainer *generic_container,
497 int def,
498 const char *ptr,
499 const char **rptr);
501 MonoMethodHeader *
502 mono_metadata_parse_mh_full (MonoImage *image,
503 MonoGenericContainer *container,
504 const char *ptr);
506 gboolean
507 mono_method_get_header_summary (MonoMethod *method, MonoMethodHeaderSummary *summary) MONO_INTERNAL;
509 int* mono_metadata_get_param_attrs (MonoImage *m, int def, int param_count) MONO_INTERNAL;
510 gboolean mono_metadata_method_has_param_attrs (MonoImage *m, int def) MONO_INTERNAL;
512 guint
513 mono_metadata_generic_context_hash (const MonoGenericContext *context) MONO_INTERNAL;
515 gboolean
516 mono_metadata_generic_context_equal (const MonoGenericContext *g1,
517 const MonoGenericContext *g2) MONO_INTERNAL;
519 MonoGenericInst *
520 mono_metadata_parse_generic_inst (MonoImage *image,
521 MonoGenericContainer *container,
522 int count,
523 const char *ptr,
524 const char **rptr) MONO_INTERNAL;
526 MonoGenericInst *
527 mono_metadata_get_generic_inst (int type_argc,
528 MonoType **type_argv) MONO_INTERNAL;
530 MonoGenericClass *
531 mono_metadata_lookup_generic_class (MonoClass *gclass,
532 MonoGenericInst *inst,
533 gboolean is_dynamic) MONO_INTERNAL;
535 MonoGenericInst * mono_metadata_inflate_generic_inst (MonoGenericInst *ginst, MonoGenericContext *context, MonoError *error) MONO_INTERNAL;
537 void mono_dynamic_stream_reset (MonoDynamicStream* stream) MONO_INTERNAL;
538 void mono_assembly_addref (MonoAssembly *assembly) MONO_INTERNAL;
539 void mono_assembly_load_friends (MonoAssembly* ass) MONO_INTERNAL;
540 gboolean mono_assembly_has_skip_verification (MonoAssembly* ass) MONO_INTERNAL;
542 gboolean mono_assembly_close_except_image_pools (MonoAssembly *assembly) MONO_INTERNAL;
543 void mono_assembly_close_finish (MonoAssembly *assembly) MONO_INTERNAL;
546 gboolean mono_public_tokens_are_equal (const unsigned char *pubt1, const unsigned char *pubt2) MONO_INTERNAL;
548 void mono_config_parse_publisher_policy (const char *filename, MonoAssemblyBindingInfo *binding_info) MONO_INTERNAL;
550 gboolean
551 mono_assembly_name_parse_full (const char *name,
552 MonoAssemblyName *aname,
553 gboolean save_public_key,
554 gboolean *is_version_defined,
555 gboolean *is_token_defined) MONO_INTERNAL;
557 guint32 mono_metadata_get_generic_param_row (MonoImage *image, guint32 token, guint32 *owner);
559 void mono_unload_interface_ids (MonoBitSet *bitset) MONO_INTERNAL;
562 MonoType *mono_metadata_type_dup (MonoImage *image, const MonoType *original) MONO_INTERNAL;
563 MonoMethodSignature *mono_metadata_signature_dup_full (MonoImage *image,MonoMethodSignature *sig) MONO_INTERNAL;
564 MonoMethodSignature *mono_metadata_signature_dup_mempool (MonoMemPool *mp, MonoMethodSignature *sig) MONO_INTERNAL;
566 MonoGenericInst *
567 mono_get_shared_generic_inst (MonoGenericContainer *container) MONO_INTERNAL;
570 mono_type_stack_size_internal (MonoType *t, int *align, gboolean allow_open) MONO_INTERNAL;
572 gboolean
573 mono_metadata_type_equal_full (MonoType *t1, MonoType *t2, gboolean signature_only) MONO_INTERNAL;
575 MonoMarshalSpec *
576 mono_metadata_parse_marshal_spec_full (MonoImage *image, const char *ptr) MONO_INTERNAL;
578 guint mono_metadata_generic_inst_hash (gconstpointer data) MONO_INTERNAL;
579 gboolean mono_metadata_generic_inst_equal (gconstpointer ka, gconstpointer kb) MONO_INTERNAL;
581 void
582 mono_metadata_field_info_with_mempool (
583 MonoImage *meta,
584 guint32 table_index,
585 guint32 *offset,
586 guint32 *rva,
587 MonoMarshalSpec **marshal_spec);
589 MonoClassField*
590 mono_metadata_get_corresponding_field_from_generic_type_definition (MonoClassField *field) MONO_INTERNAL;
592 MonoEvent*
593 mono_metadata_get_corresponding_event_from_generic_type_definition (MonoEvent *event) MONO_INTERNAL;
595 MonoProperty*
596 mono_metadata_get_corresponding_property_from_generic_type_definition (MonoProperty *property) MONO_INTERNAL;
598 guint32
599 mono_metadata_signature_size (MonoMethodSignature *sig) MONO_INTERNAL;
601 guint mono_metadata_str_hash (gconstpointer v1) MONO_INTERNAL;
603 gboolean mono_image_load_pe_data (MonoImage *image) MONO_INTERNAL;
605 gboolean mono_image_load_cli_data (MonoImage *image) MONO_INTERNAL;
607 void mono_image_load_names (MonoImage *image) MONO_INTERNAL;
609 MonoImage *mono_image_open_raw (const char *fname, MonoImageOpenStatus *status) MONO_INTERNAL;
611 #endif /* __MONO_METADATA_INTERNALS_H__ */